Skip to content

Commit 74f5520

Browse files
committed
docs: document deprecated RPC and config flag removals in 0.21 release notes
Add entries to the Breaking Changes section of the 0.21 release notes covering the RPCs, fields, and config flags removed in this PR that were announced for removal in 0.21 via the 0.20 release notes.
1 parent 57a1519 commit 74f5520

1 file changed

Lines changed: 27 additions & 0 deletions

File tree

docs/release-notes/release-notes-0.21.0.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -252,6 +252,33 @@
252252
`lncli getdebuginfo` and `lncli encryptdebugpackage` commands similarly
253253
require the `--include_log` flag to include logs in the output.
254254

255+
* Removed the deprecated payment and tracking RPCs that were
256+
[announced for removal in 0.21](https://github.com/lightningnetwork/lnd/blob/master/docs/release-notes/release-notes-0.20.0.md#deprecations)
257+
via the 0.20 release notes. Callers must migrate to the V2 equivalents:
258+
259+
| Removed RPC | Replacement |
260+
|-------------|-------------|
261+
| `lnrpc.SendPayment` (streaming) | `routerrpc.SendPaymentV2` |
262+
| `lnrpc.SendPaymentSync` | `routerrpc.SendPaymentV2` |
263+
| `lnrpc.SendToRoute` (streaming) | `routerrpc.SendToRouteV2` |
264+
| `lnrpc.SendToRouteSync` | `routerrpc.SendToRouteV2` |
265+
| `routerrpc.SendPayment` (streaming) | `routerrpc.SendPaymentV2` |
266+
| `routerrpc.SendToRoute` | `routerrpc.SendToRouteV2` |
267+
| `routerrpc.TrackPayment` (streaming) | `routerrpc.TrackPaymentV2` |
268+
269+
This also removes the corresponding REST routes
270+
`POST /v1/channels/transaction-stream`, `POST /v1/channels/transactions`,
271+
and `POST /v1/channels/transactions/route`.
272+
273+
* Removed the deprecated `outgoing_chan_id` field from `QueryRoutesRequest`
274+
and `SendPaymentRequest`. Callers must use the multi-channel
275+
`outgoing_chan_ids` field introduced in 0.20. The compatibility fallback
276+
that accepted either field (and errored when both were set) is gone.
277+
278+
* Removed the deprecated `--tor.v2` configuration flag. Tor v2 onion services
279+
have been obsolete since October 2021 when the Tor network dropped support
280+
for them; only v3 is supported now.
281+
255282
## Performance Improvements
256283

257284
* Let the [channel graph cache be populated

0 commit comments

Comments
 (0)