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