lightning-listpeerchannels -- Command returning data on channels of connected lightning nodes

SYNOPSIS

listpeerchannels [id]

DESCRIPTION

Command added in v23.02.

The listpeerchannels RPC command returns list of this node's channels, with the possibility to filter them by peer's node id.

If no id is supplied, then channel data on all lightning nodes that are connected, or not connected but have open channels with this node, are returned.

id (pubkey, optional): If supplied, limits the channels to just the peer with the given ID, if it exists.

RETURN VALUE

On success, an object containing channels is returned. It is an array of objects, where each object contains:

peer_id (pubkey): Node Public key.
peer_connected (boolean): A boolean flag that is set to true if the peer is online.
state (string) (one of "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", "CHANNELD_AWAITING_SPLICE", "DUALOPEND_OPEN_COMMITTED", "DUALOPEND_OPEN_COMMIT_READY"): The channel state, in particular CHANNELD_NORMAL means the channel can be used normally.
opener (string) (one of "local", "remote"): Who initiated the channel.
features (array of strings):
- (string, optional) (one of "option_static_remotekey", "option_anchor_outputs", "option_anchors", "option_anchors_zero_fee_htlc_tx", "option_scid_alias", "option_zeroconf"): BOLT #9 features which apply to this channel. Note that anchors_zero_fee_htlc_tx is a deprecated synonym for anchors.
reestablished (boolean, optional): A boolean flag that is set to true if we have successfully exchanged reestablish messages with this connection. (added v24.02)
scratch_txid (txid, optional): The txid we would use if we went onchain now.
channel_type (object, optional): Channel_type as negotiated with peer. (added v23.05):
- bits (array of u32s): Each bit set in this channel_type.:
  - (u32, optional): Bit number.
- names (array of strings): Feature name for each bit set in this channel_type. Note that anchors_zero_fee_htlc_tx is a deprecated synonym for anchors.:
  - (string, optional) (one of "static_remotekey/even", "anchor_outputs/even", "anchors/even", "anchors_zero_fee_htlc_tx/even", "scid_alias/even", "zeroconf/even"): Name of feature bit.
updates (object, optional): Latest gossip updates sent/received. (added v24.02):
- local (object): Our gossip for channel. (added v24.02):
  - htlc_minimum_msat (msat): Minimum msat amount we allow. (added v24.02)
  - htlc_maximum_msat (msat): Maximum msat amount we allow. (added v24.02)
  - cltv_expiry_delta (u32): Blocks delay required between incoming and outgoing HTLCs. (added v24.02)
  - fee_base_msat (msat): Amount we charge to use the channel. (added v24.02)
  - fee_proportional_millionths (u32): Amount we charge to use the channel in parts-per-million. (added v24.02)
- remote (object, optional): Peer's gossip for channel. (added v24.02):
  - htlc_minimum_msat (msat): Minimum msat amount they allow. (added v24.02)
  - htlc_maximum_msat (msat): Maximum msat amount they allow. (added v24.02)
  - cltv_expiry_delta (u32): Blocks delay required between incoming and outgoing HTLCs. (added v24.02)
  - fee_base_msat (msat): Amount they charge to use the channel. (added v24.02)
  - fee_proportional_millionths (u32): Amount they charge to use the channel in parts-per-million. (added v24.02)
