mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-19 18:11:28 +01:00
Code Issues Projects Releases Wiki Activity
442b479d2c
core-lightning/doc/schemas/listpeerchannels.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

931 lines
33 KiB
JSON
Raw Blame History

{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"additionalProperties": false,
"required": [
"channels"
],
"properties": {
"channels": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"required": [
"state",
"opener",
"features",
"peer_connected",
"peer_id"
],
"properties": {
"peer_id": {
"type": "pubkey",
"description": "Node Public key"
},
"peer_connected": {
"type": "boolean",
"description": "A boolean flag that is set to true if the peer is online"
},
"state": {
"type": "string",
"enum": [
"OPENINGD",
"CHANNELD_AWAITING_LOCKIN",
"CHANNELD_NORMAL",
"CHANNELD_SHUTTING_DOWN",
"CLOSINGD_SIGEXCHANGE",
"CLOSINGD_COMPLETE",
"AWAITING_UNILATERAL",
"FUNDING_SPEND_SEEN",
"ONCHAIN",
"DUALOPEND_OPEN_INIT",
"DUALOPEND_AWAITING_LOCKIN"
],
"description": "the channel state, in particular \"CHANNELD_NORMAL\" means the channel can be used normally"
},
"scratch_txid": {
"type": "txid",
"description": "The txid we would use if we went onchain now"
},
"feerate": {
"type": "object",
"description": "Feerates for the current tx",
"additionalProperties": false,
"required": [
"perkw",
"perkb"
],
"properties": {
"perkw": {
"type": "u32",
"description": "Feerate per 1000 weight (i.e kSipa)"
},
"perkb": {
"type": "u32",
"description": "Feerate per 1000 virtual bytes"
}
}
},
"owner": {
"type": "string",
"description": "The current subdaemon controlling this connection"
},
"short_channel_id": {
"type": "short_channel_id",
"description": "The short_channel_id (once locked in)"
},
"channel_id": {
"type": "hash",
"description": "The full channel_id (funding txid Xored with output number)"
},
"funding_txid": {
"type": "txid",
"description": "ID of the funding transaction"
},
"funding_outnum": {
"type": "u32",
"description": "The 0-based output number of the funding transaction which opens the channel"
},
"initial_feerate": {
"type": "string",
"description": "For inflight opens, the first feerate used to initiate the channel open"
},
"last_feerate": {
"type": "string",
"description": "For inflight opens, the most recent feerate used on the channel open"
},
"next_feerate": {
"type": "string",
"description": "For inflight opens, the next feerate we'll use for the channel open"
},
"next_fee_step": {
"type": "u32",
"description": "For inflight opens, the next feerate step we'll use for the channel open"
},
"inflight": {
"type": "array",
"description": "Current candidate funding transactions (only for dual-funding)",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"funding_txid",
"funding_outnum",
"feerate",
"total_funding_msat",
"our_funding_msat",
"scratch_txid"
],
"properties": {
"funding_txid": {
"type": "txid",
"description": "ID of the funding transaction"
},
"funding_outnum": {
"type": "u32",
"description": "The 0-based output number of the funding transaction which opens the channel"
},
"feerate": {
"type": "string",
"description": "The feerate for this funding transaction in per-1000-weight, with \"kpw\" appended"
},
"total_funding_msat": {
"type": "msat",
"description": "total amount in the channel"
},
"our_funding_msat": {
"type": "msat",
"description": "amount we have in the channel"
},
"scratch_txid": {
"type": "txid",
"description": "The commitment transaction txid we would use if we went onchain now"
}
}
}
},
"close_to": {
"type": "hex",
"description": "scriptPubkey which we have to close to if we mutual close"
},
"private": {
"type": "boolean",
"description": "if False, we will not announce this channel"
},
"opener": {
"type": "string",
"enum": [
"local",
"remote"
],
"description": "Who initiated the channel"
},
"closer": {
"type": "string",
"enum": [
"local",
"remote"
],
"description": "Who initiated the channel close (only present if closing)"
},
"features": {
"type": "array",
"items": {
"type": "string",
"enum": [
"option_static_remotekey",
"option_anchor_outputs",
"option_zeroconf"
],
"description": "BOLT #9 features which apply to this channel"
}
},
"funding": {
"type": "object",
"additionalProperties": false,
"required": [
"local_funds_msat",
"remote_funds_msat"
],
"properties": {
"local_msat": {
"type": "msat",
"deprecated": "v0.12.0",
"description": "Amount of channel we funded"
},
"remote_msat": {
"type": "msat",
"deprecated": "v0.12.0",
"description": "Amount of channel they funded"
},
"pushed_msat": {
"type": "msat",
"description": "Amount pushed from opener to peer"
},
"local_funds_msat": {
"type": "msat",
"description": "Amount of channel we funded"
},
"remote_funds_msat": {
"type": "msat",
"description": "Amount of channel they funded"
},
"fee_paid_msat": {
"type": "msat",
"description": "Amount we paid peer at open"
},
"fee_rcvd_msat": {
"type": "msat",
"description": "Amount we were paid by peer at open"
}
}
},
"to_us_msat": {
"type": "msat",
"description": "How much of channel is owed to us"
},
"min_to_us_msat": {
"type": "msat",
"description": "Least amount owed to us ever. If the peer were to succesfully steal from us, this is the amount we would still retain."
},
"max_to_us_msat": {
"type": "msat",
"description": "Most amount owed to us ever. If we were to successfully steal from the peer, this is the amount we could potentially get."
},
"total_msat": {
"type": "msat",
"description": "total amount in the channel"
},
"fee_base_msat": {
"type": "msat",
"description": "amount we charge to use the channel"
},
"fee_proportional_millionths": {
"type": "u32",
"description": "amount we charge to use the channel in parts-per-million"
},
"dust_limit_msat": {
"type": "msat",
"description": "Minimum amount for an output on the channel transactions"
},
"max_total_htlc_in_msat": {
"type": "msat",
"description": "Max amount accept in a single payment"
},
"their_reserve_msat": {
"type": "msat",
"description": "Minimum we insist they keep in channel (default is 1% of the total channel capacity). If they have less than this in the channel, they cannot send to us on that channel"
},
"our_reserve_msat": {
"type": "msat",
"description": "Minimum they insist we keep in channel. If you have less than this in the channel, you cannot send out via this channel."
},
"spendable_msat": {
"type": "msat",
"description": "An estimate of the total we could send through channel (can be wrong because adding HTLCs requires an increase in fees paid to onchain miners, and onchain fees change dynamically according to onchain activity)"
},
"receivable_msat": {
"type": "msat",
"description": "An estimate of the total peer could send through channel"
},
"minimum_htlc_in_msat": {
"type": "msat",
"description": "The minimum amount HTLC we accept"
},
"minimum_htlc_out_msat": {
"type": "msat",
"description": "The minimum amount HTLC we will send"
},
"maximum_htlc_out_msat": {
"type": "msat",
"description": "The maximum amount HTLC we will send"
},
"their_to_self_delay": {
"type": "u32",
"description": "The number of blocks before they can take their funds if they unilateral close"
},
"our_to_self_delay": {
"type": "u32",
"description": "The number of blocks before we can take our funds if we unilateral close"
},
"max_accepted_htlcs": {
"type": "u32",
"description": "Maximum number of incoming HTLC we will accept at once"
},
"alias": {
"type": "object",
"required": [],
"properties": {
"local": {
"type": "short_channel_id",
"description": "An alias assigned by this node to this channel, used for outgoing payments"
},
"remote": {
"type": "short_channel_id",
"description": "An alias assigned by the remote node to this channel, usable in routehints and invoices"
}
}
},
"state_changes": {
"type": "array",
"description": "Prior state changes",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"timestamp",
"old_state",
"new_state",
"cause",
"message"
],
"properties": {
"timestamp": {
"type": "string",
"description": "UTC timestamp of form YYYY-mm-ddTHH:MM:SS.%03dZ"
},
"old_state": {
"type": "string",
"enum": [
"OPENINGD",
"CHANNELD_AWAITING_LOCKIN",
"CHANNELD_NORMAL",
"CHANNELD_SHUTTING_DOWN",
"CLOSINGD_SIGEXCHANGE",
"CLOSINGD_COMPLETE",
"AWAITING_UNILATERAL",
"FUNDING_SPEND_SEEN",
"ONCHAIN",
"DUALOPEND_OPEN_INIT",
"DUALOPEND_AWAITING_LOCKIN"
],
"description": "Previous state"
},
"new_state": {
"type": "string",
"enum": [
"OPENINGD",
"CHANNELD_AWAITING_LOCKIN",
"CHANNELD_NORMAL",
"CHANNELD_SHUTTING_DOWN",
"CLOSINGD_SIGEXCHANGE",
"CLOSINGD_COMPLETE",
"AWAITING_UNILATERAL",
"FUNDING_SPEND_SEEN",
"ONCHAIN",
"DUALOPEND_OPEN_INIT",
"DUALOPEND_AWAITING_LOCKIN"
],
"description": "New state"
},
"cause": {
"type": "string",
"enum": [
"unknown",
"local",
"user",
"remote",
"protocol",
"onchain"
],
"description": "What caused the change"
},
"message": {
"type": "string",
"description": "Human-readable explanation"
}
}
}
},
"status": {
"type": "array",
"items": {
"type": "string",
"description": "Billboard log of significant changes"
}
},
"in_payments_offered": {
"type": "u64",
"description": "Number of incoming payment attempts"
},
"in_offered_msat": {
"type": "msat",
"description": "Total amount of incoming payment attempts"
},
"in_payments_fulfilled": {
"type": "u64",
"description": "Number of successful incoming payment attempts"
},
"in_fulfilled_msat": {
"type": "msat",
"description": "Total amount of successful incoming payment attempts"
},
"out_payments_offered": {
"type": "u64",
"description": "Number of outgoing payment attempts"
},
"out_offered_msat": {
"type": "msat",
"description": "Total amount of outgoing payment attempts"
},
"out_payments_fulfilled": {
"type": "u64",
"description": "Number of successful outgoing payment attempts"
},
"out_fulfilled_msat": {
"type": "msat",
"description": "Total amount of successful outgoing payment attempts"
},
"htlcs": {
"type": "array",
"description": "current HTLCs in this channel",
"items": {
"type": "object",
"additionalProperties": true,
"required": [
"direction",
"id",
"amount_msat",
"expiry",
"payment_hash",
"state"
],
"properties": {
"direction": {
"type": "string",
"enum": [
"in",
"out"
],
"description": "Whether it came from peer, or is going to peer"
},
"id": {
"type": "u64",
"description": "Unique ID for this htlc on this channel in this direction"
},
"amount_msat": {
"type": "msat",
"description": "Amount send/received for this HTLC"
},
"expiry": {
"type": "u32",
"description": "Block this HTLC expires at (after which an `in` direction HTLC will be returned to the peer, an `out` returned to us). If this expiry is too close, lightningd(8) will automatically unilaterally close the channel in order to enforce the timeout onchain."
},
"payment_hash": {
"type": "hash",
"description": "the hash of the payment_preimage which will prove payment"
},
"local_trimmed": {
"type": "boolean",
"enum": [
true
],
"description": "If this is too small to enforce onchain; it doesn't appear in the commitment transaction and will not be enforced in a unilateral close. Generally true if the HTLC (after subtracting onchain fees) is below the `dust_limit_msat` for the channel."
},
"status": {
"type": "string",
"description": "set if this HTLC is currently waiting on a hook (and shows what plugin)"
}
},
"allOf": [
{
"if": {
"properties": {
"direction": {
"enum": [
"out"
]
}
}
},
"then": {
"additionalProperties": false,
"required": [
"state"
],
"properties": {
"direction": {},
"id": {},
"amount_msat": {},
"msatoshi": {},
"expiry": {},
"payment_hash": {},
"local_trimmed": {},
"status": {},
"alias": {},
"peer_id": {},
"peer_connected": {},
"state": {
"type": "string",
"enum": [
"SENT_ADD_HTLC",
"SENT_ADD_COMMIT",
"RCVD_ADD_REVOCATION",
"RCVD_ADD_ACK_COMMIT",
"SENT_ADD_ACK_REVOCATION",
"RCVD_REMOVE_HTLC",
"RCVD_REMOVE_COMMIT",
"SENT_REMOVE_REVOCATION",
"SENT_REMOVE_ACK_COMMIT",
"RCVD_REMOVE_ACK_REVOCATION"
],
"description": "Status of the HTLC"
}
}
}
},
{
"if": {
"properties": {
"direction": {
"enum": [
"in"
]
}
}
},
"then": {
"additionalProperties": false,
"required": [
"state"
],
"properties": {
"direction": {},
"id": {},
"amount_msat": {},
"msatoshi": {},
"expiry": {},
"payment_hash": {},
"local_trimmed": {},
"status": {},
"peer_id": {},
"peer_connected": {},
"state": {
"type": "string",
"enum": [
"RCVD_ADD_HTLC",
"RCVD_ADD_COMMIT",
"SENT_ADD_REVOCATION",
"SENT_ADD_ACK_COMMIT",
"RCVD_ADD_ACK_REVOCATION",
"SENT_REMOVE_HTLC",
"SENT_REMOVE_COMMIT",
"RCVD_REMOVE_REVOCATION",
"RCVD_REMOVE_ACK_COMMIT",
"SENT_REMOVE_ACK_REVOCATION"
],
"description": "Status of the HTLC"
}
}
}
}
]
}
}
},
"allOf": [
{
"if": {
"required": [
"close_to"
]
},
"then": {
"additionalProperties": false,
"required": [],
"properties": {
"state": {},
"peer_id": {},
"peer_connected": {},
"scratch_txid": {},
"feerate": {},
"owner": {},
"short_channel_id": {},
"channel_id": {},
"funding_txid": {},
"funding_outnum": {},
"close_to": {},
"private": {},
"alias": {},
"opener": {},
"closer": {},
"features": {},
"funding": {},
"to_us_msat": {},
"min_to_us_msat": {},
"max_to_us_msat": {},
"total_msat": {},
"fee_base_msat": {},
"fee_proportional_millionths": {},
"dust_limit_msat": {},
"max_total_htlc_in_msat": {},
"their_reserve_msat": {},
"our_reserve_msat": {},
"spendable_msat": {},
"receivable_msat": {},
"minimum_htlc_in_msat": {},
"minimum_htlc_out_msat": {},
"maximum_htlc_out_msat": {},
"spendable_msatoshi": {},
"receivable_msatoshi": {},
"their_to_self_delay": {},
"our_to_self_delay": {},
"max_accepted_htlcs": {},
"msatoshi_to_us": {},
"msatoshi_to_us_min": {},
"msatoshi_to_us_max": {},
"msatoshi_total": {},
"dust_limit_satoshis": {},
"max_htlc_value_in_flight_msat": {},
"our_channel_reserve_satoshis": {},
"their_channel_reserve_satoshis": {},
"spendable_satoshis": {},
"receivable_satoshis": {},
"htlc_minimum_msat": {},
"state_changes": {},
"status": {},
"in_payments_offered": {},
"in_offered_msat": {},
"in_msatoshi_offered": {},
"in_payments_fulfilled": {},
"in_fulfilled_msat": {},
"in_msatoshi_fulfilled": {},
"out_payments_offered": {},
"out_offered_msat": {},
"out_msatoshi_offered": {},
"out_payments_fulfilled": {},
"out_fulfilled_msat": {},
"out_msatoshi_fulfilled": {},
"htlcs": {},
"initial_feerate": {},
"last_feerate": {},
"next_feerate": {},
"inflight": {},
"last_tx_fee_msat": {},
"direction": {},
"close_to_addr": {
"type": "string",
"description": "The bitcoin address we will close to (present if close_to_addr is a standardized address)"
}
}
}
},
{
"if": {
"required": [
"scratch_txid"
]
},
"then": {
"additionalProperties": false,
"required": [
"last_tx_fee_msat"
],
"properties": {
"state": {},
"peer_id": {},
"peer_connected": {},
"alias": {},
"scratch_txid": {},
"feerate": {},
"owner": {},
"short_channel_id": {},
"channel_id": {},
"funding_txid": {},
"funding_outnum": {},
"inflight": {},
"close_to": {},
"private": {},
"opener": {},
"closer": {},
"features": {},
"funding": {},
"to_us_msat": {},
"min_to_us_msat": {},
"max_to_us_msat": {},
"total_msat": {},
"fee_base_msat": {},
"fee_proportional_millionths": {},
"dust_limit_msat": {},
"max_total_htlc_in_msat": {},
"their_reserve_msat": {},
"our_reserve_msat": {},
"spendable_msat": {},
"receivable_msat": {},
"minimum_htlc_in_msat": {},
"minimum_htlc_out_msat": {},
"maximum_htlc_out_msat": {},
"spendable_msatoshi": {},
"receivable_msatoshi": {},
"their_to_self_delay": {},
"our_to_self_delay": {},
"max_accepted_htlcs": {},
"msatoshi_to_us": {},
"msatoshi_to_us_min": {},
"msatoshi_to_us_max": {},
"msatoshi_total": {},
"dust_limit_satoshis": {},
"max_htlc_value_in_flight_msat": {},
"our_channel_reserve_satoshis": {},
"their_channel_reserve_satoshis": {},
"spendable_satoshis": {},
"receivable_satoshis": {},
"htlc_minimum_msat": {},
"state_changes": {},
"status": {},
"in_payments_offered": {},
"in_offered_msat": {},
"in_msatoshi_offered": {},
"in_payments_fulfilled": {},
"in_fulfilled_msat": {},
"in_msatoshi_fulfilled": {},
"out_payments_offered": {},
"out_offered_msat": {},
"out_msatoshi_offered": {},
"out_payments_fulfilled": {},
"out_fulfilled_msat": {},
"out_msatoshi_fulfilled": {},
"htlcs": {},
"initial_feerate": {},
"last_feerate": {},
"next_feerate": {},
"close_to_addr": {},
"direction": {},
"last_tx_fee_msat": {
"type": "msat",
"description": "fee attached to this the current tx"
}
}
}
},
{
"if": {
"required": [
"short_channel_id"
]
},
"then": {
"additionalProperties": false,
"required": [
"direction"
],
"properties": {
"alias": {},
"peer_id": {},
"peer_connected": {},
"state": {},
"scratch_txid": {},
"feerate": {},
"owner": {},
"short_channel_id": {},
"channel_id": {},
"funding_txid": {},
"funding_outnum": {},
"inflight": {},
"close_to": {},
"private": {},
"opener": {},
"closer": {},
"features": {},
"funding": {},
"to_us_msat": {},
"min_to_us_msat": {},
"max_to_us_msat": {},
"total_msat": {},
"fee_base_msat": {},
"fee_proportional_millionths": {},
"dust_limit_msat": {},
"max_total_htlc_in_msat": {},
"their_reserve_msat": {},
"our_reserve_msat": {},
"spendable_msat": {},
"receivable_msat": {},
"minimum_htlc_in_msat": {},
"minimum_htlc_out_msat": {},
"maximum_htlc_out_msat": {},
"spendable_msatoshi": {},
"receivable_msatoshi": {},
"their_to_self_delay": {},
"our_to_self_delay": {},
"max_accepted_htlcs": {},
"msatoshi_to_us": {},
"msatoshi_to_us_min": {},
"msatoshi_to_us_max": {},
"msatoshi_total": {},
"dust_limit_satoshis": {},
"max_htlc_value_in_flight_msat": {},
"our_channel_reserve_satoshis": {},
"their_channel_reserve_satoshis": {},
"spendable_satoshis": {},
"receivable_satoshis": {},
"htlc_minimum_msat": {},
"state_changes": {},
"status": {},
"in_payments_offered": {},
"in_offered_msat": {},
"in_msatoshi_offered": {},
"in_payments_fulfilled": {},
"in_fulfilled_msat": {},
"in_msatoshi_fulfilled": {},
"out_payments_offered": {},
"out_offered_msat": {},
"out_msatoshi_offered": {},
"out_payments_fulfilled": {},
"out_fulfilled_msat": {},
"out_msatoshi_fulfilled": {},
"htlcs": {},
"initial_feerate": {},
"last_feerate": {},
"next_feerate": {},
"close_to_addr": {},
"last_tx_fee_msat": {},
"direction": {
"type": "u32",
"description": "0 if we're the lesser node_id, 1 if we're the greater (as used in BOLT #7 channel_update)"
}
}
}
},
{
"if": {
"required": [
"inflight"
]
},
"then": {
"additionalProperties": false,
"required": [
"initial_feerate",
"last_feerate",
"next_feerate"
],
"properties": {
"state": {},
"peer_id": {},
"peer_connected": {},
"scratch_txid": {},
"feerate": {},
"owner": {},
"alias": {},
"short_channel_id": {},
"channel_id": {},
"funding_txid": {},
"funding_outnum": {},
"close_to": {},
"private": {},
"opener": {},
"closer": {},
"features": {},
"funding": {},
"to_us_msat": {},
"min_to_us_msat": {},
"max_to_us_msat": {},
"total_msat": {},
"fee_base_msat": {},
"fee_proportional_millionths": {},
"dust_limit_msat": {},
"max_total_htlc_in_msat": {},
"their_reserve_msat": {},
"our_reserve_msat": {},
"spendable_msat": {},
"receivable_msat": {},
"minimum_htlc_in_msat": {},
"minimum_htlc_out_msat": {},
"maximum_htlc_out_msat": {},
"spendable_msatoshi": {},
"receivable_msatoshi": {},
"their_to_self_delay": {},
"our_to_self_delay": {},
"max_accepted_htlcs": {},
"msatoshi_to_us": {},
"msatoshi_to_us_min": {},
"msatoshi_to_us_max": {},
"msatoshi_total": {},
"dust_limit_satoshis": {},
"max_htlc_value_in_flight_msat": {},
"our_channel_reserve_satoshis": {},
"their_channel_reserve_satoshis": {},
"spendable_satoshis": {},
"receivable_satoshis": {},
"htlc_minimum_msat": {},
"state_changes": {},
"status": {},
"in_payments_offered": {},
"in_offered_msat": {},
"in_msatoshi_offered": {},
"in_payments_fulfilled": {},
"in_fulfilled_msat": {},
"in_msatoshi_fulfilled": {},
"out_payments_offered": {},
"out_offered_msat": {},
"out_msatoshi_offered": {},
"out_payments_fulfilled": {},
"out_fulfilled_msat": {},
"out_msatoshi_fulfilled": {},
"htlcs": {},
"inflight": {},
"close_to_addr": {},
"direction": {},
"last_tx_fee_msat": {},
"initial_feerate": {
"type": "string",
"description": "The feerate for the initial funding transaction in per-1000-weight, with \"kpw\" appended"
},
"last_feerate": {
"type": "string",
"description": "The feerate for the latest funding transaction in per-1000-weight, with \"kpw\" appended"
},
"next_feerate": {
"type": "string",
"description": "The minimum feerate for the next funding transaction in per-1000-weight, with \"kpw\" appended"
}
}
}
}
]
}
}
}
}
Reference in New Issue View Git Blame Copy Permalink