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