]> git.bitcoin.ninja Git - rust-lightning/blob - CHANGELOG.md
Track channels which a given payment part failed to traverse
[rust-lightning] / CHANGELOG.md
1 # 0.0.109 - 2022-07-01
2
3 ## API Updates
4  * `ChannelManager::update_channel_config` has been added to allow the fields
5    in `ChannelConfig` to be changed in a given channel after open (#1527).
6  * If we reconnect to a peer which proves we have a stale channel state, rather
7    than force-closing we will instead panic to provide an opportunity to switch
8    to the latest state and continue operating without channel loss (#1564).
9  * A `NodeAlias` struct has been added which handles string sanitization for
10    node aliases via the `Display` trait (#1544).
11  * `ProbabilisticScoringParameters` now has a `banned_nodes` set which we will
12     never route through during path finding (#1550).
13  * `ProbabilisticScoringParameters` now offers an `anti_probing_penalty_msat`
14    option to prefer channels which afford better privacy when routing (#1555).
15  * `ProbabilisticScorer` now provides access to its estimated liquidity range
16    for a given channel via `estimated_channel_liquidity_range` (#1549).
17  * `ChannelManager::force_close_channel` has been renamed
18    `force_close_broadcasting_latest_txn` and
19    `force_close_without_broadcasting_txn` has been added (#1564).
20  * Options which cannot be changed at runtime have been moved from
21    `ChannelConfig` to `ChannelHandshakeConfig` (#1529).
22  * `find_route` takes `&NetworkGraph` instead of `ReadOnlyNetworkGraph (#1583).
23  * `ChannelDetails` now contains a copy of the current `ChannelConfig` (#1527).
24  * The `lightning-invoice` crate now optionally depends on `serde`, with
25    `Invoice` implementing `serde::{Deserialize,Serialize}` if enabled (#1548).
26  * Several fields in `UserConfig` have been renamed for clarity (#1540).
27
28 ## Bug Fixes
29  * `find_route` no longer selects routes with more than
30    `PaymentParameters::max_mpp_path_count` paths, and
31    `ChannelManager::send_payment` no longer refuses to send along routes with
32    more than ten paths (#1526).
33  * Fixed two cases where HTLCs pending at the time a counterparty broadcasts a
34    revoked commitment transaction are considered resolved prior to their actual
35    resolution on-chain, possibly passing the update to another channel (#1486).
36  * HTLCs which are relayed through LDK may now have a total expiry time two
37    weeks in the future, up from one, reducing forwarding failures (#1532).
38
39 ## Serialization Compatibility
40  * All new fields are ignored by prior versions of LDK. All new fields are not
41    present when reading objects serialized by prior versions of LDK.
42  * `ChannelConfig`'s serialization format has changed and is not compatible
43    with any previous version of LDK. Attempts to read values written by a
44    previous version of LDK will fail and attempts to read newly written objects
45    using a previous version of LDK will fail. It is not expected that users are
46    serializing `ChannelConfig` using the LDK serialization API, however, if a
47    backward compatibility wrapper is required, please open an issue.
48
49 ## Security
50 0.0.109 fixes a denial-of-service vulnerability which is reachable from
51 untrusted input in some application deployments.
52
53  * Third parties which are allowed to open channels with an LDK-based node may
54    fund a channel with a bogus and maliciously-crafted transaction which, when
55    spent, can cause a panic in the channel's corresponding `ChannelMonitor`.
56    Such a channel is never usable as it cannot be funded with a funding
57    transaction which matches the required output script, allowing the
58    `ChannelMonitor` for such channels to be safely purged as a workaround on
59    previous versions of LDK. Thanks to Eugene Siegel for reporting this issue.
60
61 In total, this release features 32 files changed, 1948 insertions, 532
62 deletions in 33 commits from 9 authors, in alphabetical order:
63  * Antoine Riard
64  * Daniel Granhão
65  * Elias Rohrer
66  * Jeffrey Czyz
67  * Matt Corallo
68  * Matt Faltyn
69  * NicolaLS
70  * Valentine Wallace
71  * Wilmer Paulino
72
73
74 # 0.0.108 - 2022-06-10
75
76 ## Bug Fixes
77  * Fixed `lightning-background-processor` build in release mode.
78
79 In total, this release features 9 files changed, 120 insertions, 74
80 deletions in 5 commits from 4 authors, in alphabetical order:
81  * Elias Rohrer
82  * Matt Corallo
83  * Max Fang
84  * Viktor Tigerström
85
86 # 0.0.107 - 2022-06-08
87
88 ## API Updates
89  * Channels larger than 16777215 sats (Wumbo!) are now supported and can be
90    enabled for inbound channels using
91    `ChannelHandshakeLimits::max_funding_satoshis` (#1425).
92  * Support for feature `option_zeroconf`, allowing immediate forwarding of
93    payments after channel opening. This is configured for outbound channels
94    using `ChannelHandshakeLimits::trust_own_funding_0conf` whereas
95    `ChannelManager::accept_inbound_channel_from_trusted_peer_0conf` has to be
96    used for accepting inbound channels (#1401, #1505).
97  * `ChannelManager::claim_funds` no longer returns a `bool` to indicate success.
98    Instead, an `Event::PaymentClaimed` is generated if the claim was successful.
99    Likewise, `ChannelManager::fail_htlc_backwards` no longer has a return value
100    (#1434).
101  * `lightning-rapid-gossip-sync` is a new crate for syncing gossip data from a
102    server, primarily aimed at mobile devices (#1155).
103  * `RapidGossipSync` can be passed to `BackgroundProcessor` in order to persist
104    the `NetworkGraph` and handle `NetworkUpdate`s during event handling (#1433,
105    #1517).
106  * `NetGraphMsgHandler` has been renamed to `P2PGossipSync`, the `network_graph`
107     module has been renamed to `gossip`, and `NetworkUpdate::ChannelClosed` has
108    been renamed `NetworkUpdate::ChannelFailure` (#1159).
109  * Added a `filtered_block_connected` method to `chain::Listen` and a default
110    implementation of `block_connected` for those fetching filtered instead of
111    full blocks (#1453).
112  * The `lightning-block-sync` crate's `BlockSource` trait methods now take
113    `&self` instead of `&mut self` (#1307).
114  * `inbound_payment` module is now public to allow for creating invoices without
115    a `ChannelManager` (#1384).
116  * `lightning-block-sync`'s `init` and `poll` modules support `&dyn BlockSource`
117    which can be determined at runtime (#1423).
118  * `lightning-invoice` crate's `utils` now accept an expiration time (#1422,
119    #1474).
120  * `Event::PaymentForwarded` includes `prev_channel_id` and `next_channel_id`
121    (#1419, #1475).
122  * `chain::Watch::release_pending_monitor_events`' return type now associates
123    `MonitorEvent`s with funding `OutPoints` (#1475).
124  * `lightning-background-processor` crate's `Persister` trait has been moved to
125    `lightning` crate's `util::persist` module, which now has a general
126    `KVStorePersister` trait. Blanket implementations of `Persister` and
127    `chainmonitor::Persist` are given for types implementing `KVStorePersister`.
128    ` lightning-persister`'s `FilesystemPersister` implements `KVStorePersister`
129    (#1417).
130  * `ChannelDetails` and `ChannelCounterparty` include fields for HTLC minimum
131    and maximum values (#1378).
132  * Added a `max_inbound_htlc_value_in_flight_percent_of_channel` field to
133    `ChannelHandshakeConfig`, capping the total value of outstanding inbound
134    HTLCs for a channel (#1444).
135  * `ProbabilisticScorer` is parameterized by a `Logger`, which it uses to log
136    channel liquidity updates or lack thereof (#1405).
137  * `ChannelDetails` has an `outbound_htlc_limit_msat` field, which should be
138    used in routing instead of `outbound_capacity_msat` (#1435).
139  * `ProbabilisticScorer`'s channel liquidities can be logged via
140    `debug_log_liquidity_stats` (#1460).
141  * `BackgroundProcessor` now takes an optional `WriteableScore` which it will
142    persist using the `Persister` trait's new `persist_scorer` method (#1416).
143  * Upgraded to `bitcoin` crate version 0.28.1 (#1389).
144  * `ShutdownScript::new_witness_program` now takes a `WitnessVersion` instead of
145    a `NonZeroU8` (#1389).
146  * Channels will no longer be automatically force closed when the counterparty
147    is disconnected due to incompatibility (#1429).
148  * `ChannelManager` methods for funding, accepting, and closing channels now
149    take a `counterparty_node_id` parameter, which has also been added as a field
150    to `Event::FundingGenerationReady` (#1479, #1485).
151  * `InvoicePayer::new` now takes a `Retry` enum (replacing the `RetryAttempts`
152    struct), which supports both attempt- and timeout-based retrying (#1418).
153  * `Score::channel_penalty_msat` takes a `ChannelUsage` struct, which contains
154    the capacity as an `EffectiveCapacity` enum and any potential in-flight HTLC
155    value, rather than a single `u64`. Used by `ProbabilisticScorer` for more
156    accurate penalties (#1456).
157  * `build_route_from_hops` is a new function useful for constructing a `Route`
158    given a specific list of public keys (#1491).
159  * `FundingLocked` message has been renamed `ChannelReady`, and related
160    identifiers have been renamed accordingly (#1506).
161  * `core2::io` or `std::io` (depending on feature flags `no-std` or `std`) is
162    exported as a `lightning::io` module (#1504).
163  * The deprecated `Scorer` has been removed in favor or `ProbabilisticScorer`
164    (#1512).
165
166 ## Performance Improvements
167  * `lightning-persister` crate's `FilesystemPersister` is faster by 15x (#1404).
168  * Log gossip query messages at `GOSSIP` instead of `TRACE` to avoid
169    overwhelming default logging (#1421).
170  * `PeerManager` supports processing messages from different peers in parallel,
171    and this is taken advantage of in gossip processing (#1023).
172  * Greatly reduced per-channel and per-node memory usage due to upgrade of
173    `secp256k1` crate to 0.22.1 and `bitcoin` crate to 0.28.1
174  * Reduced per-peer memory usage in `PeerManager` (#1472).
175
176 ## Spec Compliance
177  * `find_route` now assumes variable-length onions by default for nodes where
178    support for the feature is unknown (#1414).
179  * A `warn` message is now sent when receiving a `channel_reestablish` with an
180    old commitment transaction number rather than immediately force-closing the
181    channel (#1430).
182  * When a `channel_update` message is included in an onion error's `failuremsg`,
183    its message type is now encoded. Reading such messages is also supported
184    (#1465).
185
186 ## Bug Fixes
187  * Fixed a bug where crashing while persisting a `ChannelMonitorUpdate` for a
188    part of a multi-path payment could cause loss of funds due to a partial
189    payment claim on restart (#1434).
190  * `BackgroundProcessor` has been fixed to improve serialization reliability on
191    slow systems which can avoid force-closes (#1436).
192  * `gossip_timestamp_filter` filters are now honored when sending gossip to
193    peers (#1452).
194  * During a reorg, only force-close a channel if its funding transaction is
195    unconfirmed rather than as it loses confirmations (#1461).
196  * Fixed a rare panic in `lightning-net-tokio` when fetching a peer's socket
197    address after the connection has been closed caused by a race condition
198    (#1449).
199  * `find_route` will no longer return routes that would cause onion construction
200    to fail in some cases (#1476).
201  * `ProbabilisticScorer` uses more precision when approximating `log10` (#1406).
202
203 ## Serialization Compatibility
204  * All above new events/fields are ignored by prior clients. All above new
205    events/fields are not present when reading objects serialized by prior
206    versions of the library.
207  * `ChannelManager` serialization is no longer compatible with versions prior to
208    0.0.99 (#1401).
209  * Channels with `option_zeroconf` feature enabled (not required for 0-conf
210    channel use) will be unreadable by versions prior to 0.0.107 (#1401, #1505).
211
212 In total, this release features 96 files changed, 9304 insertions, 4503
213 deletions in 153 commits from 18 authors, in alphabetical order:
214  * Arik Sosman
215  * Devrandom
216  * Duncan Dean
217  * Elias Rohrer
218  * Jeffrey Czyz
219  * John Cantrell
220  * John Corser
221  * Jurvis Tan
222  * Justin Moon
223  * KaFai Choi
224  * Matt Faltyn
225  * Matt Corallo
226  * Valentine Wallace
227  * Viktor Tigerström
228  * Vincenzo Palazzo
229  * atalw
230  * dependabot[bot]
231  * shamardy
232
233
234 # 0.0.106 - 2022-04-03
235
236 ## API Updates
237  * Minimum supported rust version (MSRV) is now 1.41.1 (#1310).
238  * Lightning feature `option_scid_alias` is now supported and may be negotiated
239    when opening a channel with a peer. It can be configured via
240    `ChannelHandshakeConfig::negotiate_scid_privacy` and is off by default but
241    will be on by default in the future (#1351).
242  * `OpenChannelRequest` now has a `channel_type` field indicating the features
243    the channel will operate with and should be used to filter channels with
244    undesirable features (#1351). See the Serialization Compatibility section.
245  * `ChannelManager` supports sending and receiving short channel id aliases in
246    the `funding_locked` message. These are used when forwarding payments and
247    constructing invoice route hints for improved privacy. `ChannelDetails` has a
248    `inbound_scid_alias` field and a `get_inbound_payment_scid` method to support
249    the latter (#1311).
250  * `DefaultRouter` and `find_route` take an additional random seed to improve
251    privacy by adding a random CLTV expiry offset to each path's final hop. This
252    helps obscure the intended recipient from adversarial intermediate hops
253    (#1286). The seed is  also used to randomize candidate paths during route
254    selection (#1359).
255  * The `lightning-block-sync` crate's `init::synchronize_listeners` method
256    interface has been relaxed to support multithreaded environments (#1349).
257  * `ChannelManager::create_inbound_payment_for_hash`'s documentation has been
258    corrected to remove the one-year restriction on `invoice_expiry_delta_secs`,
259    which is only applicable to the deprecated `create_inbound_payment_legacy`
260    and `create_inbound_payment_for_hash_legacy` methods (#1341).
261  * `Features` mutator methods now take `self` by reference instead of by value
262    (#1331).
263  * The CLTV of the last hop in a path is now included when comparing against
264    `RouteParameters::max_total_cltv_expiry_delta` (#1358).
265  * Invoice creation functions in `lightning-invoice` crate's `utils` module
266    include versions that accept a description hash instead of only a description
267    (#1361).
268  * `RoutingMessageHandler::sync_routing_table` has been renamed `peer_connected`
269    (#1368).
270  * `MessageSendEvent::SendGossipTimestampFilter` has been added to indicate that
271    a `gossip_timestamp_filter` should be sent (#1368).
272  * `PeerManager` takes an optional `NetAddress` in `new_outbound_connection` and
273    `new_inbound_connection`, which is used to report back the remote address to
274    the connecting peer in the `init` message (#1326).
275  * `ChannelManager::accept_inbound_channel` now takes a `user_channel_id`, which
276    is used in a similar manner as in outbound channels. (#1381).
277  * `BackgroundProcessor` now persists `NetworkGraph` on a timer and upon
278    shutdown as part of a new `Persister` trait, which also includes
279    `ChannelManager` persistence (#1376).
280  * `ProbabilisticScoringParameters` now has a `base_penalty_msat` option, which
281    default to 500 msats. It is applied at each hop to help avoid longer paths
282    (#1375).
283  * `ProbabilisticScoringParameters::liquidity_penalty_multiplier_msat`'s default
284    value is now 40,000 msats instead of 10,000 msats (#1375).
285  * The `lightning` crate has a `grind_signatures` feature used to produce
286    signatures with low r-values for more predictable transaction weight. This
287    feature is on by default (#1388).
288  * `ProbabilisticScoringParameters` now has a `amount_penalty_multiplier_msat`
289    option, which is used to further penalize large amounts (#1399).
290  * `PhantomRouteHints`, `FixedPenaltyScorer`, and `ScoringParameters` now
291    implement `Clone` (#1346).
292
293 ## Bug Fixes
294  * Fixed a compilation error in `ProbabilisticScorer` under `--feature=no-std`
295    (#1347).
296  * Invoice creation functions in `lightning-invoice` crate's `utils` module
297    filter invoice hints in order to limit the invoice size (#1325).
298  * Fixed a bug where a `funding_locked` message was delayed by a block if the
299    funding transaction was confirmed while offline, depending on the ordering
300    of `Confirm::transactions_confirmed` calls when brought back online (#1363).
301  * Fixed a bug in `NetGraphMsgHandler` where it didn't continue to receive
302    gossip messages from peers after initial connection (#1368, #1382).
303  * `ChannelManager::timer_tick_occurred` will now timeout a received multi-path
304    payment (MPP) after three ticks if not received in full instead of waiting
305    until near the HTLC timeout block(#1353).
306  * Fixed an issue with `find_route` causing it to be overly aggressive in using
307    MPP over channels to the same first hop (#1370).
308  * Reduced time spent processing `channel_update` messages by checking
309    signatures after checking if no newer messages have already been processed
310    (#1380).
311  * Fixed a few issues in `find_route` which caused preferring paths with a
312    higher cost (#1398).
313  * Fixed an issue in `ProbabilisticScorer` where a channel with not enough
314    liquidity could still be used when retrying a failed payment if it was on a
315    path with an overall lower cost (#1399).
316
317 ## Serialization Compatibility
318  * Channels open with `option_scid_alias` negotiated will be incompatible with
319    prior releases (#1351). This may occur in the following cases:
320    * Outbound channels when `ChannelHandshakeConfig::negotiate_scid_privacy` is
321      enabled.
322    * Inbound channels when automatically accepted from an `OpenChannel` message
323      with a `channel_type` that has `ChannelTypeFeatures::supports_scid_privacy`
324      return true. See `UserConfig::accept_inbound_channels`.
325    * Inbound channels when manually accepted from an `OpenChannelRequest` with a
326      `channel_type` that has `ChannelTypeFeatures::supports_scid_privacy` return
327      true. See `UserConfig::manually_accept_inbound_channels`.
328
329 In total, this release features 43 files changed, 4052 insertions, 1274
330 deletions in 75 commits from 11 authors, in alphabetical order:
331  * Devrandom
332  * Duncan Dean
333  * Elias Rohrer
334  * Jeffrey Czyz
335  * Jurvis Tan
336  * Luiz Parreira
337  * Matt Corallo
338  * Omar Shamardy
339  * Viktor Tigerström
340  * dependabot[bot]
341  * psycho-pirate
342
343
344 # 0.0.105 - 2022-02-28
345
346 ## API Updates
347  * `Phantom node` payments are now supported, allowing receipt of a payment on
348    any one of multiple nodes without any coordination across the nodes being
349    required. See the new `PhantomKeysManager`'s docs for more, as well as
350    requirements on `KeysInterface::get_inbound_payment_key_material` and
351    `lightning_invoice::utils::create_phantom_invoice` (#1199).
352  * In order to support phantom node payments, several `KeysInterface` methods
353    now accept a `Recipient` parameter to select between the local `node_id` and
354    a phantom-specific one.
355  * `ProbabilisticScorer`, a `Score` based on learning the current balances of
356    channels in the network, was added. It attempts to better capture payment
357    success probability than the existing `Scorer`, though may underperform on
358    nodes with low payment volume. We welcome feedback on performance (#1227).
359  * `Score::channel_penalty_msat` now always takes the channel value, instead of
360    an `Option` (#1227).
361  * `UserConfig::manually_accept_inbound_channels` was added which, when set,
362    generates a new `Event::OpenChannelRequest`, which allows manual acceptance
363    or rejection of incoming channels on a per-channel basis (#1281).
364  * `Payee` has been renamed to `PaymentParameters` (#1271).
365  * `PaymentParameters` now has a `max_total_cltv_expiry_delta` field. This
366    defaults to 1008 and limits the maximum amount of time an HTLC can be pending
367    before it will either fail or be claimed (#1234).
368  * The `lightning-invoice` crate now supports no-std environments. This required
369    numerous API changes around timestamp handling and std+no-std versions of
370    several methods that previously assumed knowledge of the time (#1223, #1230).
371  * `lightning-invoice` now supports parsing invoices with expiry times of more
372    than one year. This required changing the semantics of `ExpiryTime` (#1273).
373  * The `CounterpartyCommitmentSecrets` is now public, allowing external uses of
374    the `BOLT 3` secret storage scheme (#1299).
375  * Several `Sign` methods now receive HTLC preimages as proof of state
376    transition, see new documentation for more (#1251).
377  * `KeysInterface::sign_invoice` now provides the HRP and other invoice data
378    separately to make it simpler for external signers to parse (#1272).
379  * `Sign::sign_channel_announcement` now returns both the node's signature and
380    the per-channel signature. `InMemorySigner` now requires the node's secret
381    key in order to implement this (#1179).
382  * `ChannelManager` deserialization will now fail if the `KeysInterface` used
383    has a different `node_id` than the `ChannelManager` expects (#1250).
384  * A new `ErrorAction` variant was added to send `warning` messages (#1013).
385  * Several references to `chain::Listen` objects in `lightning-block-sync` no
386    longer require a mutable reference (#1304).
387
388 ## Bug Fixes
389  * Fixed a regression introduced in 0.0.104 where `ChannelManager`'s internal
390    locks could have an order violation leading to a deadlock (#1238).
391  * Fixed cases where slow code (including user I/O) could cause us to
392    disconnect peers with ping timeouts in `BackgroundProcessor` (#1269).
393  * Now persist the `ChannelManager` prior to `BackgroundProcessor` stopping,
394    preventing race conditions where channels are closed on startup even with a
395    clean shutdown. This requires that users stop network processing and
396    disconnect peers prior to `BackgroundProcessor` shutdown (#1253).
397  * Fields in `ChannelHandshakeLimits` provided via the `override_config` to
398    `create_channel` are now applied instead of the default config (#1292).
399  * Fixed the generation of documentation on docs.rs to include API surfaces
400    which are hidden behind feature flags (#1303).
401  * Added the `channel_type` field to `accept_channel` messages we send, which
402    may avoid some future compatibility issues with other nodes (#1314).
403  * Fixed a bug where, if a previous LDK run using `lightning-persister` crashed
404    while persisting updated data, we may have failed to initialize (#1332).
405  * Fixed a rare bug where having both pending inbound and outbound HTLCs on a
406    just-opened inbound channel could cause `ChannelDetails::balance_msat` to
407    underflow and be reported as large, or cause panics in debug mode (#1268).
408  * Moved more instances of verbose gossip logging from the `Trace` level to the
409    `Gossip` level (#1220).
410  * Delayed `announcement_signatures` until the channel has six confirmations,
411    slightly improving propagation of channel announcements (#1179).
412  * Several fixes in script and transaction weight calculations when anchor
413    outputs are enabled (#1229).
414
415 ## Serialization Compatibility
416  * Using `ChannelManager` data written by versions prior to 0.0.105 will result
417    in preimages for HTLCs that were pending at startup to be missing in calls
418    to `KeysInterface` methods (#1251).
419  * Any phantom invoice payments received on a node that is not upgraded to
420    0.0.105 will fail with an "unknown channel" error. Further, downgrading to
421    0.0.104 or before and then upgrading again will invalidate existing phantom
422    SCIDs which may be included in invoices (#1199).
423
424 ## Security
425 0.0.105 fixes two denial-of-service vulnerabilities which may be reachable from
426 untrusted input in certain application designs.
427
428  * Route calculation spuriously panics when a routing decision is made for a
429    path where the second-to-last hop is a private channel, included due to a
430    multi-hop route hint in an invoice.
431  * `ChannelMonitor::get_claimable_balances` spuriously panics in some scenarios
432    when the LDK application's local commitment transaction is confirmed while
433    HTLCs are still pending resolution.
434
435 In total, this release features 109 files changed, 7270 insertions, 2131
436 deletions in 108 commits from 15 authors, in alphabetical order:
437  * Conor Okus
438  * Devrandom
439  * Elias Rohrer
440  * Jeffrey Czyz
441  * Jurvis Tan
442  * Ken Sedgwick
443  * Matt Corallo
444  * Naveen
445  * Tibo-lg
446  * Valentine Wallace
447  * Viktor Tigerström
448  * dependabot[bot]
449  * hackerrdave
450  * naveen
451  * vss96
452
453
454 # 0.0.104 - 2021-12-17
455
456 ## API Updates
457  * A `PaymentFailed` event is now provided to indicate a payment has failed
458    fully. This event is generated either after
459    `ChannelManager::abandon_payment` is called for a given payment, or the
460    payment times out, and there are no further pending HTLCs for the payment.
461    This event should be used to detect payment failure instead of
462    `PaymentPathFailed::all_paths_failed`, unless no payment retries occur via
463    `ChannelManager::retry_payment` (#1202).
464  * Payment secrets are now generated deterministically using material from
465    the new `KeysInterface::get_inbound_payment_key_material` (#1177).
466  * A `PaymentPathSuccessful` event has been added to ease passing success info
467    to a scorer, along with a `Score::payment_path_successful` method to accept
468    such info (#1178, #1197).
469  * `Score::channel_penalty_msat` has additional arguments describing the
470    channel's capacity and the HTLC amount being sent over the channel (#1166).
471  * A new log level `Gossip` has been added, which is used for verbose
472    information generated during network graph sync. Enabling the
473    `max_level_trace` feature or ignoring `Gossip` log entries reduces log
474    growth during initial start up from many GiB to several MiB (#1145).
475  * The `allow_wallclock_use` feature has been removed in favor of only using
476    the `std` and `no-std` features (#1212).
477  * `NetworkGraph` can now remove channels that we haven't heard updates for in
478    two weeks with `NetworkGraph::remove_stale_channels{,with_time}`. The first
479    is called automatically if a `NetGraphMsgHandler` is passed to
480    `BackgroundProcessor::start` (#1212).
481  * `InvoicePayer::pay_pubkey` was added to enable sending "keysend" payments to
482    supported recipients, using the `InvoicePayer` to handle retires (#1160).
483  * `user_payment_id` has been removed from `PaymentPurpose`, and
484    `ChannelManager::create_inbound_payment{,_for_hash}` (#1180).
485  * Updated documentation for several `ChannelManager` functions to remove stale
486    references to panics which no longer occur (#1201).
487  * The `Score` and `LockableScore` objects have moved into the
488    `routing::scoring` module instead of being in the `routing` module (#1166).
489  * The `Time` parameter to `ScorerWithTime` is no longer longer exposed,
490    instead being fixed based on the `std`/`no-std` feature (#1184).
491  * `ChannelDetails::balance_msat` was added to fetch a channel's balance
492    without subtracting the reserve values, lining up with on-chain claim amounts
493    less on-chain fees (#1203).
494  * An explicit `UserConfig::accept_inbound_channels` flag is now provided,
495    removing the need to set `min_funding_satoshis` to > 21 million BTC (#1173).
496  * Inbound channels that fail to see the funding transaction confirm within
497    2016 blocks are automatically force-closed with
498    `ClosureReason::FundingTimedOut` (#1083).
499  * We now accept a channel_reserve value of 0 from counterparties, as it is
500    insecure for our counterparty but not us (#1163).
501  * `NetAddress::OnionV2` parsing was removed as version 2 onion services are no
502    longer supported in modern Tor (#1204).
503  * Generation and signing of anchor outputs is now supported in the
504    `KeysInterface`, though no support for them exists in the channel itself (#1176)
505
506 ## Bug Fixes
507  * Fixed a race condition in `InvoicePayer` where paths may be retried after
508    the retry count has been exceeded. In this case the
509    `Event::PaymentPathFailed::all_paths_failed` field is not a reliable payment
510    failure indicator. There was no acceptable alternative indicator,
511    `Event::PaymentFailed` as been added to provide one (#1202).
512  * Reduced the blocks-before-timeout we expect of outgoing HTLCs before
513    refusing to forward. This check was overly strict and resulted in refusing
514    to forward som HTLCs to a next hop that had a lower security threshold than
515    us (#1119).
516  * LDK no longer attempt to update the channel fee for outbound channels when
517    we cannot afford the new fee. This could have caused force-closure by our
518    channel counterparty (#1054).
519  * Fixed several bugs which may have prevented the reliable broadcast of our
520    own channel announcements and updates (#1169).
521  * Fixed a rare bug which may have resulted in spurious route finding failures
522    when using last-hop hints and MPP with large value payments (#1168).
523  * `KeysManager::spend_spendable_outputs` no longer adds a change output that
524    is below the dust threshold for non-standard change scripts (#1131).
525  * Fixed a minor memory leak when attempting to send a payment that fails due
526    to an error when updating the `ChannelMonitor` (#1143).
527  * Fixed a bug where a `FeeEstimator` that returns values rounded to the next
528    sat/vbyte may result in force-closures (#1208).
529  * Handle MPP timeout HTLC error codes, instead of considering the recipient to
530    have sent an invalid error, removing them from the network graph (#1148)
531
532 ## Serialization Compatibility
533  * All above new events/fields are ignored by prior clients. All above new
534    events/fields are not present when reading objects serialized by prior
535    versions of the library.
536  * Payment secrets are now generated deterministically. This reduces the memory
537    footprint for inbound payments, however, newly-generated inbound payments
538    using `ChannelManager::create_inbound_payment{,_for_hash}` will not be
539    receivable using versions prior to 0.0.104.
540    `ChannelManager::create_inbound_payment{,_for_hash}_legacy` are provided for
541    backwards compatibility (#1177).
542  * `PaymentPurpose::InvoicePayment::user_payment_id` will be 0 when reading
543    objects written with 0.0.104 when read by 0.0.103 and previous (#1180).
544
545 In total, this release features 51 files changed, 5356 insertions, 2238
546 deletions in 107 commits from 9 authors, in alphabetical order:
547  * Antoine Riard
548  * Conor Okus
549  * Devrandom
550  * Duncan Dean
551  * Elias Rohrer
552  * Jeffrey Czyz
553  * Ken Sedgwick
554  * Matt Corallo
555  * Valentine Wallace
556
557
558 # 0.0.103 - 2021-11-02
559
560 ## API Updates
561  * This release is almost entirely focused on a new API in the
562    `lightning-invoice` crate - the `InvoicePayer`. `InvoicePayer` is a
563    struct which takes a reference to a `ChannelManager` and a `Router`
564    and retries payments as paths fail. It limits retries to a configurable
565    number, but is not serialized to disk and may retry additional times across
566    a serialization/load. In order to learn about failed payments, it must
567    receive `Event`s directly from the `ChannelManager`, wrapping a
568    user-provided `EventHandler` which it provides all unhandled events to
569    (#1059).
570  * `get_route` has been renamed `find_route` (#1059) and now takes a
571    `RouteParameters` struct in replacement of a number of its long list of
572    arguments (#1134). The `Payee` in the `RouteParameters` is stored in the
573    `Route` object returned and provided in the `RouteParameters` contained in
574    `Event::PaymentPathFailed` (#1059).
575  * `ChannelMonitor`s must now be persisted after calls that provide new block
576    data, prior to `MonitorEvent`s being passed back to `ChannelManager` for
577    processing. If you are using a `ChainMonitor` this is handled for you.
578    The `Persist` API has been updated to `Option`ally take the
579    `ChannelMonitorUpdate` as persistence events that result from chain data no
580    longer have a corresponding update (#1108).
581  * `routing::Score` now has a `payment_path_failed` method which it can use to
582    learn which channels often fail payments. It is automatically called by
583    `InvoicePayer` for failed payment paths (#1144).
584  * The default `Scorer` implementation is now a type alias to a type generic
585    across different clocks and supports serialization to persist scoring data
586    across restarts (#1146).
587  * `Event::PaymentSent` now includes the full fee which was spent across all
588    payment paths which were fulfilled or pending when the payment was fulfilled
589    (#1142).
590  * `Event::PaymentSent` and `Event::PaymentPathFailed` now include the
591    `PaymentId` which matches the `PaymentId` returned from
592    `ChannelManager::send_payment` or `InvoicePayer::pay_invoice` (#1059).
593  * `NetGraphMsgHandler` now takes a `Deref` to the `NetworkGraph`, allowing for
594    shared references to the graph data to make serialization and references to
595    the graph data in the `InvoicePayer`'s `Router` simpler (#1149).
596  * `routing::Score::channel_penalty_msat` has been updated to provide the
597    `NodeId` of both the source and destination nodes of a channel (#1133).
598
599 ## Bug Fixes
600  * Previous versions would often disconnect peers during initial graph sync due
601    to ping timeouts while processing large numbers of gossip messages. We now
602    delay disconnecting peers if we receive messages from them even if it takes
603    a while to receive a pong from them. Further, we avoid sending too many
604    gossip messages between pings to ensure we should always receive pongs in a
605    timely manner (#1137).
606  * If a payment was sent, creating an outbound HTLC and sending it to our
607    counterparty (implying the `ChannelMonitor` was persisted on disk), but the
608    `ChannelManager` was not persisted prior to shutdown/crash, no
609    `Event::PaymentPathFailed` event was generated if the HTLC was eventually
610    failed on chain. Events are now consistent irrespective of `ChannelManager`
611    persistence or non-persistence (#1104).
612
613 ## Serialization Compatibility
614  * All above new Events/fields are ignored by prior clients. All above new
615    Events/fields are not present when reading objects serialized by prior
616    versions of the library.
617  * Payments for which a `Route` was generated using a previous version or for
618    which the payment was originally sent by a previous version of the library
619    will not be retried by an `InvoicePayer`.
620
621 This release was singularly focused and some contributions by third parties
622 were delayed.
623 In total, this release features 38 files changed, 4414 insertions, and 969
624 deletions in 71 commits from 2 authors, in alphabetical order:
625
626  * Jeffrey Czyz
627  * Matt Corallo
628
629
630 # 0.0.102 - 2021-10-18
631
632 ## API Updates
633  * `get_route` now takes a `Score` as an argument. `Score` is queried during
634    the route-finding process, returning the absolute amounts which you are
635    willing to pay to avoid routing over a given channel. As a default, a
636    `Scorer` is provided which returns a constant amount, with a suggested
637    default of 500 msat. This translates to a willingness to pay up to 500 msat
638    in additional fees per hop in order to avoid additional hops (#1124).
639  * `Event::PaymentPathFailed` now contains a `short_channel_id` field which may
640    be filled in with a channel that can be "blamed" for the payment failure.
641    Payment retries should likely avoid the given channel for some time (#1077).
642  * `PublicKey`s in `NetworkGraph` have been replaced with a `NodeId` struct
643    which contains only a simple `[u8; 33]`, substantially improving
644    `NetworkGraph` deserialization performance (#1107).
645  * `ChainMonitor`'s `HashMap` of `ChannelMonitor`s is now private, exposed via
646    `Chainmonitor::get_monitor` and `ChainMonitor::list_monitors` instead
647    (#1112).
648  * When an outbound channel is closed prior to the broadcasting of its funding
649    transaction, but after you call
650    `ChannelManager::funding_transaction_generated`, a new event type,
651    `Event::DiscardFunding`, is generated, informing you the transaction was not
652    broadcasted and that you can spend the same inputs again elsewhere (#1098).
653  * `ChannelManager::create_channel` now returns the temporary channel ID which
654    may later appear in `Event::ChannelClosed` or `ChannelDetails` prior to the
655    channel being funded (#1121).
656  * `Event::PaymentSent` now contains the payment hash as well as the payment
657    preimage (#1062).
658  * `ReadOnlyNetworkGraph::get_addresses` now returns owned `NetAddress` rather
659    than references. As a side-effect this method is now exposed in foreign
660    language bindings (#1115).
661  * The `Persist` and `ChannelMonitorUpdateErr` types have moved to the
662    `lightning::chain::chainmonitor` and `lightning::chain` modules,
663    respectively (#1112).
664  * `ChannelManager::send_payment` now returns a `PaymentId` which identifies a
665    payment (whether MPP or not) and can be used to retry the full payment or
666    MPP parts through `retry_payment` (#1096). Note that doing so is currently
667    *not* crash safe, and you may find yourself sending twice. It is recommended
668    that you *not* use the `retry_payment` API until the next release.
669
670 ## Bug Fixes
671  * Due to an earlier fix for the Lightning dust inflation vulnerability tracked
672    in CVE-2021-41591/CVE-2021-41592/CVE-2021-41593 in 0.0.100, we required
673    counterparties to accept a dust limit slightly lower than the dust limit now
674    required by other implementations. This appeared as, at least, latest lnd
675    always refusing to accept channels opened by LDK clients (#1065).
676  * If there are multiple channels available to the same counterparty,
677    `get_route` would only consider the channel listed last as available for
678    sending (#1100).
679  * `Persist` implementations returning
680    `ChannelMonitorUpdateErr::TemporaryFailure` from `watch_channel` previously
681    resulted in the `ChannelMonitor` not being stored at all, resulting in a
682    panic after monitor updating is complete (#1112).
683  * If payments are pending awaiting forwarding at startup, an
684    `Event::PendingHTLCsForwardable` event will always be provided. This ensures
685    user code calls `ChannelManager::process_pending_htlc_fowards` even if it
686    shut down while awaiting the batching timer during the previous run (#1076).
687  * If a call to `ChannelManager::send_payment` failed due to lack of
688    availability of funds locally, LDK would store the payment as pending
689    forever, with no ability to retry or fail it, leaking memory (#1109).
690
691 ## Serialization Compatibility
692  * All above new Events/fields are ignored by prior clients. All above new
693    Events/fields, except for `Event::PaymentSent::payment_hash` are not present
694    when reading objects serialized by prior versions of the library.
695
696 In total, this release features 32 files changed, 2248 insertions, and 1483
697 deletions in 51 commits from 7 authors, in alphabetical order:
698
699  * 1nF0rmed
700  * Duncan Dean
701  * Elias Rohrer
702  * Galder Zamarreño
703  * Jeffrey Czyz
704  * Matt Corallo
705  * Valentine Wallace
706
707
708 # 0.0.101 - 2021-09-23
709
710 ## API Updates
711  * Custom message types are now supported directly in the `PeerManager`,
712    allowing you to send and receive messages of any type that is not natively
713    understood by LDK. This requires a new type bound on `PeerManager`, a
714    `CustomMessageHandler`. `IgnoringMessageHandler` provides a simple default
715    for this new bound for ignoring unknown messages (#1031, #1074).
716  * Route graph updates as a result of failed payments are no longer provided as
717    `MessageSendEvent::PaymentFailureNetworkUpdate` but instead included in a
718    new field in the `Event::PaymentFailed` events. Generally, this means route
719    graph updates are no longer handled as a part of the `PeerManager` but
720    instead through the new `EventHandler` implementation for
721    `NetGraphMsgHandler`. To make this easy, a new parameter to
722    `lightning-background-processor::BackgroundProcessor::start` is added, which
723    contains an `Option`al `NetGraphmsgHandler`. If provided as `Some`, relevant
724    events will be processed by the `NetGraphMsgHandler` prior to normal event
725    handling (#1043).
726  * `NetworkGraph` is now, itself, thread-safe. Accordingly, most functions now
727    take `&self` instead of `&mut self` and the graph data can be accessed
728    through `NetworkGraph.read_only` (#1043).
729  * The balances available on-chain to claim after a channel has been closed are
730    now exposed via `ChannelMonitor::get_claimable_balances` and
731    `ChainMonitor::get_claimable_balances`. The second can be used to get
732    information about all closed channels which still have on-chain balances
733    associated with them. See enum variants of `ln::channelmonitor::Balance` and
734    method documentation for the above methods for more information on the types
735    of balances exposed (#1034).
736  * When one HTLC of a multi-path payment fails, the new field `all_paths_failed`
737    in `Event::PaymentFailed` is set to `false`. This implies that the payment
738    has not failed, but only one part. Payment resolution is only indicated by an
739    `Event::PaymentSent` event or an `Event::PaymentFailed` with
740    `all_paths_failed` set to `true`, which is also set for the last remaining
741    part of a multi-path payment (#1053).
742  * To better capture the context described above, `Event::PaymentFailed` has
743    been renamed to `Event::PaymentPathFailed` (#1084).
744  * A new event, `ChannelClosed`, is provided by `ChannelManager` when a channel
745    is closed, including a reason and error message (if relevant, #997).
746  * `lightning-invoice` now considers invoices with sub-millisatoshi precision
747    to be invalid, and requires millisatoshi values during construction (thus
748    you must call `amount_milli_satoshis` instead of `amount_pico_btc`, #1057).
749  * The `BaseSign` interface now includes two new hooks which provide additional
750    information about commitment transaction signatures and revocation secrets
751    provided by our counterparty, allowing additional verification (#1039).
752  * The `BaseSign` interface now includes additional information for cooperative
753    close transactions, making it easier for a signer to verify requests (#1064).
754  * `Route` has two additional helper methods to get fees and amounts (#1063).
755  * `Txid` and `Transaction` objects can now be deserialized from responses when
756    using the HTTP client in the `lightning-block-sync` crate (#1037, #1061).
757
758 ## Bug Fixes
759  * Fix a panic when reading a lightning invoice with a non-recoverable
760    signature. Further, restrict lightning invoice parsing to require payment
761    secrets and better handle a few edge cases as required by BOLT 11 (#1057).
762  * Fix a panic when receiving multiple messages (such as HTLC fulfill messages)
763    after a call to `chain::Watch::update_channel` returned
764    `Err(ChannelMonitorUpdateErr::TemporaryFailure)` with no
765    `ChannelManager::channel_monitor_updated` call in between (#1066).
766  * For multi-path payments, `Event::PaymentSent` is no longer generated
767    multiple times, once for each independent part (#1053).
768  * Multi-hop route hints in invoices are now considered in the default router
769    provided via `get_route` (#1040).
770  * The time peers have to respond to pings has been increased when building
771    with debug assertions enabled. This avoids peer disconnections on slow hosts
772    when running in debug mode (#1051).
773  * The timeout for the first byte of a response for requests from the
774    `lightning-block-sync` crate has been increased to 300 seconds to better
775    handle the long hangs in Bitcoin Core when it syncs to disk (#1090).
776
777 ## Serialization Compatibility
778  * Due to a bug in 0.0.100, `Event`s written by 0.0.101 which are of a type not
779    understood by 0.0.100 may lead to `Err(DecodeError::InvalidValue)` or corrupt
780    deserialized objects in 0.100. Such `Event`s will lead to an
781    `Err(DecodeError::InvalidValue)` in versions prior to 0.0.100. The only such
782    new event written by 0.0.101 is `Event::ChannelClosed` (#1087).
783  * Payments that were initiated in versions prior to 0.0.101 may still
784    generate duplicate `PaymentSent` `Event`s or may have spurious values for
785    `Event::PaymentPathFailed::all_paths_failed` (#1053).
786  * The return values of `ChannelMonitor::get_claimable_balances` (and, thus,
787    `ChainMonitor::get_claimable_balances`) may be spurious for channels where
788    the spend of the funding transaction appeared on chain while running a
789    version prior to 0.0.101. `Balance` information should only be relied upon
790    for channels that were closed while running 0.0.101+ (#1034).
791  * Payments failed while running versions prior to 0.0.101 will never have a
792    `Some` for the `network_update` field (#1043).
793
794 In total, this release features 67 files changed, 4980 insertions, 1888
795 deletions in 89 commits from 12 authors, in alphabetical order:
796  * Antoine Riard
797  * Devrandom
798  * Galder Zamarreño
799  * Giles Cope
800  * Jeffrey Czyz
801  * Joseph Goulden
802  * Matt Corallo
803  * Sergi Delgado Segura
804  * Tibo-lg
805  * Valentine Wallace
806  * abhik-99
807  * vss96
808
809
810 # 0.0.100 - 2021-08-17
811
812 ## API Updates
813  * The `lightning` crate can now be built in no_std mode, making it easy to
814    target embedded hardware for rust users. Note that mutexes are replaced with
815    no-ops for such builds (#1008, #1028).
816  * LDK now supports sending and receiving "keysend" payments. This includes
817    modifications to `lightning::util::events::Event::PaymentReceived` to
818    indicate the type of payment (#967).
819  * A new variant, `lightning::util::events::Event::PaymentForwarded` has been
820    added which indicates a forwarded payment has been successfully claimed and
821    we've received a forwarding fee (#1004).
822  * `lightning::chain::keysinterface::KeysInterface::get_shutdown_pubkey` has
823    been renamed to `get_shutdown_scriptpubkey`, returns a script, and is now
824    called on channel open only if
825    `lightning::util::config::ChannelConfig::commit_upfront_shutdown_pubkey` is
826    set (#1019).
827  * Closing-signed negotiation is now more configurable, with an explicit
828    `lightning::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis`
829    field allowing you to select the maximum amount you are willing to pay to
830    avoid a force-closure. Further, we are now less restrictive on the fee
831    placed on the closing transaction when we are not the party paying it. To
832    control the feerate paid on a channel at close-time, use
833    `ChannelManager::close_channel_with_target_feerate` instead of
834    `close_channel` (#1011).
835  * `lightning_background_processor::BackgroundProcessor` now stops the
836    background thread when dropped (#1007). It is marked `#[must_use]` so that
837    Rust users will receive a compile-time warning when it is immediately
838    dropped after construction (#1029).
839  * Total potential funds burn on force-close due to dust outputs is now limited
840    to `lightning::util::config::ChannelConfig::max_dust_htlc_exposure_msat` per
841    channel (#1009).
842  * The interval on which
843    `lightning::ln::peer_handler::PeerManager::timer_tick_occurred` should be
844    called has been reduced to once every five seconds (#1035) and
845    `lightning::ln::channelmanager::ChannelManager::timer_tick_occurred` should
846    now be called on startup in addition to once per minute (#985).
847  * The rust-bitcoin and bech32 dependencies have been updated to their
848    respective latest versions (0.27 and 0.8, #1012).
849
850 ## Bug Fixes
851  * Fix panic when reading invoices generated by some versions of c-lightning
852    (#1002 and #1003).
853  * Fix panic when attempting to validate a signed message of incorrect length
854    (#1010).
855  * Do not ignore the route hints in invoices when the invoice is over 250k
856    sats (#986).
857  * Fees are automatically updated on outbound channels to ensure commitment
858    transactions are always broadcastable (#985).
859  * Fixes a rare case where a `lightning::util::events::Event::SpendableOutputs`
860    event is not generated after a counterparty commitment transaction is
861    confirmed in a reorg when a conflicting local commitment transaction is
862    removed in the same reorg (#1022).
863  * Fixes a remotely-triggerable force-closure of an origin channel after an
864    HTLC was forwarded over a next-hop channel and the next-hop channel was
865    force-closed by our counterparty (#1025).
866  * Fixes a rare force-closure case when sending a payment as a channel fundee
867    when overdrawing our remaining balance. Instead the send will fail (#998).
868  * Fixes a rare force-closure case when a payment was claimed prior to a
869    peer disconnection or restart, and later failed (#977).
870
871 ## Serialization Compatibility
872  * Pending inbound keysend payments which have neither been failed nor claimed
873    when serialized will result in a `ChannelManager` which is not readable on
874    pre-0.0.100 clients (#967).
875  * Because
876    `lightning::chain::keysinterface::KeysInterface::get_shutdown_scriptpubkey`
877    has been updated to return a script instead of only a `PublicKey`,
878    `ChannelManager`s constructed with custom `KeysInterface` implementations on
879    0.0.100 and later versions will not be readable on previous versions.
880    `ChannelManager`s created with 0.0.99 and prior versions will remain readable
881    even after the a serialization roundtrip on 0.0.100, as long as no new
882    channels are opened. Further, users using a
883    `lightning::chain::keysinterface::KeysManager` as their `KeysInterface` will
884    have `ChannelManager`s which are readable on prior versions as well (#1019).
885  * `ChannelMonitorUpdate`s created by 0.0.100 and later for channels when
886    `lightning::util::config::ChannelConfig::commit_upfront_shutdown_pubkey` is
887    not set may not be readable by versions prior to 0.0.100 (#1019).
888  * HTLCs which were in the process of being claimed on-chain when a pre-0.0.100
889    `ChannelMonitor` was serialized may generate `PaymentForwarded` events with
890    spurious `fee_earned_msat` values. This only applies to payments which were
891    unresolved at the time of the upgrade (#1004).
892  * 0.0.100 clients with pending `Event::PaymentForwarded` events at
893    serialization-time will generate serialized `ChannelManager` objects which
894    0.0.99 and earlier clients cannot read. The likelihood of this can be reduced
895    by ensuring you process all pending events immediately before serialization
896    (as is done by the `lightning-background-processor` crate, #1004).
897
898
899 In total, this release features 59 files changed, 5861 insertions, and 2082
900 deletions in 95 commits from 6 authors.
901
902
903 # 0.0.99 - 2021-07-09
904
905 ## API Updates
906
907  * `lightning_block_sync::poll::Validate` is now public, allowing you to
908    implement the `lightning_block_sync::poll::Poll` trait without
909    `lightning_block_sync::poll::ChainPoller` (#956).
910  * `lightning::ln::peer_handler::PeerManager` no longer requires that no calls
911    are made to referencing the same `SocketDescriptor` after
912    `disconnect_socket` returns. This makes the API significantly less
913    deadlock-prone and simplifies `SocketDescriptor` implementations
914    significantly. The relevant changes have been made to `lightning_net_tokio`
915    and `PeerManager` documentation has been substantially rewritten (#957).
916  * `lightning::util::message_signing`'s `sign` and `verify` methods now take
917    secret and public keys by reference instead of value (#974).
918  * Substantially more information is now exposed about channels in
919    `ChannelDetails`. See documentation for more info (#984 and #988).
920  * The latest best block seen is now exposed in
921    `ChannelManager::current_best_block` and
922    `ChannelMonitor::current_best_block` (#984).
923  * Feerates charged when forwarding payments over channels is now set in
924    `ChannelConfig::fee_base_msat` when the channel is opened. For existing
925    channels, the value is set to the value provided in
926    `ChannelManagerReadArgs::default_config::channel_options` the first time the
927    `ChannelManager` is loaded in 0.0.99 (#975).
928  * We now reject HTLCs which are received to be forwarded over private channels
929    unless `UserConfig::accept_forwards_to_priv_channels` is set. Note that
930    `UserConfig` is never serialized and must be provided via
931    `ChannelManagerReadArgs::default_config` at each start (#975).
932
933 ## Bug Fixes
934
935  * We now forward gossip messages to peers instead of only relaying
936    locally-generated gossip or sending gossip messages during initial sync
937    (#948).
938  * Correctly send `channel_update` messages to direct peers on private channels
939    (#949). Without this, a private node connected to an LDK node over a private
940    channel cannot receive funds as it does not know which fees the LDK node
941    will charge.
942  * `lightning::ln::channelmanager::ChannelManager` no longer expects to be
943    persisted spuriously after we receive a `channel_update` message about any
944    channel in the routing gossip (#972).
945  * Asynchronous `ChannelMonitor` updates (using the
946    `ChannelMonitorUpdateErr::TemporaryFailure` return variant) no longer cause
947    spurious HTLC forwarding failures (#954).
948  * Transaction provided via `ChannelMonitor::transactions_confirmed`
949    after `ChannelMonitor::best_block_updated` was called for a much later
950    block now trigger all relevant actions as of the later block. Previously
951    some transaction broadcasts or other responses required an additional
952    block be provided via `ChannelMonitor::best_block_updated` (#970).
953  * We no longer panic in rare cases when an invoice contained last-hop route
954    hints which were unusable (#958).
955
956 ## Node Compatibility
957
958  * We now accept spurious `funding_locked` messages sent prior to
959    `channel_reestablish` messages after reconnect. This is a
960    [known, long-standing bug in lnd](https://github.com/lightningnetwork/lnd/issues/4006)
961    (#966).
962  * We now set the `first_blocknum` and `number_of_blocks` fields in
963    `reply_channel_range` messages to values which c-lightning versions prior to
964    0.10 accepted. This avoids spurious force-closes from such nodes (#961).
965
966 ## Serialization Compatibility
967
968  * Due to a bug discovered in 0.0.98, if a `ChannelManager` is serialized on
969    version 0.0.98 while an `Event::PaymentSent` is pending processing, the
970    `ChannelManager` will fail to deserialize both on version 0.0.98 and later
971    versions. If you have such a `ChannelManager` available, a simple patch will
972    allow it to deserialize. Please file an issue if you need assistance (#973).
973
974 # 0.0.98 - 2021-06-11
975
976 0.0.98 should be considered a release candidate to the first alpha release of
977 Rust-Lightning and the broader LDK. It represents several years of work
978 designing and fine-tuning a flexible API for integrating lightning into any
979 application. LDK should make it easy to build a lightning node or client which
980 meets specific requirements that other lightning node software cannot. As
981 lightning continues to evolve, and new use-cases for lightning develop, the API
982 of LDK will continue to change and expand. However, starting with version 0.1,
983 objects serialized with prior versions will be readable with the latest LDK.
984 While Rust-Lightning is approaching the 0.1 milestone, language bindings
985 components of LDK available at https://github.com/lightningdevkit are still of
986 varying quality. Some are also approaching an 0.1 release, while others are
987 still much more experimental. Please note that, at 0.0.98, using Rust-Lightning
988 on mainnet is *strongly* discouraged.