Skip to content

Commit e0bf28b

Browse files
authored
update documentation
1 parent 0dd93ba commit e0bf28b

File tree

2 files changed

+73
-2
lines changed

2 files changed

+73
-2
lines changed
Lines changed: 52 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,58 @@
1-
## Bug Fixes
1+
# Release Notes
2+
- [Bug Fixes](#bug-fixes)
3+
- [New Features](#new-features)
4+
- [Functional Enhancements](#functional-enhancements)
5+
- [RPC Additions](#rpc-additions)
6+
- [lncli Additions](#lncli-additions)
7+
- [Improvements](#improvements)
8+
- [Functional Updates](#functional-updates)
9+
- [RPC Updates](#rpc-updates)
10+
- [lncli Updates](#lncli-updates)
11+
- [Breaking Changes](#breaking-changes)
12+
- [Performance Improvements](#performance-improvements)
13+
- [Technical and Architectural Updates](#technical-and-architectural-updates)
14+
- [BOLT Spec Updates](#bolt-spec-updates)
15+
- [Testing](#testing)
16+
- [Database](#database)
17+
- [Code Health](#code-health)
18+
- [Tooling and Documentation](#tooling-and-documentation)
19+
20+
# Bug Fixes
21+
22+
* [Fixed a bug](https://github.com/lightningnetwork/lnd/pull/9459) where we
23+
would not cancel accepted HTLCs on AMP invoices if the whole invoice was
24+
canceled.
25+
26+
# New Features
27+
28+
## Functional Enhancements
29+
30+
## RPC Additions
31+
32+
## lncli Additions
33+
34+
35+
# Improvements
36+
## Functional Updates
37+
## RPC Updates
38+
39+
## lncli Updates
40+
## Code Health
41+
## Breaking Changes
42+
## Performance Improvements
43+
44+
# Technical and Architectural Updates
45+
## BOLT Spec Updates
46+
47+
## Testing
48+
## Database
49+
## Code Health
250

351
* [Improved user experience](https://github.com/lightningnetwork/lnd/pull/9454)
452
by returning a custom error code when HTLC carries incorrect custom records.
53+
54+
## Tooling and Documentation
555

656
# Contributors (Alphabetical Order)
757

8-
* Ziggie
58+
* Ziggie

docs/lnd/release-notes/release-notes-0.19.0.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
- [lncli Updates](#lncli-updates)
1111
- [Breaking Changes](#breaking-changes)
1212
- [Performance Improvements](#performance-improvements)
13+
- [Deprecations](#deprecations)
1314
- [Technical and Architectural Updates](#technical-and-architectural-updates)
1415
- [BOLT Spec Updates](#bolt-spec-updates)
1516
- [Testing](#testing)
@@ -242,6 +243,26 @@ The underlying functionality between those two options remain the same.
242243

243244
* Log rotation can now use ZSTD
244245

246+
## Deprecations
247+
248+
### ⚠️ **Warning:** The following RPCs will be removed in release version **0.21**:
249+
250+
| Deprecated RPC Method | REST Equivalent | HTTP Method | Path | Replaced By |
251+
|----------------------|----------------|-------------|------------------------------|------------------|
252+
| [`lnrpc.SendToRoute`](https://lightning.engineering/api-docs/api/lnd/lightning/send-to-route/index.html) <br> [`routerrpc.SendToRoute`](https://lightning.engineering/api-docs/api/lnd/router/send-to-route/) | ❌ (No direct REST equivalent) ||| [`routerrpc.SendToRouteV2`](https://lightning.engineering/api-docs/api/lnd/router/send-to-route-v2/) |
253+
| [`lnrpc.SendPayment`](https://lightning.engineering/api-docs/api/lnd/lightning/send-payment/) <br> [`routerrpc.SendPayment`](https://lightning.engineering/api-docs/api/lnd/router/send-payment/) || `POST` | `/v1/channels/transaction-stream` | [`routerrpc.SendPaymentV2`](https://lightning.engineering/api-docs/api/lnd/router/send-payment-v2/index.html) |
254+
| [`lnrpc.SendToRouteSync`](https://lightning.engineering/api-docs/api/lnd/lightning/send-to-route-sync/index.html) || `POST` | `/v1/channels/transactions/route` | [`routerrpc.SendToRouteV2`](https://lightning.engineering/api-docs/api/lnd/router/send-to-route-v2/) |
255+
| [`lnrpc.SendPaymentSync`](https://lightning.engineering/api-docs/api/lnd/lightning/send-payment-sync/index.html) || `POST` | `/v1/channels/transactions` | [`routerrpc.SendPaymentV2`](https://lightning.engineering/api-docs/api/lnd/router/send-payment-v2/index.html) |
256+
| [`router.TrackPayment`](https://lightning.engineering/api-docs/api/lnd/router/track-payment/index.html) | ❌ (No direct REST equivalent) ||| [`routerrpc.TrackPaymentV2`](https://lightning.engineering/api-docs/api/lnd/router/track-payment-v2/) |
257+
258+
🚨 **Users are strongly encouraged** to transition to the new **V2 methods** before release **0.21** to ensure compatibility:
259+
260+
| New RPC Method | REST Equivalent | HTTP Method | Path |
261+
|---------------|----------------|-------------|------------------------|
262+
| [`routerrpc.SendToRouteV2`](https://lightning.engineering/api-docs/api/lnd/router/send-to-route-v2/) || `POST` | `/v2/router/route/send` |
263+
| [`routerrpc.SendPaymentV2`](https://lightning.engineering/api-docs/api/lnd/router/send-payment-v2/index.html) || `POST` | `/v2/router/send` |
264+
| [`routerrpc.TrackPaymentV2`](https://lightning.engineering/api-docs/api/lnd/router/track-payment-v2/) || `GET` | `/v2/router/track/{payment_hash}` |
265+
245266
# Technical and Architectural Updates
246267
## BOLT Spec Updates
247268

0 commit comments

Comments
 (0)