4 * A `PaymentFailed` event is now provided to indicate a payment has failed
5 fully. This event is generated either after
6 `ChannelManager::abandon_payment` is called for a given payment, or the
7 payment times out, and there are no further pending HTLCs for the payment.
8 This event should be used to detect payment failure instead of
9 `PaymentPathFailed::all_paths_failed`, unless no payment retries occur via
10 `ChannelManager::retry_payment` (#1202).
11 * Payment secrets are now generated deterministically using material from
12 the new `KeysInterface::get_inbound_payment_key_material` (#1177).
13 * A `PaymentPathSuccessful` event has been added to ease passing success info
14 to a scorer, along with a `Score::payment_path_successful` method to accept
15 such info (#1178, #1197).
16 * `Score::channel_penalty_msat` has additional arguments describing the
17 channel's capacity and the HTLC amount being sent over the channel (#1166).
18 * A new log level `Gossip` has been added, which is used for verbose
19 information generated during network graph sync. Enabling the
20 `max_level_trace` feature or ignoring `Gossip` log entries reduces log
21 growth during initial start up from many GiB to several MiB (#1145).
22 * The `allow_wallclock_use` feature has been removed in favor of only using
23 the `std` and `no-std` features (#1212).
24 * `NetworkGraph` can now remove channels that we haven't heard updates for in
25 two weeks with `NetworkGraph::remove_stale_channels{,with_time}`. The first
26 is called automatically if a `NetGraphMsgHandler` is passed to
27 `BackgroundProcessor::start` (#1212).
28 * `InvoicePayer::pay_pubkey` was added to enable sending "keysend" payments to
29 supported recipients, using the `InvoicePayer` to handle retires (#1160).
30 * `user_payment_id` has been removed from `PaymentPurpose`, and
31 `ChannelManager::create_inbound_payment{,_for_hash}` (#1180).
32 * Updated documentation for several `ChannelManager` functions to remove stale
33 references to panics which no longer occur (#1201).
34 * The `Score` and `LockableScore` objects have moved into the
35 `routing::scoring` module instead of being in the `routing` module (#1166).
36 * The `Time` parameter to `ScorerWithTime` is no longer longer exposed,
37 instead being fixed based on the `std`/`no-std` feature (#1184).
38 * `ChannelDetails::balance_msat` was added to fetch a channel's balance
39 without subtracting the reserve values, lining up with on-chain claim amounts
40 less on-chain fees (#1203).
41 * An explicit `UserConfig::accept_inbound_channels` flag is now provided,
42 removing the need to set `min_funding_satoshis` to > 21 million BTC (#1173).
43 * Inbound channels that fail to see the funding transaction confirm within
44 2016 blocks are automatically force-closed with
45 `ClosureReason::FundingTimedOut` (#1083).
46 * We now accept a channel_reserve value of 0 from counterparties, as it is
47 insecure for our counterparty but not us (#1163).
48 * `NetAddress::OnionV2` parsing was removed as version 2 onion services are no
49 longer supported in modern Tor (#1204).
50 * Generation and signing of anchor outputs is now supported in the
51 `KeysInterface`, though no support for them exists in the channel itself (#1176)
54 * Fixed a race condition in `InvoicePayer` where paths may be retried after
55 the retry count has been exceeded. In this case the
56 `Event::PaymentPathFailed::all_paths_failed` field is not a reliable payment
57 failure indicator. There was no acceptable alternative indicator,
58 `Event::PaymentFailed` as been added to provide one (#1202).
59 * Reduced the blocks-before-timeout we expect of outgoing HTLCs before
60 refusing to forward. This check was overly strict and resulted in refusing
61 to forward som HTLCs to a next hop that had a lower security threshold than
63 * LDK no longer attempt to update the channel fee for outbound channels when
64 we cannot afford the new fee. This could have caused force-closure by our
65 channel counterparty (#1054).
66 * Fixed several bugs which may have prevented the reliable broadcast of our
67 own channel announcements and updates (#1169).
68 * Fixed a rare bug which may have resulted in spurious route finding failures
69 when using last-hop hints and MPP with large value payments (#1168).
70 * `KeysManager::spend_spendable_outputs` no longer adds a change output that
71 is below the dust threshold for non-standard change scripts (#1131).
72 * Fixed a minor memory leak when attempting to send a payment that fails due
73 to an error when updating the `ChannelMonitor` (#1143).
74 * Fixed a bug where a `FeeEstimator` that returns values rounded to the next
75 sat/vbyte may result in force-closures (#1208).
76 * Handle MPP timeout HTLC error codes, instead of considering the recipient to
77 have sent an invalid error, removing them from the network graph (#1148)
79 ## Serialization Compatibility
80 * All above new events/fields are ignored by prior clients. All above new
81 events/fields are not present when reading objects serialized by prior
82 versions of the library.
83 * Payment secrets are now generated deterministically. This reduces the memory
84 footprint for inbound payments, however, newly-generated inbound payments
85 using `ChannelManager::create_inbound_payment{,_for_hash}` will not be
86 receivable using versions prior to 0.0.104.
87 `ChannelManager::create_inbound_payment{,_for_hash}_legacy` are provided for
88 backwards compatibility (#1177).
89 * `PaymentPurpose::InvoicePayment::user_payment_id` will be 0 when reading
90 objects written with 0.0.104 when read by 0.0.103 and previous (#1180).
92 In total, this release features 51 files changed, 5356 insertions, 2238
93 deletions in 107 commits from 9 authors, in alphabetical order:
105 # 0.0.103 - 2021-11-02
108 * This release is almost entirely focused on a new API in the
109 `lightning-invoice` crate - the `InvoicePayer`. `InvoicePayer` is a
110 struct which takes a reference to a `ChannelManager` and a `Router`
111 and retries payments as paths fail. It limits retries to a configurable
112 number, but is not serialized to disk and may retry additional times across
113 a serialization/load. In order to learn about failed payments, it must
114 receive `Event`s directly from the `ChannelManager`, wrapping a
115 user-provided `EventHandler` which it provides all unhandled events to
117 * `get_route` has been renamed `find_route` (#1059) and now takes a
118 `RouteParameters` struct in replacement of a number of its long list of
119 arguments (#1134). The `Payee` in the `RouteParameters` is stored in the
120 `Route` object returned and provided in the `RouteParameters` contained in
121 `Event::PaymentPathFailed` (#1059).
122 * `ChannelMonitor`s must now be persisted after calls that provide new block
123 data, prior to `MonitorEvent`s being passed back to `ChannelManager` for
124 processing. If you are using a `ChainMonitor` this is handled for you.
125 The `Persist` API has been updated to `Option`ally take the
126 `ChannelMonitorUpdate` as persistence events that result from chain data no
127 longer have a corresponding update (#1108).
128 * `routing::Score` now has a `payment_path_failed` method which it can use to
129 learn which channels often fail payments. It is automatically called by
130 `InvoicePayer` for failed payment paths (#1144).
131 * The default `Scorer` implementation is now a type alias to a type generic
132 across different clocks and supports serialization to persist scoring data
133 across restarts (#1146).
134 * `Event::PaymentSent` now includes the full fee which was spent across all
135 payment paths which were fulfilled or pending when the payment was fulfilled
137 * `Event::PaymentSent` and `Event::PaymentPathFailed` now include the
138 `PaymentId` which matches the `PaymentId` returned from
139 `ChannelManager::send_payment` or `InvoicePayer::pay_invoice` (#1059).
140 * `NetGraphMsgHandler` now takes a `Deref` to the `NetworkGraph`, allowing for
141 shared references to the graph data to make serialization and references to
142 the graph data in the `InvoicePayer`'s `Router` simpler (#1149).
143 * `routing::Score::channel_penalty_msat` has been updated to provide the
144 `NodeId` of both the source and destination nodes of a channel (#1133).
147 * Previous versions would often disconnect peers during initial graph sync due
148 to ping timeouts while processing large numbers of gossip messages. We now
149 delay disconnecting peers if we receive messages from them even if it takes
150 a while to receive a pong from them. Further, we avoid sending too many
151 gossip messages between pings to ensure we should always receive pongs in a
152 timely manner (#1137).
153 * If a payment was sent, creating an outbound HTLC and sending it to our
154 counterparty (implying the `ChannelMonitor` was persisted on disk), but the
155 `ChannelManager` was not persisted prior to shutdown/crash, no
156 `Event::PaymentPathFailed` event was generated if the HTLC was eventually
157 failed on chain. Events are now consistent irrespective of `ChannelManager`
158 persistence or non-persistence (#1104).
160 ## Serialization Compatibility
161 * All above new Events/fields are ignored by prior clients. All above new
162 Events/fields are not present when reading objects serialized by prior
163 versions of the library.
164 * Payments for which a `Route` was generated using a previous version or for
165 which the payment was originally sent by a previous version of the library
166 will not be retried by an `InvoicePayer`.
168 This release was singularly focused and some contributions by third parties
170 In total, this release features 38 files changed, 4414 insertions, and 969
171 deletions in 71 commits from 2 authors, in alphabetical order:
177 # 0.0.102 - 2021-10-18
180 * `get_route` now takes a `Score` as an argument. `Score` is queried during
181 the route-finding process, returning the absolute amounts which you are
182 willing to pay to avoid routing over a given channel. As a default, a
183 `Scorer` is provided which returns a constant amount, with a suggested
184 default of 500 msat. This translates to a willingness to pay up to 500 msat
185 in additional fees per hop in order to avoid additional hops (#1124).
186 * `Event::PaymentPathFailed` now contains a `short_channel_id` field which may
187 be filled in with a channel that can be "blamed" for the payment failure.
188 Payment retries should likely avoid the given channel for some time (#1077).
189 * `PublicKey`s in `NetworkGraph` have been replaced with a `NodeId` struct
190 which contains only a simple `[u8; 33]`, substantially improving
191 `NetworkGraph` deserialization performance (#1107).
192 * `ChainMonitor`'s `HashMap` of `ChannelMonitor`s is now private, exposed via
193 `Chainmonitor::get_monitor` and `ChainMonitor::list_monitors` instead
195 * When an outbound channel is closed prior to the broadcasting of its funding
196 transaction, but after you call
197 `ChannelManager::funding_transaction_generated`, a new event type,
198 `Event::DiscardFunding`, is generated, informing you the transaction was not
199 broadcasted and that you can spend the same inputs again elsewhere (#1098).
200 * `ChannelManager::create_channel` now returns the temporary channel ID which
201 may later appear in `Event::ChannelClosed` or `ChannelDetails` prior to the
202 channel being funded (#1121).
203 * `Event::PaymentSent` now contains the payment hash as well as the payment
205 * `ReadOnlyNetworkGraph::get_addresses` now returns owned `NetAddress` rather
206 than references. As a side-effect this method is now exposed in foreign
207 language bindings (#1115).
208 * The `Persist` and `ChannelMonitorUpdateErr` types have moved to the
209 `lightning::chain::chainmonitor` and `lightning::chain` modules,
210 respectively (#1112).
211 * `ChannelManager::send_payment` now returns a `PaymentId` which identifies a
212 payment (whether MPP or not) and can be used to retry the full payment or
213 MPP parts through `retry_payment` (#1096). Note that doing so is currently
214 *not* crash safe, and you may find yourself sending twice. It is recommended
215 that you *not* use the `retry_payment` API until the next release.
218 * Due to an earlier fix for the Lightning dust inflation vulnerability tracked
219 in CVE-2021-41591/CVE-2021-41592/CVE-2021-41593 in 0.0.100, we required
220 counterparties to accept a dust limit slightly lower than the dust limit now
221 required by other implementations. This appeared as, at least, latest lnd
222 always refusing to accept channels opened by LDK clients (#1065).
223 * If there are multiple channels available to the same counterparty,
224 `get_route` would only consider the channel listed last as available for
226 * `Persist` implementations returning
227 `ChannelMonitorUpdateErr::TemporaryFailure` from `watch_channel` previously
228 resulted in the `ChannelMonitor` not being stored at all, resulting in a
229 panic after monitor updating is complete (#1112).
230 * If payments are pending awaiting forwarding at startup, an
231 `Event::PendingHTLCsForwardable` event will always be provided. This ensures
232 user code calls `ChannelManager::process_pending_htlc_fowards` even if it
233 shut down while awaiting the batching timer during the previous run (#1076).
234 * If a call to `ChannelManager::send_payment` failed due to lack of
235 availability of funds locally, LDK would store the payment as pending
236 forever, with no ability to retry or fail it, leaking memory (#1109).
238 ## Serialization Compatibility
239 * All above new Events/fields are ignored by prior clients. All above new
240 Events/fields, except for `Event::PaymentSent::payment_hash` are not present
241 when reading objects serialized by prior versions of the library.
243 In total, this release features 32 files changed, 2248 insertions, and 1483
244 deletions in 51 commits from 7 authors, in alphabetical order:
255 # 0.0.101 - 2021-09-23
258 * Custom message types are now supported directly in the `PeerManager`,
259 allowing you to send and receive messages of any type that is not natively
260 understood by LDK. This requires a new type bound on `PeerManager`, a
261 `CustomMessageHandler`. `IgnoringMessageHandler` provides a simple default
262 for this new bound for ignoring unknown messages (#1031, #1074).
263 * Route graph updates as a result of failed payments are no longer provided as
264 `MessageSendEvent::PaymentFailureNetworkUpdate` but instead included in a
265 new field in the `Event::PaymentFailed` events. Generally, this means route
266 graph updates are no longer handled as a part of the `PeerManager` but
267 instead through the new `EventHandler` implementation for
268 `NetGraphMsgHandler`. To make this easy, a new parameter to
269 `lightning-background-processor::BackgroundProcessor::start` is added, which
270 contains an `Option`al `NetGraphmsgHandler`. If provided as `Some`, relevant
271 events will be processed by the `NetGraphMsgHandler` prior to normal event
273 * `NetworkGraph` is now, itself, thread-safe. Accordingly, most functions now
274 take `&self` instead of `&mut self` and the graph data can be accessed
275 through `NetworkGraph.read_only` (#1043).
276 * The balances available on-chain to claim after a channel has been closed are
277 now exposed via `ChannelMonitor::get_claimable_balances` and
278 `ChainMonitor::get_claimable_balances`. The second can be used to get
279 information about all closed channels which still have on-chain balances
280 associated with them. See enum variants of `ln::channelmonitor::Balance` and
281 method documentation for the above methods for more information on the types
282 of balances exposed (#1034).
283 * When one HTLC of a multi-path payment fails, the new field `all_paths_failed`
284 in `Event::PaymentFailed` is set to `false`. This implies that the payment
285 has not failed, but only one part. Payment resolution is only indicated by an
286 `Event::PaymentSent` event or an `Event::PaymentFailed` with
287 `all_paths_failed` set to `true`, which is also set for the last remaining
288 part of a multi-path payment (#1053).
289 * To better capture the context described above, `Event::PaymentFailed` has
290 been renamed to `Event::PaymentPathFailed` (#1084).
291 * A new event, `ChannelClosed`, is provided by `ChannelManager` when a channel
292 is closed, including a reason and error message (if relevant, #997).
293 * `lightning-invoice` now considers invoices with sub-millisatoshi precision
294 to be invalid, and requires millisatoshi values during construction (thus
295 you must call `amount_milli_satoshis` instead of `amount_pico_btc`, #1057).
296 * The `BaseSign` interface now includes two new hooks which provide additional
297 information about commitment transaction signatures and revocation secrets
298 provided by our counterparty, allowing additional verification (#1039).
299 * The `BaseSign` interface now includes additional information for cooperative
300 close transactions, making it easier for a signer to verify requests (#1064).
301 * `Route` has two additional helper methods to get fees and amounts (#1063).
302 * `Txid` and `Transaction` objects can now be deserialized from responses when
303 using the HTTP client in the `lightning-block-sync` crate (#1037, #1061).
306 * Fix a panic when reading a lightning invoice with a non-recoverable
307 signature. Further, restrict lightning invoice parsing to require payment
308 secrets and better handle a few edge cases as required by BOLT 11 (#1057).
309 * Fix a panic when receiving multiple messages (such as HTLC fulfill messages)
310 after a call to `chain::Watch::update_channel` returned
311 `Err(ChannelMonitorUpdateErr::TemporaryFailure)` with no
312 `ChannelManager::channel_monitor_updated` call in between (#1066).
313 * For multi-path payments, `Event::PaymentSent` is no longer generated
314 multiple times, once for each independent part (#1053).
315 * Multi-hop route hints in invoices are now considered in the default router
316 provided via `get_route` (#1040).
317 * The time peers have to respond to pings has been increased when building
318 with debug assertions enabled. This avoids peer disconnections on slow hosts
319 when running in debug mode (#1051).
320 * The timeout for the first byte of a response for requests from the
321 `lightning-block-sync` crate has been increased to 300 seconds to better
322 handle the long hangs in Bitcoin Core when it syncs to disk (#1090).
324 ## Serialization Compatibility
325 * Due to a bug in 0.0.100, `Event`s written by 0.0.101 which are of a type not
326 understood by 0.0.100 may lead to `Err(DecodeError::InvalidValue)` or corrupt
327 deserialized objects in 0.100. Such `Event`s will lead to an
328 `Err(DecodeError::InvalidValue)` in versions prior to 0.0.100. The only such
329 new event written by 0.0.101 is `Event::ChannelClosed` (#1087).
330 * Payments that were initiated in versions prior to 0.0.101 may still
331 generate duplicate `PaymentSent` `Event`s or may have spurious values for
332 `Event::PaymentPathFailed::all_paths_failed` (#1053).
333 * The return values of `ChannelMonitor::get_claimable_balances` (and, thus,
334 `ChainMonitor::get_claimable_balances`) may be spurious for channels where
335 the spend of the funding transaction appeared on chain while running a
336 version prior to 0.0.101. `Balance` information should only be relied upon
337 for channels that were closed while running 0.0.101+ (#1034).
338 * Payments failed while running versions prior to 0.0.101 will never have a
339 `Some` for the `network_update` field (#1043).
341 In total, this release features 67 files changed, 4980 insertions, 1888
342 deletions in 89 commits from 12 authors, in alphabetical order:
350 * Sergi Delgado Segura
357 # 0.0.100 - 2021-08-17
360 * The `lightning` crate can now be built in no_std mode, making it easy to
361 target embedded hardware for rust users. Note that mutexes are replaced with
362 no-ops for such builds (#1008, #1028).
363 * LDK now supports sending and receiving "keysend" payments. This includes
364 modifications to `lightning::util::events::Event::PaymentReceived` to
365 indicate the type of payment (#967).
366 * A new variant, `lightning::util::events::Event::PaymentForwarded` has been
367 added which indicates a forwarded payment has been successfully claimed and
368 we've received a forwarding fee (#1004).
369 * `lightning::chain::keysinterface::KeysInterface::get_shutdown_pubkey` has
370 been renamed to `get_shutdown_scriptpubkey`, returns a script, and is now
371 called on channel open only if
372 `lightning::util::config::ChannelConfig::commit_upfront_shutdown_pubkey` is
374 * Closing-signed negotiation is now more configurable, with an explicit
375 `lightning::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis`
376 field allowing you to select the maximum amount you are willing to pay to
377 avoid a force-closure. Further, we are now less restrictive on the fee
378 placed on the closing transaction when we are not the party paying it. To
379 control the feerate paid on a channel at close-time, use
380 `ChannelManager::close_channel_with_target_feerate` instead of
381 `close_channel` (#1011).
382 * `lightning_background_processor::BackgroundProcessor` now stops the
383 background thread when dropped (#1007). It is marked `#[must_use]` so that
384 Rust users will receive a compile-time warning when it is immediately
385 dropped after construction (#1029).
386 * Total potential funds burn on force-close due to dust outputs is now limited
387 to `lightning::util::config::ChannelConfig::max_dust_htlc_exposure_msat` per
389 * The interval on which
390 `lightning::ln::peer_handler::PeerManager::timer_tick_occurred` should be
391 called has been reduced to once every five seconds (#1035) and
392 `lightning::ln::channelmanager::ChannelManager::timer_tick_occurred` should
393 now be called on startup in addition to once per minute (#985).
394 * The rust-bitcoin and bech32 dependencies have been updated to their
395 respective latest versions (0.27 and 0.8, #1012).
398 * Fix panic when reading invoices generated by some versions of c-lightning
400 * Fix panic when attempting to validate a signed message of incorrect length
402 * Do not ignore the route hints in invoices when the invoice is over 250k
404 * Fees are automatically updated on outbound channels to ensure commitment
405 transactions are always broadcastable (#985).
406 * Fixes a rare case where a `lightning::util::events::Event::SpendableOutputs`
407 event is not generated after a counterparty commitment transaction is
408 confirmed in a reorg when a conflicting local commitment transaction is
409 removed in the same reorg (#1022).
410 * Fixes a remotely-triggerable force-closure of an origin channel after an
411 HTLC was forwarded over a next-hop channel and the next-hop channel was
412 force-closed by our counterparty (#1025).
413 * Fixes a rare force-closure case when sending a payment as a channel fundee
414 when overdrawing our remaining balance. Instead the send will fail (#998).
415 * Fixes a rare force-closure case when a payment was claimed prior to a
416 peer disconnection or restart, and later failed (#977).
418 ## Serialization Compatibility
419 * Pending inbound keysend payments which have neither been failed nor claimed
420 when serialized will result in a `ChannelManager` which is not readable on
421 pre-0.0.100 clients (#967).
423 `lightning::chain::keysinterface::KeysInterface::get_shutdown_scriptpubkey`
424 has been updated to return a script instead of only a `PublicKey`,
425 `ChannelManager`s constructed with custom `KeysInterface` implementations on
426 0.0.100 and later versions will not be readable on previous versions.
427 `ChannelManager`s created with 0.0.99 and prior versions will remain readable
428 even after the a serialization roundtrip on 0.0.100, as long as no new
429 channels are opened. Further, users using a
430 `lightning::chain::keysinterface::KeysManager` as their `KeysInterface` will
431 have `ChannelManager`s which are readable on prior versions as well (#1019).
432 * `ChannelMonitorUpdate`s created by 0.0.100 and later for channels when
433 `lightning::util::config::ChannelConfig::commit_upfront_shutdown_pubkey` is
434 not set may not be readable by versions prior to 0.0.100 (#1019).
435 * HTLCs which were in the process of being claimed on-chain when a pre-0.0.100
436 `ChannelMonitor` was serialized may generate `PaymentForwarded` events with
437 spurious `fee_earned_msat` values. This only applies to payments which were
438 unresolved at the time of the upgrade (#1004).
439 * 0.0.100 clients with pending `Event::PaymentForwarded` events at
440 serialization-time will generate serialized `ChannelManager` objects which
441 0.0.99 and earlier clients cannot read. The likelihood of this can be reduced
442 by ensuring you process all pending events immediately before serialization
443 (as is done by the `lightning-background-processor` crate, #1004).
446 In total, this release features 59 files changed, 5861 insertions, and 2082
447 deletions in 95 commits from 6 authors.
450 # 0.0.99 - 2021-07-09
454 * `lightning_block_sync::poll::Validate` is now public, allowing you to
455 implement the `lightning_block_sync::poll::Poll` trait without
456 `lightning_block_sync::poll::ChainPoller` (#956).
457 * `lightning::ln::peer_handler::PeerManager` no longer requires that no calls
458 are made to referencing the same `SocketDescriptor` after
459 `disconnect_socket` returns. This makes the API significantly less
460 deadlock-prone and simplifies `SocketDescriptor` implementations
461 significantly. The relevant changes have been made to `lightning_net_tokio`
462 and `PeerManager` documentation has been substantially rewritten (#957).
463 * `lightning::util::message_signing`'s `sign` and `verify` methods now take
464 secret and public keys by reference instead of value (#974).
465 * Substantially more information is now exposed about channels in
466 `ChannelDetails`. See documentation for more info (#984 and #988).
467 * The latest best block seen is now exposed in
468 `ChannelManager::current_best_block` and
469 `ChannelMonitor::current_best_block` (#984).
470 * Feerates charged when forwarding payments over channels is now set in
471 `ChannelConfig::fee_base_msat` when the channel is opened. For existing
472 channels, the value is set to the value provided in
473 `ChannelManagerReadArgs::default_config::channel_options` the first time the
474 `ChannelManager` is loaded in 0.0.99 (#975).
475 * We now reject HTLCs which are received to be forwarded over private channels
476 unless `UserConfig::accept_forwards_to_priv_channels` is set. Note that
477 `UserConfig` is never serialized and must be provided via
478 `ChannelManagerReadArgs::default_config` at each start (#975).
482 * We now forward gossip messages to peers instead of only relaying
483 locally-generated gossip or sending gossip messages during initial sync
485 * Correctly send `channel_update` messages to direct peers on private channels
486 (#949). Without this, a private node connected to an LDK node over a private
487 channel cannot receive funds as it does not know which fees the LDK node
489 * `lightning::ln::channelmanager::ChannelManager` no longer expects to be
490 persisted spuriously after we receive a `channel_update` message about any
491 channel in the routing gossip (#972).
492 * Asynchronous `ChannelMonitor` updates (using the
493 `ChannelMonitorUpdateErr::TemporaryFailure` return variant) no longer cause
494 spurious HTLC forwarding failures (#954).
495 * Transaction provided via `ChannelMonitor::transactions_confirmed`
496 after `ChannelMonitor::best_block_updated` was called for a much later
497 block now trigger all relevant actions as of the later block. Previously
498 some transaction broadcasts or other responses required an additional
499 block be provided via `ChannelMonitor::best_block_updated` (#970).
500 * We no longer panic in rare cases when an invoice contained last-hop route
501 hints which were unusable (#958).
503 ## Node Compatibility
505 * We now accept spurious `funding_locked` messages sent prior to
506 `channel_reestablish` messages after reconnect. This is a
507 [known, long-standing bug in lnd](https://github.com/lightningnetwork/lnd/issues/4006)
509 * We now set the `first_blocknum` and `number_of_blocks` fields in
510 `reply_channel_range` messages to values which c-lightning versions prior to
511 0.10 accepted. This avoids spurious force-closes from such nodes (#961).
513 ## Serialization Compatibility
515 * Due to a bug discovered in 0.0.98, if a `ChannelManager` is serialized on
516 version 0.0.98 while an `Event::PaymentSent` is pending processing, the
517 `ChannelManager` will fail to deserialize both on version 0.0.98 and later
518 versions. If you have such a `ChannelManager` available, a simple patch will
519 allow it to deserialize. Please file an issue if you need assistance (#973).
521 # 0.0.98 - 2021-06-11
523 0.0.98 should be considered a release candidate to the first alpha release of
524 Rust-Lightning and the broader LDK. It represents several years of work
525 designing and fine-tuning a flexible API for integrating lightning into any
526 application. LDK should make it easy to build a lightning node or client which
527 meets specific requirements that other lightning node software cannot. As
528 lightning continues to evolve, and new use-cases for lightning develop, the API
529 of LDK will continue to change and expand. However, starting with version 0.1,
530 objects serialized with prior versions will be readable with the latest LDK.
531 While Rust-Lightning is approaching the 0.1 milestone, language bindings
532 components of LDK available at https://github.com/lightningdevkit are still of
533 varying quality. Some are also approaching an 0.1 release, while others are
534 still much more experimental. Please note that, at 0.0.98, using Rust-Lightning
535 on mainnet is *strongly* discouraged.
projects / rust-lightning / blob