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