4 * `ChannelManager::update_channel_config` has been added to allow the fields
5 in `ChannelConfig` to be changed in a given channel after open (#1527).
6 * If we reconnect to a peer which proves we have a stale channel state, rather
7 than force-closing we will instead panic to provide an opportunity to switch
8 to the latest state and continue operating without channel loss (#1564).
9 * A `NodeAlias` struct has been added which handles string sanitization for
10 node aliases via the `Display` trait (#1544).
11 * `ProbabilisticScoringParameters` now has a `banned_nodes` set which we will
12 never route through during path finding (#1550).
13 * `ProbabilisticScoringParameters` now offers an `anti_probing_penalty_msat`
14 option to prefer channels which afford better privacy when routing (#1555).
15 * `ProbabilisticScorer` now provides access to its estimated liquidity range
16 for a given channel via `estimated_channel_liquidity_range` (#1549).
17 * Options which cannot be changed at runtime have been moved from
18 `ChannelConfig` to `ChannelHandshakeConfig` (#1529).
19 * `find_route` takes `&NetworkGraph` instead of `ReadOnlyNetworkGraph (#1583).
20 * `ChannelDetails` now contains a copy of the current `ChannelConfig` (#1527).
21 * The `lightning-invoice` crate now optionally depends on `serde`, with
22 `Invoice` implementing `serde::{Deserialize,Serialize}` if enabled (#1548).
23 * Several fields in `UserConfig` have been renamed for clarity (#1540).
26 * `find_route` no longer selects routes with more than
27 `PaymentParameters::max_mpp_path_count` paths, and
28 `ChannelManager::send_payment` no longer refuses to send along routes with
29 more than ten paths (#1526).
30 * Fixed two cases where HTLCs pending at the time a counterparty broadcasts a
31 revoked commitment transaction are considered resolved prior to their actual
32 resolution on-chain, possibly passing the update to another channel (#1486).
33 * HTLCs which are relayed through LDK may now have a total expiry time two
34 weeks in the future, up from one, reducing forwarding failures (#1532).
36 ## Serialization Compatibility
37 * All new fields are ignored by prior versions of LDK. All new fields are not
38 present when reading objects serialized by prior versions of LDK.
39 * `ChannelConfig`'s serialization format has changed and is not compatible
40 with any previous version of LDK. Attempts to read values written by a
41 previous version of LDK will fail and attempts to read newly written objects
42 using a previous version of LDK will fail. It is not expected that users are
43 serializing `ChannelConfig` using the LDK serialization API, however, if a
44 backward compatibility wrapper is required, please open an issue.
47 0.0.109 fixes a denial-of-service vulnerability which is reachable from
48 untrusted input in some application deployments.
50 * Third parties which are allowed to open channels with an LDK-based node may
51 fund a channel with a bogus and maliciously-crafted transaction which, when
52 spent, can cause a panic in the channel's corresponding `ChannelMonitor`.
53 Such a channel is never usable as it cannot be funded with a funding
54 transaction which matches the required output script, allowing the
55 `ChannelMonitor` for such channels to be safely purged as a workaround on
56 previous versions of LDK. Thanks to Eugene Siegel for reporting this issue.
58 In total, this release features 32 files changed, 1948 insertions, 532
59 deletions in 33 commits from 9 authors, in alphabetical order:
71 # 0.0.108 - 2022-06-10
74 * Fixed `lightning-background-processor` build in release mode.
76 In total, this release features 9 files changed, 120 insertions, 74
77 deletions in 5 commits from 4 authors, in alphabetical order:
83 # 0.0.107 - 2022-06-08
86 * Channels larger than 16777215 sats (Wumbo!) are now supported and can be
87 enabled for inbound channels using
88 `ChannelHandshakeLimits::max_funding_satoshis` (#1425).
89 * Support for feature `option_zeroconf`, allowing immediate forwarding of
90 payments after channel opening. This is configured for outbound channels
91 using `ChannelHandshakeLimits::trust_own_funding_0conf` whereas
92 `ChannelManager::accept_inbound_channel_from_trusted_peer_0conf` has to be
93 used for accepting inbound channels (#1401, #1505).
94 * `ChannelManager::claim_funds` no longer returns a `bool` to indicate success.
95 Instead, an `Event::PaymentClaimed` is generated if the claim was successful.
96 Likewise, `ChannelManager::fail_htlc_backwards` no longer has a return value
98 * `lightning-rapid-gossip-sync` is a new crate for syncing gossip data from a
99 server, primarily aimed at mobile devices (#1155).
100 * `RapidGossipSync` can be passed to `BackgroundProcessor` in order to persist
101 the `NetworkGraph` and handle `NetworkUpdate`s during event handling (#1433,
103 * `NetGraphMsgHandler` has been renamed to `P2PGossipSync`, the `network_graph`
104 module has been renamed to `gossip`, and `NetworkUpdate::ChannelClosed` has
105 been renamed `NetworkUpdate::ChannelFailure` (#1159).
106 * Added a `filtered_block_connected` method to `chain::Listen` and a default
107 implementation of `block_connected` for those fetching filtered instead of
109 * The `lightning-block-sync` crate's `BlockSource` trait methods now take
110 `&self` instead of `&mut self` (#1307).
111 * `inbound_payment` module is now public to allow for creating invoices without
112 a `ChannelManager` (#1384).
113 * `lightning-block-sync`'s `init` and `poll` modules support `&dyn BlockSource`
114 which can be determined at runtime (#1423).
115 * `lightning-invoice` crate's `utils` now accept an expiration time (#1422,
117 * `Event::PaymentForwarded` includes `prev_channel_id` and `next_channel_id`
119 * `chain::Watch::release_pending_monitor_events`' return type now associates
120 `MonitorEvent`s with funding `OutPoints` (#1475).
121 * `lightning-background-processor` crate's `Persister` trait has been moved to
122 `lightning` crate's `util::persist` module, which now has a general
123 `KVStorePersister` trait. Blanket implementations of `Persister` and
124 `chainmonitor::Persist` are given for types implementing `KVStorePersister`.
125 ` lightning-persister`'s `FilesystemPersister` implements `KVStorePersister`
127 * `ChannelDetails` and `ChannelCounterparty` include fields for HTLC minimum
128 and maximum values (#1378).
129 * Added a `max_inbound_htlc_value_in_flight_percent_of_channel` field to
130 `ChannelHandshakeConfig`, capping the total value of outstanding inbound
131 HTLCs for a channel (#1444).
132 * `ProbabilisticScorer` is parameterized by a `Logger`, which it uses to log
133 channel liquidity updates or lack thereof (#1405).
134 * `ChannelDetails` has an `outbound_htlc_limit_msat` field, which should be
135 used in routing instead of `outbound_capacity_msat` (#1435).
136 * `ProbabilisticScorer`'s channel liquidities can be logged via
137 `debug_log_liquidity_stats` (#1460).
138 * `BackgroundProcessor` now takes an optional `WriteableScore` which it will
139 persist using the `Persister` trait's new `persist_scorer` method (#1416).
140 * Upgraded to `bitcoin` crate version 0.28.1 (#1389).
141 * `ShutdownScript::new_witness_program` now takes a `WitnessVersion` instead of
142 a `NonZeroU8` (#1389).
143 * Channels will no longer be automatically force closed when the counterparty
144 is disconnected due to incompatibility (#1429).
145 * `ChannelManager` methods for funding, accepting, and closing channels now
146 take a `counterparty_node_id` parameter, which has also been added as a field
147 to `Event::FundingGenerationReady` (#1479, #1485).
148 * `InvoicePayer::new` now takes a `Retry` enum (replacing the `RetryAttempts`
149 struct), which supports both attempt- and timeout-based retrying (#1418).
150 * `Score::channel_penalty_msat` takes a `ChannelUsage` struct, which contains
151 the capacity as an `EffectiveCapacity` enum and any potential in-flight HTLC
152 value, rather than a single `u64`. Used by `ProbabilisticScorer` for more
153 accurate penalties (#1456).
154 * `build_route_from_hops` is a new function useful for constructing a `Route`
155 given a specific list of public keys (#1491).
156 * `FundingLocked` message has been renamed `ChannelReady`, and related
157 identifiers have been renamed accordingly (#1506).
158 * `core2::io` or `std::io` (depending on feature flags `no-std` or `std`) is
159 exported as a `lightning::io` module (#1504).
160 * The deprecated `Scorer` has been removed in favor or `ProbabilisticScorer`
163 ## Performance Improvements
164 * `lightning-persister` crate's `FilesystemPersister` is faster by 15x (#1404).
165 * Log gossip query messages at `GOSSIP` instead of `TRACE` to avoid
166 overwhelming default logging (#1421).
167 * `PeerManager` supports processing messages from different peers in parallel,
168 and this is taken advantage of in gossip processing (#1023).
169 * Greatly reduced per-channel and per-node memory usage due to upgrade of
170 `secp256k1` crate to 0.22.1 and `bitcoin` crate to 0.28.1
171 * Reduced per-peer memory usage in `PeerManager` (#1472).
174 * `find_route` now assumes variable-length onions by default for nodes where
175 support for the feature is unknown (#1414).
176 * A `warn` message is now sent when receiving a `channel_reestablish` with an
177 old commitment transaction number rather than immediately force-closing the
179 * When a `channel_update` message is included in an onion error's `failuremsg`,
180 its message type is now encoded. Reading such messages is also supported
184 * Fixed a bug where crashing while persisting a `ChannelMonitorUpdate` for a
185 part of a multi-path payment could cause loss of funds due to a partial
186 payment claim on restart (#1434).
187 * `BackgroundProcessor` has been fixed to improve serialization reliability on
188 slow systems which can avoid force-closes (#1436).
189 * `gossip_timestamp_filter` filters are now honored when sending gossip to
191 * During a reorg, only force-close a channel if its funding transaction is
192 unconfirmed rather than as it loses confirmations (#1461).
193 * Fixed a rare panic in `lightning-net-tokio` when fetching a peer's socket
194 address after the connection has been closed caused by a race condition
196 * `find_route` will no longer return routes that would cause onion construction
197 to fail in some cases (#1476).
198 * `ProbabilisticScorer` uses more precision when approximating `log10` (#1406).
200 ## Serialization Compatibility
201 * All above new events/fields are ignored by prior clients. All above new
202 events/fields are not present when reading objects serialized by prior
203 versions of the library.
204 * `ChannelManager` serialization is no longer compatible with versions prior to
206 * Channels with `option_zeroconf` feature enabled (not required for 0-conf
207 channel use) will be unreadable by versions prior to 0.0.107 (#1401, #1505).
209 In total, this release features 96 files changed, 9304 insertions, 4503
210 deletions in 153 commits from 18 authors, in alphabetical order:
231 # 0.0.106 - 2022-04-03
234 * Minimum supported rust version (MSRV) is now 1.41.1 (#1310).
235 * Lightning feature `option_scid_alias` is now supported and may be negotiated
236 when opening a channel with a peer. It can be configured via
237 `ChannelHandshakeConfig::negotiate_scid_privacy` and is off by default but
238 will be on by default in the future (#1351).
239 * `OpenChannelRequest` now has a `channel_type` field indicating the features
240 the channel will operate with and should be used to filter channels with
241 undesirable features (#1351). See the Serialization Compatibility section.
242 * `ChannelManager` supports sending and receiving short channel id aliases in
243 the `funding_locked` message. These are used when forwarding payments and
244 constructing invoice route hints for improved privacy. `ChannelDetails` has a
245 `inbound_scid_alias` field and a `get_inbound_payment_scid` method to support
247 * `DefaultRouter` and `find_route` take an additional random seed to improve
248 privacy by adding a random CLTV expiry offset to each path's final hop. This
249 helps obscure the intended recipient from adversarial intermediate hops
250 (#1286). The seed is also used to randomize candidate paths during route
252 * The `lightning-block-sync` crate's `init::synchronize_listeners` method
253 interface has been relaxed to support multithreaded environments (#1349).
254 * `ChannelManager::create_inbound_payment_for_hash`'s documentation has been
255 corrected to remove the one-year restriction on `invoice_expiry_delta_secs`,
256 which is only applicable to the deprecated `create_inbound_payment_legacy`
257 and `create_inbound_payment_for_hash_legacy` methods (#1341).
258 * `Features` mutator methods now take `self` by reference instead of by value
260 * The CLTV of the last hop in a path is now included when comparing against
261 `RouteParameters::max_total_cltv_expiry_delta` (#1358).
262 * Invoice creation functions in `lightning-invoice` crate's `utils` module
263 include versions that accept a description hash instead of only a description
265 * `RoutingMessageHandler::sync_routing_table` has been renamed `peer_connected`
267 * `MessageSendEvent::SendGossipTimestampFilter` has been added to indicate that
268 a `gossip_timestamp_filter` should be sent (#1368).
269 * `PeerManager` takes an optional `NetAddress` in `new_outbound_connection` and
270 `new_inbound_connection`, which is used to report back the remote address to
271 the connecting peer in the `init` message (#1326).
272 * `ChannelManager::accept_inbound_channel` now takes a `user_channel_id`, which
273 is used in a similar manner as in outbound channels. (#1381).
274 * `BackgroundProcessor` now persists `NetworkGraph` on a timer and upon
275 shutdown as part of a new `Persister` trait, which also includes
276 `ChannelManager` persistence (#1376).
277 * `ProbabilisticScoringParameters` now has a `base_penalty_msat` option, which
278 default to 500 msats. It is applied at each hop to help avoid longer paths
280 * `ProbabilisticScoringParameters::liquidity_penalty_multiplier_msat`'s default
281 value is now 40,000 msats instead of 10,000 msats (#1375).
282 * The `lightning` crate has a `grind_signatures` feature used to produce
283 signatures with low r-values for more predictable transaction weight. This
284 feature is on by default (#1388).
285 * `ProbabilisticScoringParameters` now has a `amount_penalty_multiplier_msat`
286 option, which is used to further penalize large amounts (#1399).
287 * `PhantomRouteHints`, `FixedPenaltyScorer`, and `ScoringParameters` now
288 implement `Clone` (#1346).
291 * Fixed a compilation error in `ProbabilisticScorer` under `--feature=no-std`
293 * Invoice creation functions in `lightning-invoice` crate's `utils` module
294 filter invoice hints in order to limit the invoice size (#1325).
295 * Fixed a bug where a `funding_locked` message was delayed by a block if the
296 funding transaction was confirmed while offline, depending on the ordering
297 of `Confirm::transactions_confirmed` calls when brought back online (#1363).
298 * Fixed a bug in `NetGraphMsgHandler` where it didn't continue to receive
299 gossip messages from peers after initial connection (#1368, #1382).
300 * `ChannelManager::timer_tick_occurred` will now timeout a received multi-path
301 payment (MPP) after three ticks if not received in full instead of waiting
302 until near the HTLC timeout block(#1353).
303 * Fixed an issue with `find_route` causing it to be overly aggressive in using
304 MPP over channels to the same first hop (#1370).
305 * Reduced time spent processing `channel_update` messages by checking
306 signatures after checking if no newer messages have already been processed
308 * Fixed a few issues in `find_route` which caused preferring paths with a
310 * Fixed an issue in `ProbabilisticScorer` where a channel with not enough
311 liquidity could still be used when retrying a failed payment if it was on a
312 path with an overall lower cost (#1399).
314 ## Serialization Compatibility
315 * Channels open with `option_scid_alias` negotiated will be incompatible with
316 prior releases (#1351). This may occur in the following cases:
317 * Outbound channels when `ChannelHandshakeConfig::negotiate_scid_privacy` is
319 * Inbound channels when automatically accepted from an `OpenChannel` message
320 with a `channel_type` that has `ChannelTypeFeatures::supports_scid_privacy`
321 return true. See `UserConfig::accept_inbound_channels`.
322 * Inbound channels when manually accepted from an `OpenChannelRequest` with a
323 `channel_type` that has `ChannelTypeFeatures::supports_scid_privacy` return
324 true. See `UserConfig::manually_accept_inbound_channels`.
326 In total, this release features 43 files changed, 4052 insertions, 1274
327 deletions in 75 commits from 11 authors, in alphabetical order:
341 # 0.0.105 - 2022-02-28
344 * `Phantom node` payments are now supported, allowing receipt of a payment on
345 any one of multiple nodes without any coordination across the nodes being
346 required. See the new `PhantomKeysManager`'s docs for more, as well as
347 requirements on `KeysInterface::get_inbound_payment_key_material` and
348 `lightning_invoice::utils::create_phantom_invoice` (#1199).
349 * In order to support phantom node payments, several `KeysInterface` methods
350 now accept a `Recipient` parameter to select between the local `node_id` and
351 a phantom-specific one.
352 * `ProbabilisticScorer`, a `Score` based on learning the current balances of
353 channels in the network, was added. It attempts to better capture payment
354 success probability than the existing `Scorer`, though may underperform on
355 nodes with low payment volume. We welcome feedback on performance (#1227).
356 * `Score::channel_penalty_msat` now always takes the channel value, instead of
358 * `UserConfig::manually_accept_inbound_channels` was added which, when set,
359 generates a new `Event::OpenChannelRequest`, which allows manual acceptance
360 or rejection of incoming channels on a per-channel basis (#1281).
361 * `Payee` has been renamed to `PaymentParameters` (#1271).
362 * `PaymentParameters` now has a `max_total_cltv_expiry_delta` field. This
363 defaults to 1008 and limits the maximum amount of time an HTLC can be pending
364 before it will either fail or be claimed (#1234).
365 * The `lightning-invoice` crate now supports no-std environments. This required
366 numerous API changes around timestamp handling and std+no-std versions of
367 several methods that previously assumed knowledge of the time (#1223, #1230).
368 * `lightning-invoice` now supports parsing invoices with expiry times of more
369 than one year. This required changing the semantics of `ExpiryTime` (#1273).
370 * The `CounterpartyCommitmentSecrets` is now public, allowing external uses of
371 the `BOLT 3` secret storage scheme (#1299).
372 * Several `Sign` methods now receive HTLC preimages as proof of state
373 transition, see new documentation for more (#1251).
374 * `KeysInterface::sign_invoice` now provides the HRP and other invoice data
375 separately to make it simpler for external signers to parse (#1272).
376 * `Sign::sign_channel_announcement` now returns both the node's signature and
377 the per-channel signature. `InMemorySigner` now requires the node's secret
378 key in order to implement this (#1179).
379 * `ChannelManager` deserialization will now fail if the `KeysInterface` used
380 has a different `node_id` than the `ChannelManager` expects (#1250).
381 * A new `ErrorAction` variant was added to send `warning` messages (#1013).
382 * Several references to `chain::Listen` objects in `lightning-block-sync` no
383 longer require a mutable reference (#1304).
386 * Fixed a regression introduced in 0.0.104 where `ChannelManager`'s internal
387 locks could have an order violation leading to a deadlock (#1238).
388 * Fixed cases where slow code (including user I/O) could cause us to
389 disconnect peers with ping timeouts in `BackgroundProcessor` (#1269).
390 * Now persist the `ChannelManager` prior to `BackgroundProcessor` stopping,
391 preventing race conditions where channels are closed on startup even with a
392 clean shutdown. This requires that users stop network processing and
393 disconnect peers prior to `BackgroundProcessor` shutdown (#1253).
394 * Fields in `ChannelHandshakeLimits` provided via the `override_config` to
395 `create_channel` are now applied instead of the default config (#1292).
396 * Fixed the generation of documentation on docs.rs to include API surfaces
397 which are hidden behind feature flags (#1303).
398 * Added the `channel_type` field to `accept_channel` messages we send, which
399 may avoid some future compatibility issues with other nodes (#1314).
400 * Fixed a bug where, if a previous LDK run using `lightning-persister` crashed
401 while persisting updated data, we may have failed to initialize (#1332).
402 * Fixed a rare bug where having both pending inbound and outbound HTLCs on a
403 just-opened inbound channel could cause `ChannelDetails::balance_msat` to
404 underflow and be reported as large, or cause panics in debug mode (#1268).
405 * Moved more instances of verbose gossip logging from the `Trace` level to the
406 `Gossip` level (#1220).
407 * Delayed `announcement_signatures` until the channel has six confirmations,
408 slightly improving propagation of channel announcements (#1179).
409 * Several fixes in script and transaction weight calculations when anchor
410 outputs are enabled (#1229).
412 ## Serialization Compatibility
413 * Using `ChannelManager` data written by versions prior to 0.0.105 will result
414 in preimages for HTLCs that were pending at startup to be missing in calls
415 to `KeysInterface` methods (#1251).
416 * Any phantom invoice payments received on a node that is not upgraded to
417 0.0.105 will fail with an "unknown channel" error. Further, downgrading to
418 0.0.104 or before and then upgrading again will invalidate existing phantom
419 SCIDs which may be included in invoices (#1199).
422 0.0.105 fixes two denial-of-service vulnerabilities which may be reachable from
423 untrusted input in certain application designs.
425 * Route calculation spuriously panics when a routing decision is made for a
426 path where the second-to-last hop is a private channel, included due to a
427 multi-hop route hint in an invoice.
428 * `ChannelMonitor::get_claimable_balances` spuriously panics in some scenarios
429 when the LDK application's local commitment transaction is confirmed while
430 HTLCs are still pending resolution.
432 In total, this release features 109 files changed, 7270 insertions, 2131
433 deletions in 108 commits from 15 authors, in alphabetical order:
451 # 0.0.104 - 2021-12-17
454 * A `PaymentFailed` event is now provided to indicate a payment has failed
455 fully. This event is generated either after
456 `ChannelManager::abandon_payment` is called for a given payment, or the
457 payment times out, and there are no further pending HTLCs for the payment.
458 This event should be used to detect payment failure instead of
459 `PaymentPathFailed::all_paths_failed`, unless no payment retries occur via
460 `ChannelManager::retry_payment` (#1202).
461 * Payment secrets are now generated deterministically using material from
462 the new `KeysInterface::get_inbound_payment_key_material` (#1177).
463 * A `PaymentPathSuccessful` event has been added to ease passing success info
464 to a scorer, along with a `Score::payment_path_successful` method to accept
465 such info (#1178, #1197).
466 * `Score::channel_penalty_msat` has additional arguments describing the
467 channel's capacity and the HTLC amount being sent over the channel (#1166).
468 * A new log level `Gossip` has been added, which is used for verbose
469 information generated during network graph sync. Enabling the
470 `max_level_trace` feature or ignoring `Gossip` log entries reduces log
471 growth during initial start up from many GiB to several MiB (#1145).
472 * The `allow_wallclock_use` feature has been removed in favor of only using
473 the `std` and `no-std` features (#1212).
474 * `NetworkGraph` can now remove channels that we haven't heard updates for in
475 two weeks with `NetworkGraph::remove_stale_channels{,with_time}`. The first
476 is called automatically if a `NetGraphMsgHandler` is passed to
477 `BackgroundProcessor::start` (#1212).
478 * `InvoicePayer::pay_pubkey` was added to enable sending "keysend" payments to
479 supported recipients, using the `InvoicePayer` to handle retires (#1160).
480 * `user_payment_id` has been removed from `PaymentPurpose`, and
481 `ChannelManager::create_inbound_payment{,_for_hash}` (#1180).
482 * Updated documentation for several `ChannelManager` functions to remove stale
483 references to panics which no longer occur (#1201).
484 * The `Score` and `LockableScore` objects have moved into the
485 `routing::scoring` module instead of being in the `routing` module (#1166).
486 * The `Time` parameter to `ScorerWithTime` is no longer longer exposed,
487 instead being fixed based on the `std`/`no-std` feature (#1184).
488 * `ChannelDetails::balance_msat` was added to fetch a channel's balance
489 without subtracting the reserve values, lining up with on-chain claim amounts
490 less on-chain fees (#1203).
491 * An explicit `UserConfig::accept_inbound_channels` flag is now provided,
492 removing the need to set `min_funding_satoshis` to > 21 million BTC (#1173).
493 * Inbound channels that fail to see the funding transaction confirm within
494 2016 blocks are automatically force-closed with
495 `ClosureReason::FundingTimedOut` (#1083).
496 * We now accept a channel_reserve value of 0 from counterparties, as it is
497 insecure for our counterparty but not us (#1163).
498 * `NetAddress::OnionV2` parsing was removed as version 2 onion services are no
499 longer supported in modern Tor (#1204).
500 * Generation and signing of anchor outputs is now supported in the
501 `KeysInterface`, though no support for them exists in the channel itself (#1176)
504 * Fixed a race condition in `InvoicePayer` where paths may be retried after
505 the retry count has been exceeded. In this case the
506 `Event::PaymentPathFailed::all_paths_failed` field is not a reliable payment
507 failure indicator. There was no acceptable alternative indicator,
508 `Event::PaymentFailed` as been added to provide one (#1202).
509 * Reduced the blocks-before-timeout we expect of outgoing HTLCs before
510 refusing to forward. This check was overly strict and resulted in refusing
511 to forward som HTLCs to a next hop that had a lower security threshold than
513 * LDK no longer attempt to update the channel fee for outbound channels when
514 we cannot afford the new fee. This could have caused force-closure by our
515 channel counterparty (#1054).
516 * Fixed several bugs which may have prevented the reliable broadcast of our
517 own channel announcements and updates (#1169).
518 * Fixed a rare bug which may have resulted in spurious route finding failures
519 when using last-hop hints and MPP with large value payments (#1168).
520 * `KeysManager::spend_spendable_outputs` no longer adds a change output that
521 is below the dust threshold for non-standard change scripts (#1131).
522 * Fixed a minor memory leak when attempting to send a payment that fails due
523 to an error when updating the `ChannelMonitor` (#1143).
524 * Fixed a bug where a `FeeEstimator` that returns values rounded to the next
525 sat/vbyte may result in force-closures (#1208).
526 * Handle MPP timeout HTLC error codes, instead of considering the recipient to
527 have sent an invalid error, removing them from the network graph (#1148)
529 ## Serialization Compatibility
530 * All above new events/fields are ignored by prior clients. All above new
531 events/fields are not present when reading objects serialized by prior
532 versions of the library.
533 * Payment secrets are now generated deterministically. This reduces the memory
534 footprint for inbound payments, however, newly-generated inbound payments
535 using `ChannelManager::create_inbound_payment{,_for_hash}` will not be
536 receivable using versions prior to 0.0.104.
537 `ChannelManager::create_inbound_payment{,_for_hash}_legacy` are provided for
538 backwards compatibility (#1177).
539 * `PaymentPurpose::InvoicePayment::user_payment_id` will be 0 when reading
540 objects written with 0.0.104 when read by 0.0.103 and previous (#1180).
542 In total, this release features 51 files changed, 5356 insertions, 2238
543 deletions in 107 commits from 9 authors, in alphabetical order:
555 # 0.0.103 - 2021-11-02
558 * This release is almost entirely focused on a new API in the
559 `lightning-invoice` crate - the `InvoicePayer`. `InvoicePayer` is a
560 struct which takes a reference to a `ChannelManager` and a `Router`
561 and retries payments as paths fail. It limits retries to a configurable
562 number, but is not serialized to disk and may retry additional times across
563 a serialization/load. In order to learn about failed payments, it must
564 receive `Event`s directly from the `ChannelManager`, wrapping a
565 user-provided `EventHandler` which it provides all unhandled events to
567 * `get_route` has been renamed `find_route` (#1059) and now takes a
568 `RouteParameters` struct in replacement of a number of its long list of
569 arguments (#1134). The `Payee` in the `RouteParameters` is stored in the
570 `Route` object returned and provided in the `RouteParameters` contained in
571 `Event::PaymentPathFailed` (#1059).
572 * `ChannelMonitor`s must now be persisted after calls that provide new block
573 data, prior to `MonitorEvent`s being passed back to `ChannelManager` for
574 processing. If you are using a `ChainMonitor` this is handled for you.
575 The `Persist` API has been updated to `Option`ally take the
576 `ChannelMonitorUpdate` as persistence events that result from chain data no
577 longer have a corresponding update (#1108).
578 * `routing::Score` now has a `payment_path_failed` method which it can use to
579 learn which channels often fail payments. It is automatically called by
580 `InvoicePayer` for failed payment paths (#1144).
581 * The default `Scorer` implementation is now a type alias to a type generic
582 across different clocks and supports serialization to persist scoring data
583 across restarts (#1146).
584 * `Event::PaymentSent` now includes the full fee which was spent across all
585 payment paths which were fulfilled or pending when the payment was fulfilled
587 * `Event::PaymentSent` and `Event::PaymentPathFailed` now include the
588 `PaymentId` which matches the `PaymentId` returned from
589 `ChannelManager::send_payment` or `InvoicePayer::pay_invoice` (#1059).
590 * `NetGraphMsgHandler` now takes a `Deref` to the `NetworkGraph`, allowing for
591 shared references to the graph data to make serialization and references to
592 the graph data in the `InvoicePayer`'s `Router` simpler (#1149).
593 * `routing::Score::channel_penalty_msat` has been updated to provide the
594 `NodeId` of both the source and destination nodes of a channel (#1133).
597 * Previous versions would often disconnect peers during initial graph sync due
598 to ping timeouts while processing large numbers of gossip messages. We now
599 delay disconnecting peers if we receive messages from them even if it takes
600 a while to receive a pong from them. Further, we avoid sending too many
601 gossip messages between pings to ensure we should always receive pongs in a
602 timely manner (#1137).
603 * If a payment was sent, creating an outbound HTLC and sending it to our
604 counterparty (implying the `ChannelMonitor` was persisted on disk), but the
605 `ChannelManager` was not persisted prior to shutdown/crash, no
606 `Event::PaymentPathFailed` event was generated if the HTLC was eventually
607 failed on chain. Events are now consistent irrespective of `ChannelManager`
608 persistence or non-persistence (#1104).
610 ## Serialization Compatibility
611 * All above new Events/fields are ignored by prior clients. All above new
612 Events/fields are not present when reading objects serialized by prior
613 versions of the library.
614 * Payments for which a `Route` was generated using a previous version or for
615 which the payment was originally sent by a previous version of the library
616 will not be retried by an `InvoicePayer`.
618 This release was singularly focused and some contributions by third parties
620 In total, this release features 38 files changed, 4414 insertions, and 969
621 deletions in 71 commits from 2 authors, in alphabetical order:
627 # 0.0.102 - 2021-10-18
630 * `get_route` now takes a `Score` as an argument. `Score` is queried during
631 the route-finding process, returning the absolute amounts which you are
632 willing to pay to avoid routing over a given channel. As a default, a
633 `Scorer` is provided which returns a constant amount, with a suggested
634 default of 500 msat. This translates to a willingness to pay up to 500 msat
635 in additional fees per hop in order to avoid additional hops (#1124).
636 * `Event::PaymentPathFailed` now contains a `short_channel_id` field which may
637 be filled in with a channel that can be "blamed" for the payment failure.
638 Payment retries should likely avoid the given channel for some time (#1077).
639 * `PublicKey`s in `NetworkGraph` have been replaced with a `NodeId` struct
640 which contains only a simple `[u8; 33]`, substantially improving
641 `NetworkGraph` deserialization performance (#1107).
642 * `ChainMonitor`'s `HashMap` of `ChannelMonitor`s is now private, exposed via
643 `Chainmonitor::get_monitor` and `ChainMonitor::list_monitors` instead
645 * When an outbound channel is closed prior to the broadcasting of its funding
646 transaction, but after you call
647 `ChannelManager::funding_transaction_generated`, a new event type,
648 `Event::DiscardFunding`, is generated, informing you the transaction was not
649 broadcasted and that you can spend the same inputs again elsewhere (#1098).
650 * `ChannelManager::create_channel` now returns the temporary channel ID which
651 may later appear in `Event::ChannelClosed` or `ChannelDetails` prior to the
652 channel being funded (#1121).
653 * `Event::PaymentSent` now contains the payment hash as well as the payment
655 * `ReadOnlyNetworkGraph::get_addresses` now returns owned `NetAddress` rather
656 than references. As a side-effect this method is now exposed in foreign
657 language bindings (#1115).
658 * The `Persist` and `ChannelMonitorUpdateErr` types have moved to the
659 `lightning::chain::chainmonitor` and `lightning::chain` modules,
660 respectively (#1112).
661 * `ChannelManager::send_payment` now returns a `PaymentId` which identifies a
662 payment (whether MPP or not) and can be used to retry the full payment or
663 MPP parts through `retry_payment` (#1096). Note that doing so is currently
664 *not* crash safe, and you may find yourself sending twice. It is recommended
665 that you *not* use the `retry_payment` API until the next release.
668 * Due to an earlier fix for the Lightning dust inflation vulnerability tracked
669 in CVE-2021-41591/CVE-2021-41592/CVE-2021-41593 in 0.0.100, we required
670 counterparties to accept a dust limit slightly lower than the dust limit now
671 required by other implementations. This appeared as, at least, latest lnd
672 always refusing to accept channels opened by LDK clients (#1065).
673 * If there are multiple channels available to the same counterparty,
674 `get_route` would only consider the channel listed last as available for
676 * `Persist` implementations returning
677 `ChannelMonitorUpdateErr::TemporaryFailure` from `watch_channel` previously
678 resulted in the `ChannelMonitor` not being stored at all, resulting in a
679 panic after monitor updating is complete (#1112).
680 * If payments are pending awaiting forwarding at startup, an
681 `Event::PendingHTLCsForwardable` event will always be provided. This ensures
682 user code calls `ChannelManager::process_pending_htlc_fowards` even if it
683 shut down while awaiting the batching timer during the previous run (#1076).
684 * If a call to `ChannelManager::send_payment` failed due to lack of
685 availability of funds locally, LDK would store the payment as pending
686 forever, with no ability to retry or fail it, leaking memory (#1109).
688 ## Serialization Compatibility
689 * All above new Events/fields are ignored by prior clients. All above new
690 Events/fields, except for `Event::PaymentSent::payment_hash` are not present
691 when reading objects serialized by prior versions of the library.
693 In total, this release features 32 files changed, 2248 insertions, and 1483
694 deletions in 51 commits from 7 authors, in alphabetical order:
705 # 0.0.101 - 2021-09-23
708 * Custom message types are now supported directly in the `PeerManager`,
709 allowing you to send and receive messages of any type that is not natively
710 understood by LDK. This requires a new type bound on `PeerManager`, a
711 `CustomMessageHandler`. `IgnoringMessageHandler` provides a simple default
712 for this new bound for ignoring unknown messages (#1031, #1074).
713 * Route graph updates as a result of failed payments are no longer provided as
714 `MessageSendEvent::PaymentFailureNetworkUpdate` but instead included in a
715 new field in the `Event::PaymentFailed` events. Generally, this means route
716 graph updates are no longer handled as a part of the `PeerManager` but
717 instead through the new `EventHandler` implementation for
718 `NetGraphMsgHandler`. To make this easy, a new parameter to
719 `lightning-background-processor::BackgroundProcessor::start` is added, which
720 contains an `Option`al `NetGraphmsgHandler`. If provided as `Some`, relevant
721 events will be processed by the `NetGraphMsgHandler` prior to normal event
723 * `NetworkGraph` is now, itself, thread-safe. Accordingly, most functions now
724 take `&self` instead of `&mut self` and the graph data can be accessed
725 through `NetworkGraph.read_only` (#1043).
726 * The balances available on-chain to claim after a channel has been closed are
727 now exposed via `ChannelMonitor::get_claimable_balances` and
728 `ChainMonitor::get_claimable_balances`. The second can be used to get
729 information about all closed channels which still have on-chain balances
730 associated with them. See enum variants of `ln::channelmonitor::Balance` and
731 method documentation for the above methods for more information on the types
732 of balances exposed (#1034).
733 * When one HTLC of a multi-path payment fails, the new field `all_paths_failed`
734 in `Event::PaymentFailed` is set to `false`. This implies that the payment
735 has not failed, but only one part. Payment resolution is only indicated by an
736 `Event::PaymentSent` event or an `Event::PaymentFailed` with
737 `all_paths_failed` set to `true`, which is also set for the last remaining
738 part of a multi-path payment (#1053).
739 * To better capture the context described above, `Event::PaymentFailed` has
740 been renamed to `Event::PaymentPathFailed` (#1084).
741 * A new event, `ChannelClosed`, is provided by `ChannelManager` when a channel
742 is closed, including a reason and error message (if relevant, #997).
743 * `lightning-invoice` now considers invoices with sub-millisatoshi precision
744 to be invalid, and requires millisatoshi values during construction (thus
745 you must call `amount_milli_satoshis` instead of `amount_pico_btc`, #1057).
746 * The `BaseSign` interface now includes two new hooks which provide additional
747 information about commitment transaction signatures and revocation secrets
748 provided by our counterparty, allowing additional verification (#1039).
749 * The `BaseSign` interface now includes additional information for cooperative
750 close transactions, making it easier for a signer to verify requests (#1064).
751 * `Route` has two additional helper methods to get fees and amounts (#1063).
752 * `Txid` and `Transaction` objects can now be deserialized from responses when
753 using the HTTP client in the `lightning-block-sync` crate (#1037, #1061).
756 * Fix a panic when reading a lightning invoice with a non-recoverable
757 signature. Further, restrict lightning invoice parsing to require payment
758 secrets and better handle a few edge cases as required by BOLT 11 (#1057).
759 * Fix a panic when receiving multiple messages (such as HTLC fulfill messages)
760 after a call to `chain::Watch::update_channel` returned
761 `Err(ChannelMonitorUpdateErr::TemporaryFailure)` with no
762 `ChannelManager::channel_monitor_updated` call in between (#1066).
763 * For multi-path payments, `Event::PaymentSent` is no longer generated
764 multiple times, once for each independent part (#1053).
765 * Multi-hop route hints in invoices are now considered in the default router
766 provided via `get_route` (#1040).
767 * The time peers have to respond to pings has been increased when building
768 with debug assertions enabled. This avoids peer disconnections on slow hosts
769 when running in debug mode (#1051).
770 * The timeout for the first byte of a response for requests from the
771 `lightning-block-sync` crate has been increased to 300 seconds to better
772 handle the long hangs in Bitcoin Core when it syncs to disk (#1090).
774 ## Serialization Compatibility
775 * Due to a bug in 0.0.100, `Event`s written by 0.0.101 which are of a type not
776 understood by 0.0.100 may lead to `Err(DecodeError::InvalidValue)` or corrupt
777 deserialized objects in 0.100. Such `Event`s will lead to an
778 `Err(DecodeError::InvalidValue)` in versions prior to 0.0.100. The only such
779 new event written by 0.0.101 is `Event::ChannelClosed` (#1087).
780 * Payments that were initiated in versions prior to 0.0.101 may still
781 generate duplicate `PaymentSent` `Event`s or may have spurious values for
782 `Event::PaymentPathFailed::all_paths_failed` (#1053).
783 * The return values of `ChannelMonitor::get_claimable_balances` (and, thus,
784 `ChainMonitor::get_claimable_balances`) may be spurious for channels where
785 the spend of the funding transaction appeared on chain while running a
786 version prior to 0.0.101. `Balance` information should only be relied upon
787 for channels that were closed while running 0.0.101+ (#1034).
788 * Payments failed while running versions prior to 0.0.101 will never have a
789 `Some` for the `network_update` field (#1043).
791 In total, this release features 67 files changed, 4980 insertions, 1888
792 deletions in 89 commits from 12 authors, in alphabetical order:
800 * Sergi Delgado Segura
807 # 0.0.100 - 2021-08-17
810 * The `lightning` crate can now be built in no_std mode, making it easy to
811 target embedded hardware for rust users. Note that mutexes are replaced with
812 no-ops for such builds (#1008, #1028).
813 * LDK now supports sending and receiving "keysend" payments. This includes
814 modifications to `lightning::util::events::Event::PaymentReceived` to
815 indicate the type of payment (#967).
816 * A new variant, `lightning::util::events::Event::PaymentForwarded` has been
817 added which indicates a forwarded payment has been successfully claimed and
818 we've received a forwarding fee (#1004).
819 * `lightning::chain::keysinterface::KeysInterface::get_shutdown_pubkey` has
820 been renamed to `get_shutdown_scriptpubkey`, returns a script, and is now
821 called on channel open only if
822 `lightning::util::config::ChannelConfig::commit_upfront_shutdown_pubkey` is
824 * Closing-signed negotiation is now more configurable, with an explicit
825 `lightning::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis`
826 field allowing you to select the maximum amount you are willing to pay to
827 avoid a force-closure. Further, we are now less restrictive on the fee
828 placed on the closing transaction when we are not the party paying it. To
829 control the feerate paid on a channel at close-time, use
830 `ChannelManager::close_channel_with_target_feerate` instead of
831 `close_channel` (#1011).
832 * `lightning_background_processor::BackgroundProcessor` now stops the
833 background thread when dropped (#1007). It is marked `#[must_use]` so that
834 Rust users will receive a compile-time warning when it is immediately
835 dropped after construction (#1029).
836 * Total potential funds burn on force-close due to dust outputs is now limited
837 to `lightning::util::config::ChannelConfig::max_dust_htlc_exposure_msat` per
839 * The interval on which
840 `lightning::ln::peer_handler::PeerManager::timer_tick_occurred` should be
841 called has been reduced to once every five seconds (#1035) and
842 `lightning::ln::channelmanager::ChannelManager::timer_tick_occurred` should
843 now be called on startup in addition to once per minute (#985).
844 * The rust-bitcoin and bech32 dependencies have been updated to their
845 respective latest versions (0.27 and 0.8, #1012).
848 * Fix panic when reading invoices generated by some versions of c-lightning
850 * Fix panic when attempting to validate a signed message of incorrect length
852 * Do not ignore the route hints in invoices when the invoice is over 250k
854 * Fees are automatically updated on outbound channels to ensure commitment
855 transactions are always broadcastable (#985).
856 * Fixes a rare case where a `lightning::util::events::Event::SpendableOutputs`
857 event is not generated after a counterparty commitment transaction is
858 confirmed in a reorg when a conflicting local commitment transaction is
859 removed in the same reorg (#1022).
860 * Fixes a remotely-triggerable force-closure of an origin channel after an
861 HTLC was forwarded over a next-hop channel and the next-hop channel was
862 force-closed by our counterparty (#1025).
863 * Fixes a rare force-closure case when sending a payment as a channel fundee
864 when overdrawing our remaining balance. Instead the send will fail (#998).
865 * Fixes a rare force-closure case when a payment was claimed prior to a
866 peer disconnection or restart, and later failed (#977).
868 ## Serialization Compatibility
869 * Pending inbound keysend payments which have neither been failed nor claimed
870 when serialized will result in a `ChannelManager` which is not readable on
871 pre-0.0.100 clients (#967).
873 `lightning::chain::keysinterface::KeysInterface::get_shutdown_scriptpubkey`
874 has been updated to return a script instead of only a `PublicKey`,
875 `ChannelManager`s constructed with custom `KeysInterface` implementations on
876 0.0.100 and later versions will not be readable on previous versions.
877 `ChannelManager`s created with 0.0.99 and prior versions will remain readable
878 even after the a serialization roundtrip on 0.0.100, as long as no new
879 channels are opened. Further, users using a
880 `lightning::chain::keysinterface::KeysManager` as their `KeysInterface` will
881 have `ChannelManager`s which are readable on prior versions as well (#1019).
882 * `ChannelMonitorUpdate`s created by 0.0.100 and later for channels when
883 `lightning::util::config::ChannelConfig::commit_upfront_shutdown_pubkey` is
884 not set may not be readable by versions prior to 0.0.100 (#1019).
885 * HTLCs which were in the process of being claimed on-chain when a pre-0.0.100
886 `ChannelMonitor` was serialized may generate `PaymentForwarded` events with
887 spurious `fee_earned_msat` values. This only applies to payments which were
888 unresolved at the time of the upgrade (#1004).
889 * 0.0.100 clients with pending `Event::PaymentForwarded` events at
890 serialization-time will generate serialized `ChannelManager` objects which
891 0.0.99 and earlier clients cannot read. The likelihood of this can be reduced
892 by ensuring you process all pending events immediately before serialization
893 (as is done by the `lightning-background-processor` crate, #1004).
896 In total, this release features 59 files changed, 5861 insertions, and 2082
897 deletions in 95 commits from 6 authors.
900 # 0.0.99 - 2021-07-09
904 * `lightning_block_sync::poll::Validate` is now public, allowing you to
905 implement the `lightning_block_sync::poll::Poll` trait without
906 `lightning_block_sync::poll::ChainPoller` (#956).
907 * `lightning::ln::peer_handler::PeerManager` no longer requires that no calls
908 are made to referencing the same `SocketDescriptor` after
909 `disconnect_socket` returns. This makes the API significantly less
910 deadlock-prone and simplifies `SocketDescriptor` implementations
911 significantly. The relevant changes have been made to `lightning_net_tokio`
912 and `PeerManager` documentation has been substantially rewritten (#957).
913 * `lightning::util::message_signing`'s `sign` and `verify` methods now take
914 secret and public keys by reference instead of value (#974).
915 * Substantially more information is now exposed about channels in
916 `ChannelDetails`. See documentation for more info (#984 and #988).
917 * The latest best block seen is now exposed in
918 `ChannelManager::current_best_block` and
919 `ChannelMonitor::current_best_block` (#984).
920 * Feerates charged when forwarding payments over channels is now set in
921 `ChannelConfig::fee_base_msat` when the channel is opened. For existing
922 channels, the value is set to the value provided in
923 `ChannelManagerReadArgs::default_config::channel_options` the first time the
924 `ChannelManager` is loaded in 0.0.99 (#975).
925 * We now reject HTLCs which are received to be forwarded over private channels
926 unless `UserConfig::accept_forwards_to_priv_channels` is set. Note that
927 `UserConfig` is never serialized and must be provided via
928 `ChannelManagerReadArgs::default_config` at each start (#975).
932 * We now forward gossip messages to peers instead of only relaying
933 locally-generated gossip or sending gossip messages during initial sync
935 * Correctly send `channel_update` messages to direct peers on private channels
936 (#949). Without this, a private node connected to an LDK node over a private
937 channel cannot receive funds as it does not know which fees the LDK node
939 * `lightning::ln::channelmanager::ChannelManager` no longer expects to be
940 persisted spuriously after we receive a `channel_update` message about any
941 channel in the routing gossip (#972).
942 * Asynchronous `ChannelMonitor` updates (using the
943 `ChannelMonitorUpdateErr::TemporaryFailure` return variant) no longer cause
944 spurious HTLC forwarding failures (#954).
945 * Transaction provided via `ChannelMonitor::transactions_confirmed`
946 after `ChannelMonitor::best_block_updated` was called for a much later
947 block now trigger all relevant actions as of the later block. Previously
948 some transaction broadcasts or other responses required an additional
949 block be provided via `ChannelMonitor::best_block_updated` (#970).
950 * We no longer panic in rare cases when an invoice contained last-hop route
951 hints which were unusable (#958).
953 ## Node Compatibility
955 * We now accept spurious `funding_locked` messages sent prior to
956 `channel_reestablish` messages after reconnect. This is a
957 [known, long-standing bug in lnd](https://github.com/lightningnetwork/lnd/issues/4006)
959 * We now set the `first_blocknum` and `number_of_blocks` fields in
960 `reply_channel_range` messages to values which c-lightning versions prior to
961 0.10 accepted. This avoids spurious force-closes from such nodes (#961).
963 ## Serialization Compatibility
965 * Due to a bug discovered in 0.0.98, if a `ChannelManager` is serialized on
966 version 0.0.98 while an `Event::PaymentSent` is pending processing, the
967 `ChannelManager` will fail to deserialize both on version 0.0.98 and later
968 versions. If you have such a `ChannelManager` available, a simple patch will
969 allow it to deserialize. Please file an issue if you need assistance (#973).
971 # 0.0.98 - 2021-06-11
973 0.0.98 should be considered a release candidate to the first alpha release of
974 Rust-Lightning and the broader LDK. It represents several years of work
975 designing and fine-tuning a flexible API for integrating lightning into any
976 application. LDK should make it easy to build a lightning node or client which
977 meets specific requirements that other lightning node software cannot. As
978 lightning continues to evolve, and new use-cases for lightning develop, the API
979 of LDK will continue to change and expand. However, starting with version 0.1,
980 objects serialized with prior versions will be readable with the latest LDK.
981 While Rust-Lightning is approaching the 0.1 milestone, language bindings
982 components of LDK available at https://github.com/lightningdevkit are still of
983 varying quality. Some are also approaching an 0.1 release, while others are
984 still much more experimental. Please note that, at 0.0.98, using Rust-Lightning
985 on mainnet is *strongly* discouraged.
projects / rust-lightning / blob