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