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