|
3 | 3 | ## API Updates
|
4 | 4 | * This release is almost entirely focused on a new API in the
|
5 | 5 | `lightning-invoice` crate - the `InvoicePayer`. `InvoicePayer` is a
|
6 |
| - struct which takes a reference to a `ChannelManager` and a `NetworkGraph` |
| 6 | + struct which takes a reference to a `ChannelManager` and a `Router` |
7 | 7 | and retries payments as paths fail. It limits retries to a configurable
|
8 | 8 | number, but is not serialized to disk and may retry additional times across
|
9 | 9 | a serialization/load. In order to learn about failed payments, it must
|
10 | 10 | receive `Event`s directly from the `ChannelManager`, wrapping a
|
11 | 11 | user-provided `EventHandler` which it provides all unhandled events to
|
12 | 12 | (#1059).
|
13 |
| - * `get_route` has been renamed `find_route` (#1059) and now takes a `Payee` |
14 |
| - struct in replacement of a number of its long list of arguments (#1134). |
15 |
| - `Payee` is further stored in the `Route` object returned and provided in the |
16 |
| - `RouteParameters` contained in `Event::PaymentPathFailed` (#1059). |
17 |
| - * `ChannelMonitor`s must now be persisted after calls which provide new block |
| 13 | + * `get_route` has been renamed `find_route` (#1059) and now takes a |
| 14 | + `RouteParameters` struct in replacement of a number of its long list of |
| 15 | + arguments (#1134). The `Payee` in the `RouteParameters` is stored in the |
| 16 | + `Route` object returned and provided in the `RouteParameters` contained in |
| 17 | + `Event::PaymentPathFailed` (#1059). |
| 18 | + * `ChannelMonitor`s must now be persisted after calls that provide new block |
18 | 19 | data, prior to `MonitorEvent`s being passed back to `ChannelManager` for
|
19 | 20 | processing. If you are using a `ChainMonitor` this is handled for you.
|
20 | 21 | The `Persist` API has been updated to `Option`ally take the
|
|
36 | 37 | `NodeId` of both the source and destination nodes of a channel (#1133).
|
37 | 38 |
|
38 | 39 | ## Bug Fixes
|
39 |
| - * Delay disconnecting peers if we receive messages from them even if it takes |
40 |
| - a while to receive a pong from them. Further, avoid sending too many gossip |
41 |
| - messages between pings to ensure we should always receive pongs in a timely |
42 |
| - manner. Together, these should significantly reduce instances of us failing |
43 |
| - to remain connected to a peer during initial gossip sync (#1137). |
44 |
| - * If a payment is sent, creating an outbound HTLC and sending it to our |
| 40 | + * Previous versions would often disconnect peers during initial graph sync due |
| 41 | + to ping timeouts while processing large numbers of gossip messages. We now |
| 42 | + delay disconnecting peers if we receive messages from them even if it takes |
| 43 | + a while to receive a pong from them. Further, we avoid sending too many |
| 44 | + gossip messages between pings to ensure we should always receive pongs in a |
| 45 | + timely manner (#1137). |
| 46 | + * If a payment was sent, creating an outbound HTLC and sending it to our |
45 | 47 | counterparty (implying the `ChannelMonitor` was persisted on disk), but the
|
46 | 48 | `ChannelManager` was not persisted prior to shutdown/crash, no
|
47 |
| - `Event::PaymentPathFailed` event will be generated if the HTLC is eventually |
48 |
| - failed on chain (#1104). |
| 49 | + `Event::PaymentPathFailed` event was generated if the HTLC was eventually |
| 50 | + failed on chain. Events are now consistent irrespective of `ChannelManager` |
| 51 | + persistence or non-persistence (#1104). |
49 | 52 |
|
50 | 53 | ## Serialization Compatibility
|
51 | 54 | * All above new Events/fields are ignored by prior clients. All above new
|
|
0 commit comments