Skip to content

Commit 513c8f0

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 76ebb39 commit 513c8f0

1 file changed

Lines changed: 41 additions & 1 deletion

File tree

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

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -252,6 +252,46 @@
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
256+
RPCs](https://github.com/lightningnetwork/lnd/pull/10795) that were
257+
[announced for removal in 0.21](https://github.com/lightningnetwork/lnd/blob/master/docs/release-notes/release-notes-0.20.0.md#deprecations)
258+
via the 0.20 release notes. Callers must migrate to the V2 equivalents:
259+
260+
| Removed RPC | Replacement |
261+
|-------------|-------------|
262+
| `lnrpc.SendPayment` (streaming) | `routerrpc.SendPaymentV2` |
263+
| `lnrpc.SendPaymentSync` | `routerrpc.SendPaymentV2` |
264+
| `lnrpc.SendToRoute` (streaming) | `routerrpc.SendToRouteV2` |
265+
| `lnrpc.SendToRouteSync` | `routerrpc.SendToRouteV2` |
266+
| `routerrpc.SendPayment` (streaming) | `routerrpc.SendPaymentV2` |
267+
| `routerrpc.SendToRoute` | `routerrpc.SendToRouteV2` |
268+
| `routerrpc.TrackPayment` (streaming) | `routerrpc.TrackPaymentV2` |
269+
270+
This also removes the corresponding REST routes
271+
`POST /v1/channels/transaction-stream`, `POST /v1/channels/transactions`,
272+
and `POST /v1/channels/transactions/route`. The orphan
273+
`routerrpc.SendToRouteResponse` message (only used by the removed
274+
`routerrpc.SendToRoute` RPC) is also dropped.
275+
276+
* [Removed the deprecated `outgoing_chan_id`
277+
field](https://github.com/lightningnetwork/lnd/pull/10795) from
278+
`lnrpc.QueryRoutesRequest` and `routerrpc.SendPaymentRequest`. Proto tags
279+
14 and 8 respectively are now reserved. Callers must use the multi-channel
280+
`outgoing_chan_ids` field introduced in 0.20.
281+
282+
* [Removed the deprecated `--tor.v2` configuration
283+
flag](https://github.com/lightningnetwork/lnd/pull/10795). Tor v2 onion
284+
services have been obsolete since October 2021 when the Tor network dropped
285+
support for them; only v3 is supported now. Incoming
286+
`NodeAnnouncement` messages still decode successfully, but any v2 onion
287+
addresses they carry are stripped post-decode so they are never relayed
288+
onward or persisted to the graph DB. The wire/storage encoders for v2
289+
onion addresses (in
290+
`lnwire`, `graph/db`) and the `tor.OnionHostToFakeIP` helper have been
291+
removed. The `lnwire` and `graph/db` v2 decoders themselves are
292+
retained so legacy graph databases (and the existing KV-to-SQL graph
293+
migration that re-parses opaque address payloads) continue to load.
294+
255295
## Performance Improvements
256296

257297
* Let the [channel graph cache be populated
@@ -331,7 +371,7 @@
331371

332372
### ⚠️ **Warning:** Deprecated fields in `lnrpc.Hop` will be removed in release version **0.22**
333373

334-
The following deprecated fields in the [`lnrpc.Hop`](https://lightning.engineering/api-docs/api/lnd/lightning/send-to-route-sync/#lnrpchop)
374+
The following deprecated fields in the [`lnrpc.Hop`](https://lightning.engineering/api-docs/api/lnd/lightning/query-routes/#lnrpchop)
335375
message will be removed:
336376

337377
| Field | Deprecated Since | Replacement |

0 commit comments

Comments
 (0)