docs: document deprecated RPC and field removals in 0.21 release notes
What the developer wrote
Authored by Erick Cestari
docs: document deprecated RPC and field removals in 0.21 release notes
Add entries to the Breaking Changes section covering the payment and
tracking RPCs and the `outgoing_chan_id` field removed in this branch,
all of which were announced for removal in 0.21 via the 0.20 release
notes.
What changed, and why it matters
This commit only updates the 0.21 release notes to document RPC and field removals that had already been announced in the 0.20 release notes. It is a documentation-only change with no code modifications, no security fixes, and no new vulnerabilities.
No security action required. Treat as routine release-note documentation.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff adds a Breaking Changes section to docs/release-notes/release-notes-0.21.0.md describing the removal of deprecated payment/tracking RPCs (SendPayment, SendPaymentSync, SendToRoute, TrackPayment, etc.) and the outgoing_chan_id field, with their V2 replacements. It also fixes a stale API doc link for lnrpc.Hop. No source code is changed.
Changed components
docs/release-notes/release-notes-0.21.0.mdInspect captured patch +27 / −1
diff --git a/docs/release-notes/release-notes-0.21.0.md b/docs/release-notes/release-notes-0.21.0.md
index ad6147c..0e418a3 100644
--- a/docs/release-notes/release-notes-0.21.0.md
+++ b/docs/release-notes/release-notes-0.21.0.md
@@ -252,6 +252,32 @@
`lncli getdebuginfo` and `lncli encryptdebugpackage` commands similarly
require the `--include_log` flag to include logs in the output.
+* [Removed the deprecated payment RPCs and `outgoing_chan_id`
+ field](https://github.com/lightningnetwork/lnd/pull/10814) that were
+ [announced for removal in 0.21](https://github.com/lightningnetwork/lnd/blob/master/docs/release-notes/release-notes-0.20.0.md#deprecations)
+ via the 0.20 release notes. Callers must migrate to the V2 equivalents:
+
+ | Removed RPC | Replacement |
+ |-------------|-------------|
+ | `lnrpc.SendPayment` (streaming) | `routerrpc.SendPaymentV2` |
+ | `lnrpc.SendPaymentSync` | `routerrpc.SendPaymentV2` |
+ | `lnrpc.SendToRoute` (streaming) | `routerrpc.SendToRouteV2` |
+ | `lnrpc.SendToRouteSync` | `routerrpc.SendToRouteV2` |
+ | `routerrpc.SendPayment` (streaming) | `routerrpc.SendPaymentV2` |
+ | `routerrpc.SendToRoute` | `routerrpc.SendToRouteV2` |
+ | `routerrpc.TrackPayment` (streaming) | `routerrpc.TrackPaymentV2` |
+
+ This also removes the corresponding REST routes
+ `POST /v1/channels/transaction-stream`, `POST /v1/channels/transactions`,
+ and `POST /v1/channels/transactions/route`. The orphan
+ `routerrpc.SendToRouteResponse` message (only used by the removed
+ `routerrpc.SendToRoute` RPC) is also dropped.
+
+ In addition, the deprecated `outgoing_chan_id` field is removed from
+ `lnrpc.QueryRoutesRequest` and `routerrpc.SendPaymentRequest` (proto tags
+ 14 and 8 respectively, now reserved). Callers must use the multi-channel
+ `outgoing_chan_ids` field introduced in 0.20.
+
## Performance Improvements
* Let the [channel graph cache be populated
@@ -331,7 +357,7 @@
### ⚠️ **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)
+ The following deprecated fields in the [`lnrpc.Hop`](https://lightning.engineering/api-docs/api/lnd/lightning/query-routes/#lnrpchop)
message will be removed:
| Field | Deprecated Since | Replacement |
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.