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