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