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