core-lightning/doc/schemas/listtransactions.schema.json
Rusty Russell 40fe893172 doc/schemas: fix old deprecations.
`"deprecated": true` is obsolete; we don't document them anyway.

Where it would have otherwise changed the GRPC wrappers, I actually put the
version number in.

We allow "listchannels" to have "satoshis" since we have some tests
that run in deprecated-api mode.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2023-01-30 15:15:41 -06:00

150 lines
4.5 KiB
JSON

{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"additionalProperties": false,
"required": [
"transactions"
],
"properties": {
"transactions": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"hash",
"rawtx",
"blockheight",
"txindex",
"locktime",
"version",
"inputs",
"outputs"
],
"properties": {
"hash": {
"type": "txid",
"description": "the transaction id"
},
"rawtx": {
"type": "hex",
"description": "the raw transaction"
},
"blockheight": {
"type": "u32",
"description": "the block height of this tx"
},
"txindex": {
"type": "u32",
"description": "the transaction number within the block"
},
"locktime": {
"type": "u32",
"description": "The nLocktime for this tx"
},
"version": {
"type": "u32",
"description": "The nVersion for this tx"
},
"inputs": {
"type": "array",
"description": "Each input, in order",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"txid",
"index",
"sequence"
],
"properties": {
"txid": {
"type": "txid",
"description": "the transaction id spent"
},
"index": {
"type": "u32",
"description": "the output spent"
},
"sequence": {
"type": "u32",
"description": "the nSequence value"
},
"type": {
"type": "string",
"enum": [
"theirs",
"deposit",
"withdraw",
"channel_funding",
"channel_mutual_close",
"channel_unilateral_close",
"channel_sweep",
"channel_htlc_success",
"channel_htlc_timeout",
"channel_penalty",
"channel_unilateral_cheat"
],
"description": "the purpose of this input (*EXPERIMENTAL_FEATURES* only)"
},
"channel": {
"type": "short_channel_id",
"description": "the channel this input is associated with (*EXPERIMENTAL_FEATURES* only)"
}
}
}
},
"outputs": {
"type": "array",
"description": "Each output, in order",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"index",
"amount_msat",
"scriptPubKey"
],
"properties": {
"index": {
"type": "u32",
"description": "the 0-based output number"
},
"amount_msat": {
"type": "msat",
"description": "the amount of the output"
},
"scriptPubKey": {
"type": "hex",
"description": "the scriptPubKey"
},
"type": {
"type": "string",
"enum": [
"theirs",
"deposit",
"withdraw",
"channel_funding",
"channel_mutual_close",
"channel_unilateral_close",
"channel_sweep",
"channel_htlc_success",
"channel_htlc_timeout",
"channel_penalty",
"channel_unilateral_cheat"
],
"description": "the purpose of this output (*EXPERIMENTAL_FEATURES* only)"
},
"channel": {
"type": "short_channel_id",
"description": "the channel this output is associated with (*EXPERIMENTAL_FEATURES* only)"
}
}
}
}
}
}
}
}
}