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