]> git.bitcoin.ninja Git - rust-lightning/blob - CHANGELOG.md
Merge pull request #2787 from jkczyz/2023-12-onion-messenger-assert
[rust-lightning] / CHANGELOG.md
1 # 0.0.118 - Oct 23, 2023 - "Just the Twelve Sinks"
2
3 ## API Updates
4  * BOLT12 sending and receiving is now supported as an alpha feature. You may
5    run into unexpected issues and will need to have a direct connection with
6    the offer's blinded path introduction points as messages are not yet routed.
7    We are seeking feedback from early testers (#2578, #2039).
8  * `ConfirmationTarget` has been rewritten to provide information about the
9    specific use LDK needs the feerate estimate for, rather than the generic
10    low-, medium-, and high-priority estimates. This allows LDK users to more
11    accurately target their feerate estimates (#2660). For those wishing to
12    retain their existing behavior, see the table below for conversion.
13  * `ChainHash` is now used in place of `BlockHash` where it represents the
14    genesis block (#2662).
15  * `lightning-invoice` payment utilities now take a `Deref` to
16    `AChannelManager` (#2652).
17  * `peel_onion` is provided to statelessly decode an `OnionMessage` (#2599).
18  * `ToSocketAddrs` + `Display` are now impl'd for `SocketAddress` (#2636, #2670)
19  * `Display` is now implemented for `OutPoint` (#2649).
20  * `Features::from_be_bytes` is now provided (#2640).
21
22 For those moving to the new `ConfirmationTarget`, the new variants in terms of
23 the old mempool/low/medium/high priorities are as follows:
24  * `OnChainSweep` = `HighPriority`
25  * `MaxAllowedNonAnchorChannelRemoteFee` = `max(25 * 250, HighPriority * 10)`
26  * `MinAllowedAnchorChannelRemoteFee` = `MempoolMinimum`
27  * `MinAllowedNonAnchorChannelRemoteFee` = `Background - 250`
28  * `AnchorChannelFee` = `Background`
29  * `NonAnchorChannelFee` = `Normal`
30  * `ChannelCloseMinimum` = `Background`
31
32 ## Bug Fixes
33  * Calling `ChannelManager::close_channel[_with_feerate_and_script]` on a
34    channel which did not exist would immediately hang holding several key
35    `ChannelManager`-internal locks (#2657).
36  * Channel information updates received from a failing HTLC are no longer
37    applied to our `NetworkGraph`. This prevents a node which we attempted to
38    route a payment through from being able to learn the sender of the payment.
39    In some rare cases, this may result in marginally reduced payment success
40    rates (#2666).
41  * Anchor outputs are now properly considered when calculating the amount
42    available to send in HTLCs. This can prevent force-closes in anchor channels
43    when sending payments which overflow the available balance (#2674).
44  * A peer that sends an `update_fulfill_htlc` message for a forwarded HTLC,
45    then reconnects prior to sending a `commitment_signed` (thus retransmitting
46    their `update_fulfill_htlc`) may result in the channel stalling and being
47    unable to make progress (#2661).
48  * In exceedingly rare circumstances, messages intended to be sent to a peer
49    prior to reconnection can be sent after reconnection. This could result in
50    undefined channel state and force-closes (#2663).
51
52 ## Backwards Compatibility
53
54  * Creating a blinded path to receive a payment then downgrading to LDK prior to
55    0.0.117 may result in failure to receive the payment (#2413).
56  * Calling `ChannelManager::pay_for_offer` or
57    `ChannelManager::create_refund_builder` may prevent downgrading to LDK prior
58    to 0.0.118 until the payment times out and has been removed (#2039).
59
60 ## Node Compatibility
61  * LDK now sends a bogus `channel_reestablish` message to peers when they ask to
62    resume an unknown channel. This should cause LND nodes to force-close and
63    broadcast the latest channel state to the chain. In order to trigger this
64    when we wish to force-close a channel, LDK now disconnects immediately after
65    sending a channel-closing `error` message. This should result in cooperative
66    peers also working to confirm the latest commitment transaction when we wish
67    to force-close (#2658).
68
69 ## Security
70 0.0.118 expands mitigations against transaction cycling attacks to non-anchor
71 channels, though note that no mitigations which exist today are considered robust
72 to prevent the class of attacks.
73  * In order to mitigate against transaction cycling attacks, non-anchor HTLC
74    transactions are now properly re-signed before broadcasting (#2667).
75
76 In total, this release features 61 files changed, 3470 insertions, 1503
77 deletions in 85 commits from 12 authors, in alphabetical order:
78  * Antonio Yang
79  * Elias Rohrer
80  * Evan Feenstra
81  * Fedeparma74
82  * Gursharan Singh
83  * Jeffrey Czyz
84  * Matt Corallo
85  * Sergi Delgado Segura
86  * Vladimir Fomene
87  * Wilmer Paulino
88  * benthecarman
89  * slanesuke
90
91
92 # 0.0.117 - Oct 3, 2023 - "Everything but the Twelve Sinks"
93
94 ## API Updates
95  * `ProbabilisticScorer`'s internal models have been substantially improved,
96    including better decaying (#1789), a more granular historical channel
97    liquidity tracker (#2176) and a now-default option to make our estimate for a
98    channel's current liquidity nonlinear in the channel's capacity (#2547). In
99    total, these changes should result in improved payment success rates at the
100    cost of slightly worse routefinding performance.
101  * Support for custom TLVs for recipients of HTLCs has been added (#2308).
102  * Support for generating transactions for third-party watchtowers has been
103    added to `ChannelMonitor/Update`s (#2337).
104  * `KVStorePersister` has been replaced with a more generic and featureful
105    `KVStore` interface (#2472).
106  * A new `MonitorUpdatingPersister` is provided which wraps a `KVStore` and
107    implements `Persist` by writing differential updates rather than full
108    `ChannelMonitor`s (#2359).
109  * Batch funding of outbound channels is now supported using the new
110    `ChannelManager::batch_funding_transaction_generated` method (#2486).
111  * `ChannelManager::send_preflight_probes` has been added to probe a payment's
112    potential paths while a user is providing approval for a payment (#2534).
113  * Fully asynchronous `ChannelMonitor` updating is available as an alpha
114    preview. There remain a few known but incredibly rare race conditions which
115    may lead to loss of funds (#2112, #2169, #2562).
116  * `ChannelMonitorUpdateStatus::PermanentFailure` has been removed in favor of a
117    new `ChannelMonitorUpdateStatus::UnrecoverableError`. The new variant panics
118    on use, rather than force-closing a channel in an unsafe manner, which the
119    previous variant did (#2562). Rather than panicking with the new variant,
120    users may wish to use the new asynchronous `ChannelMonitor` updating using
121    `ChannelMonitorUpdateStatus::InProgress`.
122  * `RouteParameters::max_total_routing_fee_msat` was added to limit the fees
123    paid when routing, defaulting to 1% + 50sats when using the new
124    `from_payment_params_and_value` constructor (#2417, #2603, #2604).
125  * Implementations of `UtxoSource` are now provided in `lightning-block-sync`.
126    Those running with a full node should use this to validate gossip (#2248).
127  * `LockableScore` now supports read locking for parallel routefinding (#2197).
128  * `ChannelMonitor::get_spendable_outputs` was added to allow for re-generation
129    of `SpendableOutputDescriptor`s for a channel after they were provided via
130    `Event::SpendableOutputs` (#2609, #2624).
131  * `[u8; 32]` has been replaced with a `ChannelId` newtype for chan ids (#2485).
132  * `NetAddress` was renamed `SocketAddress` (#2549) and `FromStr` impl'd (#2134)
133  * For `no-std` users, `parse_onion_address` was added which creates a
134    `NetAddress` from a "...onion" string and port (#2134, #2633).
135  * HTLC information is now provided in `Event::PaymentClaimed::htlcs` (#2478).
136  * The success probability used in historical penalties when scoring is now
137    available via `historical_estimated_payment_success_probability` (#2466).
138  * `RecentPaymentDetails::*::payment_id` has been added (#2567).
139  * `Route` now contains a `RouteParameters` rather than a `PaymentParameters`,
140    tracking the original arguments passed to routefinding (#2555).
141  * `Balance::*::claimable_amount_satoshis` was renamed `amount_satoshis` (#2460)
142  * `*Features::set_*_feature_bit` have been added for non-custom flags (#2522).
143  * `channel_id` was added to `SpendableOutputs` events (#2511).
144  * `counterparty_node_id` and `channel_capacity_sats` were added to
145    `ChannelClosed` events (#2387).
146  * `ChannelMonitor` now implements `Clone` for `Clone`able signers (#2448).
147  * `create_onion_message` was added to build an onion message (#2583, #2595).
148  * `HTLCDescriptor` now implements `Writeable`/`Readable` (#2571).
149  * `SpendableOutputDescriptor` now implements `Hash` (#2602).
150  * `MonitorUpdateId` now implements `Debug` (#2594).
151  * `Payment{Hash,Id,Preimage}` now implement `Display` (#2492).
152  * `NodeSigner::sign_bolt12_invoice{,request}` were added for future use (#2432)
153
154 ## Backwards Compatibility
155  * Users migrating to the new `KVStore` can use a concatentation of
156    `[{primary_namespace}/[{secondary_namespace}/]]{key}` to build a key
157    compatible with the previous `KVStorePersister` interface (#2472).
158  * Downgrading after receipt of a payment with custom HTLC TLVs may result in
159    unintentionally accepting payments with TLVs you do not understand (#2308).
160  * `Route` objects (including pending payments) written by LDK versions prior
161    to 0.0.117 won't be retryable after being deserialized by LDK 0.0.117 or
162    above (#2555).
163  * Users of the `MonitorUpdatingPersister` can upgrade seamlessly from the
164    default `KVStore` `Persist` implementation, however the stored
165    `ChannelMonitor`s are deliberately unreadable by the default `Persist`. This
166    ensures the correct downgrade procedure is followed, which is: (#2359)
167    * First, make a backup copy of all channel state,
168    * then ensure all `ChannelMonitorUpdate`s stored are fully applied to the
169      relevant `ChannelMonitor`,
170    * finally, write each full `ChannelMonitor` using your new `Persist` impl.
171
172 ## Bug Fixes
173  * Anchor channels which were closed by a counterparty broadcasting its
174    commitment transaction (i.e. force-closing) would previously not generate a
175    `SpendableOutputs` event for our `to_remote` (i.e. non-HTLC-encumbered)
176    balance. Those with such balances available should fetch the missing
177    `SpendableOutputDescriptor`s using the new
178    `ChannelMonitor::get_spendable_outputs` method (#2605).
179  * Anchor channels may result in spurious or missing `Balance` entries for HTLC
180    balances (#2610).
181  * `ChannelManager::send_spontaneous_payment_with_retry` spuriously did not
182    provide the recipient with enough information to claim the payment, leading
183    to all spontaneous payments failing (#2475).
184    `send_spontaneous_payment_with_route` was unaffected.
185  * The `keysend` feature on node announcements was spuriously un-set in 0.0.112
186    and has been re-enabled (#2465).
187  * Fixed several races which could lead to deadlock when force-closing a channel
188    (#2597). These races have not been seen in production.
189  * The `ChannelManager` is persisted substantially less when it has not changed,
190    leading to substantially less I/O traffic for it (#2521, #2617).
191  * Passing new block data to `ChainMonitor` no longer results in all other
192    monitor operations being blocked until it completes (#2528).
193  * When retrying payments, any excess amount sent to the recipient in order to
194    meet an `htlc_minimum` constraint on the path is now no longer included in
195    the amount we send in the retry (#2575).
196  * Several edge cases in route-finding around HTLC minimums were fixed which
197    could have caused invalid routes or panics when built with debug assertions
198    (#2570, #2575).
199  * Several edge cases in route-finding around HTLC minimums and route hints
200    were fixed which would spuriously result in no route found (#2575, #2604).
201  * The `user_channel_id` passed to `SignerProvider::generate_channel_keys_id`
202    for inbound channels is now correctly using the one passed to
203    `ChannelManager::accept_inbound_channel` rather than a default value (#2428).
204  * Users of `impl_writeable_tlv_based!` no longer have use requirements (#2506).
205  * No longer force-close channels when counterparties send a `channel_update`
206    with a bogus `htlc_minimum_msat`, which LND users can manually build (#2611).
207
208 ## Node Compatibility
209  * LDK now ignores `error` messages generated by LND in response to a
210    `shutdown` message, avoiding force-closes due to LND bug 6039. This may
211    lead to non-trivial bandwidth usage with LND peers exhibiting this bug
212    during the cooperative shutdown process (#2507).
213
214 ## Security
215 0.0.117 fixes several loss-of-funds vulnerabilities in anchor output channels,
216 support for which was added in 0.0.116, in reorg handling, and when accepting
217 channel(s) from counterparties which are miners.
218  * When a counterparty broadcasts their latest commitment transaction for a
219    channel with anchor outputs, we'd previously fail to build claiming
220    transactions against any HTLC outputs in that transaction. This could lead
221    to loss of funds if the counterparty is able to eventually claim the HTLC
222    after a timeout (#2606).
223  * Anchor channels HTLC claims on-chain previously spent the entire value of any
224    HTLCs as fee, which has now been fixed (#2587).
225  * If a channel is closed via an on-chain commitment transaction confirmation
226    with a pending outbound HTLC in the commitment transaction, followed by a
227    reorg which replaces the confirmed commitment transaction with a different
228    (but non-revoked) commitment transaction, all before we learn the payment
229    preimage for this HTLC, we may previously have not generated a proper
230    claiming transaction for the HTLC's value (#2623).
231  * 0.0.117 now correctly handles channels for which our counterparty funded the
232    channel with a coinbase transaction. As such transactions are not spendable
233    until they've reached 100 confirmations, this could have resulted in
234    accepting HTLC(s) which are not enforcible on-chain (#1924).
235
236 In total, this release features 121 files changed, 20477 insertions, 8184
237 deletions in 381 commits from 27 authors, in alphabetical order:
238  * Alec Chen
239  * Allan Douglas R. de Oliveira
240  * Antonio Yang
241  * Arik Sosman
242  * Chris Waterson
243  * David Caseria
244  * DhananjayPurohit
245  * Dom Zippilli
246  * Duncan Dean
247  * Elias Rohrer
248  * Erik De Smedt
249  * Evan Feenstra
250  * Gabor Szabo
251  * Gursharan Singh
252  * Jeffrey Czyz
253  * Joseph Goulden
254  * Lalitmohansharma1
255  * Matt Corallo
256  * Rachel Malonson
257  * Sergi Delgado Segura
258  * Valentine Wallace
259  * Vladimir Fomene
260  * Willem Van Lint
261  * Wilmer Paulino
262  * benthecarman
263  * jbesraa
264  * optout
265
266
267 # 0.0.116 - Jul 21, 2023 - "Anchoring the Roadmap"
268
269 ## API Updates
270
271  * Support for zero-HTLC-fee anchor output channels has been added and is now
272    considered beta (#2367). Users who set
273    `ChannelHandshakeConfig::negotiate_anchors_zero_fee_htlc_tx` should be
274    prepared to handle the new `Event::BumpTransaction`, e.g. via the
275    `BumpTransactionEventHandler` (#2089). Note that in order to do so you must
276    ensure you always have a reserve of available unspent on-chain funds to use
277    for CPFP. LDK currently makes no attempt to ensure this for you.
278  * Users who set `ChannelHandshakeConfig::negotiate_anchors_zero_fee_htlc_tx`
279    and wish to accept inbound anchor-based channels must do so manually by
280    setting `UserConfig::manually_accept_inbound_channels` (#2368).
281  * Support forwarding and accepting HTLCs with a reduced amount has been added,
282    to support LSPs skimming a fee on the penultimate hop (#2319).
283  * BOLT11 and BOLT12 Invoice and related types have been renamed to include a
284    BOLTNN prefix, ensuring uniqueness in `lightning{,-invoice}` crates (#2416).
285  * `Score`rs now have an associated type which represents a parameter passed
286    when calculating penalties. This allows for the same `Score`r to be used with
287    different penalty calculation parameters (#2237).
288  * `DefaultRouter` is no longer restrained to a `Mutex`-wrapped `Score`,
289    allowing it to be used in `no-std` builds (#2383).
290  * `CustomMessageHandler::provided_{node,init}_features` and various custom
291    feature bit methods on `*Features` were added (#2204).
292  * Keysend/push payments using MPP are now supported when receiving if
293    `UserConfig::accept_mpp_keysend` is set and when sending if specified in the
294    `PaymentParameters`. Note that not all recipients support this (#2156).
295  * A new `ConfirmationTarget::MempoolMinimum` has been added (#2415).
296  * `SpendableOutputDescriptor::to_psbt_input` was added (#2286).
297  * `ChannelManager::update_partial_channel_config` was added (#2330).
298  * `ChannelDetails::channel_shutdown_state` was added (#2347).
299  * The shutdown script can now be provided at shutdown time via
300    `ChannelManager::close_channel_with_feerate_and_script` (#2219).
301  * `BroadcasterInterface` now takes multiple transactions at once. While not
302    available today, in the future single calls should be passed to a full node
303    via a single batch/package transaction acceptance API (#2272).
304  * `Balance::claimable_amount_satoshis` was added (#2333).
305  * `payment_{hash,preimage}` have been added to some `Balance` variants (#2217).
306  * The `lightning::chain::keysinterface` is now `lightning::sign` (#2246).
307  * Routing to a blinded path has been implemented, though sending to such a
308    route is not yet supported in `ChannelManager` (#2120).
309  * `OffersMessageHandler` was added for offers-related onion messages (#2294).
310  * The `CustomMessageHandler` parameter to `PeerManager` has moved to
311    `MessageHandler` from `PeerManager::new` explicitly (#2249).
312  * Various P2P messages for dual funding channel establishment have been added,
313    though handling for them is not yet in `ChannelManager` (#1794)
314  * Script-fetching methods in `sign` interfaces can now return errors, see docs
315    for the implications of failing (#2213).
316  * The `data_loss_protect` option is now required when reading
317    `channel_reestablish` messages, as many others have done (#2253).
318  * `InFlightHtlcs::add_inflight_htlc` has been added (#2042).
319  * The `init` message `networks` field is now written and checked (#2329).
320  * `PeerManager` generics have been simplified with the introduction of the
321    `APeerManager` trait (#2249).
322  * `ParitalOrd` and `Ord` are now implemented for `Invoice` (#2279).
323  * `ParitalEq` and `Debug` are now implemented for `InMemorySigner` (#2328).
324  * `ParitalEq` and `Eq` are now implemented for `PaymentError` (#2316).
325  * `NetworkGraph::update_channel_from_announcement_no_lookup` was added (#2222).
326  * `lightning::routing::gossip::verify_{channel,node}_announcement` was added
327    (#2307).
328
329 ## Backwards Compatibility
330  * `PaymentParameters` written with blinded path info using LDK 0.0.115 will not
331    be readable in LDK 0.0.116, and vice versa.
332  * Forwarding less than `Event::HTLCIntercepted::expected_outbound_amount_msat`
333    in `ChannelManager::forward_intercepted_htlc` may prevent the
334    `ChannelManager` from being read by LDK prior to 0.0.116 (#2319)
335  * Setting `ChannelConfig::accept_underpaying_htlcs` may prevent the
336    `ChannelManager` from being read by LDK prior to 0.0.116 and un-setting the
337    parameter between restarts may lead to payment failures (#2319).
338  * `ChannelManager::create_inbound_payment{,_for_hash}_legacy` has been removed,
339    removing the ability to create inbound payments which are claimable after
340    downgrade to LDK 0.0.103 and prior. In the future handling such payments will
341    also be removed (#2351).
342  * Some fields required by LDK 0.0.103 and earlier are no longer written, thus
343    deserializing objects written by 0.0.116 with 0.0.103 may now fail (#2351).
344
345 ## Bug Fixes
346  * `ChannelDetails::next_outbound_htlc_limit_msat` was made substantially more
347    accurate and a corresponding `next_outbound_htlc_minimum_msat` was added.
348    This resolves issues where unpayable routes were generated due to
349    overestimation of the amount which is payable over one of our channels as
350    the first hop (#2312).
351  * A rare case where delays in processing `Event`s generated by
352    `ChannelMonitor`s could lead to loss of those events in case of an untimely
353    crash. This could lead to the loss of an `Event::SpendableOutputs` (#2369).
354  * Fixed a regression in 0.0.115 which caused `PendingHTLCsForwardable` events
355    to be missed when processing phantom node receives. This caused such
356    payments to be delayed until a further, unrelated HTLC came in (#2395).
357  * Peers which are unresponsive to channel messages for several timer ticks are
358    now disconnected to allow for on-reconnection state machine reset. This
359    works around some issues in LND prior to 16.3 which can cause channels to
360    hang and eventually force-close (#2293).
361  * `ChannelManager::new` now requires the current time (either from a recent
362    block header or the system clock), ensuring invoices created immediately
363    after startup aren't already expired (#2372).
364  * Resolved an issue where reading a `ProbabilisticScorer` on some platforms
365    (e.g. iOS) can lead to a panic (#2322).
366  * `ChannelConfig::max_dust_htlc_exposure` is now allowed to scale based on
367    current fees, and the default has been updated to do so. This substantially
368    reduces the chance of force-closure due to dust exposure. Note that existing
369    channels will retain their current value and you may wish to update the
370    value on your existing channels on upgrade (#2354).
371  * `PeerManager::process_events` no longer blocks in any case. This fixes a bug
372    where reentrancy from `PeerManager` into user code which eventually calls
373    `process_events` could lead to a deadlock (#2280).
374  * The persist timing of network graph and scoring in
375    `lightning-background-processor` has been tweaked to provide more reliable
376    persistence after updates to either (#2226).
377  * The number of route hints added to BOLT 11 invoices by the
378    `lightning-invoice::utils` builders has been reduced to three to ensure
379    invoices can be represented in scan-able QR codes (#2044).
380  * Fixed sending large onion messages, which would previously have resulted in
381    an HMAC error on the second hop (#2277).
382  * Fixed a memory leak that may occur when a `ChannelManager` or
383    `ChannelMonitor` is `drop`ed (#2233).
384  * A potential deadlock in calling `NetworkGraph::eq` was resolved (#2284).
385  * Fixed an overflow which prevented disconnecting peers in some minor cases
386    with more than 31 peers (#2245).
387  * Gossip messages with an unknown chain hash are now ignored (#2230).
388  * Rapid Gossip Sync processing now fails on an unknown chain hash (#2324).
389  * `RouteHintHop::htlc_maximum_msat` is now enforced. Note that BOLT11 route
390    hints do not have such a field so this code is generally unused (#2305).
391
392 ## Security
393 0.0.116 fixes a denial-of-service vulnerability which is reachable from
394 untrusted input from channel counterparties if a 0-conf channel exists with
395 that counterparty.
396  * A premature `announcement_signatures` message from a peer prior to a 0-conf
397    channel's funding transaction receiving any confirmations would panic in any
398    version since 0-conf channels were introduced (#2439).
399
400 In total, this release features 142 files changed, 21033 insertions, 11066
401 deletions in 327 commits from 21 authors, in alphabetical order:
402  * Alec Chen
403  * Andrei
404  * Antoine Riard
405  * Arik Sosman
406  * Chad Upjohn
407  * Daniel GranhÃĢo
408  * Duncan Dean
409  * Elias Rohrer
410  * Fred Walker
411  * Gleb Naumenko
412  * Jeffrey Czyz
413  * Martin Habovstiak
414  * Matt Corallo
415  * Tony Giorgio
416  * Valentine Wallace
417  * Vladimir Fomene
418  * Willem Van Lint
419  * Wilmer Paulino
420  * benthecarman
421  * ff
422  * henghonglee
423
424
425 # 0.0.115 - Apr 24, 2023 - "Rebroadcast the Bugfixes"
426
427 ## API Updates
428  * The MSRV of the main LDK crates has been increased to 1.48 (#2107).
429  * Attempting to claim an un-expired payment on a channel which has closed no
430    longer fails. The expiry time of payments is exposed via
431    `PaymentClaimable::claim_deadline` (#2148).
432  * `payment_metadata` is now supported in `Invoice` deserialization, sending,
433    and receiving (via a new `RecipientOnionFields` struct) (#2139, #2127).
434  * `Event::PaymentFailed` now exposes a failure reason (#2142).
435  * BOLT12 messages now support stateless generation and validation (#1989).
436  * The `NetworkGraph` is now pruned of stale data after RGS processing (#2161).
437  * Max inbound HTLCs in-flight can be changed in the handshake config (#2138).
438  * `lightning-transaction-sync` feature `esplora-async-https` was added (#2085).
439  * A `ChannelPending` event is now emitted after the initial handshake (#2098).
440  * `PaymentForwarded::outbound_amount_forwarded_msat` was added (#2136).
441  * `ChannelManager::list_channels_by_counterparty` was added (#2079).
442  * `ChannelDetails::feerate_sat_per_1000_weight` was added (#2094).
443  * `Invoice::fallback_addresses` was added to fetch `bitcoin` types (#2023).
444  * The offer/refund description is now exposed in `Invoice{,Request}` (#2206).
445
446 ## Backwards Compatibility
447  * Payments sent with the legacy `*_with_route` methods on LDK 0.0.115+ will no
448    longer be retryable via the LDK 0.0.114- `retry_payment` method (#2139).
449  * `Event::PaymentPathFailed::retry` was removed and will always be `None` for
450     payments initiated on 0.0.115 which fail on an earlier version (#2063).
451  * `Route`s and `PaymentParameters` with blinded path information will not be
452    readable on prior versions of LDK. Such objects are not currently constructed
453    by LDK, but may be when processing BOLT12 data in a coming release (#2146).
454  * Providing `ChannelMonitorUpdate`s generated by LDK 0.0.115 to a
455    `ChannelMonitor` on 0.0.114 or before may panic (#2059). Note that this is
456    in general unsupported, and included here only for completeness.
457
458 ## Bug Fixes
459  * Fixed a case where `process_events_async` may `poll` a `Future` which has
460    already completed (#2081).
461  * Fixed deserialization of `u16` arrays. This bug may have previously corrupted
462    the historical buckets in a `ProbabilisticScorer`. Users relying on the
463    historical buckets may wish to wipe their scorer on upgrade to remove corrupt
464    data rather than waiting on it to decay (#2191).
465  * The `process_events_async` task is now `Send` and can thus be polled on a
466    multi-threaded runtime (#2199).
467  * Fixed a missing macro export causing
468    `impl_writeable_tlv_based_enum{,_upgradable}` calls to not compile (#2091).
469  * Fixed compilation of `lightning-invoice` with both `no-std` and serde (#2187)
470  * Fix an issue where the `background-processor` would not wake when a
471    `ChannelMonitorUpdate` completed asynchronously, causing delays (#2090).
472  * Fix an issue where `process_events_async` would exit immediately (#2145).
473  * `Router` calls from the `ChannelManager` now call `find_route_with_id` rather
474    than `find_route`, as was intended and described in the API (#2092).
475  * Ensure `process_events_async` always exits if any sleep future returns true,
476    not just if all sleep futures repeatedly return true (#2145).
477  * `channel_update` messages no longer set the disable bit unless the peer has
478    been disconnected for some time. This should resolve cases where channels are
479    disabled for extended periods of time (#2198).
480  * We no longer remove CLN nodes from the network graph for violating the BOLT
481    spec in some cases after failing to pay through them (#2220).
482  * Fixed a debug assertion which may panic under heavy load (#2172).
483  * `CounterpartyForceClosed::peer_msg` is now wrapped in UntrustedString (#2114)
484  * Fixed a potential deadlock in `funding_transaction_generated` (#2158).
485
486 ## Security
487  * Transaction re-broadcasting is now substantially more aggressive, including a
488    new regular rebroadcast feature called on a timer from the
489    `background-processor` or from `ChainMonitor::rebroadcast_pending_claims`.
490    This should substantially increase transaction confirmation reliability
491    without relying on downstream `TransactionBroadcaster` implementations for
492    rebroadcasting (#2203, #2205, #2208).
493  * Implemented the changes from BOLT PRs #1031, #1032, and #1040 which resolve a
494    privacy vulnerability which allows an intermediate node on the path to
495    discover the final destination for a payment (#2062).
496
497 In total, this release features 110 files changed, 11928 insertions, 6368
498 deletions in 215 commits from 21 authors, in alphabetical order:
499  * Advait
500  * Alan Cohen
501  * Alec Chen
502  * Allan Douglas R. de Oliveira
503  * Arik Sosman
504  * Elias Rohrer
505  * Evan Feenstra
506  * Jeffrey Czyz
507  * John Cantrell
508  * Lucas Soriano del Pino
509  * Marc Tyndel
510  * Matt Corallo
511  * Paul Miller
512  * Steven
513  * Steven Williamson
514  * Steven Zhao
515  * Tony Giorgio
516  * Valentine Wallace
517  * Wilmer Paulino
518  * benthecarman
519  * munjesi
520
521
522 # 0.0.114 - Mar 3, 2023 - "Faster Async BOLT12 Retries"
523
524 ## API Updates
525  * `InvoicePayer` has been removed and its features moved directly into
526    `ChannelManager`. As such it now requires a simplified `Router` and supports
527    `send_payment_with_retry` (and friends). `ChannelManager::retry_payment` was
528    removed in favor of the automated retries. Invoice payment utilities in
529    `lightning-invoice` now call the new code (#1812, #1916, #1929, #2007, etc).
530  * `Sign`/`BaseSign` has been renamed `ChannelSigner`, with `EcdsaChannelSigner`
531    split out in anticipation of future schnorr/taproot support (#1967).
532  * The catch-all `KeysInterface` was split into `EntropySource`, `NodeSigner`,
533    and `SignerProvider`. `KeysManager` implements all three (#1910, #1930).
534  * `KeysInterface::get_node_secret` is now `KeysManager::get_node_secret_key`
535    and is no longer required for external signers (#1951, #2070).
536  * A `lightning-transaction-sync` crate has been added which implements keeping
537    LDK in sync with the chain via an esplora server (#1870). Note that it can
538    only be used on nodes that *never* ran a previous version of LDK.
539  * `Score` is updated in `BackgroundProcessor` instead of via `Router` (#1996).
540  * `ChainAccess::get_utxo` (now `UtxoAccess`) can now be resolved async (#1980).
541  * BOLT12 `Offer`, `InvoiceRequest`, `Invoice` and `Refund` structs as well as
542    associated builders have been added. Such invoices cannot yet be paid due to
543    missing support for blinded path payments (#1927, #1908, #1926).
544  * A `lightning-custom-message` crate has been added to make combining multiple
545    custom messages into one enum/handler easier (#1832).
546  * `Event::PaymentPathFailed` is now generated for failure to send an HTLC
547    over the first hop on our local channel (#2014, #2043).
548  * `lightning-net-tokio` no longer requires an `Arc` on `PeerManager` (#1968).
549  * `ChannelManager::list_recent_payments` was added (#1873).
550  * `lightning-background-processor` `std` is now optional in async mode (#1962).
551  * `create_phantom_invoice` can now be used in `no-std` (#1985).
552  * The required final CLTV delta on inbound payments is now configurable (#1878)
553  * bitcoind RPC error code and message are now surfaced in `block-sync` (#2057).
554  * Get `historical_estimated_channel_liquidity_probabilities` was added (#1961).
555  * `ChannelManager::fail_htlc_backwards_with_reason` was added (#1948).
556  * Macros which implement serialization using TLVs or straight writing of struct
557    fields are now public (#1823, #1976, #1977).
558
559 ## Backwards Compatibility
560  * Any inbound payments with a custom final CLTV delta will be rejected by LDK
561    if you downgrade prior to receipt (#1878).
562  * `Event::PaymentPathFailed::network_update` will always be `None` if an
563    0.0.114-generated event is read by a prior version of LDK (#2043).
564  * `Event::PaymentPathFailed::all_paths_failed` will always be false if an
565    0.0.114-generated event is read by a prior version of LDK. Users who rely on
566    it to determine payment retries should migrate to `Event::PaymentFailed`, in
567    a separate release prior to upgrading to LDK 0.0.114 if downgrading is
568    supported (#2043).
569
570 ## Performance Improvements
571  * Channel data is now stored per-peer and channel updates across multiple
572    peers can be operated on simultaneously (#1507).
573  * Routefinding is roughly 1.5x faster (#1799).
574  * Deserializing a `NetworkGraph` is roughly 6x faster (#2016).
575  * Memory usage for a `NetworkGraph` has been reduced substantially (#2040).
576  * `KeysInterface::get_secure_random_bytes` is roughly 200x faster (#1974).
577
578 ## Bug Fixes
579  * Fixed a bug where a delay in processing a `PaymentSent` event longer than the
580    time taken to persist a `ChannelMonitor` update, when occurring immediately
581    prior to a crash, may result in the `PaymentSent` event being lost (#2048).
582  * Fixed spurious rejections of rapid gossip sync data when the graph has been
583    updated by other means between gossip syncs (#2046).
584  * Fixed a panic in `KeysManager` when the high bit of `starting_time_nanos`
585    is set (#1935).
586  * Resolved an issue where the `ChannelManager::get_persistable_update_future`
587    future would fail to wake until a second notification occurs (#2064).
588  * Resolved a memory leak when using `ChannelManager::send_probe` (#2037).
589  * Fixed a deadlock on some platforms at least when using async `ChannelMonitor`
590    updating (#2006).
591  * Removed debug-only assertions which were reachable in threaded code (#1964).
592  * In some cases when payment sending fails on our local channel retries no
593    longer take the same path and thus never succeed (#2014).
594  * Retries for spontaneous payments have been fixed (#2002).
595  * Return an `Err` if `lightning-persister` fails to read the directory listing
596    rather than panicing (#1943).
597  * `peer_disconnected` will now never be called without `peer_connected` (#2035)
598
599 ## Security
600 0.0.114 fixes several denial-of-service vulnerabilities which are reachable from
601 untrusted input from channel counterparties or in deployments accepting inbound
602 connections or channels. It also fixes a denial-of-service vulnerability in rare
603 cases in the route finding logic.
604  * The number of pending un-funded channels as well as peers without funded
605    channels is now limited to avoid denial of service (#1988).
606  * A second `channel_ready` message received immediately after the first could
607    lead to a spurious panic (#2071). This issue was introduced with 0conf
608    support in LDK 0.0.107.
609  * A division-by-zero issue was fixed in the `ProbabilisticScorer` if the amount
610    being sent (including previous-hop fees) is equal to a channel's capacity
611    while walking the graph (#2072). The division-by-zero was introduced with
612    historical data tracking in LDK 0.0.112.
613
614 In total, this release features 130 files changed, 21457 insertions, 10113
615 deletions in 343 commits from 18 authors, in alphabetical order:
616  * Alec Chen
617  * Allan Douglas R. de Oliveira
618  * Andrei
619  * Arik Sosman
620  * Daniel GranhÃĢo
621  * Duncan Dean
622  * Elias Rohrer
623  * Jeffrey Czyz
624  * John Cantrell
625  * Kurtsley
626  * Matt Corallo
627  * Max Fang
628  * Omer Yacine
629  * Valentine Wallace
630  * Viktor TigerstrÃķm
631  * Wilmer Paulino
632  * benthecarman
633  * jurvis
634
635
636 # 0.0.113 - Dec 16, 2022 - "Big Movement Intercepted"
637
638 ## API Updates
639  * `ChannelManager::send_payment` now takes an explicit `PaymentId` which is a
640    loose idempotency token. See `send_payment` docs for more (#1761, #1826).
641  * HTLCs bound for SCIDs from `ChannelManager::get_intercept_scid` are now
642    intercepted and can be forwarded manually over any channel (#1835, #1893).
643  * `Confirm::get_relevant_txids` now returns a `BlockHash`, expanding the set
644    of cases where `transaction_unconfirmed` must be called, see docs (#1796).
645  * Pending outbound payments are no longer automatically timed-out a few blocks
646    after failure. Thus, in order to avoid leaking memory, you MUST call
647    `ChannelManager::abandon_payment` when you no longer wish to retry (#1761).
648  * `ChannelManager::abandon_payment` docs were updated to note that the payment
649    may return to pending after a restart if no persistence occurs (#1907).
650  * `Event::PaymentReceived` has been renamed `Event::PaymentClaimable` (#1891).
651  * `Event` handling is now optionally async for Rust users (#1787).
652  * `user_channel_id` is now a `u128` and random for inbound channels (#1790).
653  * A new `ChannelReady` event is generated whenever a channel becomes ready to
654    be used, i.e., after both sides sent the `channel_ready` message (#1743).
655  * `NetworkGraph` now prunes channels where either node is offline for 2 weeks
656    and refuses to accept re-announcements of pruned channels (#1735).
657  * Onion messages are now read in `CustomOnionMessageHandler` rather than via
658    `MaybeReadableArgs` (#1809).
659  * Added a new util to generate an invoice with a custom hash (#1894) -
660 `create_invoice_from_channelmanager_and_duration_since_epoch_with_payment_hash`
661  * `Sign`ers are now by default re-derived using `KeysInterface`'s new
662    `derive_channel_signer` rather than `read_chan_signer` (#1867).
663  * `Confirm::transactions_confirmed` is now idempotent (#1861).
664  * `ChannelManager::compute_inflight_htlcs` has been added to fetch in-flight
665    HTLCs for scoring. Note that `InvoicePayer` does this for you (#1830).
666  * Added `PaymentClaimable::via_channel_id` (#1856).
667  * Added the `node_id` (phantom or regular) to payment events (#1766).
668  * Added the funding transaction `confirmations` to `ChannelDetails` (#1856).
669  * `BlindedRoute` has been renamed `BlindedPath` (#1918).
670  * Support for the BOLT 4 "legacy" onion format has been removed, in line with
671    its removal in the spec and vanishingly rare use (#1413).
672  * `ChainMonitor::list_pending_monitor_updates` was added (#1834).
673  * Signing for non-zero-fee anchor commitments is supported again (#1828).
674  * Several helpers for transaction matching and generation are now pub (#1839).
675
676 ## Bug Fixes
677  * Fixed a rare race where a crash may result in a pending HTLC not being
678    failed backwards, leading to a force-closure by our counterparty (#1857).
679  * Avoid incorrectly assigning a lower-bound on channel liquidity when routing
680    fails due to a closed channel earlier in the path (#1817).
681  * If a counterparty increases the channel fee, but not enough per our own fee
682    estimator, we no longer force-close the channel (#1852).
683  * Several bugs in the `lightning-background-processor` `future` feature were
684    fixed, including requirements doc corrections (#1843, #1845, #1851).
685  * Some failure messages sent back when failing an HTLC were corrected (#1895).
686  * `rapid-gossip-sync` no longer errors if an update is applied duplicatively
687    or in rare cases when the graph is updated from payment failures (#1833).
688  * Sending onion messages to a blinded path in which we're the introduction
689    node no longer fails (#1791).
690
691 ## Backwards Compatibility
692  * No `ChannelReady` events will be generated for previously existing channels,
693    including those which become ready after upgrading to 0.0.113 (#1743).
694  * Once `UserConfig::accept_intercept_htlcs` is set, downgrades to LDK versions
695    prior to 0.0.113 are not supported (#1835).
696  * Existing payments may see a `PaymentClaimable::user_channel_id` of 0 (#1856)
697  * When downgrading to a version of LDK prior to 0.0.113 when there are
698    resolved payments waiting for a small timeout, the payments may not be
699    removed, preventing payments with the same `PaymentId` (#1761).
700
701 In total, this release features 76 files changed, 11639 insertions, 6067
702 deletions in 210 commits from 18 authors, in alphabetical order:
703  * Antoine Riard
704  * Arik Sosman
705  * Devrandom
706  * Duncan Dean
707  * Elias Rohrer
708  * Gleb Naumenko
709  * Jeffrey Czyz
710  * John Cantrell
711  * Matt Corallo
712  * Tee8z
713  * Tobin C. Harding
714  * Tristan F
715  * Valentine Wallace
716  * Viktor TigerstrÃķm
717  * Wilmer Paulino
718  * benthecarman
719  * jurvis
720  * ssbright
721
722
723 # 0.0.112 - Oct 25, 2022 - "History Matters"
724
725 ## API Updates
726  * `Result<(), ChannelMonitorUpdateErr>` return values have been replaced with
727    a `ChannelMonitorUpdateStatus` trinary enum. This better denotes that
728    `ChannelMonitorUpdateStatus::InProgress` is not an error, but asynchronous
729    persistence of a monitor update. Note that asynchronous persistence still
730    has some edge cases and is not yet recommended for production (#1106).
731  * `ChannelMonitor` persistence failure no longer automatically broadcasts the
732    latest commitment transaction. See the
733    `ChannelMonitorUpdateStatus::PermanentFailure` docs for more info (#1106).
734  * `*Features::known` has been replaced with individual
735    `*MessageHandler::provided_*_features` methods (#1707).
736  * `OnionMessenger` now takes a `CustomOnionMessageHandler` implementation,
737    allowing you to send and receive custom onion messages (#1748).
738  * `ProbabilisticScorer` now tracks the historical distribution of liquidity
739    estimates for channels. See new `historical_*` parameters in
740    `ProbabilisticScoringParameters` for more details (#1625).
741  * `lightning-block-sync`'s `BlockSource` trait now supports BIP 157/158
742    filtering clients by returning only header data for some blocks (#1706).
743  * `lightning-invoice`'s `Router` trait now accepts an `InFlightHtlcs` to
744    ensure we do not over-use a remote channel's funds during routing (#1694).
745    Note that this was previously backported to 0.0.111 for bindings users.
746  * `NetworkGraph::remove_stale_channels` has been renamed
747    `NetworkGraph::remove_stale_channels_and_tracking` as `NetworkGraph` now
748    refuses to re-add nodes and channels that were recently removed (#1649).
749  * The `lightning-rapid-gossip-sync` crate now supports `no-std` (#1708).
750  * The default `ProbabilisticScoringParameters::liquidity_offset_half_life` has
751    been increased to six hours from one (#1754).
752  * All commitment transaction building logic for anchor outputs now assumes the
753    no-HTLC-tx-fee variant (#1685).
754  * A number of missing `Eq` implementations were added (#1763).
755
756 ## Bug Fixes
757  * `lightning-background-processor` now builds without error with the `futures`
758    feature (#1744).
759  * `ChannelManager::get_persistable_update_future`'s returned `Future` has been
760    corrected to not fail to be awoken in some cases (#1758).
761  * Asynchronously performing the initial `ChannelMonitor` persistence is now
762    safe (#1678).
763  * Redundantly applying rapid gossip sync updates no longer `Err`s (#1764).
764  * Nodes which inform us via payment failures that they should no longer be
765    used are now removed from the network graph. Some LND nodes spuriously
766    generate this error and may remove themselves from our graph (#1649).
767
768 In total, this release features 134 files changed, 6598 insertions, 4370
769 deletions in 109 commits from 13 authors, in alphabetical order:
770  * Duncan Dean
771  * Elias Rohrer
772  * Gabriel Comte
773  * Gursharan Singh
774  * Jeffrey Czyz
775  * Jurvis Tan
776  * Matt Corallo
777  * Max Fang
778  * Paul Miller
779  * Valentine Wallace
780  * Viktor TigerstrÃķm
781  * Wilmer Paulino
782  * acid-bit
783
784 # 0.0.111 - Sep 12, 2022 - "Saturated with Messages"
785
786 ## API Updates
787  * Support for relaying onion messages has been added via a new
788    `OnionMessenger` struct when passed as the `OnionMessageHandler` to a
789    `PeerManager`. Pre-encoded onion messages can also be sent and received
790    (#1503, #1650, #1652, #1688).
791  * Rate-limiting of outbound gossip syncs has been rewritten to utilize less
792    buffering inside LDK. The new rate-limiting is also used for onion messages
793    to avoid delaying other messages (#1604. #1660, #1683).
794  * Rather than spawning a full OS thread, `lightning-background-processor` has
795    a new `process_events_async` method which takes the place of a
796    `BackgroundProcessor` for those using Rust's async (#1657).
797  * `ChannelManager::get_persistable_update_future` has been added to block on
798    a ChannelManager needing re-persistence in a Rust async environment (#1657).
799  * The `Filter::register_output` return value has been removed, as it was
800    very difficult to correctly implement (i.e., without blocking). Users
801    previously using it should instead pass dependent transactions in via
802    additional `chain::Confirm::transactions_confirmed` calls (#1663).
803  * `ChannelHandshakeConfig::their_channel_reserve_proportional_millionths` has
804    been added to allow configuring counterparty reserve values (#1619).
805  * `KeysInterface::ecdh` has been added as an ECDH oracle (#1503, #1658).
806  * The `rust-bitcoin` dependency has been updated 0.29 (#1658).
807  * The `bitcoin_hashes` dependency has been updated 0.11 (#1677).
808  * `ChannelManager::broadcast_node_announcement` has been moved to
809    `PeerManager` (#1699).
810  * `channel_` and `node_announcement`s are now rebroadcast automatically to all
811    new peers which connect (#1699).
812  * `{Init,Node}Features` sent to peers/broadcasted are now fetched via the
813    various `*MessageHandler` traits, rather than hard-coded (#1701, #1688).
814  * `Event::PaymentPathFailed::rejected_by_dest` has been renamed
815    `payment_failed_permanently` (#1702).
816  * `Invoice` now derives the std `Hash` trait (#1575).
817  * `{Signed,}RawInvoice::hash` have been renamed `signable_hash` (#1714).
818  * `chain::AccessError` now derives the std `Debug` trait (#1709).
819  * `ReadOnlyNetworkGraph::list_{channels,nodes}` have been added largely for
820    users of downstream bindings (#1651).
821  * `ChannelMonitor::get_counterparty_node_id` is now available (#1635).
822
823 ## Bug Fixes
824  * The script compared with that returned from `chain::Access` was incorrect
825    ~half of the time, causing spurious gossip rejection (#1666).
826  * Pending in-flight HTLCs are now considered when calculating new routes,
827    ensuring, e.g. MPP retries do not take known-saturated paths (#1643).
828  * Counterparty-revoked outputs are now included in `get_claimable_balance`
829    output via a new `Balance::CounterpartyRevokedOutputClaimable` (#1495).
830  * Inbound HTLCs for which we do not (yet) have a preimage are now included in
831    `get_claimable_balance` via a `Balance::MaybePreimageClaimableHTLC` (#1673).
832  * Probes that fail prior to being sent over their first hop are correctly
833    failed with a `Event::ProbeFailed` rather than a `PaymentPathFailed` (#1704).
834  * Pending `Event::HTLCHandlingFailed`s are no longer lost on restart (#1700).
835  * HTLCs that fail prior to being sent over their first hop are now marked as
836    retryable via `!PaymentPathFailed::payment_failed_permanently` (#1702).
837  * Dust HTLCs are now considered failed in the payment tracking logic after the
838    commitment transaction confirms, allowing retry on restart (#1691).
839  * On machines with buggy "monotonic" clocks, LDK will no longer panic if time
840    goes backwards (#1692).
841
842 ## Backwards Compatibility
843  * The new `current_time` argument to `PeerManager` constructors must be set to
844    a UNIX timestamp for upgraded nodes; new nodes may use a counter (#1699).
845  * `Balance::CounterpartyRevokedOutputClaimable` will never be generated for
846    channels that were observed to go on-chain with LDK versions prior to
847    0.0.111 (#1495).
848  * `ChannelMonitor::get_counterparty_node_id` will return `None` for all
849    channels opened on a version of LDK prior to 0.0.110 (#1635).
850  * Setting `their_channel_reserve_proportional_millionths` to any value other
851    than the default will cause LDK versions prior to 0.0.104 to be unable to
852    read the serialized `ChannelManager` (#1619).
853
854 ## Security
855 0.0.111 fixes a denial-of-service vulnerability which is reachable from
856 untrusted input in deployments accepting 0conf channels, or via a race-condition
857 in deployments creating outbound 0conf channels.
858
859  * LDK versions prior to 0.0.111 may spuriously panic when receiving a block if
860    they are awaiting the construction of a funding transaction for a 0-conf
861    channel (#1711). 0-conf support was added in LDK version 0.0.107.
862
863 In total, this release features 84 files changed, 6306 insertions, 1960
864 deletions in 121 commits from 11 authors, in alphabetical order:
865  * Arik Sosman
866  * Devrandom
867  * Duncan Dean
868  * Elias Rohrer
869  * Gursharan Singh
870  * Matt Corallo
871  * NicolaLS
872  * Valentine Wallace
873  * Viktor TigerstrÃķm
874  * jurvis
875  * ok300
876
877
878 # 0.0.110 - 2022-07-26 - "Routing, With a Vengeance"
879
880 ## API Updates
881  * `ChannelManager::send_probe` and `Score::probe_{failed,successful}` have
882    been added to make probing more explicit, as well as new
883    `Event::Probe{Failed,Successful}` events (#1567).
884  * `ProbabilisticScoringParameters::banned_nodes` has been renamed
885    `manual_node_penalties` and changed to take msat penalties (#1592).
886  * Per-payment tracking of failed paths was added to enable configuration of
887    `ProbabilisticScoringParameters::considered_impossible_penalty_msat` (#1600)
888  * `ProbabilisticScoringParameters::base_penalty_amount_multiplier_msat` was
889    added to allow a penalty that is only amount-dependent (#1617).
890  * `ProbabilisticScoringParameters::amount_penalty_multiplier_msat` was renamed
891    `liquidity_penalty_amount_multiplier_msat` (#1617).
892  * A new `Event::HTLCHandlingFailed` has been added which provides visibility
893    into failures to forward/claim accepted HTLCs (#1403).
894  * Support has been added for DNS hostnames in the `NetAddress` type, see
895    [BOLT PR #911](https://github.com/lightning/bolts/pull/911) (#1553).
896  * `GossipSync` now has `rapid`, `p2p`, and `none` constructors (#1618).
897  * `lightning-net-tokio` no longer requires types to be in `Arc`s (#1623).
898  * The `htlc_maximum_msat` field is now required in `ChannelUpdate` gossip
899    messages. In tests this rejects < 1% of channels (#1519).
900  * `ReadOnlyNetworkGraph::{channel,node}` have been added to query for
901    individual channel/node data, primarily for bindings users (#1543).
902  * `FeeEstimator` implementations are now wrapped internally to ensure values
903    below 253 sats/kW are never used (#1552).
904  * Route selection no longer attempts to randomize path selection. This is
905    unlikely to lead to a material change in the paths selected (#1610).
906
907 ## Bug Fixes
908  * Fixed a panic when deserializing `ChannelDetails` objects (#1588).
909  * When routing, channels are no longer fully saturated before MPP splits are
910    generated, instead a configuration knob was added as
911    `PaymentParameters::max_channel_saturation_power_of_half` (#1605).
912  * Fixed a panic which occurred in `ProbabilisticScorer` when wallclock time
913    goes backwards across a restart (#1603).
914
915 ## Serialization Compatibility
916  * All new fields are ignored by prior versions of LDK. All new fields are not
917    present when reading objects serialized by prior versions of LDK.
918  * Channel information written in the `NetworkGraph` which is missing
919    `htlc_maximum_msat` may be dropped on deserialization (#1519).
920  * Similarly, node information written in the `NetworkGraph` which contains an
921    invalid hostname may be dropped on deserialization (#1519).
922
923 In total, this release features 79 files changed, 2935 insertions, 1363
924 deletions in 52 commits from 9 authors, in alphabetical order:
925  * Duncan Dean
926  * Elias Rohrer
927  * Jeffrey Czyz
928  * Matt Corallo
929  * Max Fang
930  * Viktor TigerstrÃķm
931  * Willem Van Lint
932  * Wilmer Paulino
933  * jurvis
934
935 # 0.0.109 - 2022-07-01 - "The Kitchen Sink"
936
937 ## API Updates
938  * `ChannelManager::update_channel_config` has been added to allow the fields
939    in `ChannelConfig` to be changed in a given channel after open (#1527).
940  * If we reconnect to a peer which proves we have a stale channel state, rather
941    than force-closing we will instead panic to provide an opportunity to switch
942    to the latest state and continue operating without channel loss (#1564).
943  * A `NodeAlias` struct has been added which handles string sanitization for
944    node aliases via the `Display` trait (#1544).
945  * `ProbabilisticScoringParameters` now has a `banned_nodes` set which we will
946     never route through during path finding (#1550).
947  * `ProbabilisticScoringParameters` now offers an `anti_probing_penalty_msat`
948    option to prefer channels which afford better privacy when routing (#1555).
949  * `ProbabilisticScorer` now provides access to its estimated liquidity range
950    for a given channel via `estimated_channel_liquidity_range` (#1549).
951  * `ChannelManager::force_close_channel` has been renamed
952    `force_close_broadcasting_latest_txn` and
953    `force_close_without_broadcasting_txn` has been added (#1564).
954  * Options which cannot be changed at runtime have been moved from
955    `ChannelConfig` to `ChannelHandshakeConfig` (#1529).
956  * `find_route` takes `&NetworkGraph` instead of `ReadOnlyNetworkGraph (#1583).
957  * `ChannelDetails` now contains a copy of the current `ChannelConfig` (#1527).
958  * The `lightning-invoice` crate now optionally depends on `serde`, with
959    `Invoice` implementing `serde::{Deserialize,Serialize}` if enabled (#1548).
960  * Several fields in `UserConfig` have been renamed for clarity (#1540).
961
962 ## Bug Fixes
963  * `find_route` no longer selects routes with more than
964    `PaymentParameters::max_mpp_path_count` paths, and
965    `ChannelManager::send_payment` no longer refuses to send along routes with
966    more than ten paths (#1526).
967  * Fixed two cases where HTLCs pending at the time a counterparty broadcasts a
968    revoked commitment transaction are considered resolved prior to their actual
969    resolution on-chain, possibly passing the update to another channel (#1486).
970  * HTLCs which are relayed through LDK may now have a total expiry time two
971    weeks in the future, up from one, reducing forwarding failures (#1532).
972
973 ## Serialization Compatibility
974  * All new fields are ignored by prior versions of LDK. All new fields are not
975    present when reading objects serialized by prior versions of LDK.
976  * `ChannelConfig`'s serialization format has changed and is not compatible
977    with any previous version of LDK. Attempts to read values written by a
978    previous version of LDK will fail and attempts to read newly written objects
979    using a previous version of LDK will fail. It is not expected that users are
980    serializing `ChannelConfig` using the LDK serialization API, however, if a
981    backward compatibility wrapper is required, please open an issue.
982
983 ## Security
984 0.0.109 fixes a denial-of-service vulnerability which is reachable from
985 untrusted input in some application deployments.
986
987  * Third parties which are allowed to open channels with an LDK-based node may
988    fund a channel with a bogus and maliciously-crafted transaction which, when
989    spent, can cause a panic in the channel's corresponding `ChannelMonitor`.
990    Such a channel is never usable as it cannot be funded with a funding
991    transaction which matches the required output script, allowing the
992    `ChannelMonitor` for such channels to be safely purged as a workaround on
993    previous versions of LDK. Thanks to Eugene Siegel for reporting this issue.
994
995 In total, this release features 32 files changed, 1948 insertions, 532
996 deletions in 33 commits from 9 authors, in alphabetical order:
997  * Antoine Riard
998  * Daniel GranhÃĢo
999  * Elias Rohrer
1000  * Jeffrey Czyz
1001  * Matt Corallo
1002  * Matt Faltyn
1003  * NicolaLS
1004  * Valentine Wallace
1005  * Wilmer Paulino
1006
1007
1008 # 0.0.108 - 2022-06-10 - "You Wanted It To Build?! Why Didn't You Say So?"
1009
1010 ## Bug Fixes
1011  * Fixed `lightning-background-processor` build in release mode.
1012
1013 In total, this release features 9 files changed, 120 insertions, 74
1014 deletions in 5 commits from 4 authors, in alphabetical order:
1015  * Elias Rohrer
1016  * Matt Corallo
1017  * Max Fang
1018  * Viktor TigerstrÃķm
1019
1020 # 0.0.107 - 2022-06-08 - "BlueWallet's Wishlist"
1021
1022 ## API Updates
1023  * Channels larger than 16777215 sats (Wumbo!) are now supported and can be
1024    enabled for inbound channels using
1025    `ChannelHandshakeLimits::max_funding_satoshis` (#1425).
1026  * Support for feature `option_zeroconf`, allowing immediate forwarding of
1027    payments after channel opening. This is configured for outbound channels
1028    using `ChannelHandshakeLimits::trust_own_funding_0conf` whereas
1029    `ChannelManager::accept_inbound_channel_from_trusted_peer_0conf` has to be
1030    used for accepting inbound channels (#1401, #1505).
1031  * `ChannelManager::claim_funds` no longer returns a `bool` to indicate success.
1032    Instead, an `Event::PaymentClaimed` is generated if the claim was successful.
1033    Likewise, `ChannelManager::fail_htlc_backwards` no longer has a return value
1034    (#1434).
1035  * `lightning-rapid-gossip-sync` is a new crate for syncing gossip data from a
1036    server, primarily aimed at mobile devices (#1155).
1037  * `RapidGossipSync` can be passed to `BackgroundProcessor` in order to persist
1038    the `NetworkGraph` and handle `NetworkUpdate`s during event handling (#1433,
1039    #1517).
1040  * `NetGraphMsgHandler` has been renamed to `P2PGossipSync`, the `network_graph`
1041     module has been renamed to `gossip`, and `NetworkUpdate::ChannelClosed` has
1042    been renamed `NetworkUpdate::ChannelFailure` (#1159).
1043  * Added a `filtered_block_connected` method to `chain::Listen` and a default
1044    implementation of `block_connected` for those fetching filtered instead of
1045    full blocks (#1453).
1046  * The `lightning-block-sync` crate's `BlockSource` trait methods now take
1047    `&self` instead of `&mut self` (#1307).
1048  * `inbound_payment` module is now public to allow for creating invoices without
1049    a `ChannelManager` (#1384).
1050  * `lightning-block-sync`'s `init` and `poll` modules support `&dyn BlockSource`
1051    which can be determined at runtime (#1423).
1052  * `lightning-invoice` crate's `utils` now accept an expiration time (#1422,
1053    #1474).
1054  * `Event::PaymentForwarded` includes `prev_channel_id` and `next_channel_id`
1055    (#1419, #1475).
1056  * `chain::Watch::release_pending_monitor_events`' return type now associates
1057    `MonitorEvent`s with funding `OutPoints` (#1475).
1058  * `lightning-background-processor` crate's `Persister` trait has been moved to
1059    `lightning` crate's `util::persist` module, which now has a general
1060    `KVStorePersister` trait. Blanket implementations of `Persister` and
1061    `chainmonitor::Persist` are given for types implementing `KVStorePersister`.
1062    ` lightning-persister`'s `FilesystemPersister` implements `KVStorePersister`
1063    (#1417).
1064  * `ChannelDetails` and `ChannelCounterparty` include fields for HTLC minimum
1065    and maximum values (#1378).
1066  * Added a `max_inbound_htlc_value_in_flight_percent_of_channel` field to
1067    `ChannelHandshakeConfig`, capping the total value of outstanding inbound
1068    HTLCs for a channel (#1444).
1069  * `ProbabilisticScorer` is parameterized by a `Logger`, which it uses to log
1070    channel liquidity updates or lack thereof (#1405).
1071  * `ChannelDetails` has an `outbound_htlc_limit_msat` field, which should be
1072    used in routing instead of `outbound_capacity_msat` (#1435).
1073  * `ProbabilisticScorer`'s channel liquidities can be logged via
1074    `debug_log_liquidity_stats` (#1460).
1075  * `BackgroundProcessor` now takes an optional `WriteableScore` which it will
1076    persist using the `Persister` trait's new `persist_scorer` method (#1416).
1077  * Upgraded to `bitcoin` crate version 0.28.1 (#1389).
1078  * `ShutdownScript::new_witness_program` now takes a `WitnessVersion` instead of
1079    a `NonZeroU8` (#1389).
1080  * Channels will no longer be automatically force closed when the counterparty
1081    is disconnected due to incompatibility (#1429).
1082  * `ChannelManager` methods for funding, accepting, and closing channels now
1083    take a `counterparty_node_id` parameter, which has also been added as a field
1084    to `Event::FundingGenerationReady` (#1479, #1485).
1085  * `InvoicePayer::new` now takes a `Retry` enum (replacing the `RetryAttempts`
1086    struct), which supports both attempt- and timeout-based retrying (#1418).
1087  * `Score::channel_penalty_msat` takes a `ChannelUsage` struct, which contains
1088    the capacity as an `EffectiveCapacity` enum and any potential in-flight HTLC
1089    value, rather than a single `u64`. Used by `ProbabilisticScorer` for more
1090    accurate penalties (#1456).
1091  * `build_route_from_hops` is a new function useful for constructing a `Route`
1092    given a specific list of public keys (#1491).
1093  * `FundingLocked` message has been renamed `ChannelReady`, and related
1094    identifiers have been renamed accordingly (#1506).
1095  * `core2::io` or `std::io` (depending on feature flags `no-std` or `std`) is
1096    exported as a `lightning::io` module (#1504).
1097  * The deprecated `Scorer` has been removed in favor or `ProbabilisticScorer`
1098    (#1512).
1099
1100 ## Performance Improvements
1101  * `lightning-persister` crate's `FilesystemPersister` is faster by 15x (#1404).
1102  * Log gossip query messages at `GOSSIP` instead of `TRACE` to avoid
1103    overwhelming default logging (#1421).
1104  * `PeerManager` supports processing messages from different peers in parallel,
1105    and this is taken advantage of in gossip processing (#1023).
1106  * Greatly reduced per-channel and per-node memory usage due to upgrade of
1107    `secp256k1` crate to 0.22.1 and `bitcoin` crate to 0.28.1
1108  * Reduced per-peer memory usage in `PeerManager` (#1472).
1109
1110 ## Spec Compliance
1111  * `find_route` now assumes variable-length onions by default for nodes where
1112    support for the feature is unknown (#1414).
1113  * A `warn` message is now sent when receiving a `channel_reestablish` with an
1114    old commitment transaction number rather than immediately force-closing the
1115    channel (#1430).
1116  * When a `channel_update` message is included in an onion error's `failuremsg`,
1117    its message type is now encoded. Reading such messages is also supported
1118    (#1465).
1119
1120 ## Bug Fixes
1121  * Fixed a bug where crashing while persisting a `ChannelMonitorUpdate` for a
1122    part of a multi-path payment could cause loss of funds due to a partial
1123    payment claim on restart (#1434).
1124  * `BackgroundProcessor` has been fixed to improve serialization reliability on
1125    slow systems which can avoid force-closes (#1436).
1126  * `gossip_timestamp_filter` filters are now honored when sending gossip to
1127    peers (#1452).
1128  * During a reorg, only force-close a channel if its funding transaction is
1129    unconfirmed rather than as it loses confirmations (#1461).
1130  * Fixed a rare panic in `lightning-net-tokio` when fetching a peer's socket
1131    address after the connection has been closed caused by a race condition
1132    (#1449).
1133  * `find_route` will no longer return routes that would cause onion construction
1134    to fail in some cases (#1476).
1135  * `ProbabilisticScorer` uses more precision when approximating `log10` (#1406).
1136
1137 ## Serialization Compatibility
1138  * All above new events/fields are ignored by prior clients. All above new
1139    events/fields are not present when reading objects serialized by prior
1140    versions of the library.
1141  * `ChannelManager` serialization is no longer compatible with versions prior to
1142    0.0.99 (#1401).
1143  * Channels with `option_zeroconf` feature enabled (not required for 0-conf
1144    channel use) will be unreadable by versions prior to 0.0.107 (#1401, #1505).
1145
1146 In total, this release features 96 files changed, 9304 insertions, 4503
1147 deletions in 153 commits from 18 authors, in alphabetical order:
1148  * Arik Sosman
1149  * Devrandom
1150  * Duncan Dean
1151  * Elias Rohrer
1152  * Jeffrey Czyz
1153  * John Cantrell
1154  * John Corser
1155  * Jurvis Tan
1156  * Justin Moon
1157  * KaFai Choi
1158  * Matt Faltyn
1159  * Matt Corallo
1160  * Valentine Wallace
1161  * Viktor TigerstrÃķm
1162  * Vincenzo Palazzo
1163  * atalw
1164  * dependabot[bot]
1165  * shamardy
1166
1167
1168 # 0.0.106 - 2022-04-03
1169
1170 ## API Updates
1171  * Minimum supported rust version (MSRV) is now 1.41.1 (#1310).
1172  * Lightning feature `option_scid_alias` is now supported and may be negotiated
1173    when opening a channel with a peer. It can be configured via
1174    `ChannelHandshakeConfig::negotiate_scid_privacy` and is off by default but
1175    will be on by default in the future (#1351).
1176  * `OpenChannelRequest` now has a `channel_type` field indicating the features
1177    the channel will operate with and should be used to filter channels with
1178    undesirable features (#1351). See the Serialization Compatibility section.
1179  * `ChannelManager` supports sending and receiving short channel id aliases in
1180    the `funding_locked` message. These are used when forwarding payments and
1181    constructing invoice route hints for improved privacy. `ChannelDetails` has a
1182    `inbound_scid_alias` field and a `get_inbound_payment_scid` method to support
1183    the latter (#1311).
1184  * `DefaultRouter` and `find_route` take an additional random seed to improve
1185    privacy by adding a random CLTV expiry offset to each path's final hop. This
1186    helps obscure the intended recipient from adversarial intermediate hops
1187    (#1286). The seed is  also used to randomize candidate paths during route
1188    selection (#1359).
1189  * The `lightning-block-sync` crate's `init::synchronize_listeners` method
1190    interface has been relaxed to support multithreaded environments (#1349).
1191  * `ChannelManager::create_inbound_payment_for_hash`'s documentation has been
1192    corrected to remove the one-year restriction on `invoice_expiry_delta_secs`,
1193    which is only applicable to the deprecated `create_inbound_payment_legacy`
1194    and `create_inbound_payment_for_hash_legacy` methods (#1341).
1195  * `Features` mutator methods now take `self` by reference instead of by value
1196    (#1331).
1197  * The CLTV of the last hop in a path is now included when comparing against
1198    `RouteParameters::max_total_cltv_expiry_delta` (#1358).
1199  * Invoice creation functions in `lightning-invoice` crate's `utils` module
1200    include versions that accept a description hash instead of only a description
1201    (#1361).
1202  * `RoutingMessageHandler::sync_routing_table` has been renamed `peer_connected`
1203    (#1368).
1204  * `MessageSendEvent::SendGossipTimestampFilter` has been added to indicate that
1205    a `gossip_timestamp_filter` should be sent (#1368).
1206  * `PeerManager` takes an optional `NetAddress` in `new_outbound_connection` and
1207    `new_inbound_connection`, which is used to report back the remote address to
1208    the connecting peer in the `init` message (#1326).
1209  * `ChannelManager::accept_inbound_channel` now takes a `user_channel_id`, which
1210    is used in a similar manner as in outbound channels. (#1381).
1211  * `BackgroundProcessor` now persists `NetworkGraph` on a timer and upon
1212    shutdown as part of a new `Persister` trait, which also includes
1213    `ChannelManager` persistence (#1376).
1214  * `ProbabilisticScoringParameters` now has a `base_penalty_msat` option, which
1215    default to 500 msats. It is applied at each hop to help avoid longer paths
1216    (#1375).
1217  * `ProbabilisticScoringParameters::liquidity_penalty_multiplier_msat`'s default
1218    value is now 40,000 msats instead of 10,000 msats (#1375).
1219  * The `lightning` crate has a `grind_signatures` feature used to produce
1220    signatures with low r-values for more predictable transaction weight. This
1221    feature is on by default (#1388).
1222  * `ProbabilisticScoringParameters` now has a `amount_penalty_multiplier_msat`
1223    option, which is used to further penalize large amounts (#1399).
1224  * `PhantomRouteHints`, `FixedPenaltyScorer`, and `ScoringParameters` now
1225    implement `Clone` (#1346).
1226
1227 ## Bug Fixes
1228  * Fixed a compilation error in `ProbabilisticScorer` under `--feature=no-std`
1229    (#1347).
1230  * Invoice creation functions in `lightning-invoice` crate's `utils` module
1231    filter invoice hints in order to limit the invoice size (#1325).
1232  * Fixed a bug where a `funding_locked` message was delayed by a block if the
1233    funding transaction was confirmed while offline, depending on the ordering
1234    of `Confirm::transactions_confirmed` calls when brought back online (#1363).
1235  * Fixed a bug in `NetGraphMsgHandler` where it didn't continue to receive
1236    gossip messages from peers after initial connection (#1368, #1382).
1237  * `ChannelManager::timer_tick_occurred` will now timeout a received multi-path
1238    payment (MPP) after three ticks if not received in full instead of waiting
1239    until near the HTLC timeout block(#1353).
1240  * Fixed an issue with `find_route` causing it to be overly aggressive in using
1241    MPP over channels to the same first hop (#1370).
1242  * Reduced time spent processing `channel_update` messages by checking
1243    signatures after checking if no newer messages have already been processed
1244    (#1380).
1245  * Fixed a few issues in `find_route` which caused preferring paths with a
1246    higher cost (#1398).
1247  * Fixed an issue in `ProbabilisticScorer` where a channel with not enough
1248    liquidity could still be used when retrying a failed payment if it was on a
1249    path with an overall lower cost (#1399).
1250
1251 ## Serialization Compatibility
1252  * Channels open with `option_scid_alias` negotiated will be incompatible with
1253    prior releases (#1351). This may occur in the following cases:
1254    * Outbound channels when `ChannelHandshakeConfig::negotiate_scid_privacy` is
1255      enabled.
1256    * Inbound channels when automatically accepted from an `OpenChannel` message
1257      with a `channel_type` that has `ChannelTypeFeatures::supports_scid_privacy`
1258      return true. See `UserConfig::accept_inbound_channels`.
1259    * Inbound channels when manually accepted from an `OpenChannelRequest` with a
1260      `channel_type` that has `ChannelTypeFeatures::supports_scid_privacy` return
1261      true. See `UserConfig::manually_accept_inbound_channels`.
1262
1263 In total, this release features 43 files changed, 4052 insertions, 1274
1264 deletions in 75 commits from 11 authors, in alphabetical order:
1265  * Devrandom
1266  * Duncan Dean
1267  * Elias Rohrer
1268  * Jeffrey Czyz
1269  * Jurvis Tan
1270  * Luiz Parreira
1271  * Matt Corallo
1272  * Omar Shamardy
1273  * Viktor TigerstrÃķm
1274  * dependabot[bot]
1275  * psycho-pirate
1276
1277
1278 # 0.0.105 - 2022-02-28
1279
1280 ## API Updates
1281  * `Phantom node` payments are now supported, allowing receipt of a payment on
1282    any one of multiple nodes without any coordination across the nodes being
1283    required. See the new `PhantomKeysManager`'s docs for more, as well as
1284    requirements on `KeysInterface::get_inbound_payment_key_material` and
1285    `lightning_invoice::utils::create_phantom_invoice` (#1199).
1286  * In order to support phantom node payments, several `KeysInterface` methods
1287    now accept a `Recipient` parameter to select between the local `node_id` and
1288    a phantom-specific one.
1289  * `ProbabilisticScorer`, a `Score` based on learning the current balances of
1290    channels in the network, was added. It attempts to better capture payment
1291    success probability than the existing `Scorer`, though may underperform on
1292    nodes with low payment volume. We welcome feedback on performance (#1227).
1293  * `Score::channel_penalty_msat` now always takes the channel value, instead of
1294    an `Option` (#1227).
1295  * `UserConfig::manually_accept_inbound_channels` was added which, when set,
1296    generates a new `Event::OpenChannelRequest`, which allows manual acceptance
1297    or rejection of incoming channels on a per-channel basis (#1281).
1298  * `Payee` has been renamed to `PaymentParameters` (#1271).
1299  * `PaymentParameters` now has a `max_total_cltv_expiry_delta` field. This
1300    defaults to 1008 and limits the maximum amount of time an HTLC can be pending
1301    before it will either fail or be claimed (#1234).
1302  * The `lightning-invoice` crate now supports no-std environments. This required
1303    numerous API changes around timestamp handling and std+no-std versions of
1304    several methods that previously assumed knowledge of the time (#1223, #1230).
1305  * `lightning-invoice` now supports parsing invoices with expiry times of more
1306    than one year. This required changing the semantics of `ExpiryTime` (#1273).
1307  * The `CounterpartyCommitmentSecrets` is now public, allowing external uses of
1308    the `BOLT 3` secret storage scheme (#1299).
1309  * Several `Sign` methods now receive HTLC preimages as proof of state
1310    transition, see new documentation for more (#1251).
1311  * `KeysInterface::sign_invoice` now provides the HRP and other invoice data
1312    separately to make it simpler for external signers to parse (#1272).
1313  * `Sign::sign_channel_announcement` now returns both the node's signature and
1314    the per-channel signature. `InMemorySigner` now requires the node's secret
1315    key in order to implement this (#1179).
1316  * `ChannelManager` deserialization will now fail if the `KeysInterface` used
1317    has a different `node_id` than the `ChannelManager` expects (#1250).
1318  * A new `ErrorAction` variant was added to send `warning` messages (#1013).
1319  * Several references to `chain::Listen` objects in `lightning-block-sync` no
1320    longer require a mutable reference (#1304).
1321
1322 ## Bug Fixes
1323  * Fixed a regression introduced in 0.0.104 where `ChannelManager`'s internal
1324    locks could have an order violation leading to a deadlock (#1238).
1325  * Fixed cases where slow code (including user I/O) could cause us to
1326    disconnect peers with ping timeouts in `BackgroundProcessor` (#1269).
1327  * Now persist the `ChannelManager` prior to `BackgroundProcessor` stopping,
1328    preventing race conditions where channels are closed on startup even with a
1329    clean shutdown. This requires that users stop network processing and
1330    disconnect peers prior to `BackgroundProcessor` shutdown (#1253).
1331  * Fields in `ChannelHandshakeLimits` provided via the `override_config` to
1332    `create_channel` are now applied instead of the default config (#1292).
1333  * Fixed the generation of documentation on docs.rs to include API surfaces
1334    which are hidden behind feature flags (#1303).
1335  * Added the `channel_type` field to `accept_channel` messages we send, which
1336    may avoid some future compatibility issues with other nodes (#1314).
1337  * Fixed a bug where, if a previous LDK run using `lightning-persister` crashed
1338    while persisting updated data, we may have failed to initialize (#1332).
1339  * Fixed a rare bug where having both pending inbound and outbound HTLCs on a
1340    just-opened inbound channel could cause `ChannelDetails::balance_msat` to
1341    underflow and be reported as large, or cause panics in debug mode (#1268).
1342  * Moved more instances of verbose gossip logging from the `Trace` level to the
1343    `Gossip` level (#1220).
1344  * Delayed `announcement_signatures` until the channel has six confirmations,
1345    slightly improving propagation of channel announcements (#1179).
1346  * Several fixes in script and transaction weight calculations when anchor
1347    outputs are enabled (#1229).
1348
1349 ## Serialization Compatibility
1350  * Using `ChannelManager` data written by versions prior to 0.0.105 will result
1351    in preimages for HTLCs that were pending at startup to be missing in calls
1352    to `KeysInterface` methods (#1251).
1353  * Any phantom invoice payments received on a node that is not upgraded to
1354    0.0.105 will fail with an "unknown channel" error. Further, downgrading to
1355    0.0.104 or before and then upgrading again will invalidate existing phantom
1356    SCIDs which may be included in invoices (#1199).
1357
1358 ## Security
1359 0.0.105 fixes two denial-of-service vulnerabilities which may be reachable from
1360 untrusted input in certain application designs.
1361
1362  * Route calculation spuriously panics when a routing decision is made for a
1363    path where the second-to-last hop is a private channel, included due to a
1364    multi-hop route hint in an invoice.
1365  * `ChannelMonitor::get_claimable_balances` spuriously panics in some scenarios
1366    when the LDK application's local commitment transaction is confirmed while
1367    HTLCs are still pending resolution.
1368
1369 In total, this release features 109 files changed, 7270 insertions, 2131
1370 deletions in 108 commits from 15 authors, in alphabetical order:
1371  * Conor Okus
1372  * Devrandom
1373  * Elias Rohrer
1374  * Jeffrey Czyz
1375  * Jurvis Tan
1376  * Ken Sedgwick
1377  * Matt Corallo
1378  * Naveen
1379  * Tibo-lg
1380  * Valentine Wallace
1381  * Viktor TigerstrÃķm
1382  * dependabot[bot]
1383  * hackerrdave
1384  * naveen
1385  * vss96
1386
1387
1388 # 0.0.104 - 2021-12-17
1389
1390 ## API Updates
1391  * A `PaymentFailed` event is now provided to indicate a payment has failed
1392    fully. This event is generated either after
1393    `ChannelManager::abandon_payment` is called for a given payment, or the
1394    payment times out, and there are no further pending HTLCs for the payment.
1395    This event should be used to detect payment failure instead of
1396    `PaymentPathFailed::all_paths_failed`, unless no payment retries occur via
1397    `ChannelManager::retry_payment` (#1202).
1398  * Payment secrets are now generated deterministically using material from
1399    the new `KeysInterface::get_inbound_payment_key_material` (#1177).
1400  * A `PaymentPathSuccessful` event has been added to ease passing success info
1401    to a scorer, along with a `Score::payment_path_successful` method to accept
1402    such info (#1178, #1197).
1403  * `Score::channel_penalty_msat` has additional arguments describing the
1404    channel's capacity and the HTLC amount being sent over the channel (#1166).
1405  * A new log level `Gossip` has been added, which is used for verbose
1406    information generated during network graph sync. Enabling the
1407    `max_level_trace` feature or ignoring `Gossip` log entries reduces log
1408    growth during initial start up from many GiB to several MiB (#1145).
1409  * The `allow_wallclock_use` feature has been removed in favor of only using
1410    the `std` and `no-std` features (#1212).
1411  * `NetworkGraph` can now remove channels that we haven't heard updates for in
1412    two weeks with `NetworkGraph::remove_stale_channels{,with_time}`. The first
1413    is called automatically if a `NetGraphMsgHandler` is passed to
1414    `BackgroundProcessor::start` (#1212).
1415  * `InvoicePayer::pay_pubkey` was added to enable sending "keysend" payments to
1416    supported recipients, using the `InvoicePayer` to handle retires (#1160).
1417  * `user_payment_id` has been removed from `PaymentPurpose`, and
1418    `ChannelManager::create_inbound_payment{,_for_hash}` (#1180).
1419  * Updated documentation for several `ChannelManager` functions to remove stale
1420    references to panics which no longer occur (#1201).
1421  * The `Score` and `LockableScore` objects have moved into the
1422    `routing::scoring` module instead of being in the `routing` module (#1166).
1423  * The `Time` parameter to `ScorerWithTime` is no longer longer exposed,
1424    instead being fixed based on the `std`/`no-std` feature (#1184).
1425  * `ChannelDetails::balance_msat` was added to fetch a channel's balance
1426    without subtracting the reserve values, lining up with on-chain claim amounts
1427    less on-chain fees (#1203).
1428  * An explicit `UserConfig::accept_inbound_channels` flag is now provided,
1429    removing the need to set `min_funding_satoshis` to > 21 million BTC (#1173).
1430  * Inbound channels that fail to see the funding transaction confirm within
1431    2016 blocks are automatically force-closed with
1432    `ClosureReason::FundingTimedOut` (#1083).
1433  * We now accept a channel_reserve value of 0 from counterparties, as it is
1434    insecure for our counterparty but not us (#1163).
1435  * `NetAddress::OnionV2` parsing was removed as version 2 onion services are no
1436    longer supported in modern Tor (#1204).
1437  * Generation and signing of anchor outputs is now supported in the
1438    `KeysInterface`, though no support for them exists in the channel itself (#1176)
1439
1440 ## Bug Fixes
1441  * Fixed a race condition in `InvoicePayer` where paths may be retried after
1442    the retry count has been exceeded. In this case the
1443    `Event::PaymentPathFailed::all_paths_failed` field is not a reliable payment
1444    failure indicator. There was no acceptable alternative indicator,
1445    `Event::PaymentFailed` as been added to provide one (#1202).
1446  * Reduced the blocks-before-timeout we expect of outgoing HTLCs before
1447    refusing to forward. This check was overly strict and resulted in refusing
1448    to forward som HTLCs to a next hop that had a lower security threshold than
1449    us (#1119).
1450  * LDK no longer attempt to update the channel fee for outbound channels when
1451    we cannot afford the new fee. This could have caused force-closure by our
1452    channel counterparty (#1054).
1453  * Fixed several bugs which may have prevented the reliable broadcast of our
1454    own channel announcements and updates (#1169).
1455  * Fixed a rare bug which may have resulted in spurious route finding failures
1456    when using last-hop hints and MPP with large value payments (#1168).
1457  * `KeysManager::spend_spendable_outputs` no longer adds a change output that
1458    is below the dust threshold for non-standard change scripts (#1131).
1459  * Fixed a minor memory leak when attempting to send a payment that fails due
1460    to an error when updating the `ChannelMonitor` (#1143).
1461  * Fixed a bug where a `FeeEstimator` that returns values rounded to the next
1462    sat/vbyte may result in force-closures (#1208).
1463  * Handle MPP timeout HTLC error codes, instead of considering the recipient to
1464    have sent an invalid error, removing them from the network graph (#1148)
1465
1466 ## Serialization Compatibility
1467  * All above new events/fields are ignored by prior clients. All above new
1468    events/fields are not present when reading objects serialized by prior
1469    versions of the library.
1470  * Payment secrets are now generated deterministically. This reduces the memory
1471    footprint for inbound payments, however, newly-generated inbound payments
1472    using `ChannelManager::create_inbound_payment{,_for_hash}` will not be
1473    receivable using versions prior to 0.0.104.
1474    `ChannelManager::create_inbound_payment{,_for_hash}_legacy` are provided for
1475    backwards compatibility (#1177).
1476  * `PaymentPurpose::InvoicePayment::user_payment_id` will be 0 when reading
1477    objects written with 0.0.104 when read by 0.0.103 and previous (#1180).
1478
1479 In total, this release features 51 files changed, 5356 insertions, 2238
1480 deletions in 107 commits from 9 authors, in alphabetical order:
1481  * Antoine Riard
1482  * Conor Okus
1483  * Devrandom
1484  * Duncan Dean
1485  * Elias Rohrer
1486  * Jeffrey Czyz
1487  * Ken Sedgwick
1488  * Matt Corallo
1489  * Valentine Wallace
1490
1491
1492 # 0.0.103 - 2021-11-02
1493
1494 ## API Updates
1495  * This release is almost entirely focused on a new API in the
1496    `lightning-invoice` crate - the `InvoicePayer`. `InvoicePayer` is a
1497    struct which takes a reference to a `ChannelManager` and a `Router`
1498    and retries payments as paths fail. It limits retries to a configurable
1499    number, but is not serialized to disk and may retry additional times across
1500    a serialization/load. In order to learn about failed payments, it must
1501    receive `Event`s directly from the `ChannelManager`, wrapping a
1502    user-provided `EventHandler` which it provides all unhandled events to
1503    (#1059).
1504  * `get_route` has been renamed `find_route` (#1059) and now takes a
1505    `RouteParameters` struct in replacement of a number of its long list of
1506    arguments (#1134). The `Payee` in the `RouteParameters` is stored in the
1507    `Route` object returned and provided in the `RouteParameters` contained in
1508    `Event::PaymentPathFailed` (#1059).
1509  * `ChannelMonitor`s must now be persisted after calls that provide new block
1510    data, prior to `MonitorEvent`s being passed back to `ChannelManager` for
1511    processing. If you are using a `ChainMonitor` this is handled for you.
1512    The `Persist` API has been updated to `Option`ally take the
1513    `ChannelMonitorUpdate` as persistence events that result from chain data no
1514    longer have a corresponding update (#1108).
1515  * `routing::Score` now has a `payment_path_failed` method which it can use to
1516    learn which channels often fail payments. It is automatically called by
1517    `InvoicePayer` for failed payment paths (#1144).
1518  * The default `Scorer` implementation is now a type alias to a type generic
1519    across different clocks and supports serialization to persist scoring data
1520    across restarts (#1146).
1521  * `Event::PaymentSent` now includes the full fee which was spent across all
1522    payment paths which were fulfilled or pending when the payment was fulfilled
1523    (#1142).
1524  * `Event::PaymentSent` and `Event::PaymentPathFailed` now include the
1525    `PaymentId` which matches the `PaymentId` returned from
1526    `ChannelManager::send_payment` or `InvoicePayer::pay_invoice` (#1059).
1527  * `NetGraphMsgHandler` now takes a `Deref` to the `NetworkGraph`, allowing for
1528    shared references to the graph data to make serialization and references to
1529    the graph data in the `InvoicePayer`'s `Router` simpler (#1149).
1530  * `routing::Score::channel_penalty_msat` has been updated to provide the
1531    `NodeId` of both the source and destination nodes of a channel (#1133).
1532
1533 ## Bug Fixes
1534  * Previous versions would often disconnect peers during initial graph sync due
1535    to ping timeouts while processing large numbers of gossip messages. We now
1536    delay disconnecting peers if we receive messages from them even if it takes
1537    a while to receive a pong from them. Further, we avoid sending too many
1538    gossip messages between pings to ensure we should always receive pongs in a
1539    timely manner (#1137).
1540  * If a payment was sent, creating an outbound HTLC and sending it to our
1541    counterparty (implying the `ChannelMonitor` was persisted on disk), but the
1542    `ChannelManager` was not persisted prior to shutdown/crash, no
1543    `Event::PaymentPathFailed` event was generated if the HTLC was eventually
1544    failed on chain. Events are now consistent irrespective of `ChannelManager`
1545    persistence or non-persistence (#1104).
1546
1547 ## Serialization Compatibility
1548  * All above new Events/fields are ignored by prior clients. All above new
1549    Events/fields are not present when reading objects serialized by prior
1550    versions of the library.
1551  * Payments for which a `Route` was generated using a previous version or for
1552    which the payment was originally sent by a previous version of the library
1553    will not be retried by an `InvoicePayer`.
1554
1555 This release was singularly focused and some contributions by third parties
1556 were delayed.
1557 In total, this release features 38 files changed, 4414 insertions, and 969
1558 deletions in 71 commits from 2 authors, in alphabetical order:
1559
1560  * Jeffrey Czyz
1561  * Matt Corallo
1562
1563
1564 # 0.0.102 - 2021-10-18
1565
1566 ## API Updates
1567  * `get_route` now takes a `Score` as an argument. `Score` is queried during
1568    the route-finding process, returning the absolute amounts which you are
1569    willing to pay to avoid routing over a given channel. As a default, a
1570    `Scorer` is provided which returns a constant amount, with a suggested
1571    default of 500 msat. This translates to a willingness to pay up to 500 msat
1572    in additional fees per hop in order to avoid additional hops (#1124).
1573  * `Event::PaymentPathFailed` now contains a `short_channel_id` field which may
1574    be filled in with a channel that can be "blamed" for the payment failure.
1575    Payment retries should likely avoid the given channel for some time (#1077).
1576  * `PublicKey`s in `NetworkGraph` have been replaced with a `NodeId` struct
1577    which contains only a simple `[u8; 33]`, substantially improving
1578    `NetworkGraph` deserialization performance (#1107).
1579  * `ChainMonitor`'s `HashMap` of `ChannelMonitor`s is now private, exposed via
1580    `Chainmonitor::get_monitor` and `ChainMonitor::list_monitors` instead
1581    (#1112).
1582  * When an outbound channel is closed prior to the broadcasting of its funding
1583    transaction, but after you call
1584    `ChannelManager::funding_transaction_generated`, a new event type,
1585    `Event::DiscardFunding`, is generated, informing you the transaction was not
1586    broadcasted and that you can spend the same inputs again elsewhere (#1098).
1587  * `ChannelManager::create_channel` now returns the temporary channel ID which
1588    may later appear in `Event::ChannelClosed` or `ChannelDetails` prior to the
1589    channel being funded (#1121).
1590  * `Event::PaymentSent` now contains the payment hash as well as the payment
1591    preimage (#1062).
1592  * `ReadOnlyNetworkGraph::get_addresses` now returns owned `NetAddress` rather
1593    than references. As a side-effect this method is now exposed in foreign
1594    language bindings (#1115).
1595  * The `Persist` and `ChannelMonitorUpdateErr` types have moved to the
1596    `lightning::chain::chainmonitor` and `lightning::chain` modules,
1597    respectively (#1112).
1598  * `ChannelManager::send_payment` now returns a `PaymentId` which identifies a
1599    payment (whether MPP or not) and can be used to retry the full payment or
1600    MPP parts through `retry_payment` (#1096). Note that doing so is currently
1601    *not* crash safe, and you may find yourself sending twice. It is recommended
1602    that you *not* use the `retry_payment` API until the next release.
1603
1604 ## Bug Fixes
1605  * Due to an earlier fix for the Lightning dust inflation vulnerability tracked
1606    in CVE-2021-41591/CVE-2021-41592/CVE-2021-41593 in 0.0.100, we required
1607    counterparties to accept a dust limit slightly lower than the dust limit now
1608    required by other implementations. This appeared as, at least, latest lnd
1609    always refusing to accept channels opened by LDK clients (#1065).
1610  * If there are multiple channels available to the same counterparty,
1611    `get_route` would only consider the channel listed last as available for
1612    sending (#1100).
1613  * `Persist` implementations returning
1614    `ChannelMonitorUpdateErr::TemporaryFailure` from `watch_channel` previously
1615    resulted in the `ChannelMonitor` not being stored at all, resulting in a
1616    panic after monitor updating is complete (#1112).
1617  * If payments are pending awaiting forwarding at startup, an
1618    `Event::PendingHTLCsForwardable` event will always be provided. This ensures
1619    user code calls `ChannelManager::process_pending_htlc_fowards` even if it
1620    shut down while awaiting the batching timer during the previous run (#1076).
1621  * If a call to `ChannelManager::send_payment` failed due to lack of
1622    availability of funds locally, LDK would store the payment as pending
1623    forever, with no ability to retry or fail it, leaking memory (#1109).
1624
1625 ## Serialization Compatibility
1626  * All above new Events/fields are ignored by prior clients. All above new
1627    Events/fields, except for `Event::PaymentSent::payment_hash` are not present
1628    when reading objects serialized by prior versions of the library.
1629
1630 In total, this release features 32 files changed, 2248 insertions, and 1483
1631 deletions in 51 commits from 7 authors, in alphabetical order:
1632
1633  * 1nF0rmed
1634  * Duncan Dean
1635  * Elias Rohrer
1636  * Galder ZamarrenĖƒo
1637  * Jeffrey Czyz
1638  * Matt Corallo
1639  * Valentine Wallace
1640
1641
1642 # 0.0.101 - 2021-09-23
1643
1644 ## API Updates
1645  * Custom message types are now supported directly in the `PeerManager`,
1646    allowing you to send and receive messages of any type that is not natively
1647    understood by LDK. This requires a new type bound on `PeerManager`, a
1648    `CustomMessageHandler`. `IgnoringMessageHandler` provides a simple default
1649    for this new bound for ignoring unknown messages (#1031, #1074).
1650  * Route graph updates as a result of failed payments are no longer provided as
1651    `MessageSendEvent::PaymentFailureNetworkUpdate` but instead included in a
1652    new field in the `Event::PaymentFailed` events. Generally, this means route
1653    graph updates are no longer handled as a part of the `PeerManager` but
1654    instead through the new `EventHandler` implementation for
1655    `NetGraphMsgHandler`. To make this easy, a new parameter to
1656    `lightning-background-processor::BackgroundProcessor::start` is added, which
1657    contains an `Option`al `NetGraphmsgHandler`. If provided as `Some`, relevant
1658    events will be processed by the `NetGraphMsgHandler` prior to normal event
1659    handling (#1043).
1660  * `NetworkGraph` is now, itself, thread-safe. Accordingly, most functions now
1661    take `&self` instead of `&mut self` and the graph data can be accessed
1662    through `NetworkGraph.read_only` (#1043).
1663  * The balances available on-chain to claim after a channel has been closed are
1664    now exposed via `ChannelMonitor::get_claimable_balances` and
1665    `ChainMonitor::get_claimable_balances`. The second can be used to get
1666    information about all closed channels which still have on-chain balances
1667    associated with them. See enum variants of `ln::channelmonitor::Balance` and
1668    method documentation for the above methods for more information on the types
1669    of balances exposed (#1034).
1670  * When one HTLC of a multi-path payment fails, the new field `all_paths_failed`
1671    in `Event::PaymentFailed` is set to `false`. This implies that the payment
1672    has not failed, but only one part. Payment resolution is only indicated by an
1673    `Event::PaymentSent` event or an `Event::PaymentFailed` with
1674    `all_paths_failed` set to `true`, which is also set for the last remaining
1675    part of a multi-path payment (#1053).
1676  * To better capture the context described above, `Event::PaymentFailed` has
1677    been renamed to `Event::PaymentPathFailed` (#1084).
1678  * A new event, `ChannelClosed`, is provided by `ChannelManager` when a channel
1679    is closed, including a reason and error message (if relevant, #997).
1680  * `lightning-invoice` now considers invoices with sub-millisatoshi precision
1681    to be invalid, and requires millisatoshi values during construction (thus
1682    you must call `amount_milli_satoshis` instead of `amount_pico_btc`, #1057).
1683  * The `BaseSign` interface now includes two new hooks which provide additional
1684    information about commitment transaction signatures and revocation secrets
1685    provided by our counterparty, allowing additional verification (#1039).
1686  * The `BaseSign` interface now includes additional information for cooperative
1687    close transactions, making it easier for a signer to verify requests (#1064).
1688  * `Route` has two additional helper methods to get fees and amounts (#1063).
1689  * `Txid` and `Transaction` objects can now be deserialized from responses when
1690    using the HTTP client in the `lightning-block-sync` crate (#1037, #1061).
1691
1692 ## Bug Fixes
1693  * Fix a panic when reading a lightning invoice with a non-recoverable
1694    signature. Further, restrict lightning invoice parsing to require payment
1695    secrets and better handle a few edge cases as required by BOLT 11 (#1057).
1696  * Fix a panic when receiving multiple messages (such as HTLC fulfill messages)
1697    after a call to `chain::Watch::update_channel` returned
1698    `Err(ChannelMonitorUpdateErr::TemporaryFailure)` with no
1699    `ChannelManager::channel_monitor_updated` call in between (#1066).
1700  * For multi-path payments, `Event::PaymentSent` is no longer generated
1701    multiple times, once for each independent part (#1053).
1702  * Multi-hop route hints in invoices are now considered in the default router
1703    provided via `get_route` (#1040).
1704  * The time peers have to respond to pings has been increased when building
1705    with debug assertions enabled. This avoids peer disconnections on slow hosts
1706    when running in debug mode (#1051).
1707  * The timeout for the first byte of a response for requests from the
1708    `lightning-block-sync` crate has been increased to 300 seconds to better
1709    handle the long hangs in Bitcoin Core when it syncs to disk (#1090).
1710
1711 ## Serialization Compatibility
1712  * Due to a bug in 0.0.100, `Event`s written by 0.0.101 which are of a type not
1713    understood by 0.0.100 may lead to `Err(DecodeError::InvalidValue)` or corrupt
1714    deserialized objects in 0.100. Such `Event`s will lead to an
1715    `Err(DecodeError::InvalidValue)` in versions prior to 0.0.100. The only such
1716    new event written by 0.0.101 is `Event::ChannelClosed` (#1087).
1717  * Payments that were initiated in versions prior to 0.0.101 may still
1718    generate duplicate `PaymentSent` `Event`s or may have spurious values for
1719    `Event::PaymentPathFailed::all_paths_failed` (#1053).
1720  * The return values of `ChannelMonitor::get_claimable_balances` (and, thus,
1721    `ChainMonitor::get_claimable_balances`) may be spurious for channels where
1722    the spend of the funding transaction appeared on chain while running a
1723    version prior to 0.0.101. `Balance` information should only be relied upon
1724    for channels that were closed while running 0.0.101+ (#1034).
1725  * Payments failed while running versions prior to 0.0.101 will never have a
1726    `Some` for the `network_update` field (#1043).
1727
1728 In total, this release features 67 files changed, 4980 insertions, 1888
1729 deletions in 89 commits from 12 authors, in alphabetical order:
1730  * Antoine Riard
1731  * Devrandom
1732  * Galder ZamarrenĖƒo
1733  * Giles Cope
1734  * Jeffrey Czyz
1735  * Joseph Goulden
1736  * Matt Corallo
1737  * Sergi Delgado Segura
1738  * Tibo-lg
1739  * Valentine Wallace
1740  * abhik-99
1741  * vss96
1742
1743
1744 # 0.0.100 - 2021-08-17 - "Oh, so *that's* what's going on inside the box"
1745
1746 ## API Updates
1747  * The `lightning` crate can now be built in no_std mode, making it easy to
1748    target embedded hardware for rust users. Note that mutexes are replaced with
1749    no-ops for such builds (#1008, #1028).
1750  * LDK now supports sending and receiving "keysend" payments. This includes
1751    modifications to `lightning::util::events::Event::PaymentReceived` to
1752    indicate the type of payment (#967).
1753  * A new variant, `lightning::util::events::Event::PaymentForwarded` has been
1754    added which indicates a forwarded payment has been successfully claimed and
1755    we've received a forwarding fee (#1004).
1756  * `lightning::chain::keysinterface::KeysInterface::get_shutdown_pubkey` has
1757    been renamed to `get_shutdown_scriptpubkey`, returns a script, and is now
1758    called on channel open only if
1759    `lightning::util::config::ChannelConfig::commit_upfront_shutdown_pubkey` is
1760    set (#1019).
1761  * Closing-signed negotiation is now more configurable, with an explicit
1762    `lightning::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis`
1763    field allowing you to select the maximum amount you are willing to pay to
1764    avoid a force-closure. Further, we are now less restrictive on the fee
1765    placed on the closing transaction when we are not the party paying it. To
1766    control the feerate paid on a channel at close-time, use
1767    `ChannelManager::close_channel_with_target_feerate` instead of
1768    `close_channel` (#1011).
1769  * `lightning_background_processor::BackgroundProcessor` now stops the
1770    background thread when dropped (#1007). It is marked `#[must_use]` so that
1771    Rust users will receive a compile-time warning when it is immediately
1772    dropped after construction (#1029).
1773  * Total potential funds burn on force-close due to dust outputs is now limited
1774    to `lightning::util::config::ChannelConfig::max_dust_htlc_exposure_msat` per
1775    channel (#1009).
1776  * The interval on which
1777    `lightning::ln::peer_handler::PeerManager::timer_tick_occurred` should be
1778    called has been reduced to once every five seconds (#1035) and
1779    `lightning::ln::channelmanager::ChannelManager::timer_tick_occurred` should
1780    now be called on startup in addition to once per minute (#985).
1781  * The rust-bitcoin and bech32 dependencies have been updated to their
1782    respective latest versions (0.27 and 0.8, #1012).
1783
1784 ## Bug Fixes
1785  * Fix panic when reading invoices generated by some versions of c-lightning
1786    (#1002 and #1003).
1787  * Fix panic when attempting to validate a signed message of incorrect length
1788    (#1010).
1789  * Do not ignore the route hints in invoices when the invoice is over 250k
1790    sats (#986).
1791  * Fees are automatically updated on outbound channels to ensure commitment
1792    transactions are always broadcastable (#985).
1793  * Fixes a rare case where a `lightning::util::events::Event::SpendableOutputs`
1794    event is not generated after a counterparty commitment transaction is
1795    confirmed in a reorg when a conflicting local commitment transaction is
1796    removed in the same reorg (#1022).
1797  * Fixes a remotely-triggerable force-closure of an origin channel after an
1798    HTLC was forwarded over a next-hop channel and the next-hop channel was
1799    force-closed by our counterparty (#1025).
1800  * Fixes a rare force-closure case when sending a payment as a channel fundee
1801    when overdrawing our remaining balance. Instead the send will fail (#998).
1802  * Fixes a rare force-closure case when a payment was claimed prior to a
1803    peer disconnection or restart, and later failed (#977).
1804
1805 ## Serialization Compatibility
1806  * Pending inbound keysend payments which have neither been failed nor claimed
1807    when serialized will result in a `ChannelManager` which is not readable on
1808    pre-0.0.100 clients (#967).
1809  * Because
1810    `lightning::chain::keysinterface::KeysInterface::get_shutdown_scriptpubkey`
1811    has been updated to return a script instead of only a `PublicKey`,
1812    `ChannelManager`s constructed with custom `KeysInterface` implementations on
1813    0.0.100 and later versions will not be readable on previous versions.
1814    `ChannelManager`s created with 0.0.99 and prior versions will remain readable
1815    even after the a serialization roundtrip on 0.0.100, as long as no new
1816    channels are opened. Further, users using a
1817    `lightning::chain::keysinterface::KeysManager` as their `KeysInterface` will
1818    have `ChannelManager`s which are readable on prior versions as well (#1019).
1819  * `ChannelMonitorUpdate`s created by 0.0.100 and later for channels when
1820    `lightning::util::config::ChannelConfig::commit_upfront_shutdown_pubkey` is
1821    not set may not be readable by versions prior to 0.0.100 (#1019).
1822  * HTLCs which were in the process of being claimed on-chain when a pre-0.0.100
1823    `ChannelMonitor` was serialized may generate `PaymentForwarded` events with
1824    spurious `fee_earned_msat` values. This only applies to payments which were
1825    unresolved at the time of the upgrade (#1004).
1826  * 0.0.100 clients with pending `Event::PaymentForwarded` events at
1827    serialization-time will generate serialized `ChannelManager` objects which
1828    0.0.99 and earlier clients cannot read. The likelihood of this can be reduced
1829    by ensuring you process all pending events immediately before serialization
1830    (as is done by the `lightning-background-processor` crate, #1004).
1831
1832
1833 In total, this release features 59 files changed, 5861 insertions, and 2082
1834 deletions in 95 commits from 6 authors.
1835
1836
1837 # 0.0.99 - 2021-07-09 - "It's a Bugz Life"
1838
1839 ## API Updates
1840
1841  * `lightning_block_sync::poll::Validate` is now public, allowing you to
1842    implement the `lightning_block_sync::poll::Poll` trait without
1843    `lightning_block_sync::poll::ChainPoller` (#956).
1844  * `lightning::ln::peer_handler::PeerManager` no longer requires that no calls
1845    are made to referencing the same `SocketDescriptor` after
1846    `disconnect_socket` returns. This makes the API significantly less
1847    deadlock-prone and simplifies `SocketDescriptor` implementations
1848    significantly. The relevant changes have been made to `lightning_net_tokio`
1849    and `PeerManager` documentation has been substantially rewritten (#957).
1850  * `lightning::util::message_signing`'s `sign` and `verify` methods now take
1851    secret and public keys by reference instead of value (#974).
1852  * Substantially more information is now exposed about channels in
1853    `ChannelDetails`. See documentation for more info (#984 and #988).
1854  * The latest best block seen is now exposed in
1855    `ChannelManager::current_best_block` and
1856    `ChannelMonitor::current_best_block` (#984).
1857  * Feerates charged when forwarding payments over channels is now set in
1858    `ChannelConfig::fee_base_msat` when the channel is opened. For existing
1859    channels, the value is set to the value provided in
1860    `ChannelManagerReadArgs::default_config::channel_options` the first time the
1861    `ChannelManager` is loaded in 0.0.99 (#975).
1862  * We now reject HTLCs which are received to be forwarded over private channels
1863    unless `UserConfig::accept_forwards_to_priv_channels` is set. Note that
1864    `UserConfig` is never serialized and must be provided via
1865    `ChannelManagerReadArgs::default_config` at each start (#975).
1866
1867 ## Bug Fixes
1868
1869  * We now forward gossip messages to peers instead of only relaying
1870    locally-generated gossip or sending gossip messages during initial sync
1871    (#948).
1872  * Correctly send `channel_update` messages to direct peers on private channels
1873    (#949). Without this, a private node connected to an LDK node over a private
1874    channel cannot receive funds as it does not know which fees the LDK node
1875    will charge.
1876  * `lightning::ln::channelmanager::ChannelManager` no longer expects to be
1877    persisted spuriously after we receive a `channel_update` message about any
1878    channel in the routing gossip (#972).
1879  * Asynchronous `ChannelMonitor` updates (using the
1880    `ChannelMonitorUpdateErr::TemporaryFailure` return variant) no longer cause
1881    spurious HTLC forwarding failures (#954).
1882  * Transaction provided via `ChannelMonitor::transactions_confirmed`
1883    after `ChannelMonitor::best_block_updated` was called for a much later
1884    block now trigger all relevant actions as of the later block. Previously
1885    some transaction broadcasts or other responses required an additional
1886    block be provided via `ChannelMonitor::best_block_updated` (#970).
1887  * We no longer panic in rare cases when an invoice contained last-hop route
1888    hints which were unusable (#958).
1889
1890 ## Node Compatibility
1891
1892  * We now accept spurious `funding_locked` messages sent prior to
1893    `channel_reestablish` messages after reconnect. This is a
1894    [known, long-standing bug in lnd](https://github.com/lightningnetwork/lnd/issues/4006)
1895    (#966).
1896  * We now set the `first_blocknum` and `number_of_blocks` fields in
1897    `reply_channel_range` messages to values which c-lightning versions prior to
1898    0.10 accepted. This avoids spurious force-closes from such nodes (#961).
1899
1900 ## Serialization Compatibility
1901
1902  * Due to a bug discovered in 0.0.98, if a `ChannelManager` is serialized on
1903    version 0.0.98 while an `Event::PaymentSent` is pending processing, the
1904    `ChannelManager` will fail to deserialize both on version 0.0.98 and later
1905    versions. If you have such a `ChannelManager` available, a simple patch will
1906    allow it to deserialize. Please file an issue if you need assistance (#973).
1907
1908 # 0.0.98 - 2021-06-11 - "It's ALIVVVVEEEEEEE"
1909
1910 0.0.98 should be considered a release candidate to the first alpha release of
1911 Rust-Lightning and the broader LDK. It represents several years of work
1912 designing and fine-tuning a flexible API for integrating lightning into any
1913 application. LDK should make it easy to build a lightning node or client which
1914 meets specific requirements that other lightning node software cannot. As
1915 lightning continues to evolve, and new use-cases for lightning develop, the API
1916 of LDK will continue to change and expand. However, starting with version 0.1,
1917 objects serialized with prior versions will be readable with the latest LDK.
1918 While Rust-Lightning is approaching the 0.1 milestone, language bindings
1919 components of LDK available at https://github.com/lightningdevkit are still of
1920 varying quality. Some are also approaching an 0.1 release, while others are
1921 still much more experimental. Please note that, at 0.0.98, using Rust-Lightning
1922 on mainnet is *strongly* discouraged.