ignore_fee_limits (boolean, optional): Set if we allow this peer to set fees to anything they want. (added v23.08)
lost_state (boolean, optional): Set if we are fallen behind i.e. lost some channel state. (added v24.02)
feerate (object, optional): Feerates for the current tx.:
- perkw (u32): Feerate per 1000 weight (i.e kSipa).
- perkb (u32): Feerate per 1000 virtual bytes.
owner (string, optional): The current subdaemon controlling this connection.
short_channel_id (short_channel_id, optional): The short_channel_id (once locked in).
channel_id (hash, optional): The full channel_id (funding txid Xored with output number).
funding_txid (txid, optional): ID of the funding transaction.
funding_outnum (u32, optional): The 0-based output number of the funding transaction which opens the channel.
initial_feerate (string, optional): For inflight opens, the first feerate used to initiate the channel open.
last_feerate (string, optional): For inflight opens, the most recent feerate used on the channel open.
next_feerate (string, optional): For inflight opens, the next feerate we'll use for the channel open.
next_fee_step (u32, optional): For inflight opens, the next feerate step we'll use for the channel open.
inflight (array of objects, optional): Current candidate funding transactions.:
- funding_txid (txid): ID of the funding transaction.
- funding_outnum (u32): The 0-based output number of the funding transaction which opens the channel.
- feerate (string): The feerate for this funding transaction in per-1000-weight, with kpw appended.
- total_funding_msat (msat): Total amount in the channel.
- splice_amount (integer): The amount of sats we're splicing in or out. (added v23.08)
- our_funding_msat (msat): Amount we have in the channel.
- scratch_txid (txid, optional): The commitment transaction txid we would use if we went onchain now.
close_to (hex, optional): ScriptPubkey which we have to close to if we mutual close.
private (boolean, optional): If True, we will not announce this channel.
closer (string, optional) (one of "local", "remote"): Who initiated the channel close (only present if closing).
funding (object, optional):
- local_funds_msat (msat): Amount of channel we funded.
- remote_funds_msat (msat): Amount of channel they funded.
- pushed_msat (msat, optional): Amount pushed from opener to peer.
- fee_paid_msat (msat, optional): Amount we paid peer at open.
- fee_rcvd_msat (msat, optional): Amount we were paid by peer at open.
to_us_msat (msat, optional): How much of channel is owed to us.
min_to_us_msat (msat, optional): Least amount owed to us ever. If the peer were to successfully steal from us, this is the amount we would still retain.
max_to_us_msat (msat, optional): 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 (msat, optional): Total amount in the channel.
fee_base_msat (msat, optional): Amount we charge to use the channel.
fee_proportional_millionths (u32, optional): Amount we charge to use the channel in parts-per-million.
dust_limit_msat (msat, optional): Minimum amount for an output on the channel transactions.
max_total_htlc_in_msat (msat, optional): Max amount accept in a single payment.
their_reserve_msat (msat, optional): Minimum we insist they keep in channel. If they have less than this in the channel, they cannot send to us on that channel. The default is 1% of the total channel capacity.
our_reserve_msat (msat, optional): 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 (msat, optional): 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 (msat, optional): An estimate of the total peer could send through channel.
minimum_htlc_in_msat (msat, optional): The minimum amount HTLC we accept.
minimum_htlc_out_msat (msat, optional): The minimum amount HTLC we will send.
maximum_htlc_out_msat (msat, optional): The maximum amount HTLC we will send.
their_to_self_delay (u32, optional): The number of blocks before they can take their funds if they unilateral close.
our_to_self_delay (u32, optional): The number of blocks before we can take our funds if we unilateral close.
max_accepted_htlcs (u32, optional): Maximum number of incoming HTLC we will accept at once.
alias (object, optional):
- local (short_channel_id, optional): An alias assigned by this node to this channel, used for outgoing payments.
- remote (short_channel_id, optional): An alias assigned by the remote node to this channel, usable in routehints and invoices.
state_changes (array of objects, optional): Prior state changes.:
- timestamp (string): UTC timestamp of form YYYY-mm-ddTHH:MM:SS.%03dZ.
- old_state (string) (one of "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", "DUALOPEND_OPEN_COMMITTED", "DUALOPEND_OPEN_COMMIT_READY", "CHANNELD_AWAITING_SPLICE"): Previous state.
- new_state (string) (one of "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", "DUALOPEND_OPEN_COMMITTED", "DUALOPEND_OPEN_COMMIT_READY", "CHANNELD_AWAITING_SPLICE"): New state.
- cause (string) (one of "unknown", "local", "user", "remote", "protocol", "onchain"): What caused the change.
- message (string): Human-readable explanation.
status (array of strings, optional):
- (string, optional): Billboard log of significant changes.
in_payments_offered (u64, optional): Number of incoming payment attempts.
in_offered_msat (msat, optional): Total amount of incoming payment attempts.
in_payments_fulfilled (u64, optional): Number of successful incoming payment attempts.
in_fulfilled_msat (msat, optional): Total amount of successful incoming payment attempts.
out_payments_offered (u64, optional): Number of outgoing payment attempts.
out_offered_msat (msat, optional): Total amount of outgoing payment attempts.
out_payments_fulfilled (u64, optional): Number of successful outgoing payment attempts.
out_fulfilled_msat (msat, optional): Total amount of successful outgoing payment attempts.
last_stable_connection (u64, optional): Last time we reestablished the open channel and stayed connected for 1 minute. (added v24.02)
htlcs (array of objects, optional): Current HTLCs in this channel.:
- direction (string) (one of "in", "out"): Whether it came from peer, or is going to peer. (added v23.02)
- id (u64): Unique ID for this htlc on this channel in this direction.
- amount_msat (msat): Amount send/received for this HTLC.
- expiry (u32): 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 (hash): The hash of the payment_preimage which will prove payment.
- local_trimmed (boolean, optional) (always true): 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 (string, optional): Set if this HTLC is currently waiting on a hook (and shows what plugin).
If direction is "out":
- state (string) (one of "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"): Status of the HTLC.
If direction is "in":
- state (string) (one of "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"): Status of the HTLC.

