4 * This release is almost entirely focused on a new API in the
5 `lightning-invoice` crate - the `InvoicePayer`. `InvoicePayer` is a
6 struct which takes a reference to a `ChannelManager` and a `Router`
7 and retries payments as paths fail. It limits retries to a configurable
8 number, but is not serialized to disk and may retry additional times across
9 a serialization/load. In order to learn about failed payments, it must
10 receive `Event`s directly from the `ChannelManager`, wrapping a
11 user-provided `EventHandler` which it provides all unhandled events to
13 * `get_route` has been renamed `find_route` (#1059) and now takes a
14 `RouteParameters` struct in replacement of a number of its long list of
15 arguments (#1134). The `Payee` in the `RouteParameters` is stored in the
16 `Route` object returned and provided in the `RouteParameters` contained in
17 `Event::PaymentPathFailed` (#1059).
18 * `ChannelMonitor`s must now be persisted after calls that provide new block
19 data, prior to `MonitorEvent`s being passed back to `ChannelManager` for
20 processing. If you are using a `ChainMonitor` this is handled for you.
21 The `Persist` API has been updated to `Option`ally take the
22 `ChannelMonitorUpdate` as persistence events that result from chain data no
23 longer have a corresponding update (#1108).
24 * `routing::Score` now has a `payment_path_failed` method which it can use to
25 learn which channels often fail payments. It is automatically called by
26 `InvoicePayer` for failed payment paths (#1144).
27 * The default `Scorer` implementation is now a type alias to a type generic
28 across different clocks and supports serialization to persist scoring data
29 across restarts (#1146).
30 * `Event::PaymentSent` now includes the full fee which was spent across all
31 payment paths which were fulfilled or pending when the payment was fulfilled
33 * `Event::PaymentSent` and `Event::PaymentPathFailed` now include the
34 `PaymentId` which matches the `PaymentId` returned from
35 `ChannelManager::send_payment` or `InvoicePayer::pay_invoice` (#1059).
36 * `NetGraphMsgHandler` now takes a `Deref` to the `NetworkGraph`, allowing for
37 shared references to the graph data to make serialization and references to
38 the graph data in the `InvoicePayer`'s `Router` simpler (#1149).
39 * `routing::Score::channel_penalty_msat` has been updated to provide the
40 `NodeId` of both the source and destination nodes of a channel (#1133).
43 * Previous versions would often disconnect peers during initial graph sync due
44 to ping timeouts while processing large numbers of gossip messages. We now
45 delay disconnecting peers if we receive messages from them even if it takes
46 a while to receive a pong from them. Further, we avoid sending too many
47 gossip messages between pings to ensure we should always receive pongs in a
48 timely manner (#1137).
49 * If a payment was sent, creating an outbound HTLC and sending it to our
50 counterparty (implying the `ChannelMonitor` was persisted on disk), but the
51 `ChannelManager` was not persisted prior to shutdown/crash, no
52 `Event::PaymentPathFailed` event was generated if the HTLC was eventually
53 failed on chain. Events are now consistent irrespective of `ChannelManager`
54 persistence or non-persistence (#1104).
56 ## Serialization Compatibility
57 * All above new Events/fields are ignored by prior clients. All above new
58 Events/fields are not present when reading objects serialized by prior
59 versions of the library.
60 * Payments for which a `Route` was generated using a previous version or for
61 which the payment was originally sent by a previous version of the library
62 will not be retried by an `InvoicePayer`.
64 This release was singularly focused and some contributions by third parties
66 In total, this release features 38 files changed, 4414 insertions, and 969
67 deletions in 71 commits from 2 authors, in alphabetical order:
73 # 0.0.102 - 2021-10-18
76 * `get_route` now takes a `Score` as an argument. `Score` is queried during
77 the route-finding process, returning the absolute amounts which you are
78 willing to pay to avoid routing over a given channel. As a default, a
79 `Scorer` is provided which returns a constant amount, with a suggested
80 default of 500 msat. This translates to a willingness to pay up to 500 msat
81 in additional fees per hop in order to avoid additional hops (#1124).
82 * `Event::PaymentPathFailed` now contains a `short_channel_id` field which may
83 be filled in with a channel that can be "blamed" for the payment failure.
84 Payment retries should likely avoid the given channel for some time (#1077).
85 * `PublicKey`s in `NetworkGraph` have been replaced with a `NodeId` struct
86 which contains only a simple `[u8; 33]`, substantially improving
87 `NetworkGraph` deserialization performance (#1107).
88 * `ChainMonitor`'s `HashMap` of `ChannelMonitor`s is now private, exposed via
89 `Chainmonitor::get_monitor` and `ChainMonitor::list_monitors` instead
91 * When an outbound channel is closed prior to the broadcasting of its funding
92 transaction, but after you call
93 `ChannelManager::funding_transaction_generated`, a new event type,
94 `Event::DiscardFunding`, is generated, informing you the transaction was not
95 broadcasted and that you can spend the same inputs again elsewhere (#1098).
96 * `ChannelManager::create_channel` now returns the temporary channel ID which
97 may later appear in `Event::ChannelClosed` or `ChannelDetails` prior to the
98 channel being funded (#1121).
99 * `Event::PaymentSent` now contains the payment hash as well as the payment
101 * `ReadOnlyNetworkGraph::get_addresses` now returns owned `NetAddress` rather
102 than references. As a side-effect this method is now exposed in foreign
103 language bindings (#1115).
104 * The `Persist` and `ChannelMonitorUpdateErr` types have moved to the
105 `lightning::chain::chainmonitor` and `lightning::chain` modules,
106 respectively (#1112).
107 * `ChannelManager::send_payment` now returns a `PaymentId` which identifies a
108 payment (whether MPP or not) and can be used to retry the full payment or
109 MPP parts through `retry_payment` (#1096). Note that doing so is currently
110 *not* crash safe, and you may find yourself sending twice. It is recommended
111 that you *not* use the `retry_payment` API until the next release.
114 * Due to an earlier fix for the Lightning dust inflation vulnerability tracked
115 in CVE-2021-41591/CVE-2021-41592/CVE-2021-41593 in 0.0.100, we required
116 counterparties to accept a dust limit slightly lower than the dust limit now
117 required by other implementations. This appeared as, at least, latest lnd
118 always refusing to accept channels opened by LDK clients (#1065).
119 * If there are multiple channels available to the same counterparty,
120 `get_route` would only consider the channel listed last as available for
122 * `Persist` implementations returning
123 `ChannelMonitorUpdateErr::TemporaryFailure` from `watch_channel` previously
124 resulted in the `ChannelMonitor` not being stored at all, resulting in a
125 panic after monitor updating is complete (#1112).
126 * If payments are pending awaiting forwarding at startup, an
127 `Event::PendingHTLCsForwardable` event will always be provided. This ensures
128 user code calls `ChannelManager::process_pending_htlc_fowards` even if it
129 shut down while awaiting the batching timer during the previous run (#1076).
130 * If a call to `ChannelManager::send_payment` failed due to lack of
131 availability of funds locally, LDK would store the payment as pending
132 forever, with no ability to retry or fail it, leaking memory (#1109).
134 ## Serialization Compatibility
135 * All above new Events/fields are ignored by prior clients. All above new
136 Events/fields, except for `Event::PaymentSent::payment_hash` are not present
137 when reading objects serialized by prior versions of the library.
139 In total, this release features 32 files changed, 2248 insertions, and 1483
140 deletions in 51 commits from 7 authors, in alphabetical order:
151 # 0.0.101 - 2021-09-23
154 * Custom message types are now supported directly in the `PeerManager`,
155 allowing you to send and receive messages of any type that is not natively
156 understood by LDK. This requires a new type bound on `PeerManager`, a
157 `CustomMessageHandler`. `IgnoringMessageHandler` provides a simple default
158 for this new bound for ignoring unknown messages (#1031, #1074).
159 * Route graph updates as a result of failed payments are no longer provided as
160 `MessageSendEvent::PaymentFailureNetworkUpdate` but instead included in a
161 new field in the `Event::PaymentFailed` events. Generally, this means route
162 graph updates are no longer handled as a part of the `PeerManager` but
163 instead through the new `EventHandler` implementation for
164 `NetGraphMsgHandler`. To make this easy, a new parameter to
165 `lightning-background-processor::BackgroundProcessor::start` is added, which
166 contains an `Option`al `NetGraphmsgHandler`. If provided as `Some`, relevant
167 events will be processed by the `NetGraphMsgHandler` prior to normal event
169 * `NetworkGraph` is now, itself, thread-safe. Accordingly, most functions now
170 take `&self` instead of `&mut self` and the graph data can be accessed
171 through `NetworkGraph.read_only` (#1043).
172 * The balances available on-chain to claim after a channel has been closed are
173 now exposed via `ChannelMonitor::get_claimable_balances` and
174 `ChainMonitor::get_claimable_balances`. The second can be used to get
175 information about all closed channels which still have on-chain balances
176 associated with them. See enum variants of `ln::channelmonitor::Balance` and
177 method documentation for the above methods for more information on the types
178 of balances exposed (#1034).
179 * When one HTLC of a multi-path payment fails, the new field `all_paths_failed`
180 in `Event::PaymentFailed` is set to `false`. This implies that the payment
181 has not failed, but only one part. Payment resolution is only indicated by an
182 `Event::PaymentSent` event or an `Event::PaymentFailed` with
183 `all_paths_failed` set to `true`, which is also set for the last remaining
184 part of a multi-path payment (#1053).
185 * To better capture the context described above, `Event::PaymentFailed` has
186 been renamed to `Event::PaymentPathFailed` (#1084).
187 * A new event, `ChannelClosed`, is provided by `ChannelManager` when a channel
188 is closed, including a reason and error message (if relevant, #997).
189 * `lightning-invoice` now considers invoices with sub-millisatoshi precision
190 to be invalid, and requires millisatoshi values during construction (thus
191 you must call `amount_milli_satoshis` instead of `amount_pico_btc`, #1057).
192 * The `BaseSign` interface now includes two new hooks which provide additional
193 information about commitment transaction signatures and revocation secrets
194 provided by our counterparty, allowing additional verification (#1039).
195 * The `BaseSign` interface now includes additional information for cooperative
196 close transactions, making it easier for a signer to verify requests (#1064).
197 * `Route` has two additional helper methods to get fees and amounts (#1063).
198 * `Txid` and `Transaction` objects can now be deserialized from responses when
199 using the HTTP client in the `lightning-block-sync` crate (#1037, #1061).
202 * Fix a panic when reading a lightning invoice with a non-recoverable
203 signature. Further, restrict lightning invoice parsing to require payment
204 secrets and better handle a few edge cases as required by BOLT 11 (#1057).
205 * Fix a panic when receiving multiple messages (such as HTLC fulfill messages)
206 after a call to `chain::Watch::update_channel` returned
207 `Err(ChannelMonitorUpdateErr::TemporaryFailure)` with no
208 `ChannelManager::channel_monitor_updated` call in between (#1066).
209 * For multi-path payments, `Event::PaymentSent` is no longer generated
210 multiple times, once for each independent part (#1053).
211 * Multi-hop route hints in invoices are now considered in the default router
212 provided via `get_route` (#1040).
213 * The time peers have to respond to pings has been increased when building
214 with debug assertions enabled. This avoids peer disconnections on slow hosts
215 when running in debug mode (#1051).
216 * The timeout for the first byte of a response for requests from the
217 `lightning-block-sync` crate has been increased to 300 seconds to better
218 handle the long hangs in Bitcoin Core when it syncs to disk (#1090).
220 ## Serialization Compatibility
221 * Due to a bug in 0.0.100, `Event`s written by 0.0.101 which are of a type not
222 understood by 0.0.100 may lead to `Err(DecodeError::InvalidValue)` or corrupt
223 deserialized objects in 0.100. Such `Event`s will lead to an
224 `Err(DecodeError::InvalidValue)` in versions prior to 0.0.100. The only such
225 new event written by 0.0.101 is `Event::ChannelClosed` (#1087).
226 * Payments that were initiated in versions prior to 0.0.101 may still
227 generate duplicate `PaymentSent` `Event`s or may have spurious values for
228 `Event::PaymentPathFailed::all_paths_failed` (#1053).
229 * The return values of `ChannelMonitor::get_claimable_balances` (and, thus,
230 `ChainMonitor::get_claimable_balances`) may be spurious for channels where
231 the spend of the funding transaction appeared on chain while running a
232 version prior to 0.0.101. `Balance` information should only be relied upon
233 for channels that were closed while running 0.0.101+ (#1034).
234 * Payments failed while running versions prior to 0.0.101 will never have a
235 `Some` for the `network_update` field (#1043).
237 In total, this release features 67 files changed, 4980 insertions, 1888
238 deletions in 89 commits from 12 authors, in alphabetical order:
246 * Sergi Delgado Segura
253 # 0.0.100 - 2021-08-17
256 * The `lightning` crate can now be built in no_std mode, making it easy to
257 target embedded hardware for rust users. Note that mutexes are replaced with
258 no-ops for such builds (#1008, #1028).
259 * LDK now supports sending and receiving "keysend" payments. This includes
260 modifications to `lightning::util::events::Event::PaymentReceived` to
261 indicate the type of payment (#967).
262 * A new variant, `lightning::util::events::Event::PaymentForwarded` has been
263 added which indicates a forwarded payment has been successfully claimed and
264 we've received a forwarding fee (#1004).
265 * `lightning::chain::keysinterface::KeysInterface::get_shutdown_pubkey` has
266 been renamed to `get_shutdown_scriptpubkey`, returns a script, and is now
267 called on channel open only if
268 `lightning::util::config::ChannelConfig::commit_upfront_shutdown_pubkey` is
270 * Closing-signed negotiation is now more configurable, with an explicit
271 `lightning::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis`
272 field allowing you to select the maximum amount you are willing to pay to
273 avoid a force-closure. Further, we are now less restrictive on the fee
274 placed on the closing transaction when we are not the party paying it. To
275 control the feerate paid on a channel at close-time, use
276 `ChannelManager::close_channel_with_target_feerate` instead of
277 `close_channel` (#1011).
278 * `lightning_background_processor::BackgroundProcessor` now stops the
279 background thread when dropped (#1007). It is marked `#[must_use]` so that
280 Rust users will receive a compile-time warning when it is immediately
281 dropped after construction (#1029).
282 * Total potential funds burn on force-close due to dust outputs is now limited
283 to `lightning::util::config::ChannelConfig::max_dust_htlc_exposure_msat` per
285 * The interval on which
286 `lightning::ln::peer_handler::PeerManager::timer_tick_occurred` should be
287 called has been reduced to once every five seconds (#1035) and
288 `lightning::ln::channelmanager::ChannelManager::timer_tick_occurred` should
289 now be called on startup in addition to once per minute (#985).
290 * The rust-bitcoin and bech32 dependencies have been updated to their
291 respective latest versions (0.27 and 0.8, #1012).
294 * Fix panic when reading invoices generated by some versions of c-lightning
296 * Fix panic when attempting to validate a signed message of incorrect length
298 * Do not ignore the route hints in invoices when the invoice is over 250k
300 * Fees are automatically updated on outbound channels to ensure commitment
301 transactions are always broadcastable (#985).
302 * Fixes a rare case where a `lightning::util::events::Event::SpendableOutputs`
303 event is not generated after a counterparty commitment transaction is
304 confirmed in a reorg when a conflicting local commitment transaction is
305 removed in the same reorg (#1022).
306 * Fixes a remotely-triggerable force-closure of an origin channel after an
307 HTLC was forwarded over a next-hop channel and the next-hop channel was
308 force-closed by our counterparty (#1025).
309 * Fixes a rare force-closure case when sending a payment as a channel fundee
310 when overdrawing our remaining balance. Instead the send will fail (#998).
311 * Fixes a rare force-closure case when a payment was claimed prior to a
312 peer disconnection or restart, and later failed (#977).
314 ## Serialization Compatibility
315 * Pending inbound keysend payments which have neither been failed nor claimed
316 when serialized will result in a `ChannelManager` which is not readable on
317 pre-0.0.100 clients (#967).
319 `lightning::chain::keysinterface::KeysInterface::get_shutdown_scriptpubkey`
320 has been updated to return a script instead of only a `PublicKey`,
321 `ChannelManager`s constructed with custom `KeysInterface` implementations on
322 0.0.100 and later versions will not be readable on previous versions.
323 `ChannelManager`s created with 0.0.99 and prior versions will remain readable
324 even after the a serialization roundtrip on 0.0.100, as long as no new
325 channels are opened. Further, users using a
326 `lightning::chain::keysinterface::KeysManager` as their `KeysInterface` will
327 have `ChannelManager`s which are readable on prior versions as well (#1019).
328 * `ChannelMonitorUpdate`s created by 0.0.100 and later for channels when
329 `lightning::util::config::ChannelConfig::commit_upfront_shutdown_pubkey` is
330 not set may not be readable by versions prior to 0.0.100 (#1019).
331 * HTLCs which were in the process of being claimed on-chain when a pre-0.0.100
332 `ChannelMonitor` was serialized may generate `PaymentForwarded` events with
333 spurious `fee_earned_msat` values. This only applies to payments which were
334 unresolved at the time of the upgrade (#1004).
335 * 0.0.100 clients with pending `Event::PaymentForwarded` events at
336 serialization-time will generate serialized `ChannelManager` objects which
337 0.0.99 and earlier clients cannot read. The likelihood of this can be reduced
338 by ensuring you process all pending events immediately before serialization
339 (as is done by the `lightning-background-processor` crate, #1004).
342 In total, this release features 59 files changed, 5861 insertions, and 2082
343 deletions in 95 commits from 6 authors.
346 # 0.0.99 - 2021-07-09
350 * `lightning_block_sync::poll::Validate` is now public, allowing you to
351 implement the `lightning_block_sync::poll::Poll` trait without
352 `lightning_block_sync::poll::ChainPoller` (#956).
353 * `lightning::ln::peer_handler::PeerManager` no longer requires that no calls
354 are made to referencing the same `SocketDescriptor` after
355 `disconnect_socket` returns. This makes the API significantly less
356 deadlock-prone and simplifies `SocketDescriptor` implementations
357 significantly. The relevant changes have been made to `lightning_net_tokio`
358 and `PeerManager` documentation has been substantially rewritten (#957).
359 * `lightning::util::message_signing`'s `sign` and `verify` methods now take
360 secret and public keys by reference instead of value (#974).
361 * Substantially more information is now exposed about channels in
362 `ChannelDetails`. See documentation for more info (#984 and #988).
363 * The latest best block seen is now exposed in
364 `ChannelManager::current_best_block` and
365 `ChannelMonitor::current_best_block` (#984).
366 * Feerates charged when forwarding payments over channels is now set in
367 `ChannelConfig::fee_base_msat` when the channel is opened. For existing
368 channels, the value is set to the value provided in
369 `ChannelManagerReadArgs::default_config::channel_options` the first time the
370 `ChannelManager` is loaded in 0.0.99 (#975).
371 * We now reject HTLCs which are received to be forwarded over private channels
372 unless `UserConfig::accept_forwards_to_priv_channels` is set. Note that
373 `UserConfig` is never serialized and must be provided via
374 `ChannelManagerReadArgs::default_config` at each start (#975).
378 * We now forward gossip messages to peers instead of only relaying
379 locally-generated gossip or sending gossip messages during initial sync
381 * Correctly send `channel_update` messages to direct peers on private channels
382 (#949). Without this, a private node connected to an LDK node over a private
383 channel cannot receive funds as it does not know which fees the LDK node
385 * `lightning::ln::channelmanager::ChannelManager` no longer expects to be
386 persisted spuriously after we receive a `channel_update` message about any
387 channel in the routing gossip (#972).
388 * Asynchronous `ChannelMonitor` updates (using the
389 `ChannelMonitorUpdateErr::TemporaryFailure` return variant) no longer cause
390 spurious HTLC forwarding failures (#954).
391 * Transaction provided via `ChannelMonitor::transactions_confirmed`
392 after `ChannelMonitor::best_block_updated` was called for a much later
393 block now trigger all relevant actions as of the later block. Previously
394 some transaction broadcasts or other responses required an additional
395 block be provided via `ChannelMonitor::best_block_updated` (#970).
396 * We no longer panic in rare cases when an invoice contained last-hop route
397 hints which were unusable (#958).
399 ## Node Compatibility
401 * We now accept spurious `funding_locked` messages sent prior to
402 `channel_reestablish` messages after reconnect. This is a
403 [known, long-standing bug in lnd](https://github.com/lightningnetwork/lnd/issues/4006)
405 * We now set the `first_blocknum` and `number_of_blocks` fields in
406 `reply_channel_range` messages to values which c-lightning versions prior to
407 0.10 accepted. This avoids spurious force-closes from such nodes (#961).
409 ## Serialization Compatibility
411 * Due to a bug discovered in 0.0.98, if a `ChannelManager` is serialized on
412 version 0.0.98 while an `Event::PaymentSent` is pending processing, the
413 `ChannelManager` will fail to deserialize both on version 0.0.98 and later
414 versions. If you have such a `ChannelManager` available, a simple patch will
415 allow it to deserialize. Please file an issue if you need assistance (#973).
417 # 0.0.98 - 2021-06-11
419 0.0.98 should be considered a release candidate to the first alpha release of
420 Rust-Lightning and the broader LDK. It represents several years of work
421 designing and fine-tuning a flexible API for integrating lightning into any
422 application. LDK should make it easy to build a lightning node or client which
423 meets specific requirements that other lightning node software cannot. As
424 lightning continues to evolve, and new use-cases for lightning develop, the API
425 of LDK will continue to change and expand. However, starting with version 0.1,
426 objects serialized with prior versions will be readable with the latest LDK.
427 While Rust-Lightning is approaching the 0.1 milestone, language bindings
428 components of LDK available at https://github.com/lightningdevkit are still of
429 varying quality. Some are also approaching an 0.1 release, while others are
430 still much more experimental. Please note that, at 0.0.98, using Rust-Lightning
431 on mainnet is *strongly* discouraged.
projects / rust-lightning / blob