docs: add removal notice of deprecated hop rpc elements
What the developer wrote
Authored by ziggie
docs: add removal notice of deprecated hop rpc elements
The previous commit stopped setting the channel capacity when
retrieving the route. This commit makes sure that in the next
release we remove the entries from the rpc interface.
What changed, and why it matters
This commit only updates the release notes document to announce that several old, deprecated fields in the `lnrpc.Hop` message will be removed in a future version. It does not change any code, API behavior, or fix any vulnerability. It is a documentation-only notice.
No security action required. This is a routine documentation update. Users and integrators may review the deprecation notice to prepare for the upcoming RPC field removals.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff adds a deprecation warning to docs/release-notes/release-notes-0.21.0.md stating that chan_capacity, amt_to_forward, and fee fields in lnrpc.Hop will be removed in version 0.22. The commit message confirms this is a follow-up documentation change to a prior commit that stopped setting chan_capacity when retrieving routes. No functional code is modified.
Changed components
docs/release-notes/release-notes-0.21.0.mdInspect captured patch +11 / −0
diff --git a/docs/release-notes/release-notes-0.21.0.md b/docs/release-notes/release-notes-0.21.0.md
index f4c0155..6363068 100644
--- a/docs/release-notes/release-notes-0.21.0.md
+++ b/docs/release-notes/release-notes-0.21.0.md
@@ -177,6 +177,17 @@
## Deprecations
+### ⚠️ **Warning:** Deprecated fields in `lnrpc.Hop` will be removed in release version **0.22**
+
+ The following deprecated fields in the [`lnrpc.Hop`](https://lightning.engineering/api-docs/api/lnd/lightning/send-to-route-sync/#lnrpchop)
+ message will be removed:
+
+ | Field | Deprecated Since | Replacement |
+ |-------|------------------|-------------|
+ | `chan_capacity` | 0.7.1 | None |
+ | `amt_to_forward` | 0.7.1 | `amt_to_forward_msat` |
+ | `fee` | 0.7.1 | `fee_msat` |
+
### ⚠️ **Warning:** The deprecated fee rate option `--sat_per_byte` will be removed in release version **0.22**
The deprecated `--sat_per_byte` option will be fully removed. This flag was
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.