davide/palladum-lightning
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

lightningd: separate coin_movement tags array into primary_tag and extra_tags.

Browse Source 
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
Changelog-Deprecated: JSON-RPC: `coin_movement` notification `tags` array (use `primary_tag` and `extra_tags`).
Changelog-Added: JSON-RPC: `coin_movement` notification `primary_tag` and `extra_tags`.
This commit is contained in:
Rusty Russell
2025-08-14 10:57:55 +09:30
parent 9b2c87f052
commit 650f3882dd
5 changed files with 68 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
doc/developers-guide/deprecated-features.md
View File

@@ -18,6 +18,7 @@ hidden: false
| listpeerchannels.max_total_htlc_in_msat | Field | v25.02 | v26.03 | Use our_max_total_htlc_out_msat |
| wait.details | Field | v25.05 | v26.06 | Use subsystem-specific object instead |
| channel_state_changed.old_state.unknown | Notification Field | v25.05 | v26.03 | Value "unknown" is deprecated: field will be omitted instead |
| coin_movement.tags | Notification Field | v25.09 | v26.09 | Use `primary_tag` (first tag) and `extra_tags` instead |
Inevitably there are features which need to change: either to be generalized, or removed when they can no longer be supported.

17
doc/developers-guide/plugin-development/event-notifications.md
View File

@@ -339,7 +339,8 @@ A notification for topic `coin_movement` is sent to record the movement of coins
"output_msat": 2000000000, // ('chain_mvt' only)
"output_count": 2, // ('chain_mvt' only, typically only channel closes)
"fees_msat": 382, // ('channel_mvt' only)
"tags": ["deposit"],
"primary_tag": "deposit",
"extra_tags": [],
"blockheight":102, // 'chain_mvt' only
"timestamp":1585948198,
"coin_type":"bc"
@@ -376,7 +377,7 @@ _Only_ tagged on external events (deposits/withdrawals to an external party).
`fees` is an HTLC annotation for the amount of fees either paid or earned. For "invoice" tagged events, the fees are the total fees paid to send that payment. The end amount can be found by subtracting the total fees from the `debited` amount. For "routed" tagged events, both the debit/credit contain fees. Technically routed debits are the 'fee generating' event, however we include them on routed credits as well.
`tag` is a movement descriptor. Current tags are as follows:
`primary_tag` is a movement descriptor. Current primary tags are as follows:
- `deposit`: funds deposited
- `withdrawal`: funds withdrawn
@@ -391,15 +392,21 @@ _Only_ tagged on external events (deposits/withdrawals to an external party).
- `htlc_fulfill`: on-chian htlc fulfill output
- `htlc_tx`: on-chain htlc tx has happened
- `to_wallet`: output being spent into our wallet
- `ignored`: output is being ignored
- `anchor`: an anchor output
- `to_them`: output intended to peer's wallet
- `penalized`: output we've 'lost' due to a penalty (failed cheat attempt)
- `stolen`: output we've 'lost' due to peer's cheat
- `to_miner`: output we've burned to miner (OP_RETURN)
- `opener`: tags channel_open, we are the channel opener
- `lease_fee`: amount paid as lease fee
- `leased`: tags channel_open, channel contains leased funds
- `channel_proposed`: a zero-conf channel
`extra_tags` is zero or more additional tags. Current extra tags are as follows:
- `ignored`: output is being ignored
- `opener`: tags `channel_open` or `channel_proposed`, we are the channel opener
- `stealable`: funds can be taken by the other party
- `leased`: tags `channel_open` or `channel_proposed`, channel contains leased funds
- `splice`: a channel close due to splice operation.
`blockheight` is the block the txid is included in. `channel_mvt`s will be null, so will the blockheight for withdrawals to external parties (we issue these events when we send the tx containing them, before they're included in the chain).