|
| 1 | +# 0.0.102 - 2021-10-18 |
| 2 | + |
| 3 | +## API Updates |
| 4 | + * `get_route` now takes a `Score` as an argument. `Score` is queried during |
| 5 | + the route-finding process, returning the absolute amounts which you are |
| 6 | + willing to pay to avoid routing over a given channel. As a default, a |
| 7 | + `Scorer` is provided which returns a constant amount, with a suggested |
| 8 | + default of 500 msat. This translates to a willingness to pay up to 500 msat |
| 9 | + in additional fees per hop in order to avoid additional hops (#1124). |
| 10 | + * `Event::PaymentPathFailed` now contains a `short_channel_id` field which may |
| 11 | + be filled in with a channel that can be "blamed" for the payment failure. |
| 12 | + Payment retries should likely avoid the given channel for some time (#1077). |
| 13 | + * `PublicKey`s in `NetworkGraph` have been replaced with a `NodeId` struct |
| 14 | + which contains only a simple `[u8; 33]`, substantially improving |
| 15 | + `NetworkGraph` deserialization performance (#1107). |
| 16 | + * `ChainMonitor`'s `HashMap` of `ChannelMonitor`s is now private, exposed via |
| 17 | + `Chainmonitor::get_monitor` and `ChainMonitor::list_monitors` instead |
| 18 | + (#1112). |
| 19 | + * When an outbound channel is closed prior to the broadcasting of its funding |
| 20 | + transaction, but after you call |
| 21 | + `ChannelManager::funding_transaction_generated`, a new event type, |
| 22 | + `Event::DiscardFunding`, is generated, informing you the transaction was not |
| 23 | + broadcasted and that you can spend the same inputs again elsewhere (#1098). |
| 24 | + * `ChannelManager::create_channel` now returns the temporary channel ID which |
| 25 | + may later appear in `Event::ChannelClosed` or `ChannelDetails` prior to the |
| 26 | + channel being funded (#1121). |
| 27 | + * `Event::PaymentSent` now contains the payment hash as well as the payment |
| 28 | + preimage (#1062). |
| 29 | + * `ReadOnlyNetworkGraph::get_addresses` now returns owned `NetAddress` rather |
| 30 | + than references. As a side-effect this method is now exposed in foreign |
| 31 | + language bindings (#1115). |
| 32 | + * The `Persist` and `ChannelMonitorUpdateErr` types have moved to the |
| 33 | + `lightning::chain::chainmonitor` and `lightning::chain` modules, |
| 34 | + respectively (#1112). |
| 35 | + * `ChannelManager::send_payment` now returns a `PaymentId` which identifies a |
| 36 | + payment (whether MPP or not) and can be used to retry the full payment or |
| 37 | + MPP parts through `retry_payment` (#1096). Note that doing so is currently |
| 38 | + *not* crash safe, and you may find yourself sending twice. It is recommended |
| 39 | + that you *not* use the `retry_payment` API until the next release. |
| 40 | + |
| 41 | +## Bug Fixes |
| 42 | + * Due to an earlier fix for the Lightning dust inflation vulnerability tracked |
| 43 | + in CVE-2021-41591/CVE-2021-41592/CVE-2021-41593 in 0.0.100, we required |
| 44 | + counterparties to accept a dust limit slightly lower than the dust limit now |
| 45 | + required by other implementations. This appeared as, at least, latest lnd |
| 46 | + always refusing to accept channels opened by LDK clients (#1065). |
| 47 | + * If there are multiple channels available to the same counterparty, |
| 48 | + `get_route` would only consider the channel listed last as available for |
| 49 | + sending (#1100). |
| 50 | + * `Persist` implementations returning |
| 51 | + `ChannelMonitorUpdateErr::TemporaryFailure` from `watch_channel` previously |
| 52 | + resulted in the `ChannelMonitor` not being stored at all, resulting in a |
| 53 | + panic after monitor updating is complete (#1112). |
| 54 | + * If payments are pending awaiting forwarding at startup, an |
| 55 | + `Event::PendingHTLCsForwardable` event will always be provided. This ensures |
| 56 | + user code calls `ChannelManager::process_pending_htlc_fowards` even if it |
| 57 | + shut down while awaiting the batching timer during the previous run (#1076). |
| 58 | + * If a call to `ChannelManager::send_payment` failed due to lack of |
| 59 | + availability of funds locally, LDK would store the payment as pending |
| 60 | + forever, with no ability to retry or fail it, leaking memory (#1109). |
| 61 | + |
| 62 | +## Serialization Compatibility |
| 63 | + * All above new Events/fields are ignored by prior clients. All above new |
| 64 | + Events/fields, except for `Event::PaymentSent::payment_hash` are not present |
| 65 | + when reading objects serialized by prior versions of the library. |
| 66 | + |
| 67 | +In total, this release features 32 files changed, 2248 insertions, and 1483 |
| 68 | +deletions in 51 commits from 7 authors, in alphabetical order: |
| 69 | + |
| 70 | + * 1nF0rmed |
| 71 | + * Duncan Dean |
| 72 | + * Elias Rohrer |
| 73 | + * Galder Zamarreño |
| 74 | + * Jeffrey Czyz |
| 75 | + * Matt Corallo |
| 76 | + * Valentine Wallace |
| 77 | + |
| 78 | + |
1 | 79 | # 0.0.101 - 2021-09-23 |
2 | 80 |
|
3 | 81 | ## API Updates |
|
0 commit comments