Skip to content

Commit 3707b1f

Browse files
authored
Merge pull request #9814 from ziggie1984/add-info-release-notes
Update release notes for LND 19 - lncli breaking change
2 parents 5ea7232 + 468c527 commit 3707b1f

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

docs/release-notes/release-notes-0.19.0.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -245,9 +245,9 @@ when running LND with an aux component injected (custom channels).
245245
specify the max fees to output amounts ratio.](https://github.com/lightningnetwork/lnd/pull/8600)
246246

247247
* [Enhance](https://github.com/lightningnetwork/lnd/pull/9390) the
248-
`lncli listchannels` output by adding the human readable short
249-
channel id and the channel id defined in BOLT02. Moreover change
250-
the misnomer of `chan_id` which was describing the short channel
248+
`lncli listchannels` and `lncli closedchannels` output by adding the human
249+
readable short channel id and the channel id defined in BOLT02. Moreover
250+
change the misnomer of `chan_id` which was describing the short channel
251251
id to `scid` to represent what it really is.
252252

253253
* [In the coop close](https://github.com/lightningnetwork/lnd/pull/9491) case
@@ -439,6 +439,21 @@ The underlying functionality between those two options remain the same.
439439
compatibility.
440440

441441
## Breaking Changes
442+
443+
* ⚠️ **Breaking Change (lncli only)**: The `lncli listchannels` and
444+
`lncli closedchannels` command output has been updated to fix a misnomer in the
445+
field names. The field previously named `chan_id` (which actually contained
446+
the short channel ID) has been renamed to `scid` to correctly represent its
447+
content. The `chan_id` field now contains the actual channel ID as defined
448+
in BOLT02. This is a breaking change for any automation scripts that parse
449+
the `chan_id` field from the command output. Please update your scripts to
450+
use the new `scid` field name if you were previously using the
451+
short channel ID value. For more details, see
452+
the [lncli Additions](#lncli-additions) section.
453+
454+
>**Note**: This change only affects the `lncli` command output.
455+
>The RPC responses for `listchannels` and `closedchannels` remain unchanged.
456+
442457
## Performance Improvements
443458

444459
* Users can now [limit the total amount of

0 commit comments

Comments
 (0)