mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-19 09:54:16 +01:00
Code Issues Projects Releases Wiki Activity
d45b13df56
core-lightning/doc/lightning-listhtlcs.7.md
Rusty Russell 7420a7021f lightningd: add listhtlcs to list all the HTLCs we know about. 
Using `listfowards` for this wrong; expose this directly if people
care (and unlike listforwards, which could be deleted, we have to
remember these while the channel is still open!).

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
Changelog-Added: JSON-RPC: `listhtlcs` new command to list all known HTLCS.
2022-09-22 15:19:46 +02:00

2.0 KiB
Raw Blame History

lightning-listhtlcs -- Command for querying HTLCs

SYNOPSIS

listhtlcs [id]

DESCRIPTION

The listhtlcs RPC command gets all HTLCs (which, generally, we remember for as long as a channel is open, even if they've completed long ago). If given a short channel id (e.g. 1x2x3) or full 64-byte hex channel id, it will only list htlcs for that channel (which must be known).

RETURN VALUE

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

  • short_channel_id (short_channel_id): the channel that contains/contained the HTLC
  • id (u64): the unique, incrementing HTLC id the creator gave this
  • expiry (u32): the block number where this HTLC expires/expired
  • amount_msat (msat): the value of the HTLC
  • direction (string): out if we offered this to the peer, in if they offered it (one of "out", "in")
  • payment_hash (hex): payment hash sought by HTLC (always 64 characters)
  • state (string): The first 10 states are for in, the next 10 are for out. (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", "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")

AUTHOR

Rusty Russell <rusty@rustcorp.com.au> is mainly responsible.

SEE ALSO

lightning-listforwards(7)

RESOURCES

Main web site: https://github.com/ElementsProject/lightning