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