1 # 0.0.115 - Apr 24, 2023 - "Rebroadcast the Bugfixes"
4 * The MSRV of the main LDK crates has been increased to 1.48 (#2107).
5 * Attempting to claim an un-expired payment on a channel which has closed no
6 longer fails. The expiry time of payments is exposed via
7 `PaymentClaimable::claim_deadline` (#2148).
8 * `payment_metadata` is now supported in `Invoice` deserialization, sending,
9 and receiving (via a new `RecipientOnionFields` struct) (#2139, #2127).
10 * `Event::PaymentFailed` now exposes a failure reason (#2142).
11 * BOLT12 messages now support stateless generation and validation (#1989).
12 * The `NetworkGraph` is now pruned of stale data after RGS processing (#2161).
13 * Max inbound HTLCs in-flight can be changed in the handshake config (#2138).
14 * `lightning-transaction-sync` feature `esplora-async-https` was added (#2085).
15 * A `ChannelPending` event is now emitted after the initial handshake (#2098).
16 * `PaymentForwarded::outbound_amount_forwarded_msat` was added (#2136).
17 * `ChannelManager::list_channels_by_counterparty` was added (#2079).
18 * `ChannelDetails::feerate_sat_per_1000_weight` was added (#2094).
19 * `Invoice::fallback_addresses` was added to fetch `bitcoin` types (#2023).
20 * The offer/refund description is now exposed in `Invoice{,Request}` (#2206).
22 ## Backwards Compatibility
23 * Payments sent with the legacy `*_with_route` methods on LDK 0.0.115+ will no
24 longer be retryable via the LDK 0.0.114- `retry_payment` method (#2139).
25 * `Event::PaymentPathFailed::retry` was removed and will always be `None` for
26 payments initiated on 0.0.115 which fail on an earlier version (#2063).
27 * `Route`s and `PaymentParameters` with blinded path information will not be
28 readable on prior versions of LDK. Such objects are not currently constructed
29 by LDK, but may be when processing BOLT12 data in a coming release (#2146).
30 * Providing `ChannelMonitorUpdate`s generated by LDK 0.0.115 to a
31 `ChannelMonitor` on 0.0.114 or before may panic (#2059). Note that this is
32 in general unsupported, and included here only for completeness.
35 * Fixed a case where `process_events_async` may `poll` a `Future` which has
36 already completed (#2081).
37 * Fixed deserialization of `u16` arrays. This bug may have previously corrupted
38 the historical buckets in a `ProbabilisticScorer`. Users relying on the
39 historical buckets may wish to wipe their scorer on upgrade to remove corrupt
40 data rather than waiting on it to decay (#2191).
41 * The `process_events_async` task is now `Send` and can thus be polled on a
42 multi-threaded runtime (#2199).
43 * Fixed a missing macro export causing
44 `impl_writeable_tlv_based_enum{,_upgradable}` calls to not compile (#2091).
45 * Fixed compilation of `lightning-invoice` with both `no-std` and serde (#2187)
46 * Fix an issue where the `background-processor` would not wake when a
47 `ChannelMonitorUpdate` completed asynchronously, causing delays (#2090).
48 * Fix an issue where `process_events_async` would exit immediately (#2145).
49 * `Router` calls from the `ChannelManager` now call `find_route_with_id` rather
50 than `find_route`, as was intended and described in the API (#2092).
51 * Ensure `process_events_async` always exits if any sleep future returns true,
52 not just if all sleep futures repeatedly return true (#2145).
53 * `channel_update` messages no longer set the disable bit unless the peer has
54 been disconnected for some time. This should resolve cases where channels are
55 disabled for extended periods of time (#2198).
56 * We no longer remove CLN nodes from the network graph for violating the BOLT
57 spec in some cases after failing to pay through them (#2220).
58 * Fixed a debug assertion which may panic under heavy load (#2172).
59 * `CounterpartyForceClosed::peer_msg` is now wrapped in UntrustedString (#2114)
60 * Fixed a potential deadlock in `funding_transaction_generated` (#2158).
63 * Transaction re-broadcasting is now substantially more aggressive, including a
64 new regular rebroadcast feature called on a timer from the
65 `background-processor` or from `ChainMonitor::rebroadcast_pending_claims`.
66 This should substantially increase transaction confirmation reliability
67 without relying on downstream `TransactionBroadcaster` implementations for
68 rebroadcasting (#2203, #2205, #2208).
69 * Implemented the changes from BOLT PRs #1031, #1032, and #1040 which resolve a
70 privacy vulnerability which allows an intermediate node on the path to
71 discover the final destination for a payment (#2062).
73 In total, this release features 110 files changed, 11928 insertions, 6368
74 deletions in 215 commits from 21 authors, in alphabetical order:
78 * Allan Douglas R. de Oliveira
84 * Lucas Soriano del Pino
98 # 0.0.114 - Mar 3, 2023 - "Faster Async BOLT12 Retries"
101 * `InvoicePayer` has been removed and its features moved directly into
102 `ChannelManager`. As such it now requires a simplified `Router` and supports
103 `send_payment_with_retry` (and friends). `ChannelManager::retry_payment` was
104 removed in favor of the automated retries. Invoice payment utilities in
105 `lightning-invoice` now call the new code (#1812, #1916, #1929, #2007, etc).
106 * `Sign`/`BaseSign` has been renamed `ChannelSigner`, with `EcdsaChannelSigner`
107 split out in anticipation of future schnorr/taproot support (#1967).
108 * The catch-all `KeysInterface` was split into `EntropySource`, `NodeSigner`,
109 and `SignerProvider`. `KeysManager` implements all three (#1910, #1930).
110 * `KeysInterface::get_node_secret` is now `KeysManager::get_node_secret_key`
111 and is no longer required for external signers (#1951, #2070).
112 * A `lightning-transaction-sync` crate has been added which implements keeping
113 LDK in sync with the chain via an esplora server (#1870). Note that it can
114 only be used on nodes that *never* ran a previous version of LDK.
115 * `Score` is updated in `BackgroundProcessor` instead of via `Router` (#1996).
116 * `ChainAccess::get_utxo` (now `UtxoAccess`) can now be resolved async (#1980).
117 * BOLT12 `Offer`, `InvoiceRequest`, `Invoice` and `Refund` structs as well as
118 associated builders have been added. Such invoices cannot yet be paid due to
119 missing support for blinded path payments (#1927, #1908, #1926).
120 * A `lightning-custom-message` crate has been added to make combining multiple
121 custom messages into one enum/handler easier (#1832).
122 * `Event::PaymentPathFailed` is now generated for failure to send an HTLC
123 over the first hop on our local channel (#2014, #2043).
124 * `lightning-net-tokio` no longer requires an `Arc` on `PeerManager` (#1968).
125 * `ChannelManager::list_recent_payments` was added (#1873).
126 * `lightning-background-processor` `std` is now optional in async mode (#1962).
127 * `create_phantom_invoice` can now be used in `no-std` (#1985).
128 * The required final CLTV delta on inbound payments is now configurable (#1878)
129 * bitcoind RPC error code and message are now surfaced in `block-sync` (#2057).
130 * Get `historical_estimated_channel_liquidity_probabilities` was added (#1961).
131 * `ChannelManager::fail_htlc_backwards_with_reason` was added (#1948).
132 * Macros which implement serialization using TLVs or straight writing of struct
133 fields are now public (#1823, #1976, #1977).
135 ## Backwards Compatibility
136 * Any inbound payments with a custom final CLTV delta will be rejected by LDK
137 if you downgrade prior to receipt (#1878).
138 * `Event::PaymentPathFailed::network_update` will always be `None` if an
139 0.0.114-generated event is read by a prior version of LDK (#2043).
140 * `Event::PaymentPathFailed::all_paths_failed` will always be false if an
141 0.0.114-generated event is read by a prior version of LDK. Users who rely on
142 it to determine payment retries should migrate to `Event::PaymentFailed`, in
143 a separate release prior to upgrading to LDK 0.0.114 if downgrading is
146 ## Performance Improvements
147 * Channel data is now stored per-peer and channel updates across multiple
148 peers can be operated on simultaneously (#1507).
149 * Routefinding is roughly 1.5x faster (#1799).
150 * Deserializing a `NetworkGraph` is roughly 6x faster (#2016).
151 * Memory usage for a `NetworkGraph` has been reduced substantially (#2040).
152 * `KeysInterface::get_secure_random_bytes` is roughly 200x faster (#1974).
155 * Fixed a bug where a delay in processing a `PaymentSent` event longer than the
156 time taken to persist a `ChannelMonitor` update, when occurring immediately
157 prior to a crash, may result in the `PaymentSent` event being lost (#2048).
158 * Fixed spurious rejections of rapid gossip sync data when the graph has been
159 updated by other means between gossip syncs (#2046).
160 * Fixed a panic in `KeysManager` when the high bit of `starting_time_nanos`
162 * Resolved an issue where the `ChannelManager::get_persistable_update_future`
163 future would fail to wake until a second notification occurs (#2064).
164 * Resolved a memory leak when using `ChannelManager::send_probe` (#2037).
165 * Fixed a deadlock on some platforms at least when using async `ChannelMonitor`
167 * Removed debug-only assertions which were reachable in threaded code (#1964).
168 * In some cases when payment sending fails on our local channel retries no
169 longer take the same path and thus never succeed (#2014).
170 * Retries for spontaneous payments have been fixed (#2002).
171 * Return an `Err` if `lightning-persister` fails to read the directory listing
172 rather than panicing (#1943).
173 * `peer_disconnected` will now never be called without `peer_connected` (#2035)
176 0.0.114 fixes several denial-of-service vulnerabilities which are reachable from
177 untrusted input from channel counterparties or in deployments accepting inbound
178 connections or channels. It also fixes a denial-of-service vulnerability in rare
179 cases in the route finding logic.
180 * The number of pending un-funded channels as well as peers without funded
181 channels is now limited to avoid denial of service (#1988).
182 * A second `channel_ready` message received immediately after the first could
183 lead to a spurious panic (#2071). This issue was introduced with 0conf
184 support in LDK 0.0.107.
185 * A division-by-zero issue was fixed in the `ProbabilisticScorer` if the amount
186 being sent (including previous-hop fees) is equal to a channel's capacity
187 while walking the graph (#2072). The division-by-zero was introduced with
188 historical data tracking in LDK 0.0.112.
190 In total, this release features 130 files changed, 21457 insertions, 10113
191 deletions in 343 commits from 18 authors, in alphabetical order:
193 * Allan Douglas R. de Oliveira
212 # 0.0.113 - Dec 16, 2022 - "Big Movement Intercepted"
215 * `ChannelManager::send_payment` now takes an explicit `PaymentId` which is a
216 loose idempotency token. See `send_payment` docs for more (#1761, #1826).
217 * HTLCs bound for SCIDs from `ChannelManager::get_intercept_scid` are now
218 intercepted and can be forwarded manually over any channel (#1835, #1893).
219 * `Confirm::get_relevant_txids` now returns a `BlockHash`, expanding the set
220 of cases where `transaction_unconfirmed` must be called, see docs (#1796).
221 * Pending outbound payments are no longer automatically timed-out a few blocks
222 after failure. Thus, in order to avoid leaking memory, you MUST call
223 `ChannelManager::abandon_payment` when you no longer wish to retry (#1761).
224 * `ChannelManager::abandon_payment` docs were updated to note that the payment
225 may return to pending after a restart if no persistence occurs (#1907).
226 * `Event::PaymentReceived` has been renamed `Event::PaymentClaimable` (#1891).
227 * `Event` handling is now optionally async for Rust users (#1787).
228 * `user_channel_id` is now a `u128` and random for inbound channels (#1790).
229 * A new `ChannelReady` event is generated whenever a channel becomes ready to
230 be used, i.e., after both sides sent the `channel_ready` message (#1743).
231 * `NetworkGraph` now prunes channels where either node is offline for 2 weeks
232 and refuses to accept re-announcements of pruned channels (#1735).
233 * Onion messages are now read in `CustomOnionMessageHandler` rather than via
234 `MaybeReadableArgs` (#1809).
235 * Added a new util to generate an invoice with a custom hash (#1894) -
236 `create_invoice_from_channelmanager_and_duration_since_epoch_with_payment_hash`
237 * `Sign`ers are now by default re-derived using `KeysInterface`'s new
238 `derive_channel_signer` rather than `read_chan_signer` (#1867).
239 * `Confirm::transactions_confirmed` is now idempotent (#1861).
240 * `ChannelManager::compute_inflight_htlcs` has been added to fetch in-flight
241 HTLCs for scoring. Note that `InvoicePayer` does this for you (#1830).
242 * Added `PaymentClaimable::via_channel_id` (#1856).
243 * Added the `node_id` (phantom or regular) to payment events (#1766).
244 * Added the funding transaction `confirmations` to `ChannelDetails` (#1856).
245 * `BlindedRoute` has been renamed `BlindedPath` (#1918).
246 * Support for the BOLT 4 "legacy" onion format has been removed, in line with
247 its removal in the spec and vanishingly rare use (#1413).
248 * `ChainMonitor::list_pending_monitor_updates` was added (#1834).
249 * Signing for non-zero-fee anchor commitments is supported again (#1828).
250 * Several helpers for transaction matching and generation are now pub (#1839).
253 * Fixed a rare race where a crash may result in a pending HTLC not being
254 failed backwards, leading to a force-closure by our counterparty (#1857).
255 * Avoid incorrectly assigning a lower-bound on channel liquidity when routing
256 fails due to a closed channel earlier in the path (#1817).
257 * If a counterparty increases the channel fee, but not enough per our own fee
258 estimator, we no longer force-close the channel (#1852).
259 * Several bugs in the `lightning-background-processor` `future` feature were
260 fixed, including requirements doc corrections (#1843, #1845, #1851).
261 * Some failure messages sent back when failing an HTLC were corrected (#1895).
262 * `rapid-gossip-sync` no longer errors if an update is applied duplicatively
263 or in rare cases when the graph is updated from payment failures (#1833).
264 * Sending onion messages to a blinded path in which we're the introduction
265 node no longer fails (#1791).
267 ## Backwards Compatibility
268 * No `ChannelReady` events will be generated for previously existing channels,
269 including those which become ready after upgrading to 0.0.113 (#1743).
270 * Once `UserConfig::accept_intercept_htlcs` is set, downgrades to LDK versions
271 prior to 0.0.113 are not supported (#1835).
272 * Existing payments may see a `PaymentClaimable::user_channel_id` of 0 (#1856)
273 * When downgrading to a version of LDK prior to 0.0.113 when there are
274 resolved payments waiting for a small timeout, the payments may not be
275 removed, preventing payments with the same `PaymentId` (#1761).
277 In total, this release features 76 files changed, 11639 insertions, 6067
278 deletions in 210 commits from 18 authors, in alphabetical order:
299 # 0.0.112 - Oct 25, 2022 - "History Matters"
302 * `Result<(), ChannelMonitorUpdateErr>` return values have been replaced with
303 a `ChannelMonitorUpdateStatus` trinary enum. This better denotes that
304 `ChannelMonitorUpdateStatus::InProgress` is not an error, but asynchronous
305 persistence of a monitor update. Note that asynchronous persistence still
306 has some edge cases and is not yet recommended for production (#1106).
307 * `ChannelMonitor` persistence failure no longer automatically broadcasts the
308 latest commitment transaction. See the
309 `ChannelMonitorUpdateStatus::PermanentFailure` docs for more info (#1106).
310 * `*Features::known` has been replaced with individual
311 `*MessageHandler::provided_*_features` methods (#1707).
312 * `OnionMessenger` now takes a `CustomOnionMessageHandler` implementation,
313 allowing you to send and receive custom onion messages (#1748).
314 * `ProbabilisticScorer` now tracks the historical distribution of liquidity
315 estimates for channels. See new `historical_*` parameters in
316 `ProbabilisticScoringParameters` for more details (#1625).
317 * `lightning-block-sync`'s `BlockSource` trait now supports BIP 157/158
318 filtering clients by returning only header data for some blocks (#1706).
319 * `lightning-invoice`'s `Router` trait now accepts an `InFlightHtlcs` to
320 ensure we do not over-use a remote channel's funds during routing (#1694).
321 Note that this was previously backported to 0.0.111 for bindings users.
322 * `NetworkGraph::remove_stale_channels` has been renamed
323 `NetworkGraph::remove_stale_channels_and_tracking` as `NetworkGraph` now
324 refuses to re-add nodes and channels that were recently removed (#1649).
325 * The `lightning-rapid-gossip-sync` crate now supports `no-std` (#1708).
326 * The default `ProbabilisticScoringParameters::liquidity_offset_half_life` has
327 been increased to six hours from one (#1754).
328 * All commitment transaction building logic for anchor outputs now assumes the
329 no-HTLC-tx-fee variant (#1685).
330 * A number of missing `Eq` implementations were added (#1763).
333 * `lightning-background-processor` now builds without error with the `futures`
335 * `ChannelManager::get_persistable_update_future`'s returned `Future` has been
336 corrected to not fail to be awoken in some cases (#1758).
337 * Asynchronously performing the initial `ChannelMonitor` persistence is now
339 * Redundantly applying rapid gossip sync updates no longer `Err`s (#1764).
340 * Nodes which inform us via payment failures that they should no longer be
341 used are now removed from the network graph. Some LND nodes spuriously
342 generate this error and may remove themselves from our graph (#1649).
344 In total, this release features 134 files changed, 6598 insertions, 4370
345 deletions in 109 commits from 13 authors, in alphabetical order:
360 # 0.0.111 - Sep 12, 2022 - "Saturated with Messages"
363 * Support for relaying onion messages has been added via a new
364 `OnionMessenger` struct when passed as the `OnionMessageHandler` to a
365 `PeerManager`. Pre-encoded onion messages can also be sent and received
366 (#1503, #1650, #1652, #1688).
367 * Rate-limiting of outbound gossip syncs has been rewritten to utilize less
368 buffering inside LDK. The new rate-limiting is also used for onion messages
369 to avoid delaying other messages (#1604. #1660, #1683).
370 * Rather than spawning a full OS thread, `lightning-background-processor` has
371 a new `process_events_async` method which takes the place of a
372 `BackgroundProcessor` for those using Rust's async (#1657).
373 * `ChannelManager::get_persistable_update_future` has been added to block on
374 a ChannelManager needing re-persistence in a Rust async environment (#1657).
375 * The `Filter::register_output` return value has been removed, as it was
376 very difficult to correctly implement (i.e., without blocking). Users
377 previously using it should instead pass dependent transactions in via
378 additional `chain::Confirm::transactions_confirmed` calls (#1663).
379 * `ChannelHandshakeConfig::their_channel_reserve_proportional_millionths` has
380 been added to allow configuring counterparty reserve values (#1619).
381 * `KeysInterface::ecdh` has been added as an ECDH oracle (#1503, #1658).
382 * The `rust-bitcoin` dependency has been updated 0.29 (#1658).
383 * The `bitcoin_hashes` dependency has been updated 0.11 (#1677).
384 * `ChannelManager::broadcast_node_announcement` has been moved to
385 `PeerManager` (#1699).
386 * `channel_` and `node_announcement`s are now rebroadcast automatically to all
387 new peers which connect (#1699).
388 * `{Init,Node}Features` sent to peers/broadcasted are now fetched via the
389 various `*MessageHandler` traits, rather than hard-coded (#1701, #1688).
390 * `Event::PaymentPathFailed::rejected_by_dest` has been renamed
391 `payment_failed_permanently` (#1702).
392 * `Invoice` now derives the std `Hash` trait (#1575).
393 * `{Signed,}RawInvoice::hash` have been renamed `signable_hash` (#1714).
394 * `chain::AccessError` now derives the std `Debug` trait (#1709).
395 * `ReadOnlyNetworkGraph::list_{channels,nodes}` have been added largely for
396 users of downstream bindings (#1651).
397 * `ChannelMonitor::get_counterparty_node_id` is now available (#1635).
400 * The script compared with that returned from `chain::Access` was incorrect
401 ~half of the time, causing spurious gossip rejection (#1666).
402 * Pending in-flight HTLCs are now considered when calculating new routes,
403 ensuring, e.g. MPP retries do not take known-saturated paths (#1643).
404 * Counterparty-revoked outputs are now included in `get_claimable_balance`
405 output via a new `Balance::CounterpartyRevokedOutputClaimable` (#1495).
406 * Inbound HTLCs for which we do not (yet) have a preimage are now included in
407 `get_claimable_balance` via a `Balance::MaybePreimageClaimableHTLC` (#1673).
408 * Probes that fail prior to being sent over their first hop are correctly
409 failed with a `Event::ProbeFailed` rather than a `PaymentPathFailed` (#1704).
410 * Pending `Event::HTLCHandlingFailed`s are no longer lost on restart (#1700).
411 * HTLCs that fail prior to being sent over their first hop are now marked as
412 retryable via `!PaymentPathFailed::payment_failed_permanently` (#1702).
413 * Dust HTLCs are now considered failed in the payment tracking logic after the
414 commitment transaction confirms, allowing retry on restart (#1691).
415 * On machines with buggy "monotonic" clocks, LDK will no longer panic if time
416 goes backwards (#1692).
418 ## Backwards Compatibility
419 * The new `current_time` argument to `PeerManager` constructors must be set to
420 a UNIX timestamp for upgraded nodes; new nodes may use a counter (#1699).
421 * `Balance::CounterpartyRevokedOutputClaimable` will never be generated for
422 channels that were observed to go on-chain with LDK versions prior to
424 * `ChannelMonitor::get_counterparty_node_id` will return `None` for all
425 channels opened on a version of LDK prior to 0.0.110 (#1635).
426 * Setting `their_channel_reserve_proportional_millionths` to any value other
427 than the default will cause LDK versions prior to 0.0.104 to be unable to
428 read the serialized `ChannelManager` (#1619).
431 0.0.111 fixes a denial-of-service vulnerability which is reachable from
432 untrusted input in deployments accepting 0conf channels, or via a race-condition
433 in deployments creating outbound 0conf channels.
435 * LDK versions prior to 0.0.111 may spuriously panic when receiving a block if
436 they are awaiting the construction of a funding transaction for a 0-conf
437 channel (#1711). 0-conf support was added in LDK version 0.0.107.
439 In total, this release features 84 files changed, 6306 insertions, 1960
440 deletions in 121 commits from 11 authors, in alphabetical order:
454 # 0.0.110 - 2022-07-26 - "Routing, With a Vengeance"
457 * `ChannelManager::send_probe` and `Score::probe_{failed,successful}` have
458 been added to make probing more explicit, as well as new
459 `Event::Probe{Failed,Successful}` events (#1567).
460 * `ProbabilisticScoringParameters::banned_nodes` has been renamed
461 `manual_node_penalties` and changed to take msat penalties (#1592).
462 * Per-payment tracking of failed paths was added to enable configuration of
463 `ProbabilisticScoringParameters::considered_impossible_penalty_msat` (#1600)
464 * `ProbabilisticScoringParameters::base_penalty_amount_multiplier_msat` was
465 added to allow a penalty that is only amount-dependent (#1617).
466 * `ProbabilisticScoringParameters::amount_penalty_multiplier_msat` was renamed
467 `liquidity_penalty_amount_multiplier_msat` (#1617).
468 * A new `Event::HTLCHandlingFailed` has been added which provides visibility
469 into failures to forward/claim accepted HTLCs (#1403).
470 * Support has been added for DNS hostnames in the `NetAddress` type, see
471 [BOLT PR #911](https://github.com/lightning/bolts/pull/911) (#1553).
472 * `GossipSync` now has `rapid`, `p2p`, and `none` constructors (#1618).
473 * `lightning-net-tokio` no longer requires types to be in `Arc`s (#1623).
474 * The `htlc_maximum_msat` field is now required in `ChannelUpdate` gossip
475 messages. In tests this rejects < 1% of channels (#1519).
476 * `ReadOnlyNetworkGraph::{channel,node}` have been added to query for
477 individual channel/node data, primarily for bindings users (#1543).
478 * `FeeEstimator` implementations are now wrapped internally to ensure values
479 below 253 sats/kW are never used (#1552).
480 * Route selection no longer attempts to randomize path selection. This is
481 unlikely to lead to a material change in the paths selected (#1610).
484 * Fixed a panic when deserializing `ChannelDetails` objects (#1588).
485 * When routing, channels are no longer fully saturated before MPP splits are
486 generated, instead a configuration knob was added as
487 `PaymentParameters::max_channel_saturation_power_of_half` (#1605).
488 * Fixed a panic which occurred in `ProbabilisticScorer` when wallclock time
489 goes backwards across a restart (#1603).
491 ## Serialization Compatibility
492 * All new fields are ignored by prior versions of LDK. All new fields are not
493 present when reading objects serialized by prior versions of LDK.
494 * Channel information written in the `NetworkGraph` which is missing
495 `htlc_maximum_msat` may be dropped on deserialization (#1519).
496 * Similarly, node information written in the `NetworkGraph` which contains an
497 invalid hostname may be dropped on deserialization (#1519).
499 In total, this release features 79 files changed, 2935 insertions, 1363
500 deletions in 52 commits from 9 authors, in alphabetical order:
511 # 0.0.109 - 2022-07-01 - "The Kitchen Sink"
514 * `ChannelManager::update_channel_config` has been added to allow the fields
515 in `ChannelConfig` to be changed in a given channel after open (#1527).
516 * If we reconnect to a peer which proves we have a stale channel state, rather
517 than force-closing we will instead panic to provide an opportunity to switch
518 to the latest state and continue operating without channel loss (#1564).
519 * A `NodeAlias` struct has been added which handles string sanitization for
520 node aliases via the `Display` trait (#1544).
521 * `ProbabilisticScoringParameters` now has a `banned_nodes` set which we will
522 never route through during path finding (#1550).
523 * `ProbabilisticScoringParameters` now offers an `anti_probing_penalty_msat`
524 option to prefer channels which afford better privacy when routing (#1555).
525 * `ProbabilisticScorer` now provides access to its estimated liquidity range
526 for a given channel via `estimated_channel_liquidity_range` (#1549).
527 * `ChannelManager::force_close_channel` has been renamed
528 `force_close_broadcasting_latest_txn` and
529 `force_close_without_broadcasting_txn` has been added (#1564).
530 * Options which cannot be changed at runtime have been moved from
531 `ChannelConfig` to `ChannelHandshakeConfig` (#1529).
532 * `find_route` takes `&NetworkGraph` instead of `ReadOnlyNetworkGraph (#1583).
533 * `ChannelDetails` now contains a copy of the current `ChannelConfig` (#1527).
534 * The `lightning-invoice` crate now optionally depends on `serde`, with
535 `Invoice` implementing `serde::{Deserialize,Serialize}` if enabled (#1548).
536 * Several fields in `UserConfig` have been renamed for clarity (#1540).
539 * `find_route` no longer selects routes with more than
540 `PaymentParameters::max_mpp_path_count` paths, and
541 `ChannelManager::send_payment` no longer refuses to send along routes with
542 more than ten paths (#1526).
543 * Fixed two cases where HTLCs pending at the time a counterparty broadcasts a
544 revoked commitment transaction are considered resolved prior to their actual
545 resolution on-chain, possibly passing the update to another channel (#1486).
546 * HTLCs which are relayed through LDK may now have a total expiry time two
547 weeks in the future, up from one, reducing forwarding failures (#1532).
549 ## Serialization Compatibility
550 * All new fields are ignored by prior versions of LDK. All new fields are not
551 present when reading objects serialized by prior versions of LDK.
552 * `ChannelConfig`'s serialization format has changed and is not compatible
553 with any previous version of LDK. Attempts to read values written by a
554 previous version of LDK will fail and attempts to read newly written objects
555 using a previous version of LDK will fail. It is not expected that users are
556 serializing `ChannelConfig` using the LDK serialization API, however, if a
557 backward compatibility wrapper is required, please open an issue.
560 0.0.109 fixes a denial-of-service vulnerability which is reachable from
561 untrusted input in some application deployments.
563 * Third parties which are allowed to open channels with an LDK-based node may
564 fund a channel with a bogus and maliciously-crafted transaction which, when
565 spent, can cause a panic in the channel's corresponding `ChannelMonitor`.
566 Such a channel is never usable as it cannot be funded with a funding
567 transaction which matches the required output script, allowing the
568 `ChannelMonitor` for such channels to be safely purged as a workaround on
569 previous versions of LDK. Thanks to Eugene Siegel for reporting this issue.
571 In total, this release features 32 files changed, 1948 insertions, 532
572 deletions in 33 commits from 9 authors, in alphabetical order:
584 # 0.0.108 - 2022-06-10 - "You Wanted It To Build?! Why Didn't You Say So?"
587 * Fixed `lightning-background-processor` build in release mode.
589 In total, this release features 9 files changed, 120 insertions, 74
590 deletions in 5 commits from 4 authors, in alphabetical order:
596 # 0.0.107 - 2022-06-08 - "BlueWallet's Wishlist"
599 * Channels larger than 16777215 sats (Wumbo!) are now supported and can be
600 enabled for inbound channels using
601 `ChannelHandshakeLimits::max_funding_satoshis` (#1425).
602 * Support for feature `option_zeroconf`, allowing immediate forwarding of
603 payments after channel opening. This is configured for outbound channels
604 using `ChannelHandshakeLimits::trust_own_funding_0conf` whereas
605 `ChannelManager::accept_inbound_channel_from_trusted_peer_0conf` has to be
606 used for accepting inbound channels (#1401, #1505).
607 * `ChannelManager::claim_funds` no longer returns a `bool` to indicate success.
608 Instead, an `Event::PaymentClaimed` is generated if the claim was successful.
609 Likewise, `ChannelManager::fail_htlc_backwards` no longer has a return value
611 * `lightning-rapid-gossip-sync` is a new crate for syncing gossip data from a
612 server, primarily aimed at mobile devices (#1155).
613 * `RapidGossipSync` can be passed to `BackgroundProcessor` in order to persist
614 the `NetworkGraph` and handle `NetworkUpdate`s during event handling (#1433,
616 * `NetGraphMsgHandler` has been renamed to `P2PGossipSync`, the `network_graph`
617 module has been renamed to `gossip`, and `NetworkUpdate::ChannelClosed` has
618 been renamed `NetworkUpdate::ChannelFailure` (#1159).
619 * Added a `filtered_block_connected` method to `chain::Listen` and a default
620 implementation of `block_connected` for those fetching filtered instead of
622 * The `lightning-block-sync` crate's `BlockSource` trait methods now take
623 `&self` instead of `&mut self` (#1307).
624 * `inbound_payment` module is now public to allow for creating invoices without
625 a `ChannelManager` (#1384).
626 * `lightning-block-sync`'s `init` and `poll` modules support `&dyn BlockSource`
627 which can be determined at runtime (#1423).
628 * `lightning-invoice` crate's `utils` now accept an expiration time (#1422,
630 * `Event::PaymentForwarded` includes `prev_channel_id` and `next_channel_id`
632 * `chain::Watch::release_pending_monitor_events`' return type now associates
633 `MonitorEvent`s with funding `OutPoints` (#1475).
634 * `lightning-background-processor` crate's `Persister` trait has been moved to
635 `lightning` crate's `util::persist` module, which now has a general
636 `KVStorePersister` trait. Blanket implementations of `Persister` and
637 `chainmonitor::Persist` are given for types implementing `KVStorePersister`.
638 ` lightning-persister`'s `FilesystemPersister` implements `KVStorePersister`
640 * `ChannelDetails` and `ChannelCounterparty` include fields for HTLC minimum
641 and maximum values (#1378).
642 * Added a `max_inbound_htlc_value_in_flight_percent_of_channel` field to
643 `ChannelHandshakeConfig`, capping the total value of outstanding inbound
644 HTLCs for a channel (#1444).
645 * `ProbabilisticScorer` is parameterized by a `Logger`, which it uses to log
646 channel liquidity updates or lack thereof (#1405).
647 * `ChannelDetails` has an `outbound_htlc_limit_msat` field, which should be
648 used in routing instead of `outbound_capacity_msat` (#1435).
649 * `ProbabilisticScorer`'s channel liquidities can be logged via
650 `debug_log_liquidity_stats` (#1460).
651 * `BackgroundProcessor` now takes an optional `WriteableScore` which it will
652 persist using the `Persister` trait's new `persist_scorer` method (#1416).
653 * Upgraded to `bitcoin` crate version 0.28.1 (#1389).
654 * `ShutdownScript::new_witness_program` now takes a `WitnessVersion` instead of
655 a `NonZeroU8` (#1389).
656 * Channels will no longer be automatically force closed when the counterparty
657 is disconnected due to incompatibility (#1429).
658 * `ChannelManager` methods for funding, accepting, and closing channels now
659 take a `counterparty_node_id` parameter, which has also been added as a field
660 to `Event::FundingGenerationReady` (#1479, #1485).
661 * `InvoicePayer::new` now takes a `Retry` enum (replacing the `RetryAttempts`
662 struct), which supports both attempt- and timeout-based retrying (#1418).
663 * `Score::channel_penalty_msat` takes a `ChannelUsage` struct, which contains
664 the capacity as an `EffectiveCapacity` enum and any potential in-flight HTLC
665 value, rather than a single `u64`. Used by `ProbabilisticScorer` for more
666 accurate penalties (#1456).
667 * `build_route_from_hops` is a new function useful for constructing a `Route`
668 given a specific list of public keys (#1491).
669 * `FundingLocked` message has been renamed `ChannelReady`, and related
670 identifiers have been renamed accordingly (#1506).
671 * `core2::io` or `std::io` (depending on feature flags `no-std` or `std`) is
672 exported as a `lightning::io` module (#1504).
673 * The deprecated `Scorer` has been removed in favor or `ProbabilisticScorer`
676 ## Performance Improvements
677 * `lightning-persister` crate's `FilesystemPersister` is faster by 15x (#1404).
678 * Log gossip query messages at `GOSSIP` instead of `TRACE` to avoid
679 overwhelming default logging (#1421).
680 * `PeerManager` supports processing messages from different peers in parallel,
681 and this is taken advantage of in gossip processing (#1023).
682 * Greatly reduced per-channel and per-node memory usage due to upgrade of
683 `secp256k1` crate to 0.22.1 and `bitcoin` crate to 0.28.1
684 * Reduced per-peer memory usage in `PeerManager` (#1472).
687 * `find_route` now assumes variable-length onions by default for nodes where
688 support for the feature is unknown (#1414).
689 * A `warn` message is now sent when receiving a `channel_reestablish` with an
690 old commitment transaction number rather than immediately force-closing the
692 * When a `channel_update` message is included in an onion error's `failuremsg`,
693 its message type is now encoded. Reading such messages is also supported
697 * Fixed a bug where crashing while persisting a `ChannelMonitorUpdate` for a
698 part of a multi-path payment could cause loss of funds due to a partial
699 payment claim on restart (#1434).
700 * `BackgroundProcessor` has been fixed to improve serialization reliability on
701 slow systems which can avoid force-closes (#1436).
702 * `gossip_timestamp_filter` filters are now honored when sending gossip to
704 * During a reorg, only force-close a channel if its funding transaction is
705 unconfirmed rather than as it loses confirmations (#1461).
706 * Fixed a rare panic in `lightning-net-tokio` when fetching a peer's socket
707 address after the connection has been closed caused by a race condition
709 * `find_route` will no longer return routes that would cause onion construction
710 to fail in some cases (#1476).
711 * `ProbabilisticScorer` uses more precision when approximating `log10` (#1406).
713 ## Serialization Compatibility
714 * All above new events/fields are ignored by prior clients. All above new
715 events/fields are not present when reading objects serialized by prior
716 versions of the library.
717 * `ChannelManager` serialization is no longer compatible with versions prior to
719 * Channels with `option_zeroconf` feature enabled (not required for 0-conf
720 channel use) will be unreadable by versions prior to 0.0.107 (#1401, #1505).
722 In total, this release features 96 files changed, 9304 insertions, 4503
723 deletions in 153 commits from 18 authors, in alphabetical order:
744 # 0.0.106 - 2022-04-03
747 * Minimum supported rust version (MSRV) is now 1.41.1 (#1310).
748 * Lightning feature `option_scid_alias` is now supported and may be negotiated
749 when opening a channel with a peer. It can be configured via
750 `ChannelHandshakeConfig::negotiate_scid_privacy` and is off by default but
751 will be on by default in the future (#1351).
752 * `OpenChannelRequest` now has a `channel_type` field indicating the features
753 the channel will operate with and should be used to filter channels with
754 undesirable features (#1351). See the Serialization Compatibility section.
755 * `ChannelManager` supports sending and receiving short channel id aliases in
756 the `funding_locked` message. These are used when forwarding payments and
757 constructing invoice route hints for improved privacy. `ChannelDetails` has a
758 `inbound_scid_alias` field and a `get_inbound_payment_scid` method to support
760 * `DefaultRouter` and `find_route` take an additional random seed to improve
761 privacy by adding a random CLTV expiry offset to each path's final hop. This
762 helps obscure the intended recipient from adversarial intermediate hops
763 (#1286). The seed is also used to randomize candidate paths during route
765 * The `lightning-block-sync` crate's `init::synchronize_listeners` method
766 interface has been relaxed to support multithreaded environments (#1349).
767 * `ChannelManager::create_inbound_payment_for_hash`'s documentation has been
768 corrected to remove the one-year restriction on `invoice_expiry_delta_secs`,
769 which is only applicable to the deprecated `create_inbound_payment_legacy`
770 and `create_inbound_payment_for_hash_legacy` methods (#1341).
771 * `Features` mutator methods now take `self` by reference instead of by value
773 * The CLTV of the last hop in a path is now included when comparing against
774 `RouteParameters::max_total_cltv_expiry_delta` (#1358).
775 * Invoice creation functions in `lightning-invoice` crate's `utils` module
776 include versions that accept a description hash instead of only a description
778 * `RoutingMessageHandler::sync_routing_table` has been renamed `peer_connected`
780 * `MessageSendEvent::SendGossipTimestampFilter` has been added to indicate that
781 a `gossip_timestamp_filter` should be sent (#1368).
782 * `PeerManager` takes an optional `NetAddress` in `new_outbound_connection` and
783 `new_inbound_connection`, which is used to report back the remote address to
784 the connecting peer in the `init` message (#1326).
785 * `ChannelManager::accept_inbound_channel` now takes a `user_channel_id`, which
786 is used in a similar manner as in outbound channels. (#1381).
787 * `BackgroundProcessor` now persists `NetworkGraph` on a timer and upon
788 shutdown as part of a new `Persister` trait, which also includes
789 `ChannelManager` persistence (#1376).
790 * `ProbabilisticScoringParameters` now has a `base_penalty_msat` option, which
791 default to 500 msats. It is applied at each hop to help avoid longer paths
793 * `ProbabilisticScoringParameters::liquidity_penalty_multiplier_msat`'s default
794 value is now 40,000 msats instead of 10,000 msats (#1375).
795 * The `lightning` crate has a `grind_signatures` feature used to produce
796 signatures with low r-values for more predictable transaction weight. This
797 feature is on by default (#1388).
798 * `ProbabilisticScoringParameters` now has a `amount_penalty_multiplier_msat`
799 option, which is used to further penalize large amounts (#1399).
800 * `PhantomRouteHints`, `FixedPenaltyScorer`, and `ScoringParameters` now
801 implement `Clone` (#1346).
804 * Fixed a compilation error in `ProbabilisticScorer` under `--feature=no-std`
806 * Invoice creation functions in `lightning-invoice` crate's `utils` module
807 filter invoice hints in order to limit the invoice size (#1325).
808 * Fixed a bug where a `funding_locked` message was delayed by a block if the
809 funding transaction was confirmed while offline, depending on the ordering
810 of `Confirm::transactions_confirmed` calls when brought back online (#1363).
811 * Fixed a bug in `NetGraphMsgHandler` where it didn't continue to receive
812 gossip messages from peers after initial connection (#1368, #1382).
813 * `ChannelManager::timer_tick_occurred` will now timeout a received multi-path
814 payment (MPP) after three ticks if not received in full instead of waiting
815 until near the HTLC timeout block(#1353).
816 * Fixed an issue with `find_route` causing it to be overly aggressive in using
817 MPP over channels to the same first hop (#1370).
818 * Reduced time spent processing `channel_update` messages by checking
819 signatures after checking if no newer messages have already been processed
821 * Fixed a few issues in `find_route` which caused preferring paths with a
823 * Fixed an issue in `ProbabilisticScorer` where a channel with not enough
824 liquidity could still be used when retrying a failed payment if it was on a
825 path with an overall lower cost (#1399).
827 ## Serialization Compatibility
828 * Channels open with `option_scid_alias` negotiated will be incompatible with
829 prior releases (#1351). This may occur in the following cases:
830 * Outbound channels when `ChannelHandshakeConfig::negotiate_scid_privacy` is
832 * Inbound channels when automatically accepted from an `OpenChannel` message
833 with a `channel_type` that has `ChannelTypeFeatures::supports_scid_privacy`
834 return true. See `UserConfig::accept_inbound_channels`.
835 * Inbound channels when manually accepted from an `OpenChannelRequest` with a
836 `channel_type` that has `ChannelTypeFeatures::supports_scid_privacy` return
837 true. See `UserConfig::manually_accept_inbound_channels`.
839 In total, this release features 43 files changed, 4052 insertions, 1274
840 deletions in 75 commits from 11 authors, in alphabetical order:
854 # 0.0.105 - 2022-02-28
857 * `Phantom node` payments are now supported, allowing receipt of a payment on
858 any one of multiple nodes without any coordination across the nodes being
859 required. See the new `PhantomKeysManager`'s docs for more, as well as
860 requirements on `KeysInterface::get_inbound_payment_key_material` and
861 `lightning_invoice::utils::create_phantom_invoice` (#1199).
862 * In order to support phantom node payments, several `KeysInterface` methods
863 now accept a `Recipient` parameter to select between the local `node_id` and
864 a phantom-specific one.
865 * `ProbabilisticScorer`, a `Score` based on learning the current balances of
866 channels in the network, was added. It attempts to better capture payment
867 success probability than the existing `Scorer`, though may underperform on
868 nodes with low payment volume. We welcome feedback on performance (#1227).
869 * `Score::channel_penalty_msat` now always takes the channel value, instead of
871 * `UserConfig::manually_accept_inbound_channels` was added which, when set,
872 generates a new `Event::OpenChannelRequest`, which allows manual acceptance
873 or rejection of incoming channels on a per-channel basis (#1281).
874 * `Payee` has been renamed to `PaymentParameters` (#1271).
875 * `PaymentParameters` now has a `max_total_cltv_expiry_delta` field. This
876 defaults to 1008 and limits the maximum amount of time an HTLC can be pending
877 before it will either fail or be claimed (#1234).
878 * The `lightning-invoice` crate now supports no-std environments. This required
879 numerous API changes around timestamp handling and std+no-std versions of
880 several methods that previously assumed knowledge of the time (#1223, #1230).
881 * `lightning-invoice` now supports parsing invoices with expiry times of more
882 than one year. This required changing the semantics of `ExpiryTime` (#1273).
883 * The `CounterpartyCommitmentSecrets` is now public, allowing external uses of
884 the `BOLT 3` secret storage scheme (#1299).
885 * Several `Sign` methods now receive HTLC preimages as proof of state
886 transition, see new documentation for more (#1251).
887 * `KeysInterface::sign_invoice` now provides the HRP and other invoice data
888 separately to make it simpler for external signers to parse (#1272).
889 * `Sign::sign_channel_announcement` now returns both the node's signature and
890 the per-channel signature. `InMemorySigner` now requires the node's secret
891 key in order to implement this (#1179).
892 * `ChannelManager` deserialization will now fail if the `KeysInterface` used
893 has a different `node_id` than the `ChannelManager` expects (#1250).
894 * A new `ErrorAction` variant was added to send `warning` messages (#1013).
895 * Several references to `chain::Listen` objects in `lightning-block-sync` no
896 longer require a mutable reference (#1304).
899 * Fixed a regression introduced in 0.0.104 where `ChannelManager`'s internal
900 locks could have an order violation leading to a deadlock (#1238).
901 * Fixed cases where slow code (including user I/O) could cause us to
902 disconnect peers with ping timeouts in `BackgroundProcessor` (#1269).
903 * Now persist the `ChannelManager` prior to `BackgroundProcessor` stopping,
904 preventing race conditions where channels are closed on startup even with a
905 clean shutdown. This requires that users stop network processing and
906 disconnect peers prior to `BackgroundProcessor` shutdown (#1253).
907 * Fields in `ChannelHandshakeLimits` provided via the `override_config` to
908 `create_channel` are now applied instead of the default config (#1292).
909 * Fixed the generation of documentation on docs.rs to include API surfaces
910 which are hidden behind feature flags (#1303).
911 * Added the `channel_type` field to `accept_channel` messages we send, which
912 may avoid some future compatibility issues with other nodes (#1314).
913 * Fixed a bug where, if a previous LDK run using `lightning-persister` crashed
914 while persisting updated data, we may have failed to initialize (#1332).
915 * Fixed a rare bug where having both pending inbound and outbound HTLCs on a
916 just-opened inbound channel could cause `ChannelDetails::balance_msat` to
917 underflow and be reported as large, or cause panics in debug mode (#1268).
918 * Moved more instances of verbose gossip logging from the `Trace` level to the
919 `Gossip` level (#1220).
920 * Delayed `announcement_signatures` until the channel has six confirmations,
921 slightly improving propagation of channel announcements (#1179).
922 * Several fixes in script and transaction weight calculations when anchor
923 outputs are enabled (#1229).
925 ## Serialization Compatibility
926 * Using `ChannelManager` data written by versions prior to 0.0.105 will result
927 in preimages for HTLCs that were pending at startup to be missing in calls
928 to `KeysInterface` methods (#1251).
929 * Any phantom invoice payments received on a node that is not upgraded to
930 0.0.105 will fail with an "unknown channel" error. Further, downgrading to
931 0.0.104 or before and then upgrading again will invalidate existing phantom
932 SCIDs which may be included in invoices (#1199).
935 0.0.105 fixes two denial-of-service vulnerabilities which may be reachable from
936 untrusted input in certain application designs.
938 * Route calculation spuriously panics when a routing decision is made for a
939 path where the second-to-last hop is a private channel, included due to a
940 multi-hop route hint in an invoice.
941 * `ChannelMonitor::get_claimable_balances` spuriously panics in some scenarios
942 when the LDK application's local commitment transaction is confirmed while
943 HTLCs are still pending resolution.
945 In total, this release features 109 files changed, 7270 insertions, 2131
946 deletions in 108 commits from 15 authors, in alphabetical order:
964 # 0.0.104 - 2021-12-17
967 * A `PaymentFailed` event is now provided to indicate a payment has failed
968 fully. This event is generated either after
969 `ChannelManager::abandon_payment` is called for a given payment, or the
970 payment times out, and there are no further pending HTLCs for the payment.
971 This event should be used to detect payment failure instead of
972 `PaymentPathFailed::all_paths_failed`, unless no payment retries occur via
973 `ChannelManager::retry_payment` (#1202).
974 * Payment secrets are now generated deterministically using material from
975 the new `KeysInterface::get_inbound_payment_key_material` (#1177).
976 * A `PaymentPathSuccessful` event has been added to ease passing success info
977 to a scorer, along with a `Score::payment_path_successful` method to accept
978 such info (#1178, #1197).
979 * `Score::channel_penalty_msat` has additional arguments describing the
980 channel's capacity and the HTLC amount being sent over the channel (#1166).
981 * A new log level `Gossip` has been added, which is used for verbose
982 information generated during network graph sync. Enabling the
983 `max_level_trace` feature or ignoring `Gossip` log entries reduces log
984 growth during initial start up from many GiB to several MiB (#1145).
985 * The `allow_wallclock_use` feature has been removed in favor of only using
986 the `std` and `no-std` features (#1212).
987 * `NetworkGraph` can now remove channels that we haven't heard updates for in
988 two weeks with `NetworkGraph::remove_stale_channels{,with_time}`. The first
989 is called automatically if a `NetGraphMsgHandler` is passed to
990 `BackgroundProcessor::start` (#1212).
991 * `InvoicePayer::pay_pubkey` was added to enable sending "keysend" payments to
992 supported recipients, using the `InvoicePayer` to handle retires (#1160).
993 * `user_payment_id` has been removed from `PaymentPurpose`, and
994 `ChannelManager::create_inbound_payment{,_for_hash}` (#1180).
995 * Updated documentation for several `ChannelManager` functions to remove stale
996 references to panics which no longer occur (#1201).
997 * The `Score` and `LockableScore` objects have moved into the
998 `routing::scoring` module instead of being in the `routing` module (#1166).
999 * The `Time` parameter to `ScorerWithTime` is no longer longer exposed,
1000 instead being fixed based on the `std`/`no-std` feature (#1184).
1001 * `ChannelDetails::balance_msat` was added to fetch a channel's balance
1002 without subtracting the reserve values, lining up with on-chain claim amounts
1003 less on-chain fees (#1203).
1004 * An explicit `UserConfig::accept_inbound_channels` flag is now provided,
1005 removing the need to set `min_funding_satoshis` to > 21 million BTC (#1173).
1006 * Inbound channels that fail to see the funding transaction confirm within
1007 2016 blocks are automatically force-closed with
1008 `ClosureReason::FundingTimedOut` (#1083).
1009 * We now accept a channel_reserve value of 0 from counterparties, as it is
1010 insecure for our counterparty but not us (#1163).
1011 * `NetAddress::OnionV2` parsing was removed as version 2 onion services are no
1012 longer supported in modern Tor (#1204).
1013 * Generation and signing of anchor outputs is now supported in the
1014 `KeysInterface`, though no support for them exists in the channel itself (#1176)
1017 * Fixed a race condition in `InvoicePayer` where paths may be retried after
1018 the retry count has been exceeded. In this case the
1019 `Event::PaymentPathFailed::all_paths_failed` field is not a reliable payment
1020 failure indicator. There was no acceptable alternative indicator,
1021 `Event::PaymentFailed` as been added to provide one (#1202).
1022 * Reduced the blocks-before-timeout we expect of outgoing HTLCs before
1023 refusing to forward. This check was overly strict and resulted in refusing
1024 to forward som HTLCs to a next hop that had a lower security threshold than
1026 * LDK no longer attempt to update the channel fee for outbound channels when
1027 we cannot afford the new fee. This could have caused force-closure by our
1028 channel counterparty (#1054).
1029 * Fixed several bugs which may have prevented the reliable broadcast of our
1030 own channel announcements and updates (#1169).
1031 * Fixed a rare bug which may have resulted in spurious route finding failures
1032 when using last-hop hints and MPP with large value payments (#1168).
1033 * `KeysManager::spend_spendable_outputs` no longer adds a change output that
1034 is below the dust threshold for non-standard change scripts (#1131).
1035 * Fixed a minor memory leak when attempting to send a payment that fails due
1036 to an error when updating the `ChannelMonitor` (#1143).
1037 * Fixed a bug where a `FeeEstimator` that returns values rounded to the next
1038 sat/vbyte may result in force-closures (#1208).
1039 * Handle MPP timeout HTLC error codes, instead of considering the recipient to
1040 have sent an invalid error, removing them from the network graph (#1148)
1042 ## Serialization Compatibility
1043 * All above new events/fields are ignored by prior clients. All above new
1044 events/fields are not present when reading objects serialized by prior
1045 versions of the library.
1046 * Payment secrets are now generated deterministically. This reduces the memory
1047 footprint for inbound payments, however, newly-generated inbound payments
1048 using `ChannelManager::create_inbound_payment{,_for_hash}` will not be
1049 receivable using versions prior to 0.0.104.
1050 `ChannelManager::create_inbound_payment{,_for_hash}_legacy` are provided for
1051 backwards compatibility (#1177).
1052 * `PaymentPurpose::InvoicePayment::user_payment_id` will be 0 when reading
1053 objects written with 0.0.104 when read by 0.0.103 and previous (#1180).
1055 In total, this release features 51 files changed, 5356 insertions, 2238
1056 deletions in 107 commits from 9 authors, in alphabetical order:
1068 # 0.0.103 - 2021-11-02
1071 * This release is almost entirely focused on a new API in the
1072 `lightning-invoice` crate - the `InvoicePayer`. `InvoicePayer` is a
1073 struct which takes a reference to a `ChannelManager` and a `Router`
1074 and retries payments as paths fail. It limits retries to a configurable
1075 number, but is not serialized to disk and may retry additional times across
1076 a serialization/load. In order to learn about failed payments, it must
1077 receive `Event`s directly from the `ChannelManager`, wrapping a
1078 user-provided `EventHandler` which it provides all unhandled events to
1080 * `get_route` has been renamed `find_route` (#1059) and now takes a
1081 `RouteParameters` struct in replacement of a number of its long list of
1082 arguments (#1134). The `Payee` in the `RouteParameters` is stored in the
1083 `Route` object returned and provided in the `RouteParameters` contained in
1084 `Event::PaymentPathFailed` (#1059).
1085 * `ChannelMonitor`s must now be persisted after calls that provide new block
1086 data, prior to `MonitorEvent`s being passed back to `ChannelManager` for
1087 processing. If you are using a `ChainMonitor` this is handled for you.
1088 The `Persist` API has been updated to `Option`ally take the
1089 `ChannelMonitorUpdate` as persistence events that result from chain data no
1090 longer have a corresponding update (#1108).
1091 * `routing::Score` now has a `payment_path_failed` method which it can use to
1092 learn which channels often fail payments. It is automatically called by
1093 `InvoicePayer` for failed payment paths (#1144).
1094 * The default `Scorer` implementation is now a type alias to a type generic
1095 across different clocks and supports serialization to persist scoring data
1096 across restarts (#1146).
1097 * `Event::PaymentSent` now includes the full fee which was spent across all
1098 payment paths which were fulfilled or pending when the payment was fulfilled
1100 * `Event::PaymentSent` and `Event::PaymentPathFailed` now include the
1101 `PaymentId` which matches the `PaymentId` returned from
1102 `ChannelManager::send_payment` or `InvoicePayer::pay_invoice` (#1059).
1103 * `NetGraphMsgHandler` now takes a `Deref` to the `NetworkGraph`, allowing for
1104 shared references to the graph data to make serialization and references to
1105 the graph data in the `InvoicePayer`'s `Router` simpler (#1149).
1106 * `routing::Score::channel_penalty_msat` has been updated to provide the
1107 `NodeId` of both the source and destination nodes of a channel (#1133).
1110 * Previous versions would often disconnect peers during initial graph sync due
1111 to ping timeouts while processing large numbers of gossip messages. We now
1112 delay disconnecting peers if we receive messages from them even if it takes
1113 a while to receive a pong from them. Further, we avoid sending too many
1114 gossip messages between pings to ensure we should always receive pongs in a
1115 timely manner (#1137).
1116 * If a payment was sent, creating an outbound HTLC and sending it to our
1117 counterparty (implying the `ChannelMonitor` was persisted on disk), but the
1118 `ChannelManager` was not persisted prior to shutdown/crash, no
1119 `Event::PaymentPathFailed` event was generated if the HTLC was eventually
1120 failed on chain. Events are now consistent irrespective of `ChannelManager`
1121 persistence or non-persistence (#1104).
1123 ## Serialization Compatibility
1124 * All above new Events/fields are ignored by prior clients. All above new
1125 Events/fields are not present when reading objects serialized by prior
1126 versions of the library.
1127 * Payments for which a `Route` was generated using a previous version or for
1128 which the payment was originally sent by a previous version of the library
1129 will not be retried by an `InvoicePayer`.
1131 This release was singularly focused and some contributions by third parties
1133 In total, this release features 38 files changed, 4414 insertions, and 969
1134 deletions in 71 commits from 2 authors, in alphabetical order:
1140 # 0.0.102 - 2021-10-18
1143 * `get_route` now takes a `Score` as an argument. `Score` is queried during
1144 the route-finding process, returning the absolute amounts which you are
1145 willing to pay to avoid routing over a given channel. As a default, a
1146 `Scorer` is provided which returns a constant amount, with a suggested
1147 default of 500 msat. This translates to a willingness to pay up to 500 msat
1148 in additional fees per hop in order to avoid additional hops (#1124).
1149 * `Event::PaymentPathFailed` now contains a `short_channel_id` field which may
1150 be filled in with a channel that can be "blamed" for the payment failure.
1151 Payment retries should likely avoid the given channel for some time (#1077).
1152 * `PublicKey`s in `NetworkGraph` have been replaced with a `NodeId` struct
1153 which contains only a simple `[u8; 33]`, substantially improving
1154 `NetworkGraph` deserialization performance (#1107).
1155 * `ChainMonitor`'s `HashMap` of `ChannelMonitor`s is now private, exposed via
1156 `Chainmonitor::get_monitor` and `ChainMonitor::list_monitors` instead
1158 * When an outbound channel is closed prior to the broadcasting of its funding
1159 transaction, but after you call
1160 `ChannelManager::funding_transaction_generated`, a new event type,
1161 `Event::DiscardFunding`, is generated, informing you the transaction was not
1162 broadcasted and that you can spend the same inputs again elsewhere (#1098).
1163 * `ChannelManager::create_channel` now returns the temporary channel ID which
1164 may later appear in `Event::ChannelClosed` or `ChannelDetails` prior to the
1165 channel being funded (#1121).
1166 * `Event::PaymentSent` now contains the payment hash as well as the payment
1168 * `ReadOnlyNetworkGraph::get_addresses` now returns owned `NetAddress` rather
1169 than references. As a side-effect this method is now exposed in foreign
1170 language bindings (#1115).
1171 * The `Persist` and `ChannelMonitorUpdateErr` types have moved to the
1172 `lightning::chain::chainmonitor` and `lightning::chain` modules,
1173 respectively (#1112).
1174 * `ChannelManager::send_payment` now returns a `PaymentId` which identifies a
1175 payment (whether MPP or not) and can be used to retry the full payment or
1176 MPP parts through `retry_payment` (#1096). Note that doing so is currently
1177 *not* crash safe, and you may find yourself sending twice. It is recommended
1178 that you *not* use the `retry_payment` API until the next release.
1181 * Due to an earlier fix for the Lightning dust inflation vulnerability tracked
1182 in CVE-2021-41591/CVE-2021-41592/CVE-2021-41593 in 0.0.100, we required
1183 counterparties to accept a dust limit slightly lower than the dust limit now
1184 required by other implementations. This appeared as, at least, latest lnd
1185 always refusing to accept channels opened by LDK clients (#1065).
1186 * If there are multiple channels available to the same counterparty,
1187 `get_route` would only consider the channel listed last as available for
1189 * `Persist` implementations returning
1190 `ChannelMonitorUpdateErr::TemporaryFailure` from `watch_channel` previously
1191 resulted in the `ChannelMonitor` not being stored at all, resulting in a
1192 panic after monitor updating is complete (#1112).
1193 * If payments are pending awaiting forwarding at startup, an
1194 `Event::PendingHTLCsForwardable` event will always be provided. This ensures
1195 user code calls `ChannelManager::process_pending_htlc_fowards` even if it
1196 shut down while awaiting the batching timer during the previous run (#1076).
1197 * If a call to `ChannelManager::send_payment` failed due to lack of
1198 availability of funds locally, LDK would store the payment as pending
1199 forever, with no ability to retry or fail it, leaking memory (#1109).
1201 ## Serialization Compatibility
1202 * All above new Events/fields are ignored by prior clients. All above new
1203 Events/fields, except for `Event::PaymentSent::payment_hash` are not present
1204 when reading objects serialized by prior versions of the library.
1206 In total, this release features 32 files changed, 2248 insertions, and 1483
1207 deletions in 51 commits from 7 authors, in alphabetical order:
1218 # 0.0.101 - 2021-09-23
1221 * Custom message types are now supported directly in the `PeerManager`,
1222 allowing you to send and receive messages of any type that is not natively
1223 understood by LDK. This requires a new type bound on `PeerManager`, a
1224 `CustomMessageHandler`. `IgnoringMessageHandler` provides a simple default
1225 for this new bound for ignoring unknown messages (#1031, #1074).
1226 * Route graph updates as a result of failed payments are no longer provided as
1227 `MessageSendEvent::PaymentFailureNetworkUpdate` but instead included in a
1228 new field in the `Event::PaymentFailed` events. Generally, this means route
1229 graph updates are no longer handled as a part of the `PeerManager` but
1230 instead through the new `EventHandler` implementation for
1231 `NetGraphMsgHandler`. To make this easy, a new parameter to
1232 `lightning-background-processor::BackgroundProcessor::start` is added, which
1233 contains an `Option`al `NetGraphmsgHandler`. If provided as `Some`, relevant
1234 events will be processed by the `NetGraphMsgHandler` prior to normal event
1236 * `NetworkGraph` is now, itself, thread-safe. Accordingly, most functions now
1237 take `&self` instead of `&mut self` and the graph data can be accessed
1238 through `NetworkGraph.read_only` (#1043).
1239 * The balances available on-chain to claim after a channel has been closed are
1240 now exposed via `ChannelMonitor::get_claimable_balances` and
1241 `ChainMonitor::get_claimable_balances`. The second can be used to get
1242 information about all closed channels which still have on-chain balances
1243 associated with them. See enum variants of `ln::channelmonitor::Balance` and
1244 method documentation for the above methods for more information on the types
1245 of balances exposed (#1034).
1246 * When one HTLC of a multi-path payment fails, the new field `all_paths_failed`
1247 in `Event::PaymentFailed` is set to `false`. This implies that the payment
1248 has not failed, but only one part. Payment resolution is only indicated by an
1249 `Event::PaymentSent` event or an `Event::PaymentFailed` with
1250 `all_paths_failed` set to `true`, which is also set for the last remaining
1251 part of a multi-path payment (#1053).
1252 * To better capture the context described above, `Event::PaymentFailed` has
1253 been renamed to `Event::PaymentPathFailed` (#1084).
1254 * A new event, `ChannelClosed`, is provided by `ChannelManager` when a channel
1255 is closed, including a reason and error message (if relevant, #997).
1256 * `lightning-invoice` now considers invoices with sub-millisatoshi precision
1257 to be invalid, and requires millisatoshi values during construction (thus
1258 you must call `amount_milli_satoshis` instead of `amount_pico_btc`, #1057).
1259 * The `BaseSign` interface now includes two new hooks which provide additional
1260 information about commitment transaction signatures and revocation secrets
1261 provided by our counterparty, allowing additional verification (#1039).
1262 * The `BaseSign` interface now includes additional information for cooperative
1263 close transactions, making it easier for a signer to verify requests (#1064).
1264 * `Route` has two additional helper methods to get fees and amounts (#1063).
1265 * `Txid` and `Transaction` objects can now be deserialized from responses when
1266 using the HTTP client in the `lightning-block-sync` crate (#1037, #1061).
1269 * Fix a panic when reading a lightning invoice with a non-recoverable
1270 signature. Further, restrict lightning invoice parsing to require payment
1271 secrets and better handle a few edge cases as required by BOLT 11 (#1057).
1272 * Fix a panic when receiving multiple messages (such as HTLC fulfill messages)
1273 after a call to `chain::Watch::update_channel` returned
1274 `Err(ChannelMonitorUpdateErr::TemporaryFailure)` with no
1275 `ChannelManager::channel_monitor_updated` call in between (#1066).
1276 * For multi-path payments, `Event::PaymentSent` is no longer generated
1277 multiple times, once for each independent part (#1053).
1278 * Multi-hop route hints in invoices are now considered in the default router
1279 provided via `get_route` (#1040).
1280 * The time peers have to respond to pings has been increased when building
1281 with debug assertions enabled. This avoids peer disconnections on slow hosts
1282 when running in debug mode (#1051).
1283 * The timeout for the first byte of a response for requests from the
1284 `lightning-block-sync` crate has been increased to 300 seconds to better
1285 handle the long hangs in Bitcoin Core when it syncs to disk (#1090).
1287 ## Serialization Compatibility
1288 * Due to a bug in 0.0.100, `Event`s written by 0.0.101 which are of a type not
1289 understood by 0.0.100 may lead to `Err(DecodeError::InvalidValue)` or corrupt
1290 deserialized objects in 0.100. Such `Event`s will lead to an
1291 `Err(DecodeError::InvalidValue)` in versions prior to 0.0.100. The only such
1292 new event written by 0.0.101 is `Event::ChannelClosed` (#1087).
1293 * Payments that were initiated in versions prior to 0.0.101 may still
1294 generate duplicate `PaymentSent` `Event`s or may have spurious values for
1295 `Event::PaymentPathFailed::all_paths_failed` (#1053).
1296 * The return values of `ChannelMonitor::get_claimable_balances` (and, thus,
1297 `ChainMonitor::get_claimable_balances`) may be spurious for channels where
1298 the spend of the funding transaction appeared on chain while running a
1299 version prior to 0.0.101. `Balance` information should only be relied upon
1300 for channels that were closed while running 0.0.101+ (#1034).
1301 * Payments failed while running versions prior to 0.0.101 will never have a
1302 `Some` for the `network_update` field (#1043).
1304 In total, this release features 67 files changed, 4980 insertions, 1888
1305 deletions in 89 commits from 12 authors, in alphabetical order:
1313 * Sergi Delgado Segura
1320 # 0.0.100 - 2021-08-17 - "Oh, so *that's* what's going on inside the box"
1323 * The `lightning` crate can now be built in no_std mode, making it easy to
1324 target embedded hardware for rust users. Note that mutexes are replaced with
1325 no-ops for such builds (#1008, #1028).
1326 * LDK now supports sending and receiving "keysend" payments. This includes
1327 modifications to `lightning::util::events::Event::PaymentReceived` to
1328 indicate the type of payment (#967).
1329 * A new variant, `lightning::util::events::Event::PaymentForwarded` has been
1330 added which indicates a forwarded payment has been successfully claimed and
1331 we've received a forwarding fee (#1004).
1332 * `lightning::chain::keysinterface::KeysInterface::get_shutdown_pubkey` has
1333 been renamed to `get_shutdown_scriptpubkey`, returns a script, and is now
1334 called on channel open only if
1335 `lightning::util::config::ChannelConfig::commit_upfront_shutdown_pubkey` is
1337 * Closing-signed negotiation is now more configurable, with an explicit
1338 `lightning::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis`
1339 field allowing you to select the maximum amount you are willing to pay to
1340 avoid a force-closure. Further, we are now less restrictive on the fee
1341 placed on the closing transaction when we are not the party paying it. To
1342 control the feerate paid on a channel at close-time, use
1343 `ChannelManager::close_channel_with_target_feerate` instead of
1344 `close_channel` (#1011).
1345 * `lightning_background_processor::BackgroundProcessor` now stops the
1346 background thread when dropped (#1007). It is marked `#[must_use]` so that
1347 Rust users will receive a compile-time warning when it is immediately
1348 dropped after construction (#1029).
1349 * Total potential funds burn on force-close due to dust outputs is now limited
1350 to `lightning::util::config::ChannelConfig::max_dust_htlc_exposure_msat` per
1352 * The interval on which
1353 `lightning::ln::peer_handler::PeerManager::timer_tick_occurred` should be
1354 called has been reduced to once every five seconds (#1035) and
1355 `lightning::ln::channelmanager::ChannelManager::timer_tick_occurred` should
1356 now be called on startup in addition to once per minute (#985).
1357 * The rust-bitcoin and bech32 dependencies have been updated to their
1358 respective latest versions (0.27 and 0.8, #1012).
1361 * Fix panic when reading invoices generated by some versions of c-lightning
1363 * Fix panic when attempting to validate a signed message of incorrect length
1365 * Do not ignore the route hints in invoices when the invoice is over 250k
1367 * Fees are automatically updated on outbound channels to ensure commitment
1368 transactions are always broadcastable (#985).
1369 * Fixes a rare case where a `lightning::util::events::Event::SpendableOutputs`
1370 event is not generated after a counterparty commitment transaction is
1371 confirmed in a reorg when a conflicting local commitment transaction is
1372 removed in the same reorg (#1022).
1373 * Fixes a remotely-triggerable force-closure of an origin channel after an
1374 HTLC was forwarded over a next-hop channel and the next-hop channel was
1375 force-closed by our counterparty (#1025).
1376 * Fixes a rare force-closure case when sending a payment as a channel fundee
1377 when overdrawing our remaining balance. Instead the send will fail (#998).
1378 * Fixes a rare force-closure case when a payment was claimed prior to a
1379 peer disconnection or restart, and later failed (#977).
1381 ## Serialization Compatibility
1382 * Pending inbound keysend payments which have neither been failed nor claimed
1383 when serialized will result in a `ChannelManager` which is not readable on
1384 pre-0.0.100 clients (#967).
1386 `lightning::chain::keysinterface::KeysInterface::get_shutdown_scriptpubkey`
1387 has been updated to return a script instead of only a `PublicKey`,
1388 `ChannelManager`s constructed with custom `KeysInterface` implementations on
1389 0.0.100 and later versions will not be readable on previous versions.
1390 `ChannelManager`s created with 0.0.99 and prior versions will remain readable
1391 even after the a serialization roundtrip on 0.0.100, as long as no new
1392 channels are opened. Further, users using a
1393 `lightning::chain::keysinterface::KeysManager` as their `KeysInterface` will
1394 have `ChannelManager`s which are readable on prior versions as well (#1019).
1395 * `ChannelMonitorUpdate`s created by 0.0.100 and later for channels when
1396 `lightning::util::config::ChannelConfig::commit_upfront_shutdown_pubkey` is
1397 not set may not be readable by versions prior to 0.0.100 (#1019).
1398 * HTLCs which were in the process of being claimed on-chain when a pre-0.0.100
1399 `ChannelMonitor` was serialized may generate `PaymentForwarded` events with
1400 spurious `fee_earned_msat` values. This only applies to payments which were
1401 unresolved at the time of the upgrade (#1004).
1402 * 0.0.100 clients with pending `Event::PaymentForwarded` events at
1403 serialization-time will generate serialized `ChannelManager` objects which
1404 0.0.99 and earlier clients cannot read. The likelihood of this can be reduced
1405 by ensuring you process all pending events immediately before serialization
1406 (as is done by the `lightning-background-processor` crate, #1004).
1409 In total, this release features 59 files changed, 5861 insertions, and 2082
1410 deletions in 95 commits from 6 authors.
1413 # 0.0.99 - 2021-07-09 - "It's a Bugz Life"
1417 * `lightning_block_sync::poll::Validate` is now public, allowing you to
1418 implement the `lightning_block_sync::poll::Poll` trait without
1419 `lightning_block_sync::poll::ChainPoller` (#956).
1420 * `lightning::ln::peer_handler::PeerManager` no longer requires that no calls
1421 are made to referencing the same `SocketDescriptor` after
1422 `disconnect_socket` returns. This makes the API significantly less
1423 deadlock-prone and simplifies `SocketDescriptor` implementations
1424 significantly. The relevant changes have been made to `lightning_net_tokio`
1425 and `PeerManager` documentation has been substantially rewritten (#957).
1426 * `lightning::util::message_signing`'s `sign` and `verify` methods now take
1427 secret and public keys by reference instead of value (#974).
1428 * Substantially more information is now exposed about channels in
1429 `ChannelDetails`. See documentation for more info (#984 and #988).
1430 * The latest best block seen is now exposed in
1431 `ChannelManager::current_best_block` and
1432 `ChannelMonitor::current_best_block` (#984).
1433 * Feerates charged when forwarding payments over channels is now set in
1434 `ChannelConfig::fee_base_msat` when the channel is opened. For existing
1435 channels, the value is set to the value provided in
1436 `ChannelManagerReadArgs::default_config::channel_options` the first time the
1437 `ChannelManager` is loaded in 0.0.99 (#975).
1438 * We now reject HTLCs which are received to be forwarded over private channels
1439 unless `UserConfig::accept_forwards_to_priv_channels` is set. Note that
1440 `UserConfig` is never serialized and must be provided via
1441 `ChannelManagerReadArgs::default_config` at each start (#975).
1445 * We now forward gossip messages to peers instead of only relaying
1446 locally-generated gossip or sending gossip messages during initial sync
1448 * Correctly send `channel_update` messages to direct peers on private channels
1449 (#949). Without this, a private node connected to an LDK node over a private
1450 channel cannot receive funds as it does not know which fees the LDK node
1452 * `lightning::ln::channelmanager::ChannelManager` no longer expects to be
1453 persisted spuriously after we receive a `channel_update` message about any
1454 channel in the routing gossip (#972).
1455 * Asynchronous `ChannelMonitor` updates (using the
1456 `ChannelMonitorUpdateErr::TemporaryFailure` return variant) no longer cause
1457 spurious HTLC forwarding failures (#954).
1458 * Transaction provided via `ChannelMonitor::transactions_confirmed`
1459 after `ChannelMonitor::best_block_updated` was called for a much later
1460 block now trigger all relevant actions as of the later block. Previously
1461 some transaction broadcasts or other responses required an additional
1462 block be provided via `ChannelMonitor::best_block_updated` (#970).
1463 * We no longer panic in rare cases when an invoice contained last-hop route
1464 hints which were unusable (#958).
1466 ## Node Compatibility
1468 * We now accept spurious `funding_locked` messages sent prior to
1469 `channel_reestablish` messages after reconnect. This is a
1470 [known, long-standing bug in lnd](https://github.com/lightningnetwork/lnd/issues/4006)
1472 * We now set the `first_blocknum` and `number_of_blocks` fields in
1473 `reply_channel_range` messages to values which c-lightning versions prior to
1474 0.10 accepted. This avoids spurious force-closes from such nodes (#961).
1476 ## Serialization Compatibility
1478 * Due to a bug discovered in 0.0.98, if a `ChannelManager` is serialized on
1479 version 0.0.98 while an `Event::PaymentSent` is pending processing, the
1480 `ChannelManager` will fail to deserialize both on version 0.0.98 and later
1481 versions. If you have such a `ChannelManager` available, a simple patch will
1482 allow it to deserialize. Please file an issue if you need assistance (#973).
1484 # 0.0.98 - 2021-06-11 - "It's ALIVVVVEEEEEEE"
1486 0.0.98 should be considered a release candidate to the first alpha release of
1487 Rust-Lightning and the broader LDK. It represents several years of work
1488 designing and fine-tuning a flexible API for integrating lightning into any
1489 application. LDK should make it easy to build a lightning node or client which
1490 meets specific requirements that other lightning node software cannot. As
1491 lightning continues to evolve, and new use-cases for lightning develop, the API
1492 of LDK will continue to change and expand. However, starting with version 0.1,
1493 objects serialized with prior versions will be readable with the latest LDK.
1494 While Rust-Lightning is approaching the 0.1 milestone, language bindings
1495 components of LDK available at https://github.com/lightningdevkit are still of
1496 varying quality. Some are also approaching an 0.1 release, while others are
1497 still much more experimental. Please note that, at 0.0.98, using Rust-Lightning
1498 on mainnet is *strongly* discouraged.
projects / rust-lightning / blob