]> git.bitcoin.ninja Git - rust-lightning/blob - CHANGELOG.md
Add an `optional_vec` TLV format which makes sense, unlike vec_type
[rust-lightning] / CHANGELOG.md
1 # 0.0.114 - Mar 3, 2023 - "Faster Async BOLT12 Retries"
2
3 ## API Updates
4  * `InvoicePayer` has been removed and its features moved directly into
5    `ChannelManager`. As such it now requires a simplified `Router` and supports
6    `send_payment_with_retry` (and friends). `ChannelManager::retry_payment` was
7    removed in favor of the automated retries. Invoice payment utilities in
8    `lightning-invoice` now call the new code (#1812, #1916, #1929, #2007, etc).
9  * `Sign`/`BaseSign` has been renamed `ChannelSigner`, with `EcdsaChannelSigner`
10    split out in anticipation of future schnorr/taproot support (#1967).
11  * The catch-all `KeysInterface` was split into `EntropySource`, `NodeSigner`,
12    and `SignerProvider`. `KeysManager` implements all three (#1910, #1930).
13  * `KeysInterface::get_node_secret` is now `KeysManager::get_node_secret_key`
14    and is no longer required for external signers (#1951, #2070).
15  * A `lightning-transaction-sync` crate has been added which implements keeping
16    LDK in sync with the chain via an esplora server (#1870). Note that it can
17    only be used on nodes that *never* ran a previous version of LDK.
18  * `Score` is updated in `BackgroundProcessor` instead of via `Router` (#1996).
19  * `ChainAccess::get_utxo` (now `UtxoAccess`) can now be resolved async (#1980).
20  * BOLT12 `Offer`, `InvoiceRequest`, `Invoice` and `Refund` structs as well as
21    associated builders have been added. Such invoices cannot yet be paid due to
22    missing support for blinded path payments (#1927, #1908, #1926).
23  * A `lightning-custom-message` crate has been added to make combining multiple
24    custom messages into one enum/handler easier (#1832).
25  * `Event::PaymentPathFailed` is now generated for failure to send an HTLC
26    over the first hop on our local channel (#2014, #2043).
27  * `lightning-net-tokio` no longer requires an `Arc` on `PeerManager` (#1968).
28  * `ChannelManager::list_recent_payments` was added (#1873).
29  * `lightning-background-processor` `std` is now optional in async mode (#1962).
30  * `create_phantom_invoice` can now be used in `no-std` (#1985).
31  * The required final CLTV delta on inbound payments is now configurable (#1878)
32  * bitcoind RPC error code and message are now surfaced in `block-sync` (#2057).
33  * Get `historical_estimated_channel_liquidity_probabilities` was added (#1961).
34  * `ChannelManager::fail_htlc_backwards_with_reason` was added (#1948).
35  * Macros which implement serialization using TLVs or straight writing of struct
36    fields are now public (#1823, #1976, #1977).
37
38 ## Backwards Compatibility
39  * Any inbound payments with a custom final CLTV delta will be rejected by LDK
40    if you downgrade prior to receipt (#1878).
41  * `Event::PaymentPathFailed::network_update` will always be `None` if an
42    0.0.114-generated event is read by a prior version of LDK (#2043).
43  * `Event::PaymentPathFailed::all_paths_failed` will always be false if an
44    0.0.114-generated event is read by a prior version of LDK. Users who rely on
45    it to determine payment retries should migrate to `Event::PaymentFailed`, in
46    a separate release prior to upgrading to LDK 0.0.114 if downgrading is
47    supported (#2043).
48
49 ## Performance Improvements
50  * Channel data is now stored per-peer and channel updates across multiple
51    peers can be operated on simultaneously (#1507).
52  * Routefinding is roughly 1.5x faster (#1799).
53  * Deserializing a `NetworkGraph` is roughly 6x faster (#2016).
54  * Memory usage for a `NetworkGraph` has been reduced substantially (#2040).
55  * `KeysInterface::get_secure_random_bytes` is roughly 200x faster (#1974).
56
57 ## Bug Fixes
58  * Fixed a bug where a delay in processing a `PaymentSent` event longer than the
59    time taken to persist a `ChannelMonitor` update, when occurring immediately
60    prior to a crash, may result in the `PaymentSent` event being lost (#2048).
61  * Fixed spurious rejections of rapid gossip sync data when the graph has been
62    updated by other means between gossip syncs (#2046).
63  * Fixed a panic in `KeysManager` when the high bit of `starting_time_nanos`
64    is set (#1935).
65  * Resolved an issue where the `ChannelManager::get_persistable_update_future`
66    future would fail to wake until a second notification occurs (#2064).
67  * Resolved a memory leak when using `ChannelManager::send_probe` (#2037).
68  * Fixed a deadlock on some platforms at least when using async `ChannelMonitor`
69    updating (#2006).
70  * Removed debug-only assertions which were reachable in threaded code (#1964).
71  * In some cases when payment sending fails on our local channel retries no
72    longer take the same path and thus never succeed (#2014).
73  * Retries for spontaneous payments have been fixed (#2002).
74  * Return an `Err` if `lightning-persister` fails to read the directory listing
75    rather than panicing (#1943).
76  * `peer_disconnected` will now never be called without `peer_connected` (#2035)
77
78 ## Security
79 0.0.114 fixes several denial-of-service vulnerabilities which are reachable from
80 untrusted input from channel counterparties or in deployments accepting inbound
81 connections or channels. It also fixes a denial-of-service vulnerability in rare
82 cases in the route finding logic.
83  * The number of pending un-funded channels as well as peers without funded
84    channels is now limited to avoid denial of service (#1988).
85  * A second `channel_ready` message received immediately after the first could
86    lead to a spurious panic (#2071). This issue was introduced with 0conf
87    support in LDK 0.0.107.
88  * A division-by-zero issue was fixed in the `ProbabilisticScorer` if the amount
89    being sent (including previous-hop fees) is equal to a channel's capacity
90    while walking the graph (#2072). The division-by-zero was introduced with
91    historical data tracking in LDK 0.0.112.
92
93 In total, this release features 130 files changed, 21457 insertions, 10113
94 deletions in 343 commits from 18 authors, in alphabetical order:
95  * Alec Chen
96  * Allan Douglas R. de Oliveira
97  * Andrei
98  * Arik Sosman
99  * Daniel Granhão
100  * Duncan Dean
101  * Elias Rohrer
102  * Jeffrey Czyz
103  * John Cantrell
104  * Kurtsley
105  * Matt Corallo
106  * Max Fang
107  * Omer Yacine
108  * Valentine Wallace
109  * Viktor Tigerström
110  * Wilmer Paulino
111  * benthecarman
112  * jurvis
113
114
115 # 0.0.113 - Dec 16, 2022 - "Big Movement Intercepted"
116
117 ## API Updates
118  * `ChannelManager::send_payment` now takes an explicit `PaymentId` which is a
119    loose idempotency token. See `send_payment` docs for more (#1761, #1826).
120  * HTLCs bound for SCIDs from `ChannelManager::get_intercept_scid` are now
121    intercepted and can be forwarded manually over any channel (#1835, #1893).
122  * `Confirm::get_relevant_txids` now returns a `BlockHash`, expanding the set
123    of cases where `transaction_unconfirmed` must be called, see docs (#1796).
124  * Pending outbound payments are no longer automatically timed-out a few blocks
125    after failure. Thus, in order to avoid leaking memory, you MUST call
126    `ChannelManager::abandon_payment` when you no longer wish to retry (#1761).
127  * `ChannelManager::abandon_payment` docs were updated to note that the payment
128    may return to pending after a restart if no persistence occurs (#1907).
129  * `Event::PaymentReceived` has been renamed `Event::PaymentClaimable` (#1891).
130  * `Event` handling is now optionally async for Rust users (#1787).
131  * `user_channel_id` is now a `u128` and random for inbound channels (#1790).
132  * A new `ChannelReady` event is generated whenever a channel becomes ready to
133    be used, i.e., after both sides sent the `channel_ready` message (#1743).
134  * `NetworkGraph` now prunes channels where either node is offline for 2 weeks
135    and refuses to accept re-announcements of pruned channels (#1735).
136  * Onion messages are now read in `CustomOnionMessageHandler` rather than via
137    `MaybeReadableArgs` (#1809).
138  * Added a new util to generate an invoice with a custom hash (#1894) -
139 `create_invoice_from_channelmanager_and_duration_since_epoch_with_payment_hash`
140  * `Sign`ers are now by default re-derived using `KeysInterface`'s new
141    `derive_channel_signer` rather than `read_chan_signer` (#1867).
142  * `Confirm::transactions_confirmed` is now idempotent (#1861).
143  * `ChannelManager::compute_inflight_htlcs` has been added to fetch in-flight
144    HTLCs for scoring. Note that `InvoicePayer` does this for you (#1830).
145  * Added `PaymentClaimable::via_channel_id` (#1856).
146  * Added the `node_id` (phantom or regular) to payment events (#1766).
147  * Added the funding transaction `confirmations` to `ChannelDetails` (#1856).
148  * `BlindedRoute` has been renamed `BlindedPath` (#1918).
149  * Support for the BOLT 4 "legacy" onion format has been removed, in line with
150    its removal in the spec and vanishingly rare use (#1413).
151  * `ChainMonitor::list_pending_monitor_updates` was added (#1834).
152  * Signing for non-zero-fee anchor commitments is supported again (#1828).
153  * Several helpers for transaction matching and generation are now pub (#1839).
154
155 ## Bug Fixes
156  * Fixed a rare race where a crash may result in a pending HTLC not being
157    failed backwards, leading to a force-closure by our counterparty (#1857).
158  * Avoid incorrectly assigning a lower-bound on channel liquidity when routing
159    fails due to a closed channel earlier in the path (#1817).
160  * If a counterparty increases the channel fee, but not enough per our own fee
161    estimator, we no longer force-close the channel (#1852).
162  * Several bugs in the `lightning-background-processor` `future` feature were
163    fixed, including requirements doc corrections (#1843, #1845, #1851).
164  * Some failure messages sent back when failing an HTLC were corrected (#1895).
165  * `rapid-gossip-sync` no longer errors if an update is applied duplicatively
166    or in rare cases when the graph is updated from payment failures (#1833).
167  * Sending onion messages to a blinded path in which we're the introduction
168    node no longer fails (#1791).
169
170 ## Backwards Compatibility
171  * No `ChannelReady` events will be generated for previously existing channels,
172    including those which become ready after upgrading to 0.0.113 (#1743).
173  * Once `UserConfig::accept_intercept_htlcs` is set, downgrades to LDK versions
174    prior to 0.0.113 are not supported (#1835).
175  * Existing payments may see a `PaymentClaimable::user_channel_id` of 0 (#1856)
176  * When downgrading to a version of LDK prior to 0.0.113 when there are
177    resolved payments waiting for a small timeout, the payments may not be
178    removed, preventing payments with the same `PaymentId` (#1761).
179
180 In total, this release features 76 files changed, 11639 insertions, 6067
181 deletions in 210 commits from 18 authors, in alphabetical order:
182  * Antoine Riard
183  * Arik Sosman
184  * Devrandom
185  * Duncan Dean
186  * Elias Rohrer
187  * Gleb Naumenko
188  * Jeffrey Czyz
189  * John Cantrell
190  * Matt Corallo
191  * Tee8z
192  * Tobin C. Harding
193  * Tristan F
194  * Valentine Wallace
195  * Viktor Tigerström
196  * Wilmer Paulino
197  * benthecarman
198  * jurvis
199  * ssbright
200
201
202 # 0.0.112 - Oct 25, 2022 - "History Matters"
203
204 ## API Updates
205  * `Result<(), ChannelMonitorUpdateErr>` return values have been replaced with
206    a `ChannelMonitorUpdateStatus` trinary enum. This better denotes that
207    `ChannelMonitorUpdateStatus::InProgress` is not an error, but asynchronous
208    persistence of a monitor update. Note that asynchronous persistence still
209    has some edge cases and is not yet recommended for production (#1106).
210  * `ChannelMonitor` persistence failure no longer automatically broadcasts the
211    latest commitment transaction. See the
212    `ChannelMonitorUpdateStatus::PermanentFailure` docs for more info (#1106).
213  * `*Features::known` has been replaced with individual
214    `*MessageHandler::provided_*_features` methods (#1707).
215  * `OnionMessenger` now takes a `CustomOnionMessageHandler` implementation,
216    allowing you to send and receive custom onion messages (#1748).
217  * `ProbabilisticScorer` now tracks the historical distribution of liquidity
218    estimates for channels. See new `historical_*` parameters in
219    `ProbabilisticScoringParameters` for more details (#1625).
220  * `lightning-block-sync`'s `BlockSource` trait now supports BIP 157/158
221    filtering clients by returning only header data for some blocks (#1706).
222  * `lightning-invoice`'s `Router` trait now accepts an `InFlightHtlcs` to
223    ensure we do not over-use a remote channel's funds during routing (#1694).
224    Note that this was previously backported to 0.0.111 for bindings users.
225  * `NetworkGraph::remove_stale_channels` has been renamed
226    `NetworkGraph::remove_stale_channels_and_tracking` as `NetworkGraph` now
227    refuses to re-add nodes and channels that were recently removed (#1649).
228  * The `lightning-rapid-gossip-sync` crate now supports `no-std` (#1708).
229  * The default `ProbabilisticScoringParameters::liquidity_offset_half_life` has
230    been increased to six hours from one (#1754).
231  * All commitment transaction building logic for anchor outputs now assumes the
232    no-HTLC-tx-fee variant (#1685).
233  * A number of missing `Eq` implementations were added (#1763).
234
235 ## Bug Fixes
236  * `lightning-background-processor` now builds without error with the `futures`
237    feature (#1744).
238  * `ChannelManager::get_persistable_update_future`'s returned `Future` has been
239    corrected to not fail to be awoken in some cases (#1758).
240  * Asynchronously performing the initial `ChannelMonitor` persistence is now
241    safe (#1678).
242  * Redundantly applying rapid gossip sync updates no longer `Err`s (#1764).
243  * Nodes which inform us via payment failures that they should no longer be
244    used are now removed from the network graph. Some LND nodes spuriously
245    generate this error and may remove themselves from our graph (#1649).
246
247 In total, this release features 134 files changed, 6598 insertions, 4370
248 deletions in 109 commits from 13 authors, in alphabetical order:
249  * Duncan Dean
250  * Elias Rohrer
251  * Gabriel Comte
252  * Gursharan Singh
253  * Jeffrey Czyz
254  * Jurvis Tan
255  * Matt Corallo
256  * Max Fang
257  * Paul Miller
258  * Valentine Wallace
259  * Viktor Tigerström
260  * Wilmer Paulino
261  * acid-bit
262
263 # 0.0.111 - Sep 12, 2022 - "Saturated with Messages"
264
265 ## API Updates
266  * Support for relaying onion messages has been added via a new
267    `OnionMessenger` struct when passed as the `OnionMessageHandler` to a
268    `PeerManager`. Pre-encoded onion messages can also be sent and received
269    (#1503, #1650, #1652, #1688).
270  * Rate-limiting of outbound gossip syncs has been rewritten to utilize less
271    buffering inside LDK. The new rate-limiting is also used for onion messages
272    to avoid delaying other messages (#1604. #1660, #1683).
273  * Rather than spawning a full OS thread, `lightning-background-processor` has
274    a new `process_events_async` method which takes the place of a
275    `BackgroundProcessor` for those using Rust's async (#1657).
276  * `ChannelManager::get_persistable_update_future` has been added to block on
277    a ChannelManager needing re-persistence in a Rust async environment (#1657).
278  * The `Filter::register_output` return value has been removed, as it was
279    very difficult to correctly implement (i.e., without blocking). Users
280    previously using it should instead pass dependent transactions in via
281    additional `chain::Confirm::transactions_confirmed` calls (#1663).
282  * `ChannelHandshakeConfig::their_channel_reserve_proportional_millionths` has
283    been added to allow configuring counterparty reserve values (#1619).
284  * `KeysInterface::ecdh` has been added as an ECDH oracle (#1503, #1658).
285  * The `rust-bitcoin` dependency has been updated 0.29 (#1658).
286  * The `bitcoin_hashes` dependency has been updated 0.11 (#1677).
287  * `ChannelManager::broadcast_node_announcement` has been moved to
288    `PeerManager` (#1699).
289  * `channel_` and `node_announcement`s are now rebroadcast automatically to all
290    new peers which connect (#1699).
291  * `{Init,Node}Features` sent to peers/broadcasted are now fetched via the
292    various `*MessageHandler` traits, rather than hard-coded (#1701, #1688).
293  * `Event::PaymentPathFailed::rejected_by_dest` has been renamed
294    `payment_failed_permanently` (#1702).
295  * `Invoice` now derives the std `Hash` trait (#1575).
296  * `{Signed,}RawInvoice::hash` have been renamed `signable_hash` (#1714).
297  * `chain::AccessError` now derives the std `Debug` trait (#1709).
298  * `ReadOnlyNetworkGraph::list_{channels,nodes}` have been added largely for
299    users of downstream bindings (#1651).
300  * `ChannelMonitor::get_counterparty_node_id` is now available (#1635).
301
302 ## Bug Fixes
303  * The script compared with that returned from `chain::Access` was incorrect
304    ~half of the time, causing spurious gossip rejection (#1666).
305  * Pending in-flight HTLCs are now considered when calculating new routes,
306    ensuring, e.g. MPP retries do not take known-saturated paths (#1643).
307  * Counterparty-revoked outputs are now included in `get_claimable_balance`
308    output via a new `Balance::CounterpartyRevokedOutputClaimable` (#1495).
309  * Inbound HTLCs for which we do not (yet) have a preimage are now included in
310    `get_claimable_balance` via a `Balance::MaybePreimageClaimableHTLC` (#1673).
311  * Probes that fail prior to being sent over their first hop are correctly
312    failed with a `Event::ProbeFailed` rather than a `PaymentPathFailed` (#1704).
313  * Pending `Event::HTLCHandlingFailed`s are no longer lost on restart (#1700).
314  * HTLCs that fail prior to being sent over their first hop are now marked as
315    retryable via `!PaymentPathFailed::payment_failed_permanently` (#1702).
316  * Dust HTLCs are now considered failed in the payment tracking logic after the
317    commitment transaction confirms, allowing retry on restart (#1691).
318  * On machines with buggy "monotonic" clocks, LDK will no longer panic if time
319    goes backwards (#1692).
320
321 ## Backwards Compatibility
322  * The new `current_time` argument to `PeerManager` constructors must be set to
323    a UNIX timestamp for upgraded nodes; new nodes may use a counter (#1699).
324  * `Balance::CounterpartyRevokedOutputClaimable` will never be generated for
325    channels that were observed to go on-chain with LDK versions prior to
326    0.0.111 (#1495).
327  * `ChannelMonitor::get_counterparty_node_id` will return `None` for all
328    channels opened on a version of LDK prior to 0.0.110 (#1635).
329  * Setting `their_channel_reserve_proportional_millionths` to any value other
330    than the default will cause LDK versions prior to 0.0.104 to be unable to
331    read the serialized `ChannelManager` (#1619).
332
333 ## Security
334 0.0.111 fixes a denial-of-service vulnerability which is reachable from
335 untrusted input in deployments accepting 0conf channels, or via a race-condition
336 in deployments creating outbound 0conf channels.
337
338  * LDK versions prior to 0.0.111 may spuriously panic when receiving a block if
339    they are awaiting the construction of a funding transaction for a 0-conf
340    channel (#1711). 0-conf support was added in LDK version 0.0.107.
341
342 In total, this release features 84 files changed, 6306 insertions, 1960
343 deletions in 121 commits from 11 authors, in alphabetical order:
344  * Arik Sosman
345  * Devrandom
346  * Duncan Dean
347  * Elias Rohrer
348  * Gursharan Singh
349  * Matt Corallo
350  * NicolaLS
351  * Valentine Wallace
352  * Viktor Tigerström
353  * jurvis
354  * ok300
355
356
357 # 0.0.110 - 2022-07-26 - "Routing, With a Vengeance"
358
359 ## API Updates
360  * `ChannelManager::send_probe` and `Score::probe_{failed,successful}` have
361    been added to make probing more explicit, as well as new
362    `Event::Probe{Failed,Successful}` events (#1567).
363  * `ProbabilisticScoringParameters::banned_nodes` has been renamed
364    `manual_node_penalties` and changed to take msat penalties (#1592).
365  * Per-payment tracking of failed paths was added to enable configuration of
366    `ProbabilisticScoringParameters::considered_impossible_penalty_msat` (#1600)
367  * `ProbabilisticScoringParameters::base_penalty_amount_multiplier_msat` was
368    added to allow a penalty that is only amount-dependent (#1617).
369  * `ProbabilisticScoringParameters::amount_penalty_multiplier_msat` was renamed
370    `liquidity_penalty_amount_multiplier_msat` (#1617).
371  * A new `Event::HTLCHandlingFailed` has been added which provides visibility
372    into failures to forward/claim accepted HTLCs (#1403).
373  * Support has been added for DNS hostnames in the `NetAddress` type, see
374    [BOLT PR #911](https://github.com/lightning/bolts/pull/911) (#1553).
375  * `GossipSync` now has `rapid`, `p2p`, and `none` constructors (#1618).
376  * `lightning-net-tokio` no longer requires types to be in `Arc`s (#1623).
377  * The `htlc_maximum_msat` field is now required in `ChannelUpdate` gossip
378    messages. In tests this rejects < 1% of channels (#1519).
379  * `ReadOnlyNetworkGraph::{channel,node}` have been added to query for
380    individual channel/node data, primarily for bindings users (#1543).
381  * `FeeEstimator` implementations are now wrapped internally to ensure values
382    below 253 sats/kW are never used (#1552).
383  * Route selection no longer attempts to randomize path selection. This is
384    unlikely to lead to a material change in the paths selected (#1610).
385
386 ## Bug Fixes
387  * Fixed a panic when deserializing `ChannelDetails` objects (#1588).
388  * When routing, channels are no longer fully saturated before MPP splits are
389    generated, instead a configuration knob was added as
390    `PaymentParameters::max_channel_saturation_power_of_half` (#1605).
391  * Fixed a panic which occurred in `ProbabilisticScorer` when wallclock time
392    goes backwards across a restart (#1603).
393
394 ## Serialization Compatibility
395  * All new fields are ignored by prior versions of LDK. All new fields are not
396    present when reading objects serialized by prior versions of LDK.
397  * Channel information written in the `NetworkGraph` which is missing
398    `htlc_maximum_msat` may be dropped on deserialization (#1519).
399  * Similarly, node information written in the `NetworkGraph` which contains an
400    invalid hostname may be dropped on deserialization (#1519).
401
402 In total, this release features 79 files changed, 2935 insertions, 1363
403 deletions in 52 commits from 9 authors, in alphabetical order:
404  * Duncan Dean
405  * Elias Rohrer
406  * Jeffrey Czyz
407  * Matt Corallo
408  * Max Fang
409  * Viktor Tigerström
410  * Willem Van Lint
411  * Wilmer Paulino
412  * jurvis
413
414 # 0.0.109 - 2022-07-01 - "The Kitchen Sink"
415
416 ## API Updates
417  * `ChannelManager::update_channel_config` has been added to allow the fields
418    in `ChannelConfig` to be changed in a given channel after open (#1527).
419  * If we reconnect to a peer which proves we have a stale channel state, rather
420    than force-closing we will instead panic to provide an opportunity to switch
421    to the latest state and continue operating without channel loss (#1564).
422  * A `NodeAlias` struct has been added which handles string sanitization for
423    node aliases via the `Display` trait (#1544).
424  * `ProbabilisticScoringParameters` now has a `banned_nodes` set which we will
425     never route through during path finding (#1550).
426  * `ProbabilisticScoringParameters` now offers an `anti_probing_penalty_msat`
427    option to prefer channels which afford better privacy when routing (#1555).
428  * `ProbabilisticScorer` now provides access to its estimated liquidity range
429    for a given channel via `estimated_channel_liquidity_range` (#1549).
430  * `ChannelManager::force_close_channel` has been renamed
431    `force_close_broadcasting_latest_txn` and
432    `force_close_without_broadcasting_txn` has been added (#1564).
433  * Options which cannot be changed at runtime have been moved from
434    `ChannelConfig` to `ChannelHandshakeConfig` (#1529).
435  * `find_route` takes `&NetworkGraph` instead of `ReadOnlyNetworkGraph (#1583).
436  * `ChannelDetails` now contains a copy of the current `ChannelConfig` (#1527).
437  * The `lightning-invoice` crate now optionally depends on `serde`, with
438    `Invoice` implementing `serde::{Deserialize,Serialize}` if enabled (#1548).
439  * Several fields in `UserConfig` have been renamed for clarity (#1540).
440
441 ## Bug Fixes
442  * `find_route` no longer selects routes with more than
443    `PaymentParameters::max_mpp_path_count` paths, and
444    `ChannelManager::send_payment` no longer refuses to send along routes with
445    more than ten paths (#1526).
446  * Fixed two cases where HTLCs pending at the time a counterparty broadcasts a
447    revoked commitment transaction are considered resolved prior to their actual
448    resolution on-chain, possibly passing the update to another channel (#1486).
449  * HTLCs which are relayed through LDK may now have a total expiry time two
450    weeks in the future, up from one, reducing forwarding failures (#1532).
451
452 ## Serialization Compatibility
453  * All new fields are ignored by prior versions of LDK. All new fields are not
454    present when reading objects serialized by prior versions of LDK.
455  * `ChannelConfig`'s serialization format has changed and is not compatible
456    with any previous version of LDK. Attempts to read values written by a
457    previous version of LDK will fail and attempts to read newly written objects
458    using a previous version of LDK will fail. It is not expected that users are
459    serializing `ChannelConfig` using the LDK serialization API, however, if a
460    backward compatibility wrapper is required, please open an issue.
461
462 ## Security
463 0.0.109 fixes a denial-of-service vulnerability which is reachable from
464 untrusted input in some application deployments.
465
466  * Third parties which are allowed to open channels with an LDK-based node may
467    fund a channel with a bogus and maliciously-crafted transaction which, when
468    spent, can cause a panic in the channel's corresponding `ChannelMonitor`.
469    Such a channel is never usable as it cannot be funded with a funding
470    transaction which matches the required output script, allowing the
471    `ChannelMonitor` for such channels to be safely purged as a workaround on
472    previous versions of LDK. Thanks to Eugene Siegel for reporting this issue.
473
474 In total, this release features 32 files changed, 1948 insertions, 532
475 deletions in 33 commits from 9 authors, in alphabetical order:
476  * Antoine Riard
477  * Daniel Granhão
478  * Elias Rohrer
479  * Jeffrey Czyz
480  * Matt Corallo
481  * Matt Faltyn
482  * NicolaLS
483  * Valentine Wallace
484  * Wilmer Paulino
485
486
487 # 0.0.108 - 2022-06-10 - "You Wanted It To Build?! Why Didn't You Say So?"
488
489 ## Bug Fixes
490  * Fixed `lightning-background-processor` build in release mode.
491
492 In total, this release features 9 files changed, 120 insertions, 74
493 deletions in 5 commits from 4 authors, in alphabetical order:
494  * Elias Rohrer
495  * Matt Corallo
496  * Max Fang
497  * Viktor Tigerström
498
499 # 0.0.107 - 2022-06-08 - "BlueWallet's Wishlist"
500
501 ## API Updates
502  * Channels larger than 16777215 sats (Wumbo!) are now supported and can be
503    enabled for inbound channels using
504    `ChannelHandshakeLimits::max_funding_satoshis` (#1425).
505  * Support for feature `option_zeroconf`, allowing immediate forwarding of
506    payments after channel opening. This is configured for outbound channels
507    using `ChannelHandshakeLimits::trust_own_funding_0conf` whereas
508    `ChannelManager::accept_inbound_channel_from_trusted_peer_0conf` has to be
509    used for accepting inbound channels (#1401, #1505).
510  * `ChannelManager::claim_funds` no longer returns a `bool` to indicate success.
511    Instead, an `Event::PaymentClaimed` is generated if the claim was successful.
512    Likewise, `ChannelManager::fail_htlc_backwards` no longer has a return value
513    (#1434).
514  * `lightning-rapid-gossip-sync` is a new crate for syncing gossip data from a
515    server, primarily aimed at mobile devices (#1155).
516  * `RapidGossipSync` can be passed to `BackgroundProcessor` in order to persist
517    the `NetworkGraph` and handle `NetworkUpdate`s during event handling (#1433,
518    #1517).
519  * `NetGraphMsgHandler` has been renamed to `P2PGossipSync`, the `network_graph`
520     module has been renamed to `gossip`, and `NetworkUpdate::ChannelClosed` has
521    been renamed `NetworkUpdate::ChannelFailure` (#1159).
522  * Added a `filtered_block_connected` method to `chain::Listen` and a default
523    implementation of `block_connected` for those fetching filtered instead of
524    full blocks (#1453).
525  * The `lightning-block-sync` crate's `BlockSource` trait methods now take
526    `&self` instead of `&mut self` (#1307).
527  * `inbound_payment` module is now public to allow for creating invoices without
528    a `ChannelManager` (#1384).
529  * `lightning-block-sync`'s `init` and `poll` modules support `&dyn BlockSource`
530    which can be determined at runtime (#1423).
531  * `lightning-invoice` crate's `utils` now accept an expiration time (#1422,
532    #1474).
533  * `Event::PaymentForwarded` includes `prev_channel_id` and `next_channel_id`
534    (#1419, #1475).
535  * `chain::Watch::release_pending_monitor_events`' return type now associates
536    `MonitorEvent`s with funding `OutPoints` (#1475).
537  * `lightning-background-processor` crate's `Persister` trait has been moved to
538    `lightning` crate's `util::persist` module, which now has a general
539    `KVStorePersister` trait. Blanket implementations of `Persister` and
540    `chainmonitor::Persist` are given for types implementing `KVStorePersister`.
541    ` lightning-persister`'s `FilesystemPersister` implements `KVStorePersister`
542    (#1417).
543  * `ChannelDetails` and `ChannelCounterparty` include fields for HTLC minimum
544    and maximum values (#1378).
545  * Added a `max_inbound_htlc_value_in_flight_percent_of_channel` field to
546    `ChannelHandshakeConfig`, capping the total value of outstanding inbound
547    HTLCs for a channel (#1444).
548  * `ProbabilisticScorer` is parameterized by a `Logger`, which it uses to log
549    channel liquidity updates or lack thereof (#1405).
550  * `ChannelDetails` has an `outbound_htlc_limit_msat` field, which should be
551    used in routing instead of `outbound_capacity_msat` (#1435).
552  * `ProbabilisticScorer`'s channel liquidities can be logged via
553    `debug_log_liquidity_stats` (#1460).
554  * `BackgroundProcessor` now takes an optional `WriteableScore` which it will
555    persist using the `Persister` trait's new `persist_scorer` method (#1416).
556  * Upgraded to `bitcoin` crate version 0.28.1 (#1389).
557  * `ShutdownScript::new_witness_program` now takes a `WitnessVersion` instead of
558    a `NonZeroU8` (#1389).
559  * Channels will no longer be automatically force closed when the counterparty
560    is disconnected due to incompatibility (#1429).
561  * `ChannelManager` methods for funding, accepting, and closing channels now
562    take a `counterparty_node_id` parameter, which has also been added as a field
563    to `Event::FundingGenerationReady` (#1479, #1485).
564  * `InvoicePayer::new` now takes a `Retry` enum (replacing the `RetryAttempts`
565    struct), which supports both attempt- and timeout-based retrying (#1418).
566  * `Score::channel_penalty_msat` takes a `ChannelUsage` struct, which contains
567    the capacity as an `EffectiveCapacity` enum and any potential in-flight HTLC
568    value, rather than a single `u64`. Used by `ProbabilisticScorer` for more
569    accurate penalties (#1456).
570  * `build_route_from_hops` is a new function useful for constructing a `Route`
571    given a specific list of public keys (#1491).
572  * `FundingLocked` message has been renamed `ChannelReady`, and related
573    identifiers have been renamed accordingly (#1506).
574  * `core2::io` or `std::io` (depending on feature flags `no-std` or `std`) is
575    exported as a `lightning::io` module (#1504).
576  * The deprecated `Scorer` has been removed in favor or `ProbabilisticScorer`
577    (#1512).
578
579 ## Performance Improvements
580  * `lightning-persister` crate's `FilesystemPersister` is faster by 15x (#1404).
581  * Log gossip query messages at `GOSSIP` instead of `TRACE` to avoid
582    overwhelming default logging (#1421).
583  * `PeerManager` supports processing messages from different peers in parallel,
584    and this is taken advantage of in gossip processing (#1023).
585  * Greatly reduced per-channel and per-node memory usage due to upgrade of
586    `secp256k1` crate to 0.22.1 and `bitcoin` crate to 0.28.1
587  * Reduced per-peer memory usage in `PeerManager` (#1472).
588
589 ## Spec Compliance
590  * `find_route` now assumes variable-length onions by default for nodes where
591    support for the feature is unknown (#1414).
592  * A `warn` message is now sent when receiving a `channel_reestablish` with an
593    old commitment transaction number rather than immediately force-closing the
594    channel (#1430).
595  * When a `channel_update` message is included in an onion error's `failuremsg`,
596    its message type is now encoded. Reading such messages is also supported
597    (#1465).
598
599 ## Bug Fixes
600  * Fixed a bug where crashing while persisting a `ChannelMonitorUpdate` for a
601    part of a multi-path payment could cause loss of funds due to a partial
602    payment claim on restart (#1434).
603  * `BackgroundProcessor` has been fixed to improve serialization reliability on
604    slow systems which can avoid force-closes (#1436).
605  * `gossip_timestamp_filter` filters are now honored when sending gossip to
606    peers (#1452).
607  * During a reorg, only force-close a channel if its funding transaction is
608    unconfirmed rather than as it loses confirmations (#1461).
609  * Fixed a rare panic in `lightning-net-tokio` when fetching a peer's socket
610    address after the connection has been closed caused by a race condition
611    (#1449).
612  * `find_route` will no longer return routes that would cause onion construction
613    to fail in some cases (#1476).
614  * `ProbabilisticScorer` uses more precision when approximating `log10` (#1406).
615
616 ## Serialization Compatibility
617  * All above new events/fields are ignored by prior clients. All above new
618    events/fields are not present when reading objects serialized by prior
619    versions of the library.
620  * `ChannelManager` serialization is no longer compatible with versions prior to
621    0.0.99 (#1401).
622  * Channels with `option_zeroconf` feature enabled (not required for 0-conf
623    channel use) will be unreadable by versions prior to 0.0.107 (#1401, #1505).
624
625 In total, this release features 96 files changed, 9304 insertions, 4503
626 deletions in 153 commits from 18 authors, in alphabetical order:
627  * Arik Sosman
628  * Devrandom
629  * Duncan Dean
630  * Elias Rohrer
631  * Jeffrey Czyz
632  * John Cantrell
633  * John Corser
634  * Jurvis Tan
635  * Justin Moon
636  * KaFai Choi
637  * Matt Faltyn
638  * Matt Corallo
639  * Valentine Wallace
640  * Viktor Tigerström
641  * Vincenzo Palazzo
642  * atalw
643  * dependabot[bot]
644  * shamardy
645
646
647 # 0.0.106 - 2022-04-03
648
649 ## API Updates
650  * Minimum supported rust version (MSRV) is now 1.41.1 (#1310).
651  * Lightning feature `option_scid_alias` is now supported and may be negotiated
652    when opening a channel with a peer. It can be configured via
653    `ChannelHandshakeConfig::negotiate_scid_privacy` and is off by default but
654    will be on by default in the future (#1351).
655  * `OpenChannelRequest` now has a `channel_type` field indicating the features
656    the channel will operate with and should be used to filter channels with
657    undesirable features (#1351). See the Serialization Compatibility section.
658  * `ChannelManager` supports sending and receiving short channel id aliases in
659    the `funding_locked` message. These are used when forwarding payments and
660    constructing invoice route hints for improved privacy. `ChannelDetails` has a
661    `inbound_scid_alias` field and a `get_inbound_payment_scid` method to support
662    the latter (#1311).
663  * `DefaultRouter` and `find_route` take an additional random seed to improve
664    privacy by adding a random CLTV expiry offset to each path's final hop. This
665    helps obscure the intended recipient from adversarial intermediate hops
666    (#1286). The seed is  also used to randomize candidate paths during route
667    selection (#1359).
668  * The `lightning-block-sync` crate's `init::synchronize_listeners` method
669    interface has been relaxed to support multithreaded environments (#1349).
670  * `ChannelManager::create_inbound_payment_for_hash`'s documentation has been
671    corrected to remove the one-year restriction on `invoice_expiry_delta_secs`,
672    which is only applicable to the deprecated `create_inbound_payment_legacy`
673    and `create_inbound_payment_for_hash_legacy` methods (#1341).
674  * `Features` mutator methods now take `self` by reference instead of by value
675    (#1331).
676  * The CLTV of the last hop in a path is now included when comparing against
677    `RouteParameters::max_total_cltv_expiry_delta` (#1358).
678  * Invoice creation functions in `lightning-invoice` crate's `utils` module
679    include versions that accept a description hash instead of only a description
680    (#1361).
681  * `RoutingMessageHandler::sync_routing_table` has been renamed `peer_connected`
682    (#1368).
683  * `MessageSendEvent::SendGossipTimestampFilter` has been added to indicate that
684    a `gossip_timestamp_filter` should be sent (#1368).
685  * `PeerManager` takes an optional `NetAddress` in `new_outbound_connection` and
686    `new_inbound_connection`, which is used to report back the remote address to
687    the connecting peer in the `init` message (#1326).
688  * `ChannelManager::accept_inbound_channel` now takes a `user_channel_id`, which
689    is used in a similar manner as in outbound channels. (#1381).
690  * `BackgroundProcessor` now persists `NetworkGraph` on a timer and upon
691    shutdown as part of a new `Persister` trait, which also includes
692    `ChannelManager` persistence (#1376).
693  * `ProbabilisticScoringParameters` now has a `base_penalty_msat` option, which
694    default to 500 msats. It is applied at each hop to help avoid longer paths
695    (#1375).
696  * `ProbabilisticScoringParameters::liquidity_penalty_multiplier_msat`'s default
697    value is now 40,000 msats instead of 10,000 msats (#1375).
698  * The `lightning` crate has a `grind_signatures` feature used to produce
699    signatures with low r-values for more predictable transaction weight. This
700    feature is on by default (#1388).
701  * `ProbabilisticScoringParameters` now has a `amount_penalty_multiplier_msat`
702    option, which is used to further penalize large amounts (#1399).
703  * `PhantomRouteHints`, `FixedPenaltyScorer`, and `ScoringParameters` now
704    implement `Clone` (#1346).
705
706 ## Bug Fixes
707  * Fixed a compilation error in `ProbabilisticScorer` under `--feature=no-std`
708    (#1347).
709  * Invoice creation functions in `lightning-invoice` crate's `utils` module
710    filter invoice hints in order to limit the invoice size (#1325).
711  * Fixed a bug where a `funding_locked` message was delayed by a block if the
712    funding transaction was confirmed while offline, depending on the ordering
713    of `Confirm::transactions_confirmed` calls when brought back online (#1363).
714  * Fixed a bug in `NetGraphMsgHandler` where it didn't continue to receive
715    gossip messages from peers after initial connection (#1368, #1382).
716  * `ChannelManager::timer_tick_occurred` will now timeout a received multi-path
717    payment (MPP) after three ticks if not received in full instead of waiting
718    until near the HTLC timeout block(#1353).
719  * Fixed an issue with `find_route` causing it to be overly aggressive in using
720    MPP over channels to the same first hop (#1370).
721  * Reduced time spent processing `channel_update` messages by checking
722    signatures after checking if no newer messages have already been processed
723    (#1380).
724  * Fixed a few issues in `find_route` which caused preferring paths with a
725    higher cost (#1398).
726  * Fixed an issue in `ProbabilisticScorer` where a channel with not enough
727    liquidity could still be used when retrying a failed payment if it was on a
728    path with an overall lower cost (#1399).
729
730 ## Serialization Compatibility
731  * Channels open with `option_scid_alias` negotiated will be incompatible with
732    prior releases (#1351). This may occur in the following cases:
733    * Outbound channels when `ChannelHandshakeConfig::negotiate_scid_privacy` is
734      enabled.
735    * Inbound channels when automatically accepted from an `OpenChannel` message
736      with a `channel_type` that has `ChannelTypeFeatures::supports_scid_privacy`
737      return true. See `UserConfig::accept_inbound_channels`.
738    * Inbound channels when manually accepted from an `OpenChannelRequest` with a
739      `channel_type` that has `ChannelTypeFeatures::supports_scid_privacy` return
740      true. See `UserConfig::manually_accept_inbound_channels`.
741
742 In total, this release features 43 files changed, 4052 insertions, 1274
743 deletions in 75 commits from 11 authors, in alphabetical order:
744  * Devrandom
745  * Duncan Dean
746  * Elias Rohrer
747  * Jeffrey Czyz
748  * Jurvis Tan
749  * Luiz Parreira
750  * Matt Corallo
751  * Omar Shamardy
752  * Viktor Tigerström
753  * dependabot[bot]
754  * psycho-pirate
755
756
757 # 0.0.105 - 2022-02-28
758
759 ## API Updates
760  * `Phantom node` payments are now supported, allowing receipt of a payment on
761    any one of multiple nodes without any coordination across the nodes being
762    required. See the new `PhantomKeysManager`'s docs for more, as well as
763    requirements on `KeysInterface::get_inbound_payment_key_material` and
764    `lightning_invoice::utils::create_phantom_invoice` (#1199).
765  * In order to support phantom node payments, several `KeysInterface` methods
766    now accept a `Recipient` parameter to select between the local `node_id` and
767    a phantom-specific one.
768  * `ProbabilisticScorer`, a `Score` based on learning the current balances of
769    channels in the network, was added. It attempts to better capture payment
770    success probability than the existing `Scorer`, though may underperform on
771    nodes with low payment volume. We welcome feedback on performance (#1227).
772  * `Score::channel_penalty_msat` now always takes the channel value, instead of
773    an `Option` (#1227).
774  * `UserConfig::manually_accept_inbound_channels` was added which, when set,
775    generates a new `Event::OpenChannelRequest`, which allows manual acceptance
776    or rejection of incoming channels on a per-channel basis (#1281).
777  * `Payee` has been renamed to `PaymentParameters` (#1271).
778  * `PaymentParameters` now has a `max_total_cltv_expiry_delta` field. This
779    defaults to 1008 and limits the maximum amount of time an HTLC can be pending
780    before it will either fail or be claimed (#1234).
781  * The `lightning-invoice` crate now supports no-std environments. This required
782    numerous API changes around timestamp handling and std+no-std versions of
783    several methods that previously assumed knowledge of the time (#1223, #1230).
784  * `lightning-invoice` now supports parsing invoices with expiry times of more
785    than one year. This required changing the semantics of `ExpiryTime` (#1273).
786  * The `CounterpartyCommitmentSecrets` is now public, allowing external uses of
787    the `BOLT 3` secret storage scheme (#1299).
788  * Several `Sign` methods now receive HTLC preimages as proof of state
789    transition, see new documentation for more (#1251).
790  * `KeysInterface::sign_invoice` now provides the HRP and other invoice data
791    separately to make it simpler for external signers to parse (#1272).
792  * `Sign::sign_channel_announcement` now returns both the node's signature and
793    the per-channel signature. `InMemorySigner` now requires the node's secret
794    key in order to implement this (#1179).
795  * `ChannelManager` deserialization will now fail if the `KeysInterface` used
796    has a different `node_id` than the `ChannelManager` expects (#1250).
797  * A new `ErrorAction` variant was added to send `warning` messages (#1013).
798  * Several references to `chain::Listen` objects in `lightning-block-sync` no
799    longer require a mutable reference (#1304).
800
801 ## Bug Fixes
802  * Fixed a regression introduced in 0.0.104 where `ChannelManager`'s internal
803    locks could have an order violation leading to a deadlock (#1238).
804  * Fixed cases where slow code (including user I/O) could cause us to
805    disconnect peers with ping timeouts in `BackgroundProcessor` (#1269).
806  * Now persist the `ChannelManager` prior to `BackgroundProcessor` stopping,
807    preventing race conditions where channels are closed on startup even with a
808    clean shutdown. This requires that users stop network processing and
809    disconnect peers prior to `BackgroundProcessor` shutdown (#1253).
810  * Fields in `ChannelHandshakeLimits` provided via the `override_config` to
811    `create_channel` are now applied instead of the default config (#1292).
812  * Fixed the generation of documentation on docs.rs to include API surfaces
813    which are hidden behind feature flags (#1303).
814  * Added the `channel_type` field to `accept_channel` messages we send, which
815    may avoid some future compatibility issues with other nodes (#1314).
816  * Fixed a bug where, if a previous LDK run using `lightning-persister` crashed
817    while persisting updated data, we may have failed to initialize (#1332).
818  * Fixed a rare bug where having both pending inbound and outbound HTLCs on a
819    just-opened inbound channel could cause `ChannelDetails::balance_msat` to
820    underflow and be reported as large, or cause panics in debug mode (#1268).
821  * Moved more instances of verbose gossip logging from the `Trace` level to the
822    `Gossip` level (#1220).
823  * Delayed `announcement_signatures` until the channel has six confirmations,
824    slightly improving propagation of channel announcements (#1179).
825  * Several fixes in script and transaction weight calculations when anchor
826    outputs are enabled (#1229).
827
828 ## Serialization Compatibility
829  * Using `ChannelManager` data written by versions prior to 0.0.105 will result
830    in preimages for HTLCs that were pending at startup to be missing in calls
831    to `KeysInterface` methods (#1251).
832  * Any phantom invoice payments received on a node that is not upgraded to
833    0.0.105 will fail with an "unknown channel" error. Further, downgrading to
834    0.0.104 or before and then upgrading again will invalidate existing phantom
835    SCIDs which may be included in invoices (#1199).
836
837 ## Security
838 0.0.105 fixes two denial-of-service vulnerabilities which may be reachable from
839 untrusted input in certain application designs.
840
841  * Route calculation spuriously panics when a routing decision is made for a
842    path where the second-to-last hop is a private channel, included due to a
843    multi-hop route hint in an invoice.
844  * `ChannelMonitor::get_claimable_balances` spuriously panics in some scenarios
845    when the LDK application's local commitment transaction is confirmed while
846    HTLCs are still pending resolution.
847
848 In total, this release features 109 files changed, 7270 insertions, 2131
849 deletions in 108 commits from 15 authors, in alphabetical order:
850  * Conor Okus
851  * Devrandom
852  * Elias Rohrer
853  * Jeffrey Czyz
854  * Jurvis Tan
855  * Ken Sedgwick
856  * Matt Corallo
857  * Naveen
858  * Tibo-lg
859  * Valentine Wallace
860  * Viktor Tigerström
861  * dependabot[bot]
862  * hackerrdave
863  * naveen
864  * vss96
865
866
867 # 0.0.104 - 2021-12-17
868
869 ## API Updates
870  * A `PaymentFailed` event is now provided to indicate a payment has failed
871    fully. This event is generated either after
872    `ChannelManager::abandon_payment` is called for a given payment, or the
873    payment times out, and there are no further pending HTLCs for the payment.
874    This event should be used to detect payment failure instead of
875    `PaymentPathFailed::all_paths_failed`, unless no payment retries occur via
876    `ChannelManager::retry_payment` (#1202).
877  * Payment secrets are now generated deterministically using material from
878    the new `KeysInterface::get_inbound_payment_key_material` (#1177).
879  * A `PaymentPathSuccessful` event has been added to ease passing success info
880    to a scorer, along with a `Score::payment_path_successful` method to accept
881    such info (#1178, #1197).
882  * `Score::channel_penalty_msat` has additional arguments describing the
883    channel's capacity and the HTLC amount being sent over the channel (#1166).
884  * A new log level `Gossip` has been added, which is used for verbose
885    information generated during network graph sync. Enabling the
886    `max_level_trace` feature or ignoring `Gossip` log entries reduces log
887    growth during initial start up from many GiB to several MiB (#1145).
888  * The `allow_wallclock_use` feature has been removed in favor of only using
889    the `std` and `no-std` features (#1212).
890  * `NetworkGraph` can now remove channels that we haven't heard updates for in
891    two weeks with `NetworkGraph::remove_stale_channels{,with_time}`. The first
892    is called automatically if a `NetGraphMsgHandler` is passed to
893    `BackgroundProcessor::start` (#1212).
894  * `InvoicePayer::pay_pubkey` was added to enable sending "keysend" payments to
895    supported recipients, using the `InvoicePayer` to handle retires (#1160).
896  * `user_payment_id` has been removed from `PaymentPurpose`, and
897    `ChannelManager::create_inbound_payment{,_for_hash}` (#1180).
898  * Updated documentation for several `ChannelManager` functions to remove stale
899    references to panics which no longer occur (#1201).
900  * The `Score` and `LockableScore` objects have moved into the
901    `routing::scoring` module instead of being in the `routing` module (#1166).
902  * The `Time` parameter to `ScorerWithTime` is no longer longer exposed,
903    instead being fixed based on the `std`/`no-std` feature (#1184).
904  * `ChannelDetails::balance_msat` was added to fetch a channel's balance
905    without subtracting the reserve values, lining up with on-chain claim amounts
906    less on-chain fees (#1203).
907  * An explicit `UserConfig::accept_inbound_channels` flag is now provided,
908    removing the need to set `min_funding_satoshis` to > 21 million BTC (#1173).
909  * Inbound channels that fail to see the funding transaction confirm within
910    2016 blocks are automatically force-closed with
911    `ClosureReason::FundingTimedOut` (#1083).
912  * We now accept a channel_reserve value of 0 from counterparties, as it is
913    insecure for our counterparty but not us (#1163).
914  * `NetAddress::OnionV2` parsing was removed as version 2 onion services are no
915    longer supported in modern Tor (#1204).
916  * Generation and signing of anchor outputs is now supported in the
917    `KeysInterface`, though no support for them exists in the channel itself (#1176)
918
919 ## Bug Fixes
920  * Fixed a race condition in `InvoicePayer` where paths may be retried after
921    the retry count has been exceeded. In this case the
922    `Event::PaymentPathFailed::all_paths_failed` field is not a reliable payment
923    failure indicator. There was no acceptable alternative indicator,
924    `Event::PaymentFailed` as been added to provide one (#1202).
925  * Reduced the blocks-before-timeout we expect of outgoing HTLCs before
926    refusing to forward. This check was overly strict and resulted in refusing
927    to forward som HTLCs to a next hop that had a lower security threshold than
928    us (#1119).
929  * LDK no longer attempt to update the channel fee for outbound channels when
930    we cannot afford the new fee. This could have caused force-closure by our
931    channel counterparty (#1054).
932  * Fixed several bugs which may have prevented the reliable broadcast of our
933    own channel announcements and updates (#1169).
934  * Fixed a rare bug which may have resulted in spurious route finding failures
935    when using last-hop hints and MPP with large value payments (#1168).
936  * `KeysManager::spend_spendable_outputs` no longer adds a change output that
937    is below the dust threshold for non-standard change scripts (#1131).
938  * Fixed a minor memory leak when attempting to send a payment that fails due
939    to an error when updating the `ChannelMonitor` (#1143).
940  * Fixed a bug where a `FeeEstimator` that returns values rounded to the next
941    sat/vbyte may result in force-closures (#1208).
942  * Handle MPP timeout HTLC error codes, instead of considering the recipient to
943    have sent an invalid error, removing them from the network graph (#1148)
944
945 ## Serialization Compatibility
946  * All above new events/fields are ignored by prior clients. All above new
947    events/fields are not present when reading objects serialized by prior
948    versions of the library.
949  * Payment secrets are now generated deterministically. This reduces the memory
950    footprint for inbound payments, however, newly-generated inbound payments
951    using `ChannelManager::create_inbound_payment{,_for_hash}` will not be
952    receivable using versions prior to 0.0.104.
953    `ChannelManager::create_inbound_payment{,_for_hash}_legacy` are provided for
954    backwards compatibility (#1177).
955  * `PaymentPurpose::InvoicePayment::user_payment_id` will be 0 when reading
956    objects written with 0.0.104 when read by 0.0.103 and previous (#1180).
957
958 In total, this release features 51 files changed, 5356 insertions, 2238
959 deletions in 107 commits from 9 authors, in alphabetical order:
960  * Antoine Riard
961  * Conor Okus
962  * Devrandom
963  * Duncan Dean
964  * Elias Rohrer
965  * Jeffrey Czyz
966  * Ken Sedgwick
967  * Matt Corallo
968  * Valentine Wallace
969
970
971 # 0.0.103 - 2021-11-02
972
973 ## API Updates
974  * This release is almost entirely focused on a new API in the
975    `lightning-invoice` crate - the `InvoicePayer`. `InvoicePayer` is a
976    struct which takes a reference to a `ChannelManager` and a `Router`
977    and retries payments as paths fail. It limits retries to a configurable
978    number, but is not serialized to disk and may retry additional times across
979    a serialization/load. In order to learn about failed payments, it must
980    receive `Event`s directly from the `ChannelManager`, wrapping a
981    user-provided `EventHandler` which it provides all unhandled events to
982    (#1059).
983  * `get_route` has been renamed `find_route` (#1059) and now takes a
984    `RouteParameters` struct in replacement of a number of its long list of
985    arguments (#1134). The `Payee` in the `RouteParameters` is stored in the
986    `Route` object returned and provided in the `RouteParameters` contained in
987    `Event::PaymentPathFailed` (#1059).
988  * `ChannelMonitor`s must now be persisted after calls that provide new block
989    data, prior to `MonitorEvent`s being passed back to `ChannelManager` for
990    processing. If you are using a `ChainMonitor` this is handled for you.
991    The `Persist` API has been updated to `Option`ally take the
992    `ChannelMonitorUpdate` as persistence events that result from chain data no
993    longer have a corresponding update (#1108).
994  * `routing::Score` now has a `payment_path_failed` method which it can use to
995    learn which channels often fail payments. It is automatically called by
996    `InvoicePayer` for failed payment paths (#1144).
997  * The default `Scorer` implementation is now a type alias to a type generic
998    across different clocks and supports serialization to persist scoring data
999    across restarts (#1146).
1000  * `Event::PaymentSent` now includes the full fee which was spent across all
1001    payment paths which were fulfilled or pending when the payment was fulfilled
1002    (#1142).
1003  * `Event::PaymentSent` and `Event::PaymentPathFailed` now include the
1004    `PaymentId` which matches the `PaymentId` returned from
1005    `ChannelManager::send_payment` or `InvoicePayer::pay_invoice` (#1059).
1006  * `NetGraphMsgHandler` now takes a `Deref` to the `NetworkGraph`, allowing for
1007    shared references to the graph data to make serialization and references to
1008    the graph data in the `InvoicePayer`'s `Router` simpler (#1149).
1009  * `routing::Score::channel_penalty_msat` has been updated to provide the
1010    `NodeId` of both the source and destination nodes of a channel (#1133).
1011
1012 ## Bug Fixes
1013  * Previous versions would often disconnect peers during initial graph sync due
1014    to ping timeouts while processing large numbers of gossip messages. We now
1015    delay disconnecting peers if we receive messages from them even if it takes
1016    a while to receive a pong from them. Further, we avoid sending too many
1017    gossip messages between pings to ensure we should always receive pongs in a
1018    timely manner (#1137).
1019  * If a payment was sent, creating an outbound HTLC and sending it to our
1020    counterparty (implying the `ChannelMonitor` was persisted on disk), but the
1021    `ChannelManager` was not persisted prior to shutdown/crash, no
1022    `Event::PaymentPathFailed` event was generated if the HTLC was eventually
1023    failed on chain. Events are now consistent irrespective of `ChannelManager`
1024    persistence or non-persistence (#1104).
1025
1026 ## Serialization Compatibility
1027  * All above new Events/fields are ignored by prior clients. All above new
1028    Events/fields are not present when reading objects serialized by prior
1029    versions of the library.
1030  * Payments for which a `Route` was generated using a previous version or for
1031    which the payment was originally sent by a previous version of the library
1032    will not be retried by an `InvoicePayer`.
1033
1034 This release was singularly focused and some contributions by third parties
1035 were delayed.
1036 In total, this release features 38 files changed, 4414 insertions, and 969
1037 deletions in 71 commits from 2 authors, in alphabetical order:
1038
1039  * Jeffrey Czyz
1040  * Matt Corallo
1041
1042
1043 # 0.0.102 - 2021-10-18
1044
1045 ## API Updates
1046  * `get_route` now takes a `Score` as an argument. `Score` is queried during
1047    the route-finding process, returning the absolute amounts which you are
1048    willing to pay to avoid routing over a given channel. As a default, a
1049    `Scorer` is provided which returns a constant amount, with a suggested
1050    default of 500 msat. This translates to a willingness to pay up to 500 msat
1051    in additional fees per hop in order to avoid additional hops (#1124).
1052  * `Event::PaymentPathFailed` now contains a `short_channel_id` field which may
1053    be filled in with a channel that can be "blamed" for the payment failure.
1054    Payment retries should likely avoid the given channel for some time (#1077).
1055  * `PublicKey`s in `NetworkGraph` have been replaced with a `NodeId` struct
1056    which contains only a simple `[u8; 33]`, substantially improving
1057    `NetworkGraph` deserialization performance (#1107).
1058  * `ChainMonitor`'s `HashMap` of `ChannelMonitor`s is now private, exposed via
1059    `Chainmonitor::get_monitor` and `ChainMonitor::list_monitors` instead
1060    (#1112).
1061  * When an outbound channel is closed prior to the broadcasting of its funding
1062    transaction, but after you call
1063    `ChannelManager::funding_transaction_generated`, a new event type,
1064    `Event::DiscardFunding`, is generated, informing you the transaction was not
1065    broadcasted and that you can spend the same inputs again elsewhere (#1098).
1066  * `ChannelManager::create_channel` now returns the temporary channel ID which
1067    may later appear in `Event::ChannelClosed` or `ChannelDetails` prior to the
1068    channel being funded (#1121).
1069  * `Event::PaymentSent` now contains the payment hash as well as the payment
1070    preimage (#1062).
1071  * `ReadOnlyNetworkGraph::get_addresses` now returns owned `NetAddress` rather
1072    than references. As a side-effect this method is now exposed in foreign
1073    language bindings (#1115).
1074  * The `Persist` and `ChannelMonitorUpdateErr` types have moved to the
1075    `lightning::chain::chainmonitor` and `lightning::chain` modules,
1076    respectively (#1112).
1077  * `ChannelManager::send_payment` now returns a `PaymentId` which identifies a
1078    payment (whether MPP or not) and can be used to retry the full payment or
1079    MPP parts through `retry_payment` (#1096). Note that doing so is currently
1080    *not* crash safe, and you may find yourself sending twice. It is recommended
1081    that you *not* use the `retry_payment` API until the next release.
1082
1083 ## Bug Fixes
1084  * Due to an earlier fix for the Lightning dust inflation vulnerability tracked
1085    in CVE-2021-41591/CVE-2021-41592/CVE-2021-41593 in 0.0.100, we required
1086    counterparties to accept a dust limit slightly lower than the dust limit now
1087    required by other implementations. This appeared as, at least, latest lnd
1088    always refusing to accept channels opened by LDK clients (#1065).
1089  * If there are multiple channels available to the same counterparty,
1090    `get_route` would only consider the channel listed last as available for
1091    sending (#1100).
1092  * `Persist` implementations returning
1093    `ChannelMonitorUpdateErr::TemporaryFailure` from `watch_channel` previously
1094    resulted in the `ChannelMonitor` not being stored at all, resulting in a
1095    panic after monitor updating is complete (#1112).
1096  * If payments are pending awaiting forwarding at startup, an
1097    `Event::PendingHTLCsForwardable` event will always be provided. This ensures
1098    user code calls `ChannelManager::process_pending_htlc_fowards` even if it
1099    shut down while awaiting the batching timer during the previous run (#1076).
1100  * If a call to `ChannelManager::send_payment` failed due to lack of
1101    availability of funds locally, LDK would store the payment as pending
1102    forever, with no ability to retry or fail it, leaking memory (#1109).
1103
1104 ## Serialization Compatibility
1105  * All above new Events/fields are ignored by prior clients. All above new
1106    Events/fields, except for `Event::PaymentSent::payment_hash` are not present
1107    when reading objects serialized by prior versions of the library.
1108
1109 In total, this release features 32 files changed, 2248 insertions, and 1483
1110 deletions in 51 commits from 7 authors, in alphabetical order:
1111
1112  * 1nF0rmed
1113  * Duncan Dean
1114  * Elias Rohrer
1115  * Galder Zamarreño
1116  * Jeffrey Czyz
1117  * Matt Corallo
1118  * Valentine Wallace
1119
1120
1121 # 0.0.101 - 2021-09-23
1122
1123 ## API Updates
1124  * Custom message types are now supported directly in the `PeerManager`,
1125    allowing you to send and receive messages of any type that is not natively
1126    understood by LDK. This requires a new type bound on `PeerManager`, a
1127    `CustomMessageHandler`. `IgnoringMessageHandler` provides a simple default
1128    for this new bound for ignoring unknown messages (#1031, #1074).
1129  * Route graph updates as a result of failed payments are no longer provided as
1130    `MessageSendEvent::PaymentFailureNetworkUpdate` but instead included in a
1131    new field in the `Event::PaymentFailed` events. Generally, this means route
1132    graph updates are no longer handled as a part of the `PeerManager` but
1133    instead through the new `EventHandler` implementation for
1134    `NetGraphMsgHandler`. To make this easy, a new parameter to
1135    `lightning-background-processor::BackgroundProcessor::start` is added, which
1136    contains an `Option`al `NetGraphmsgHandler`. If provided as `Some`, relevant
1137    events will be processed by the `NetGraphMsgHandler` prior to normal event
1138    handling (#1043).
1139  * `NetworkGraph` is now, itself, thread-safe. Accordingly, most functions now
1140    take `&self` instead of `&mut self` and the graph data can be accessed
1141    through `NetworkGraph.read_only` (#1043).
1142  * The balances available on-chain to claim after a channel has been closed are
1143    now exposed via `ChannelMonitor::get_claimable_balances` and
1144    `ChainMonitor::get_claimable_balances`. The second can be used to get
1145    information about all closed channels which still have on-chain balances
1146    associated with them. See enum variants of `ln::channelmonitor::Balance` and
1147    method documentation for the above methods for more information on the types
1148    of balances exposed (#1034).
1149  * When one HTLC of a multi-path payment fails, the new field `all_paths_failed`
1150    in `Event::PaymentFailed` is set to `false`. This implies that the payment
1151    has not failed, but only one part. Payment resolution is only indicated by an
1152    `Event::PaymentSent` event or an `Event::PaymentFailed` with
1153    `all_paths_failed` set to `true`, which is also set for the last remaining
1154    part of a multi-path payment (#1053).
1155  * To better capture the context described above, `Event::PaymentFailed` has
1156    been renamed to `Event::PaymentPathFailed` (#1084).
1157  * A new event, `ChannelClosed`, is provided by `ChannelManager` when a channel
1158    is closed, including a reason and error message (if relevant, #997).
1159  * `lightning-invoice` now considers invoices with sub-millisatoshi precision
1160    to be invalid, and requires millisatoshi values during construction (thus
1161    you must call `amount_milli_satoshis` instead of `amount_pico_btc`, #1057).
1162  * The `BaseSign` interface now includes two new hooks which provide additional
1163    information about commitment transaction signatures and revocation secrets
1164    provided by our counterparty, allowing additional verification (#1039).
1165  * The `BaseSign` interface now includes additional information for cooperative
1166    close transactions, making it easier for a signer to verify requests (#1064).
1167  * `Route` has two additional helper methods to get fees and amounts (#1063).
1168  * `Txid` and `Transaction` objects can now be deserialized from responses when
1169    using the HTTP client in the `lightning-block-sync` crate (#1037, #1061).
1170
1171 ## Bug Fixes
1172  * Fix a panic when reading a lightning invoice with a non-recoverable
1173    signature. Further, restrict lightning invoice parsing to require payment
1174    secrets and better handle a few edge cases as required by BOLT 11 (#1057).
1175  * Fix a panic when receiving multiple messages (such as HTLC fulfill messages)
1176    after a call to `chain::Watch::update_channel` returned
1177    `Err(ChannelMonitorUpdateErr::TemporaryFailure)` with no
1178    `ChannelManager::channel_monitor_updated` call in between (#1066).
1179  * For multi-path payments, `Event::PaymentSent` is no longer generated
1180    multiple times, once for each independent part (#1053).
1181  * Multi-hop route hints in invoices are now considered in the default router
1182    provided via `get_route` (#1040).
1183  * The time peers have to respond to pings has been increased when building
1184    with debug assertions enabled. This avoids peer disconnections on slow hosts
1185    when running in debug mode (#1051).
1186  * The timeout for the first byte of a response for requests from the
1187    `lightning-block-sync` crate has been increased to 300 seconds to better
1188    handle the long hangs in Bitcoin Core when it syncs to disk (#1090).
1189
1190 ## Serialization Compatibility
1191  * Due to a bug in 0.0.100, `Event`s written by 0.0.101 which are of a type not
1192    understood by 0.0.100 may lead to `Err(DecodeError::InvalidValue)` or corrupt
1193    deserialized objects in 0.100. Such `Event`s will lead to an
1194    `Err(DecodeError::InvalidValue)` in versions prior to 0.0.100. The only such
1195    new event written by 0.0.101 is `Event::ChannelClosed` (#1087).
1196  * Payments that were initiated in versions prior to 0.0.101 may still
1197    generate duplicate `PaymentSent` `Event`s or may have spurious values for
1198    `Event::PaymentPathFailed::all_paths_failed` (#1053).
1199  * The return values of `ChannelMonitor::get_claimable_balances` (and, thus,
1200    `ChainMonitor::get_claimable_balances`) may be spurious for channels where
1201    the spend of the funding transaction appeared on chain while running a
1202    version prior to 0.0.101. `Balance` information should only be relied upon
1203    for channels that were closed while running 0.0.101+ (#1034).
1204  * Payments failed while running versions prior to 0.0.101 will never have a
1205    `Some` for the `network_update` field (#1043).
1206
1207 In total, this release features 67 files changed, 4980 insertions, 1888
1208 deletions in 89 commits from 12 authors, in alphabetical order:
1209  * Antoine Riard
1210  * Devrandom
1211  * Galder Zamarreño
1212  * Giles Cope
1213  * Jeffrey Czyz
1214  * Joseph Goulden
1215  * Matt Corallo
1216  * Sergi Delgado Segura
1217  * Tibo-lg
1218  * Valentine Wallace
1219  * abhik-99
1220  * vss96
1221
1222
1223 # 0.0.100 - 2021-08-17 - "Oh, so *that's* what's going on inside the box"
1224
1225 ## API Updates
1226  * The `lightning` crate can now be built in no_std mode, making it easy to
1227    target embedded hardware for rust users. Note that mutexes are replaced with
1228    no-ops for such builds (#1008, #1028).
1229  * LDK now supports sending and receiving "keysend" payments. This includes
1230    modifications to `lightning::util::events::Event::PaymentReceived` to
1231    indicate the type of payment (#967).
1232  * A new variant, `lightning::util::events::Event::PaymentForwarded` has been
1233    added which indicates a forwarded payment has been successfully claimed and
1234    we've received a forwarding fee (#1004).
1235  * `lightning::chain::keysinterface::KeysInterface::get_shutdown_pubkey` has
1236    been renamed to `get_shutdown_scriptpubkey`, returns a script, and is now
1237    called on channel open only if
1238    `lightning::util::config::ChannelConfig::commit_upfront_shutdown_pubkey` is
1239    set (#1019).
1240  * Closing-signed negotiation is now more configurable, with an explicit
1241    `lightning::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis`
1242    field allowing you to select the maximum amount you are willing to pay to
1243    avoid a force-closure. Further, we are now less restrictive on the fee
1244    placed on the closing transaction when we are not the party paying it. To
1245    control the feerate paid on a channel at close-time, use
1246    `ChannelManager::close_channel_with_target_feerate` instead of
1247    `close_channel` (#1011).
1248  * `lightning_background_processor::BackgroundProcessor` now stops the
1249    background thread when dropped (#1007). It is marked `#[must_use]` so that
1250    Rust users will receive a compile-time warning when it is immediately
1251    dropped after construction (#1029).
1252  * Total potential funds burn on force-close due to dust outputs is now limited
1253    to `lightning::util::config::ChannelConfig::max_dust_htlc_exposure_msat` per
1254    channel (#1009).
1255  * The interval on which
1256    `lightning::ln::peer_handler::PeerManager::timer_tick_occurred` should be
1257    called has been reduced to once every five seconds (#1035) and
1258    `lightning::ln::channelmanager::ChannelManager::timer_tick_occurred` should
1259    now be called on startup in addition to once per minute (#985).
1260  * The rust-bitcoin and bech32 dependencies have been updated to their
1261    respective latest versions (0.27 and 0.8, #1012).
1262
1263 ## Bug Fixes
1264  * Fix panic when reading invoices generated by some versions of c-lightning
1265    (#1002 and #1003).
1266  * Fix panic when attempting to validate a signed message of incorrect length
1267    (#1010).
1268  * Do not ignore the route hints in invoices when the invoice is over 250k
1269    sats (#986).
1270  * Fees are automatically updated on outbound channels to ensure commitment
1271    transactions are always broadcastable (#985).
1272  * Fixes a rare case where a `lightning::util::events::Event::SpendableOutputs`
1273    event is not generated after a counterparty commitment transaction is
1274    confirmed in a reorg when a conflicting local commitment transaction is
1275    removed in the same reorg (#1022).
1276  * Fixes a remotely-triggerable force-closure of an origin channel after an
1277    HTLC was forwarded over a next-hop channel and the next-hop channel was
1278    force-closed by our counterparty (#1025).
1279  * Fixes a rare force-closure case when sending a payment as a channel fundee
1280    when overdrawing our remaining balance. Instead the send will fail (#998).
1281  * Fixes a rare force-closure case when a payment was claimed prior to a
1282    peer disconnection or restart, and later failed (#977).
1283
1284 ## Serialization Compatibility
1285  * Pending inbound keysend payments which have neither been failed nor claimed
1286    when serialized will result in a `ChannelManager` which is not readable on
1287    pre-0.0.100 clients (#967).
1288  * Because
1289    `lightning::chain::keysinterface::KeysInterface::get_shutdown_scriptpubkey`
1290    has been updated to return a script instead of only a `PublicKey`,
1291    `ChannelManager`s constructed with custom `KeysInterface` implementations on
1292    0.0.100 and later versions will not be readable on previous versions.
1293    `ChannelManager`s created with 0.0.99 and prior versions will remain readable
1294    even after the a serialization roundtrip on 0.0.100, as long as no new
1295    channels are opened. Further, users using a
1296    `lightning::chain::keysinterface::KeysManager` as their `KeysInterface` will
1297    have `ChannelManager`s which are readable on prior versions as well (#1019).
1298  * `ChannelMonitorUpdate`s created by 0.0.100 and later for channels when
1299    `lightning::util::config::ChannelConfig::commit_upfront_shutdown_pubkey` is
1300    not set may not be readable by versions prior to 0.0.100 (#1019).
1301  * HTLCs which were in the process of being claimed on-chain when a pre-0.0.100
1302    `ChannelMonitor` was serialized may generate `PaymentForwarded` events with
1303    spurious `fee_earned_msat` values. This only applies to payments which were
1304    unresolved at the time of the upgrade (#1004).
1305  * 0.0.100 clients with pending `Event::PaymentForwarded` events at
1306    serialization-time will generate serialized `ChannelManager` objects which
1307    0.0.99 and earlier clients cannot read. The likelihood of this can be reduced
1308    by ensuring you process all pending events immediately before serialization
1309    (as is done by the `lightning-background-processor` crate, #1004).
1310
1311
1312 In total, this release features 59 files changed, 5861 insertions, and 2082
1313 deletions in 95 commits from 6 authors.
1314
1315
1316 # 0.0.99 - 2021-07-09 - "It's a Bugz Life"
1317
1318 ## API Updates
1319
1320  * `lightning_block_sync::poll::Validate` is now public, allowing you to
1321    implement the `lightning_block_sync::poll::Poll` trait without
1322    `lightning_block_sync::poll::ChainPoller` (#956).
1323  * `lightning::ln::peer_handler::PeerManager` no longer requires that no calls
1324    are made to referencing the same `SocketDescriptor` after
1325    `disconnect_socket` returns. This makes the API significantly less
1326    deadlock-prone and simplifies `SocketDescriptor` implementations
1327    significantly. The relevant changes have been made to `lightning_net_tokio`
1328    and `PeerManager` documentation has been substantially rewritten (#957).
1329  * `lightning::util::message_signing`'s `sign` and `verify` methods now take
1330    secret and public keys by reference instead of value (#974).
1331  * Substantially more information is now exposed about channels in
1332    `ChannelDetails`. See documentation for more info (#984 and #988).
1333  * The latest best block seen is now exposed in
1334    `ChannelManager::current_best_block` and
1335    `ChannelMonitor::current_best_block` (#984).
1336  * Feerates charged when forwarding payments over channels is now set in
1337    `ChannelConfig::fee_base_msat` when the channel is opened. For existing
1338    channels, the value is set to the value provided in
1339    `ChannelManagerReadArgs::default_config::channel_options` the first time the
1340    `ChannelManager` is loaded in 0.0.99 (#975).
1341  * We now reject HTLCs which are received to be forwarded over private channels
1342    unless `UserConfig::accept_forwards_to_priv_channels` is set. Note that
1343    `UserConfig` is never serialized and must be provided via
1344    `ChannelManagerReadArgs::default_config` at each start (#975).
1345
1346 ## Bug Fixes
1347
1348  * We now forward gossip messages to peers instead of only relaying
1349    locally-generated gossip or sending gossip messages during initial sync
1350    (#948).
1351  * Correctly send `channel_update` messages to direct peers on private channels
1352    (#949). Without this, a private node connected to an LDK node over a private
1353    channel cannot receive funds as it does not know which fees the LDK node
1354    will charge.
1355  * `lightning::ln::channelmanager::ChannelManager` no longer expects to be
1356    persisted spuriously after we receive a `channel_update` message about any
1357    channel in the routing gossip (#972).
1358  * Asynchronous `ChannelMonitor` updates (using the
1359    `ChannelMonitorUpdateErr::TemporaryFailure` return variant) no longer cause
1360    spurious HTLC forwarding failures (#954).
1361  * Transaction provided via `ChannelMonitor::transactions_confirmed`
1362    after `ChannelMonitor::best_block_updated` was called for a much later
1363    block now trigger all relevant actions as of the later block. Previously
1364    some transaction broadcasts or other responses required an additional
1365    block be provided via `ChannelMonitor::best_block_updated` (#970).
1366  * We no longer panic in rare cases when an invoice contained last-hop route
1367    hints which were unusable (#958).
1368
1369 ## Node Compatibility
1370
1371  * We now accept spurious `funding_locked` messages sent prior to
1372    `channel_reestablish` messages after reconnect. This is a
1373    [known, long-standing bug in lnd](https://github.com/lightningnetwork/lnd/issues/4006)
1374    (#966).
1375  * We now set the `first_blocknum` and `number_of_blocks` fields in
1376    `reply_channel_range` messages to values which c-lightning versions prior to
1377    0.10 accepted. This avoids spurious force-closes from such nodes (#961).
1378
1379 ## Serialization Compatibility
1380
1381  * Due to a bug discovered in 0.0.98, if a `ChannelManager` is serialized on
1382    version 0.0.98 while an `Event::PaymentSent` is pending processing, the
1383    `ChannelManager` will fail to deserialize both on version 0.0.98 and later
1384    versions. If you have such a `ChannelManager` available, a simple patch will
1385    allow it to deserialize. Please file an issue if you need assistance (#973).
1386
1387 # 0.0.98 - 2021-06-11 - "It's ALIVVVVEEEEEEE"
1388
1389 0.0.98 should be considered a release candidate to the first alpha release of
1390 Rust-Lightning and the broader LDK. It represents several years of work
1391 designing and fine-tuning a flexible API for integrating lightning into any
1392 application. LDK should make it easy to build a lightning node or client which
1393 meets specific requirements that other lightning node software cannot. As
1394 lightning continues to evolve, and new use-cases for lightning develop, the API
1395 of LDK will continue to change and expand. However, starting with version 0.1,
1396 objects serialized with prior versions will be readable with the latest LDK.
1397 While Rust-Lightning is approaching the 0.1 milestone, language bindings
1398 components of LDK available at https://github.com/lightningdevkit are still of
1399 varying quality. Some are also approaching an 0.1 release, while others are
1400 still much more experimental. Please note that, at 0.0.98, using Rust-Lightning
1401 on mainnet is *strongly* discouraged.