Skip to content

Commit 95d7c04

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 4728515 commit 95d7c04

1 file changed

Lines changed: 29 additions & 0 deletions

File tree

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

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -252,6 +252,35 @@
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+
* The deprecated `outgoing_chan_id` field on `QueryRoutesRequest` and
274+
`SendPaymentRequest` is no longer honored. The proto field is retained for
275+
wire compatibility, but any request that sets it to a non-zero value is now
276+
rejected with an error so that callers cannot silently get an unrestricted
277+
route/payment. Callers must use the multi-channel `outgoing_chan_ids` field
278+
introduced in 0.20.
279+
280+
* Removed the deprecated `--tor.v2` configuration flag. Tor v2 onion services
281+
have been obsolete since October 2021 when the Tor network dropped support
282+
for them; only v3 is supported now.
283+
255284
## Performance Improvements
256285

257286
* Let the [channel graph cache be populated

0 commit comments

Comments
 (0)