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