If peer_connected is true:

reestablished (boolean, optional): True if we have successfully exchanged reestablish messages this connection.

If close_to is present:

close_to_addr (string, optional): The bitcoin address we will close to (present if close_to_addr is a standardized address).

If scratch_txid is present:

last_tx_fee_msat (msat): Fee attached to this the current tx.

If short_channel_id is present:

direction (u32): 0 if we're the lesser node_id, 1 if we're the greater (as used in BOLT #7 channel_update). (added v23.02)

If inflight is present:

initial_feerate (string): The feerate for the initial funding transaction in per-1000-weight, with kpw appended.
last_feerate (string): The feerate for the latest funding transaction in per-1000-weight, with kpw appended.
next_feerate (string): The minimum feerate for the next funding transaction in per-1000-weight, with kpw appended.

The state field values (and old_state / new_state) are worth describing further:

OPENINGD: The channel funding protocol with the peer is ongoing and both sides are negotiating parameters.
DUALOPEND_OPEN_INIT: Like OPENINGD, but for v2 connections which are using collaborative opens.
DUALOPEND_OPEN_COMMIT_READY: Like OPENINGD, but for v2 connections which are using collaborative opens. You're ready to send your commitment signed to your peer.
DUALOPEND_OPEN_COMMITTED: Like OPENINGD, but for v2 connections which are using collaborative opens. You've gotten an initial signed commitment from your peer.
CHANNELD_AWAITING_LOCKIN / DUALOPEND_AWAITING_LOCKIN: The peer and you have agreed on channel parameters and are just waiting for the channel funding transaction to be confirmed deeply (original and collaborative open protocols, respectively). Both you and the peer must acknowledge the channel funding transaction to be confirmed deeply before entering the next state. Also, you can increase the onchain fee for channels in DUALOPEND_AWAITING_LOCKIN using lightning-openchannel_bump(7).
CHANNELD_NORMAL: The channel can be used for normal payments.
CHANNELD_SHUTTING_DOWN: A mutual close was requested (by you or peer) and both of you are waiting for HTLCs in-flight to be either failed or succeeded. The channel can no longer be used for normal payments and forwarding. Mutual close will proceed only once all HTLCs in the channel have either been fulfilled or failed.
CLOSINGD_SIGEXCHANGE: You and the peer are negotiating the mutual close onchain fee.
CLOSINGD_COMPLETE: You and the peer have agreed on the mutual close onchain fee and are awaiting the mutual close getting confirmed deeply.
AWAITING_UNILATERAL: You initiated a unilateral close, and are now waiting for the peer-selected unilateral close timeout to complete.
FUNDING_SPEND_SEEN: You saw the funding transaction getting spent (usually the peer initiated a unilateral close) and will now determine what exactly happened (i.e. if it was a theft attempt).
ONCHAIN: You saw the funding transaction getting spent and now know what happened (i.e. if it was a proper unilateral close by the peer, or a theft attempt).

ERRORS

On error the returned object will contain code and message properties, with code being one of the following:

-32602: If the given parameters are wrong.

AUTHOR

Michael Hawkins <[email protected]>.

RESOURCES

Main web site: https://github.com/ElementsProject/lightning
Lightning RFC site (BOLT #9):
https://github.com/lightningnetwork/lightning-rfc/blob/master/09-features.md

EXAMPLES

Example 1:

Request:

lightning-cli listpeerchannels -k "id"="nodeid020202020202020202020202020202020202020202020202020202020202"

{
  "id": "example:listpeerchannels#1",
  "method": "listpeerchannels",
  "params": {
    "id": "nodeid020202020202020202020202020202020202020202020202020202020202"
  }
}

Response:

{
  "channels": [
    {
      "peer_id": "nodeid020202020202020202020202020202020202020202020202020202020202",
      "peer_connected": true,
      "reestablished": true,
      "channel_type": {
        "bits": [
          12,
          22
        ],
        "names": [
          "static_remotekey/even",
          "anchors/even"
        ]
      },
      "updates": {
        "local": {
          "htlc_minimum_msat": 0,
          "htlc_maximum_msat": 990000000,
          "cltv_expiry_delta": 6,
          "fee_base_msat": 1,
          "fee_proportional_millionths": 10
        },
        "remote": {
          "htlc_minimum_msat": 0,
          "htlc_maximum_msat": 990000000,
          "cltv_expiry_delta": 6,
          "fee_base_msat": 1,
          "fee_proportional_millionths": 10
        }
      },
      "last_stable_connection": 1738510000,
      "state": "CHANNELD_NORMAL",
      "scratch_txid": "scratchid1010101010101010101010101010101010101010101010101010101",
      "last_tx_fee_msat": 4867000,
      "lost_state": false,
      "feerate": {
        "perkw": 3755,
        "perkb": 15020
      },
      "owner": "channeld",
      "short_channel_id": "109x1x1",
      "direction": 1,
      "channel_id": "channelid0120000120000120000120000120000120000120000120000120000",
      "funding_txid": "channeltxid120000120000120000120000120000120000120000120000120000",
      "funding_outnum": 1,
      "close_to_addr": "bcrt1p8c0ku4mpxq3443rss8e6rjwamztvv8yxvmxtetal5d0n6v39rlwqvfqy6n",
      "close_to": "51203e1f6e576130235ac47081f3a1c9ddd896c61c8666ccbcafbfa35f3d32251fdc",
      "private": false,
      "opener": "local",
      "alias": {
        "local": "30000001x60000001x60001",
        "remote": "10000001x20000001x30001"
      },
      "features": [
        "option_static_remotekey",
        "option_anchors_zero_fee_htlc_tx",
        "option_anchors"
      ],
      "funding": {
        "local_funds_msat": 1000000000,
        "remote_funds_msat": 0,
        "pushed_msat": 0
      },
      "to_us_msat": 390492790,
      "min_to_us_msat": 390492790,
      "max_to_us_msat": 1000000000,
      "total_msat": 1000000000,
      "fee_base_msat": 1,
      "fee_proportional_millionths": 10,
      "dust_limit_msat": 546000,
      "max_total_htlc_in_msat": 18446744073709552000,
      "their_reserve_msat": 10000000,
      "our_reserve_msat": 10000000,
      "spendable_msat": 363951708,
      "receivable_msat": 599507210,
      "minimum_htlc_in_msat": 0,
      "minimum_htlc_out_msat": 0,
      "maximum_htlc_out_msat": 990000000,
      "their_to_self_delay": 5,
      "our_to_self_delay": 5,
      "max_accepted_htlcs": 483,
      "state_changes": [
        {
          "timestamp": "2024-10-10T00:01:00.000Z",
          "old_state": "DUALOPEND_OPEN_COMMITTED",
          "new_state": "DUALOPEND_AWAITING_LOCKIN",
          "cause": "user",
          "message": "Sigs exchanged, waiting for lock-in"
        },
        {
          "timestamp": "2024-10-10T00:02:00.000Z",
          "old_state": "DUALOPEND_AWAITING_LOCKIN",
          "new_state": "CHANNELD_NORMAL",
          "cause": "user",
          "message": "Lockin complete"
        }
      ],
      "status": [
        "CHANNELD_NORMAL:Channel ready for use."
      ],
      "in_payments_offered": 1,
      "in_offered_msat": 1000000,
      "in_payments_fulfilled": 1,
      "in_fulfilled_msat": 1000000,
      "out_payments_offered": 22,
      "out_offered_msat": 665528797,
      "out_payments_fulfilled": 16,
      "out_fulfilled_msat": 610507210,
      "htlcs": [
        {
          "direction": "out",
          "id": 17,
          "amount_msat": 4000082,
          "expiry": 181,
          "payment_hash": "paymenthashdelpay30303030303030303030303030303030303030303030303",
          "state": "SENT_ADD_ACK_REVOCATION"
        }
      ]
    }
  ]
}

Example 2: