X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=CHANGELOG.md;h=80745291a0e6722a01b77a8e67dede699a79bc76;hb=c575429639a388ef3d5fc2b036163914bc947c57;hp=24a8c96ffaa4e94d88139a31549be0d4c079e0ec;hpb=e635db0da31841e8a8ac5c5450c8f595541a6ced;p=rust-lightning diff --git a/CHANGELOG.md b/CHANGELOG.md index 24a8c96f..80745291 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,153 @@ +# 0.0.103 - 2021-11-02 + +## API Updates + * This release is almost entirely focused on a new API in the + `lightning-invoice` crate - the `InvoicePayer`. `InvoicePayer` is a + struct which takes a reference to a `ChannelManager` and a `Router` + and retries payments as paths fail. It limits retries to a configurable + number, but is not serialized to disk and may retry additional times across + a serialization/load. In order to learn about failed payments, it must + receive `Event`s directly from the `ChannelManager`, wrapping a + user-provided `EventHandler` which it provides all unhandled events to + (#1059). + * `get_route` has been renamed `find_route` (#1059) and now takes a + `RouteParameters` struct in replacement of a number of its long list of + arguments (#1134). The `Payee` in the `RouteParameters` is stored in the + `Route` object returned and provided in the `RouteParameters` contained in + `Event::PaymentPathFailed` (#1059). + * `ChannelMonitor`s must now be persisted after calls that provide new block + data, prior to `MonitorEvent`s being passed back to `ChannelManager` for + processing. If you are using a `ChainMonitor` this is handled for you. + The `Persist` API has been updated to `Option`ally take the + `ChannelMonitorUpdate` as persistence events that result from chain data no + longer have a corresponding update (#1108). + * `routing::Score` now has a `payment_path_failed` method which it can use to + learn which channels often fail payments. It is automatically called by + `InvoicePayer` for failed payment paths (#1144). + * The default `Scorer` implementation is now a type alias to a type generic + across different clocks and supports serialization to persist scoring data + across restarts (#1146). + * `Event::PaymentSent` now includes the full fee which was spent across all + payment paths which were fulfilled or pending when the payment was fulfilled + (#1142). + * `Event::PaymentSent` and `Event::PaymentPathFailed` now include the + `PaymentId` which matches the `PaymentId` returned from + `ChannelManager::send_payment` or `InvoicePayer::pay_invoice` (#1059). + * `NetGraphMsgHandler` now takes a `Deref` to the `NetworkGraph`, allowing for + shared references to the graph data to make serialization and references to + the graph data in the `InvoicePayer`'s `Router` simpler (#1149). + * `routing::Score::channel_penalty_msat` has been updated to provide the + `NodeId` of both the source and destination nodes of a channel (#1133). + +## Bug Fixes + * Previous versions would often disconnect peers during initial graph sync due + to ping timeouts while processing large numbers of gossip messages. We now + delay disconnecting peers if we receive messages from them even if it takes + a while to receive a pong from them. Further, we avoid sending too many + gossip messages between pings to ensure we should always receive pongs in a + timely manner (#1137). + * If a payment was sent, creating an outbound HTLC and sending it to our + counterparty (implying the `ChannelMonitor` was persisted on disk), but the + `ChannelManager` was not persisted prior to shutdown/crash, no + `Event::PaymentPathFailed` event was generated if the HTLC was eventually + failed on chain. Events are now consistent irrespective of `ChannelManager` + persistence or non-persistence (#1104). + +## Serialization Compatibility + * All above new Events/fields are ignored by prior clients. All above new + Events/fields are not present when reading objects serialized by prior + versions of the library. + * Payments for which a `Route` was generated using a previous version or for + which the payment was originally sent by a previous version of the library + will not be retried by an `InvoicePayer`. + +This release was singularly focused and some contributions by third parties +were delayed. +In total, this release features 38 files changed, 4414 insertions, and 969 +deletions in 71 commits from 2 authors, in alphabetical order: + + * Jeffrey Czyz + * Matt Corallo + + +# 0.0.102 - 2021-10-18 + +## API Updates + * `get_route` now takes a `Score` as an argument. `Score` is queried during + the route-finding process, returning the absolute amounts which you are + willing to pay to avoid routing over a given channel. As a default, a + `Scorer` is provided which returns a constant amount, with a suggested + default of 500 msat. This translates to a willingness to pay up to 500 msat + in additional fees per hop in order to avoid additional hops (#1124). + * `Event::PaymentPathFailed` now contains a `short_channel_id` field which may + be filled in with a channel that can be "blamed" for the payment failure. + Payment retries should likely avoid the given channel for some time (#1077). + * `PublicKey`s in `NetworkGraph` have been replaced with a `NodeId` struct + which contains only a simple `[u8; 33]`, substantially improving + `NetworkGraph` deserialization performance (#1107). + * `ChainMonitor`'s `HashMap` of `ChannelMonitor`s is now private, exposed via + `Chainmonitor::get_monitor` and `ChainMonitor::list_monitors` instead + (#1112). + * When an outbound channel is closed prior to the broadcasting of its funding + transaction, but after you call + `ChannelManager::funding_transaction_generated`, a new event type, + `Event::DiscardFunding`, is generated, informing you the transaction was not + broadcasted and that you can spend the same inputs again elsewhere (#1098). + * `ChannelManager::create_channel` now returns the temporary channel ID which + may later appear in `Event::ChannelClosed` or `ChannelDetails` prior to the + channel being funded (#1121). + * `Event::PaymentSent` now contains the payment hash as well as the payment + preimage (#1062). + * `ReadOnlyNetworkGraph::get_addresses` now returns owned `NetAddress` rather + than references. As a side-effect this method is now exposed in foreign + language bindings (#1115). + * The `Persist` and `ChannelMonitorUpdateErr` types have moved to the + `lightning::chain::chainmonitor` and `lightning::chain` modules, + respectively (#1112). + * `ChannelManager::send_payment` now returns a `PaymentId` which identifies a + payment (whether MPP or not) and can be used to retry the full payment or + MPP parts through `retry_payment` (#1096). Note that doing so is currently + *not* crash safe, and you may find yourself sending twice. It is recommended + that you *not* use the `retry_payment` API until the next release. + +## Bug Fixes + * Due to an earlier fix for the Lightning dust inflation vulnerability tracked + in CVE-2021-41591/CVE-2021-41592/CVE-2021-41593 in 0.0.100, we required + counterparties to accept a dust limit slightly lower than the dust limit now + required by other implementations. This appeared as, at least, latest lnd + always refusing to accept channels opened by LDK clients (#1065). + * If there are multiple channels available to the same counterparty, + `get_route` would only consider the channel listed last as available for + sending (#1100). + * `Persist` implementations returning + `ChannelMonitorUpdateErr::TemporaryFailure` from `watch_channel` previously + resulted in the `ChannelMonitor` not being stored at all, resulting in a + panic after monitor updating is complete (#1112). + * If payments are pending awaiting forwarding at startup, an + `Event::PendingHTLCsForwardable` event will always be provided. This ensures + user code calls `ChannelManager::process_pending_htlc_fowards` even if it + shut down while awaiting the batching timer during the previous run (#1076). + * If a call to `ChannelManager::send_payment` failed due to lack of + availability of funds locally, LDK would store the payment as pending + forever, with no ability to retry or fail it, leaking memory (#1109). + +## Serialization Compatibility + * All above new Events/fields are ignored by prior clients. All above new + Events/fields, except for `Event::PaymentSent::payment_hash` are not present + when reading objects serialized by prior versions of the library. + +In total, this release features 32 files changed, 2248 insertions, and 1483 +deletions in 51 commits from 7 authors, in alphabetical order: + + * 1nF0rmed + * Duncan Dean + * Elias Rohrer + * Galder Zamarreño + * Jeffrey Czyz + * Matt Corallo + * Valentine Wallace + + # 0.0.101 - 2021-09-23 ## API Updates