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