4 * Minimum supported rust version (MSRV) is now 1.41.1 (#1310).
5 * Lightning feature `option_scid_alias` is now supported and may be negotiated
6 when opening a channel with a peer. It can be configured via
7 `ChannelHandshakeConfig::negotiate_scid_privacy` and is off by default but
8 will be on by default in the future (#1351).
9 * `OpenChannelRequest` now has a `channel_type` field indicating the features
10 the channel will operate with and should be used to filter channels with
11 undesirable features (#1351). See the Serialization Compatibility section.
12 * `ChannelManager` supports sending and receiving short channel id aliases in
13 the `funding_locked` message. These are used when forwarding payments and
14 constructing invoice route hints for improved privacy. `ChannelDetails` has a
15 `inbound_scid_alias` field and a `get_inbound_payment_scid` method to support
17 * `DefaultRouter` and `find_route` take an additional random seed to improve
18 privacy by adding a random CLTV expiry offset to each path's final hop. This
19 helps obscure the intended recipient from adversarial intermediate hops
20 (#1286). The seed is also used to randomize candidate paths during route
22 * The `lightning-block-sync` crate's `init::synchronize_listeners` method
23 interface has been relaxed to support multithreaded environments (#1349).
24 * `ChannelManager::create_inbound_payment_for_hash`'s documentation has been
25 corrected to remove the one-year restriction on `invoice_expiry_delta_secs`,
26 which is only applicable to the deprecated `create_inbound_payment_legacy`
27 and `create_inbound_payment_for_hash_legacy` methods (#1341).
28 * `Features` mutator methods now take `self` by reference instead of by value
30 * The CLTV of the last hop in a path is now included when comparing against
31 `RouteParameters::max_total_cltv_expiry_delta` (#1358).
32 * Invoice creation functions in `lightning-invoice` crate's `utils` module
33 include versions that accept a description hash instead of only a description
35 * `RoutingMessageHandler::sync_routing_table` has been renamed `peer_connected`
37 * `MessageSendEvent::SendGossipTimestampFilter` has been added to indicate that
38 a `gossip_timestamp_filter` should be sent (#1368).
39 * `PeerManager` takes an optional `NetAddress` in `new_outbound_connection` and
40 `new_inbound_connection`, which is used to report back the remote address to
41 the connecting peer in the `init` message (#1326).
42 * `ChannelManager::accept_inbound_channel` now takes a `user_channel_id`, which
43 is used in a similar manner as in outbound channels. (#1381).
44 * `BackgroundProcessor` now persists `NetworkGraph` on a timer and upon
45 shutdown as part of a new `Persister` trait, which also includes
46 `ChannelManager` persistence (#1376).
47 * `ProbabilisticScoringParameters` now has a `base_penalty_msat` option, which
48 default to 500 msats. It is applied at each hop to help avoid longer paths
50 * `ProbabilisticScoringParameters::liquidity_penalty_multiplier_msat`'s default
51 value is now 40,000 msats instead of 10,000 msats (#1375).
52 * The `lightning` crate has a `grind_signatures` feature used to produce
53 signatures with low r-values for more predictable transaction weight. This
54 feature is on by default (#1388).
55 * `ProbabilisticScoringParameters` now has a `amount_penalty_multiplier_msat`
56 option, which is used to further penalize large amounts (#1399).
57 * `PhantomRouteHints`, `FixedPenaltyScorer`, and `ScoringParameters` now
58 implement `Clone` (#1346).
61 * Fixed a compilation error in `ProbabilisticScorer` under `--feature=no-std`
63 * Invoice creation functions in `lightning-invoice` crate's `utils` module
64 filter invoice hints in order to limit the invoice size (#1325).
65 * Fixed a bug where a `funding_locked` message was delayed by a block if the
66 funding transaction was confirmed while offline, depending on the ordering
67 of `Confirm::transactions_confirmed` calls when brought back online (#1363).
68 * Fixed a bug in `NetGraphMsgHandler` where it didn't continue to receive
69 gossip messages from peers after initial connection (#1368, #1382).
70 * `ChannelManager::timer_tick_occurred` will now timeout a received multi-path
71 payment (MPP) after three ticks if not received in full instead of waiting
72 until near the HTLC timeout block(#1353).
73 * Fixed an issue with `find_route` causing it to be overly aggressive in using
74 MPP over channels to the same first hop (#1370).
75 * Reduced time spent processing `channel_update` messages by checking
76 signatures after checking if no newer messages have already been processed
78 * Fixed a few issues in `find_route` which caused preferring paths with a
80 * Fixed an issue in `ProbabilisticScorer` where a channel with not enough
81 liquidity could still be used when retrying a failed payment if it was on a
82 path with an overall lower cost (#1399).
84 ## Serialization Compatibility
85 * Channels open with `option_scid_alias` negotiated will be incompatible with
86 prior releases (#1351). This may occur in the following cases:
87 * Outbound channels when `ChannelHandshakeConfig::negotiate_scid_privacy` is
89 * Inbound channels when automatically accepted from an `OpenChannel` message
90 with a `channel_type` that has `ChannelTypeFeatures::supports_scid_privacy`
91 return true. See `UserConfig::accept_inbound_channels`.
92 * Inbound channels when manually accepted from an `OpenChannelRequest` with a
93 `channel_type` that has `ChannelTypeFeatures::supports_scid_privacy` return
94 true. See `UserConfig::manually_accept_inbound_channels`.
96 In total, this release features 43 files changed, 4052 insertions, 1274
97 deletions in 75 commits from 11 authors, in alphabetical order:
111 # 0.0.105 - 2022-02-28
114 * `Phantom node` payments are now supported, allowing receipt of a payment on
115 any one of multiple nodes without any coordination across the nodes being
116 required. See the new `PhantomKeysManager`'s docs for more, as well as
117 requirements on `KeysInterface::get_inbound_payment_key_material` and
118 `lightning_invoice::utils::create_phantom_invoice` (#1199).
119 * In order to support phantom node payments, several `KeysInterface` methods
120 now accept a `Recipient` parameter to select between the local `node_id` and
121 a phantom-specific one.
122 * `ProbabilisticScorer`, a `Score` based on learning the current balances of
123 channels in the network, was added. It attempts to better capture payment
124 success probability than the existing `Scorer`, though may underperform on
125 nodes with low payment volume. We welcome feedback on performance (#1227).
126 * `Score::channel_penalty_msat` now always takes the channel value, instead of
128 * `UserConfig::manually_accept_inbound_channels` was added which, when set,
129 generates a new `Event::OpenChannelRequest`, which allows manual acceptance
130 or rejection of incoming channels on a per-channel basis (#1281).
131 * `Payee` has been renamed to `PaymentParameters` (#1271).
132 * `PaymentParameters` now has a `max_total_cltv_expiry_delta` field. This
133 defaults to 1008 and limits the maximum amount of time an HTLC can be pending
134 before it will either fail or be claimed (#1234).
135 * The `lightning-invoice` crate now supports no-std environments. This required
136 numerous API changes around timestamp handling and std+no-std versions of
137 several methods that previously assumed knowledge of the time (#1223, #1230).
138 * `lightning-invoice` now supports parsing invoices with expiry times of more
139 than one year. This required changing the semantics of `ExpiryTime` (#1273).
140 * The `CounterpartyCommitmentSecrets` is now public, allowing external uses of
141 the `BOLT 3` secret storage scheme (#1299).
142 * Several `Sign` methods now receive HTLC preimages as proof of state
143 transition, see new documentation for more (#1251).
144 * `KeysInterface::sign_invoice` now provides the HRP and other invoice data
145 separately to make it simpler for external signers to parse (#1272).
146 * `Sign::sign_channel_announcement` now returns both the node's signature and
147 the per-channel signature. `InMemorySigner` now requires the node's secret
148 key in order to implement this (#1179).
149 * `ChannelManager` deserialization will now fail if the `KeysInterface` used
150 has a different `node_id` than the `ChannelManager` expects (#1250).
151 * A new `ErrorAction` variant was added to send `warning` messages (#1013).
152 * Several references to `chain::Listen` objects in `lightning-block-sync` no
153 longer require a mutable reference (#1304).
156 * Fixed a regression introduced in 0.0.104 where `ChannelManager`'s internal
157 locks could have an order violation leading to a deadlock (#1238).
158 * Fixed cases where slow code (including user I/O) could cause us to
159 disconnect peers with ping timeouts in `BackgroundProcessor` (#1269).
160 * Now persist the `ChannelManager` prior to `BackgroundProcessor` stopping,
161 preventing race conditions where channels are closed on startup even with a
162 clean shutdown. This requires that users stop network processing and
163 disconnect peers prior to `BackgroundProcessor` shutdown (#1253).
164 * Fields in `ChannelHandshakeLimits` provided via the `override_config` to
165 `create_channel` are now applied instead of the default config (#1292).
166 * Fixed the generation of documentation on docs.rs to include API surfaces
167 which are hidden behind feature flags (#1303).
168 * Added the `channel_type` field to `accept_channel` messages we send, which
169 may avoid some future compatibility issues with other nodes (#1314).
170 * Fixed a bug where, if a previous LDK run using `lightning-persister` crashed
171 while persisting updated data, we may have failed to initialize (#1332).
172 * Fixed a rare bug where having both pending inbound and outbound HTLCs on a
173 just-opened inbound channel could cause `ChannelDetails::balance_msat` to
174 underflow and be reported as large, or cause panics in debug mode (#1268).
175 * Moved more instances of verbose gossip logging from the `Trace` level to the
176 `Gossip` level (#1220).
177 * Delayed `announcement_signatures` until the channel has six confirmations,
178 slightly improving propagation of channel announcements (#1179).
179 * Several fixes in script and transaction weight calculations when anchor
180 outputs are enabled (#1229).
182 ## Serialization Compatibility
183 * Using `ChannelManager` data written by versions prior to 0.0.105 will result
184 in preimages for HTLCs that were pending at startup to be missing in calls
185 to `KeysInterface` methods (#1251).
186 * Any phantom invoice payments received on a node that is not upgraded to
187 0.0.105 will fail with an "unknown channel" error. Further, downgrading to
188 0.0.104 or before and then upgrading again will invalidate existing phantom
189 SCIDs which may be included in invoices (#1199).
192 0.0.105 fixes two denial-of-service vulnerabilities which may be reachable from
193 untrusted input in certain application designs.
195 * Route calculation spuriously panics when a routing decision is made for a
196 path where the second-to-last hop is a private channel, included due to a
197 multi-hop route hint in an invoice.
198 * `ChannelMonitor::get_claimable_balances` spuriously panics in some scenarios
199 when the LDK application's local commitment transaction is confirmed while
200 HTLCs are still pending resolution.
202 In total, this release features 109 files changed, 7270 insertions, 2131
203 deletions in 108 commits from 15 authors, in alphabetical order:
221 # 0.0.104 - 2021-12-17
224 * A `PaymentFailed` event is now provided to indicate a payment has failed
225 fully. This event is generated either after
226 `ChannelManager::abandon_payment` is called for a given payment, or the
227 payment times out, and there are no further pending HTLCs for the payment.
228 This event should be used to detect payment failure instead of
229 `PaymentPathFailed::all_paths_failed`, unless no payment retries occur via
230 `ChannelManager::retry_payment` (#1202).
231 * Payment secrets are now generated deterministically using material from
232 the new `KeysInterface::get_inbound_payment_key_material` (#1177).
233 * A `PaymentPathSuccessful` event has been added to ease passing success info
234 to a scorer, along with a `Score::payment_path_successful` method to accept
235 such info (#1178, #1197).
236 * `Score::channel_penalty_msat` has additional arguments describing the
237 channel's capacity and the HTLC amount being sent over the channel (#1166).
238 * A new log level `Gossip` has been added, which is used for verbose
239 information generated during network graph sync. Enabling the
240 `max_level_trace` feature or ignoring `Gossip` log entries reduces log
241 growth during initial start up from many GiB to several MiB (#1145).
242 * The `allow_wallclock_use` feature has been removed in favor of only using
243 the `std` and `no-std` features (#1212).
244 * `NetworkGraph` can now remove channels that we haven't heard updates for in
245 two weeks with `NetworkGraph::remove_stale_channels{,with_time}`. The first
246 is called automatically if a `NetGraphMsgHandler` is passed to
247 `BackgroundProcessor::start` (#1212).
248 * `InvoicePayer::pay_pubkey` was added to enable sending "keysend" payments to
249 supported recipients, using the `InvoicePayer` to handle retires (#1160).
250 * `user_payment_id` has been removed from `PaymentPurpose`, and
251 `ChannelManager::create_inbound_payment{,_for_hash}` (#1180).
252 * Updated documentation for several `ChannelManager` functions to remove stale
253 references to panics which no longer occur (#1201).
254 * The `Score` and `LockableScore` objects have moved into the
255 `routing::scoring` module instead of being in the `routing` module (#1166).
256 * The `Time` parameter to `ScorerWithTime` is no longer longer exposed,
257 instead being fixed based on the `std`/`no-std` feature (#1184).
258 * `ChannelDetails::balance_msat` was added to fetch a channel's balance
259 without subtracting the reserve values, lining up with on-chain claim amounts
260 less on-chain fees (#1203).
261 * An explicit `UserConfig::accept_inbound_channels` flag is now provided,
262 removing the need to set `min_funding_satoshis` to > 21 million BTC (#1173).
263 * Inbound channels that fail to see the funding transaction confirm within
264 2016 blocks are automatically force-closed with
265 `ClosureReason::FundingTimedOut` (#1083).
266 * We now accept a channel_reserve value of 0 from counterparties, as it is
267 insecure for our counterparty but not us (#1163).
268 * `NetAddress::OnionV2` parsing was removed as version 2 onion services are no
269 longer supported in modern Tor (#1204).
270 * Generation and signing of anchor outputs is now supported in the
271 `KeysInterface`, though no support for them exists in the channel itself (#1176)
274 * Fixed a race condition in `InvoicePayer` where paths may be retried after
275 the retry count has been exceeded. In this case the
276 `Event::PaymentPathFailed::all_paths_failed` field is not a reliable payment
277 failure indicator. There was no acceptable alternative indicator,
278 `Event::PaymentFailed` as been added to provide one (#1202).
279 * Reduced the blocks-before-timeout we expect of outgoing HTLCs before
280 refusing to forward. This check was overly strict and resulted in refusing
281 to forward som HTLCs to a next hop that had a lower security threshold than
283 * LDK no longer attempt to update the channel fee for outbound channels when
284 we cannot afford the new fee. This could have caused force-closure by our
285 channel counterparty (#1054).
286 * Fixed several bugs which may have prevented the reliable broadcast of our
287 own channel announcements and updates (#1169).
288 * Fixed a rare bug which may have resulted in spurious route finding failures
289 when using last-hop hints and MPP with large value payments (#1168).
290 * `KeysManager::spend_spendable_outputs` no longer adds a change output that
291 is below the dust threshold for non-standard change scripts (#1131).
292 * Fixed a minor memory leak when attempting to send a payment that fails due
293 to an error when updating the `ChannelMonitor` (#1143).
294 * Fixed a bug where a `FeeEstimator` that returns values rounded to the next
295 sat/vbyte may result in force-closures (#1208).
296 * Handle MPP timeout HTLC error codes, instead of considering the recipient to
297 have sent an invalid error, removing them from the network graph (#1148)
299 ## Serialization Compatibility
300 * All above new events/fields are ignored by prior clients. All above new
301 events/fields are not present when reading objects serialized by prior
302 versions of the library.
303 * Payment secrets are now generated deterministically. This reduces the memory
304 footprint for inbound payments, however, newly-generated inbound payments
305 using `ChannelManager::create_inbound_payment{,_for_hash}` will not be
306 receivable using versions prior to 0.0.104.
307 `ChannelManager::create_inbound_payment{,_for_hash}_legacy` are provided for
308 backwards compatibility (#1177).
309 * `PaymentPurpose::InvoicePayment::user_payment_id` will be 0 when reading
310 objects written with 0.0.104 when read by 0.0.103 and previous (#1180).
312 In total, this release features 51 files changed, 5356 insertions, 2238
313 deletions in 107 commits from 9 authors, in alphabetical order:
325 # 0.0.103 - 2021-11-02
328 * This release is almost entirely focused on a new API in the
329 `lightning-invoice` crate - the `InvoicePayer`. `InvoicePayer` is a
330 struct which takes a reference to a `ChannelManager` and a `Router`
331 and retries payments as paths fail. It limits retries to a configurable
332 number, but is not serialized to disk and may retry additional times across
333 a serialization/load. In order to learn about failed payments, it must
334 receive `Event`s directly from the `ChannelManager`, wrapping a
335 user-provided `EventHandler` which it provides all unhandled events to
337 * `get_route` has been renamed `find_route` (#1059) and now takes a
338 `RouteParameters` struct in replacement of a number of its long list of
339 arguments (#1134). The `Payee` in the `RouteParameters` is stored in the
340 `Route` object returned and provided in the `RouteParameters` contained in
341 `Event::PaymentPathFailed` (#1059).
342 * `ChannelMonitor`s must now be persisted after calls that provide new block
343 data, prior to `MonitorEvent`s being passed back to `ChannelManager` for
344 processing. If you are using a `ChainMonitor` this is handled for you.
345 The `Persist` API has been updated to `Option`ally take the
346 `ChannelMonitorUpdate` as persistence events that result from chain data no
347 longer have a corresponding update (#1108).
348 * `routing::Score` now has a `payment_path_failed` method which it can use to
349 learn which channels often fail payments. It is automatically called by
350 `InvoicePayer` for failed payment paths (#1144).
351 * The default `Scorer` implementation is now a type alias to a type generic
352 across different clocks and supports serialization to persist scoring data
353 across restarts (#1146).
354 * `Event::PaymentSent` now includes the full fee which was spent across all
355 payment paths which were fulfilled or pending when the payment was fulfilled
357 * `Event::PaymentSent` and `Event::PaymentPathFailed` now include the
358 `PaymentId` which matches the `PaymentId` returned from
359 `ChannelManager::send_payment` or `InvoicePayer::pay_invoice` (#1059).
360 * `NetGraphMsgHandler` now takes a `Deref` to the `NetworkGraph`, allowing for
361 shared references to the graph data to make serialization and references to
362 the graph data in the `InvoicePayer`'s `Router` simpler (#1149).
363 * `routing::Score::channel_penalty_msat` has been updated to provide the
364 `NodeId` of both the source and destination nodes of a channel (#1133).
367 * Previous versions would often disconnect peers during initial graph sync due
368 to ping timeouts while processing large numbers of gossip messages. We now
369 delay disconnecting peers if we receive messages from them even if it takes
370 a while to receive a pong from them. Further, we avoid sending too many
371 gossip messages between pings to ensure we should always receive pongs in a
372 timely manner (#1137).
373 * If a payment was sent, creating an outbound HTLC and sending it to our
374 counterparty (implying the `ChannelMonitor` was persisted on disk), but the
375 `ChannelManager` was not persisted prior to shutdown/crash, no
376 `Event::PaymentPathFailed` event was generated if the HTLC was eventually
377 failed on chain. Events are now consistent irrespective of `ChannelManager`
378 persistence or non-persistence (#1104).
380 ## Serialization Compatibility
381 * All above new Events/fields are ignored by prior clients. All above new
382 Events/fields are not present when reading objects serialized by prior
383 versions of the library.
384 * Payments for which a `Route` was generated using a previous version or for
385 which the payment was originally sent by a previous version of the library
386 will not be retried by an `InvoicePayer`.
388 This release was singularly focused and some contributions by third parties
390 In total, this release features 38 files changed, 4414 insertions, and 969
391 deletions in 71 commits from 2 authors, in alphabetical order:
397 # 0.0.102 - 2021-10-18
400 * `get_route` now takes a `Score` as an argument. `Score` is queried during
401 the route-finding process, returning the absolute amounts which you are
402 willing to pay to avoid routing over a given channel. As a default, a
403 `Scorer` is provided which returns a constant amount, with a suggested
404 default of 500 msat. This translates to a willingness to pay up to 500 msat
405 in additional fees per hop in order to avoid additional hops (#1124).
406 * `Event::PaymentPathFailed` now contains a `short_channel_id` field which may
407 be filled in with a channel that can be "blamed" for the payment failure.
408 Payment retries should likely avoid the given channel for some time (#1077).
409 * `PublicKey`s in `NetworkGraph` have been replaced with a `NodeId` struct
410 which contains only a simple `[u8; 33]`, substantially improving
411 `NetworkGraph` deserialization performance (#1107).
412 * `ChainMonitor`'s `HashMap` of `ChannelMonitor`s is now private, exposed via
413 `Chainmonitor::get_monitor` and `ChainMonitor::list_monitors` instead
415 * When an outbound channel is closed prior to the broadcasting of its funding
416 transaction, but after you call
417 `ChannelManager::funding_transaction_generated`, a new event type,
418 `Event::DiscardFunding`, is generated, informing you the transaction was not
419 broadcasted and that you can spend the same inputs again elsewhere (#1098).
420 * `ChannelManager::create_channel` now returns the temporary channel ID which
421 may later appear in `Event::ChannelClosed` or `ChannelDetails` prior to the
422 channel being funded (#1121).
423 * `Event::PaymentSent` now contains the payment hash as well as the payment
425 * `ReadOnlyNetworkGraph::get_addresses` now returns owned `NetAddress` rather
426 than references. As a side-effect this method is now exposed in foreign
427 language bindings (#1115).
428 * The `Persist` and `ChannelMonitorUpdateErr` types have moved to the
429 `lightning::chain::chainmonitor` and `lightning::chain` modules,
430 respectively (#1112).
431 * `ChannelManager::send_payment` now returns a `PaymentId` which identifies a
432 payment (whether MPP or not) and can be used to retry the full payment or
433 MPP parts through `retry_payment` (#1096). Note that doing so is currently
434 *not* crash safe, and you may find yourself sending twice. It is recommended
435 that you *not* use the `retry_payment` API until the next release.
438 * Due to an earlier fix for the Lightning dust inflation vulnerability tracked
439 in CVE-2021-41591/CVE-2021-41592/CVE-2021-41593 in 0.0.100, we required
440 counterparties to accept a dust limit slightly lower than the dust limit now
441 required by other implementations. This appeared as, at least, latest lnd
442 always refusing to accept channels opened by LDK clients (#1065).
443 * If there are multiple channels available to the same counterparty,
444 `get_route` would only consider the channel listed last as available for
446 * `Persist` implementations returning
447 `ChannelMonitorUpdateErr::TemporaryFailure` from `watch_channel` previously
448 resulted in the `ChannelMonitor` not being stored at all, resulting in a
449 panic after monitor updating is complete (#1112).
450 * If payments are pending awaiting forwarding at startup, an
451 `Event::PendingHTLCsForwardable` event will always be provided. This ensures
452 user code calls `ChannelManager::process_pending_htlc_fowards` even if it
453 shut down while awaiting the batching timer during the previous run (#1076).
454 * If a call to `ChannelManager::send_payment` failed due to lack of
455 availability of funds locally, LDK would store the payment as pending
456 forever, with no ability to retry or fail it, leaking memory (#1109).
458 ## Serialization Compatibility
459 * All above new Events/fields are ignored by prior clients. All above new
460 Events/fields, except for `Event::PaymentSent::payment_hash` are not present
461 when reading objects serialized by prior versions of the library.
463 In total, this release features 32 files changed, 2248 insertions, and 1483
464 deletions in 51 commits from 7 authors, in alphabetical order:
475 # 0.0.101 - 2021-09-23
478 * Custom message types are now supported directly in the `PeerManager`,
479 allowing you to send and receive messages of any type that is not natively
480 understood by LDK. This requires a new type bound on `PeerManager`, a
481 `CustomMessageHandler`. `IgnoringMessageHandler` provides a simple default
482 for this new bound for ignoring unknown messages (#1031, #1074).
483 * Route graph updates as a result of failed payments are no longer provided as
484 `MessageSendEvent::PaymentFailureNetworkUpdate` but instead included in a
485 new field in the `Event::PaymentFailed` events. Generally, this means route
486 graph updates are no longer handled as a part of the `PeerManager` but
487 instead through the new `EventHandler` implementation for
488 `NetGraphMsgHandler`. To make this easy, a new parameter to
489 `lightning-background-processor::BackgroundProcessor::start` is added, which
490 contains an `Option`al `NetGraphmsgHandler`. If provided as `Some`, relevant
491 events will be processed by the `NetGraphMsgHandler` prior to normal event
493 * `NetworkGraph` is now, itself, thread-safe. Accordingly, most functions now
494 take `&self` instead of `&mut self` and the graph data can be accessed
495 through `NetworkGraph.read_only` (#1043).
496 * The balances available on-chain to claim after a channel has been closed are
497 now exposed via `ChannelMonitor::get_claimable_balances` and
498 `ChainMonitor::get_claimable_balances`. The second can be used to get
499 information about all closed channels which still have on-chain balances
500 associated with them. See enum variants of `ln::channelmonitor::Balance` and
501 method documentation for the above methods for more information on the types
502 of balances exposed (#1034).
503 * When one HTLC of a multi-path payment fails, the new field `all_paths_failed`
504 in `Event::PaymentFailed` is set to `false`. This implies that the payment
505 has not failed, but only one part. Payment resolution is only indicated by an
506 `Event::PaymentSent` event or an `Event::PaymentFailed` with
507 `all_paths_failed` set to `true`, which is also set for the last remaining
508 part of a multi-path payment (#1053).
509 * To better capture the context described above, `Event::PaymentFailed` has
510 been renamed to `Event::PaymentPathFailed` (#1084).
511 * A new event, `ChannelClosed`, is provided by `ChannelManager` when a channel
512 is closed, including a reason and error message (if relevant, #997).
513 * `lightning-invoice` now considers invoices with sub-millisatoshi precision
514 to be invalid, and requires millisatoshi values during construction (thus
515 you must call `amount_milli_satoshis` instead of `amount_pico_btc`, #1057).
516 * The `BaseSign` interface now includes two new hooks which provide additional
517 information about commitment transaction signatures and revocation secrets
518 provided by our counterparty, allowing additional verification (#1039).
519 * The `BaseSign` interface now includes additional information for cooperative
520 close transactions, making it easier for a signer to verify requests (#1064).
521 * `Route` has two additional helper methods to get fees and amounts (#1063).
522 * `Txid` and `Transaction` objects can now be deserialized from responses when
523 using the HTTP client in the `lightning-block-sync` crate (#1037, #1061).
526 * Fix a panic when reading a lightning invoice with a non-recoverable
527 signature. Further, restrict lightning invoice parsing to require payment
528 secrets and better handle a few edge cases as required by BOLT 11 (#1057).
529 * Fix a panic when receiving multiple messages (such as HTLC fulfill messages)
530 after a call to `chain::Watch::update_channel` returned
531 `Err(ChannelMonitorUpdateErr::TemporaryFailure)` with no
532 `ChannelManager::channel_monitor_updated` call in between (#1066).
533 * For multi-path payments, `Event::PaymentSent` is no longer generated
534 multiple times, once for each independent part (#1053).
535 * Multi-hop route hints in invoices are now considered in the default router
536 provided via `get_route` (#1040).
537 * The time peers have to respond to pings has been increased when building
538 with debug assertions enabled. This avoids peer disconnections on slow hosts
539 when running in debug mode (#1051).
540 * The timeout for the first byte of a response for requests from the
541 `lightning-block-sync` crate has been increased to 300 seconds to better
542 handle the long hangs in Bitcoin Core when it syncs to disk (#1090).
544 ## Serialization Compatibility
545 * Due to a bug in 0.0.100, `Event`s written by 0.0.101 which are of a type not
546 understood by 0.0.100 may lead to `Err(DecodeError::InvalidValue)` or corrupt
547 deserialized objects in 0.100. Such `Event`s will lead to an
548 `Err(DecodeError::InvalidValue)` in versions prior to 0.0.100. The only such
549 new event written by 0.0.101 is `Event::ChannelClosed` (#1087).
550 * Payments that were initiated in versions prior to 0.0.101 may still
551 generate duplicate `PaymentSent` `Event`s or may have spurious values for
552 `Event::PaymentPathFailed::all_paths_failed` (#1053).
553 * The return values of `ChannelMonitor::get_claimable_balances` (and, thus,
554 `ChainMonitor::get_claimable_balances`) may be spurious for channels where
555 the spend of the funding transaction appeared on chain while running a
556 version prior to 0.0.101. `Balance` information should only be relied upon
557 for channels that were closed while running 0.0.101+ (#1034).
558 * Payments failed while running versions prior to 0.0.101 will never have a
559 `Some` for the `network_update` field (#1043).
561 In total, this release features 67 files changed, 4980 insertions, 1888
562 deletions in 89 commits from 12 authors, in alphabetical order:
570 * Sergi Delgado Segura
577 # 0.0.100 - 2021-08-17
580 * The `lightning` crate can now be built in no_std mode, making it easy to
581 target embedded hardware for rust users. Note that mutexes are replaced with
582 no-ops for such builds (#1008, #1028).
583 * LDK now supports sending and receiving "keysend" payments. This includes
584 modifications to `lightning::util::events::Event::PaymentReceived` to
585 indicate the type of payment (#967).
586 * A new variant, `lightning::util::events::Event::PaymentForwarded` has been
587 added which indicates a forwarded payment has been successfully claimed and
588 we've received a forwarding fee (#1004).
589 * `lightning::chain::keysinterface::KeysInterface::get_shutdown_pubkey` has
590 been renamed to `get_shutdown_scriptpubkey`, returns a script, and is now
591 called on channel open only if
592 `lightning::util::config::ChannelConfig::commit_upfront_shutdown_pubkey` is
594 * Closing-signed negotiation is now more configurable, with an explicit
595 `lightning::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis`
596 field allowing you to select the maximum amount you are willing to pay to
597 avoid a force-closure. Further, we are now less restrictive on the fee
598 placed on the closing transaction when we are not the party paying it. To
599 control the feerate paid on a channel at close-time, use
600 `ChannelManager::close_channel_with_target_feerate` instead of
601 `close_channel` (#1011).
602 * `lightning_background_processor::BackgroundProcessor` now stops the
603 background thread when dropped (#1007). It is marked `#[must_use]` so that
604 Rust users will receive a compile-time warning when it is immediately
605 dropped after construction (#1029).
606 * Total potential funds burn on force-close due to dust outputs is now limited
607 to `lightning::util::config::ChannelConfig::max_dust_htlc_exposure_msat` per
609 * The interval on which
610 `lightning::ln::peer_handler::PeerManager::timer_tick_occurred` should be
611 called has been reduced to once every five seconds (#1035) and
612 `lightning::ln::channelmanager::ChannelManager::timer_tick_occurred` should
613 now be called on startup in addition to once per minute (#985).
614 * The rust-bitcoin and bech32 dependencies have been updated to their
615 respective latest versions (0.27 and 0.8, #1012).
618 * Fix panic when reading invoices generated by some versions of c-lightning
620 * Fix panic when attempting to validate a signed message of incorrect length
622 * Do not ignore the route hints in invoices when the invoice is over 250k
624 * Fees are automatically updated on outbound channels to ensure commitment
625 transactions are always broadcastable (#985).
626 * Fixes a rare case where a `lightning::util::events::Event::SpendableOutputs`
627 event is not generated after a counterparty commitment transaction is
628 confirmed in a reorg when a conflicting local commitment transaction is
629 removed in the same reorg (#1022).
630 * Fixes a remotely-triggerable force-closure of an origin channel after an
631 HTLC was forwarded over a next-hop channel and the next-hop channel was
632 force-closed by our counterparty (#1025).
633 * Fixes a rare force-closure case when sending a payment as a channel fundee
634 when overdrawing our remaining balance. Instead the send will fail (#998).
635 * Fixes a rare force-closure case when a payment was claimed prior to a
636 peer disconnection or restart, and later failed (#977).
638 ## Serialization Compatibility
639 * Pending inbound keysend payments which have neither been failed nor claimed
640 when serialized will result in a `ChannelManager` which is not readable on
641 pre-0.0.100 clients (#967).
643 `lightning::chain::keysinterface::KeysInterface::get_shutdown_scriptpubkey`
644 has been updated to return a script instead of only a `PublicKey`,
645 `ChannelManager`s constructed with custom `KeysInterface` implementations on
646 0.0.100 and later versions will not be readable on previous versions.
647 `ChannelManager`s created with 0.0.99 and prior versions will remain readable
648 even after the a serialization roundtrip on 0.0.100, as long as no new
649 channels are opened. Further, users using a
650 `lightning::chain::keysinterface::KeysManager` as their `KeysInterface` will
651 have `ChannelManager`s which are readable on prior versions as well (#1019).
652 * `ChannelMonitorUpdate`s created by 0.0.100 and later for channels when
653 `lightning::util::config::ChannelConfig::commit_upfront_shutdown_pubkey` is
654 not set may not be readable by versions prior to 0.0.100 (#1019).
655 * HTLCs which were in the process of being claimed on-chain when a pre-0.0.100
656 `ChannelMonitor` was serialized may generate `PaymentForwarded` events with
657 spurious `fee_earned_msat` values. This only applies to payments which were
658 unresolved at the time of the upgrade (#1004).
659 * 0.0.100 clients with pending `Event::PaymentForwarded` events at
660 serialization-time will generate serialized `ChannelManager` objects which
661 0.0.99 and earlier clients cannot read. The likelihood of this can be reduced
662 by ensuring you process all pending events immediately before serialization
663 (as is done by the `lightning-background-processor` crate, #1004).
666 In total, this release features 59 files changed, 5861 insertions, and 2082
667 deletions in 95 commits from 6 authors.
670 # 0.0.99 - 2021-07-09
674 * `lightning_block_sync::poll::Validate` is now public, allowing you to
675 implement the `lightning_block_sync::poll::Poll` trait without
676 `lightning_block_sync::poll::ChainPoller` (#956).
677 * `lightning::ln::peer_handler::PeerManager` no longer requires that no calls
678 are made to referencing the same `SocketDescriptor` after
679 `disconnect_socket` returns. This makes the API significantly less
680 deadlock-prone and simplifies `SocketDescriptor` implementations
681 significantly. The relevant changes have been made to `lightning_net_tokio`
682 and `PeerManager` documentation has been substantially rewritten (#957).
683 * `lightning::util::message_signing`'s `sign` and `verify` methods now take
684 secret and public keys by reference instead of value (#974).
685 * Substantially more information is now exposed about channels in
686 `ChannelDetails`. See documentation for more info (#984 and #988).
687 * The latest best block seen is now exposed in
688 `ChannelManager::current_best_block` and
689 `ChannelMonitor::current_best_block` (#984).
690 * Feerates charged when forwarding payments over channels is now set in
691 `ChannelConfig::fee_base_msat` when the channel is opened. For existing
692 channels, the value is set to the value provided in
693 `ChannelManagerReadArgs::default_config::channel_options` the first time the
694 `ChannelManager` is loaded in 0.0.99 (#975).
695 * We now reject HTLCs which are received to be forwarded over private channels
696 unless `UserConfig::accept_forwards_to_priv_channels` is set. Note that
697 `UserConfig` is never serialized and must be provided via
698 `ChannelManagerReadArgs::default_config` at each start (#975).
702 * We now forward gossip messages to peers instead of only relaying
703 locally-generated gossip or sending gossip messages during initial sync
705 * Correctly send `channel_update` messages to direct peers on private channels
706 (#949). Without this, a private node connected to an LDK node over a private
707 channel cannot receive funds as it does not know which fees the LDK node
709 * `lightning::ln::channelmanager::ChannelManager` no longer expects to be
710 persisted spuriously after we receive a `channel_update` message about any
711 channel in the routing gossip (#972).
712 * Asynchronous `ChannelMonitor` updates (using the
713 `ChannelMonitorUpdateErr::TemporaryFailure` return variant) no longer cause
714 spurious HTLC forwarding failures (#954).
715 * Transaction provided via `ChannelMonitor::transactions_confirmed`
716 after `ChannelMonitor::best_block_updated` was called for a much later
717 block now trigger all relevant actions as of the later block. Previously
718 some transaction broadcasts or other responses required an additional
719 block be provided via `ChannelMonitor::best_block_updated` (#970).
720 * We no longer panic in rare cases when an invoice contained last-hop route
721 hints which were unusable (#958).
723 ## Node Compatibility
725 * We now accept spurious `funding_locked` messages sent prior to
726 `channel_reestablish` messages after reconnect. This is a
727 [known, long-standing bug in lnd](https://github.com/lightningnetwork/lnd/issues/4006)
729 * We now set the `first_blocknum` and `number_of_blocks` fields in
730 `reply_channel_range` messages to values which c-lightning versions prior to
731 0.10 accepted. This avoids spurious force-closes from such nodes (#961).
733 ## Serialization Compatibility
735 * Due to a bug discovered in 0.0.98, if a `ChannelManager` is serialized on
736 version 0.0.98 while an `Event::PaymentSent` is pending processing, the
737 `ChannelManager` will fail to deserialize both on version 0.0.98 and later
738 versions. If you have such a `ChannelManager` available, a simple patch will
739 allow it to deserialize. Please file an issue if you need assistance (#973).
741 # 0.0.98 - 2021-06-11
743 0.0.98 should be considered a release candidate to the first alpha release of
744 Rust-Lightning and the broader LDK. It represents several years of work
745 designing and fine-tuning a flexible API for integrating lightning into any
746 application. LDK should make it easy to build a lightning node or client which
747 meets specific requirements that other lightning node software cannot. As
748 lightning continues to evolve, and new use-cases for lightning develop, the API
749 of LDK will continue to change and expand. However, starting with version 0.1,
750 objects serialized with prior versions will be readable with the latest LDK.
751 While Rust-Lightning is approaching the 0.1 milestone, language bindings
752 components of LDK available at https://github.com/lightningdevkit are still of
753 varying quality. Some are also approaching an 0.1 release, while others are
754 still much more experimental. Please note that, at 0.0.98, using Rust-Lightning
755 on mainnet is *strongly* discouraged.
projects / rust-lightning / blob