Releases: lightningdevkit/rust-lightning
v0.1.1 - Jan 28, 2025 - "Onchain Matters"
API Updates
- A
ChannelManager::send_payment_with_route
was (re-)added, with semantics
similar toChannelManager::send_payment
(rather than like the pre-0.1
send_payent_with_route
, #3534). RawBolt11Invoice::{to,from}_raw
were added (#3549).
Bug Fixes
- HTLCs which were forwarded where the inbound edge times out within the next
three blocks will have the inbound HTLC failed backwards irrespective of the
status of the outbound HTLC. This avoids the peer force-closing the channel
(and claiming the inbound edge HTLC on-chain) even if we have not yet managed
to claim the outbound edge on chain (#3556). - On restart, replay of
Event::SpendableOutput
s could have caused
OutputSweeper
to generate double-spending transactions, making it unable to
claim any delayed claims. This was resolved by retaining old claims for more
than four weeks after they are claimed on-chain to detect replays (#3559). - Fixed the additional feerate we will pay each time we RBF on-chain claims to
match the Bitcoin Core policy (1 sat/vB) instead of 16 sats/vB (#3457). - Fixed a cased where a custom
Router
which returns an invalidRoute
,
provided toChannelManager
, can result in an outbound payment remaining
pending forever despite no HTLCs being pending (#3531).
Security
0.1.1 fixes a denial-of-service vulnerability allowing channel counterparties to
cause force-closure of unrelated channels.
- If a malicious channel counterparty force-closes a channel, broadcasting a
revoked commitment transaction while the channel at closure time included
multiple non-dust forwarded outbound HTLCs with identical payment hashes and
amounts, failure to fail the HTLCs backwards could cause the channels on
which we recieved the corresponding inbound HTLCs to be force-closed. Note
that we'll receive, at a minimum, the malicious counterparty's reserve value
when they broadcast the stale commitment (#3556). Thanks to Matt Morehouse for
reporting this issue.
v0.1
0.1 - Jan 15, 2025 - "Human Readable Version Numbers"
The LDK 0.1 release represents an important milestone for the LDK project. While
there are certainly many important features which are still being built, the LDK
project has come a long way, and the LDK project is happy with the quality of
the features included in this release. Thus, the project will begin doing patch
releases to fix bugs in prior versions as new features continue to ship in new
minor versions.
API Updates
- The
lightning-liquidity
crate has been moved into therust-lightning
git tree, enabling support for both sides of the LSPS channel open
negotiation protocols (#3436). - Since its last alpha release,
lightning-liquidity
has also gained support
for acting as an LSPS1 client (#3436). - This release includes support for BIP 353 Human Readable Names resolution.
With thednssec
feature enabled, simply callChannelManager
's
pay_for_offer_from_human_readable_name
with a list of lightning nodes that
have thedns_resolver
feature flag set (e.g. those running LDK with the
newlightning_dns_resolver::OMDomainResolver
set up to resolve DNS queries
for others) and a Human Readable Name (#3346, #3179, #3283). - Asynchronous
ChannelMonitorUpdate
persistence (i.e. the use of
ChannelMonitorUpdateStatus::InProgress
) is now considered beta-quality.
There are no known issues with it, though the likelihood of unknown issues
is high (#3414). ChannelManager
'ssend_payment_with_route
andsend_spontaneous_payment
were removed. Usesend_payment
andsend_spontaneous_payment_with_retry
(now renamedsend_spontaneous_payment
) instead (#3430).ChannelMonitor
s no longer need to be re-persisted after deserializing the
ChannelManager
before beginning normal operation. As such,
ChannelManagerReadArgs::channel_monitors
no longer requires mutable
references (#3322). See the Backwards Compatibility section for more info.- Additional information is now stored in
ChannelMonitorUpdate
s which may
increase the average size ofChannelMonitorUpdate
s when claiming inbound
payments substantially. The expected maximum size ofChannelMonitorUpdate
s
shouldn't change materially (#3322). - Redundant
Event::PaymentClaimed
s will be generated more frequently on
startup compared to previous versions.
Event::PaymentClaim{able,ed}::payment_id
has been added to allow for more
robust handling of redundant events on payments with duplicate
PaymentHash
es (#3303, #3322). ChannelMonitorUpdate::update_id
s no longer have a magic value (of
u64::MAX
) for updates after a channel has been closed. They are now
always monotonically increasing (#3355).- The MSRV of
lightning-transaction-sync
has been increased to rustc 1.75 due
to its HTTP client dependencies (#3528). - The default
ProbabilisticScoringFeeParameters
values now recommend specific
ratios between different penalties, and default penalties now allow for
higher fees in order to reduce payment latency (#3495). - On-chain state resolution now more aggressively batches claims into single
transactions, reducing on-chain fee costs when resolving multiple HTLCs for a
single channel force-closure. This also reduces the on-chain reserve
requirements for nodes using anchor channels (#3340). - A
MigratableKVStore
trait was added (and implemented for
FilesystemStore
), enabling easy migration betweenKVStore
s (#3481). InvoiceRequest::amount_msats
now returns theoffer
-implied amount if a
Bitcoin-denominated amount was set in theoffer
and no amount was set
directly in theinvoice_request
(#3535).Event::OpenChannelRequest::push_msat
has been replaced with an enum in
preparation for the dual-funding protocol coming in a future release (#3137).GossipVerifier
now requires aP2PGossipSync
which holds a reference to
theGossipVerifier
via anArc
(#3432).- The
max_level_*
features were removed as the performance gain compared to
doing the limiting at runtime was negligible (#3431). ChannelManager::create_bolt11_invoice
was added, deprecating the
lightning::ln::invoice_utils
module (#3389).- The
bech32
dependency has been upgraded to 0.11 across crates (#3270). - Support for creating BOLT 12
invoice_request
s with a static signing key
rather than an ephemeral one has been removed (#3264). - The
Router
trait no longer extends theMessageRouter
trait, creating an
extra argument toChannelManager
construction (#3326). - The deprecated
AvailableBalances::balance_msat
has been removed in favor of
ChannelMonitor::get_claimable_balances
(#3243). - Deprecated re-exports of
Payment{Hash,Preimage,Secret}
andfeatures
were
removed (#3359). bolt11_payment::*_from_zero_amount_invoice
methods were renamed
*_from_variable_amount_invoice
(#3397)- Offer
signing_pubkey
(and related struct names) have been renamed
issuer_signing_pubkey
(#3218). Event::PaymentForwarded::{prev,next}_node_id
were added (#3458).Event::ChannelClosed::last_local_balance_msat
was added (#3235).RoutingMessageHandler::handle_*
now all have anode_id
argument (#3291).lightning::util::persist::MonitorName
has been exposed (#3376).ProbabilisticScorer::live_estimated_payment_success_probability
was added
(#3420)EcdsaChannelSigner::sign_splicing_funding_input
was added to support an
eventual splicing feature (#3316).{Payment,Offer}Id
now support lowercase-hex formatting (#3377).
Bug Fixes
- Fixed a rare case where a BOLT 12 payment may be made duplicatively if the
node crashes while processing a BOLT 12invoice
message (#3313). - Fixed a bug where a malicious sender could cause a payment
Event
to be
generated with anOfferId
using a payment with a lower amount than the
corresponding BOLT 12 offer would have required. The amount in the
Event::Payment{Claimable,Claimed}
were still correct (#3435). - The
ProbabilisticScorer
model and associated default scoring parameters
were tweaked to be more predictive of real-world results (#3368, #3495). ProbabilisticScoringFeeParameters::base_penalty_amount_multiplier_msat
no
longer includes any pending HTLCs we already have through channels in the
graph, avoiding over-penalizing them in comparison to other channels (#3356).- A
ChannelMonitor
will no longer be archived if aMonitorEvent
containing
a preimage for another channel is pending. This fixes an issue where a
payment preimage needed for another channel claim is lost if events go
un-processed for 4038 blocks (#3450). std
builds no longer send the full gossip state to peers that do not
request it (#3390).lightning-block-sync
listeners now receiveblock_connected
calls, rather
than always receivingfiltered_block_connected
calls (#3354).- Fixed a bug where some transactions were broadcasted one block before their
locktime made them candidates for inclusion in the mempool (though they would
be automatically re-broadcasted later, #3453). ChainMonitor
now persistsChannelMonitor
s when theirBalance
set first
goes empty, makingChannelMonitor
pruning more reliable on nodes that are
only online briefly (e.g. mobile nodes, #3442).- BOLT 12 invoice requests now better handle intermittent internet connectivity
(e.g. on mobile devices with app interruptions, #3010). - Broadcast-gossip
MessageSendEvent
s from theChannelMessageHandler
are now
delivered to peers even if the peer is behind in processing relayed gossip.
This ensures our own gossip propagates well even if we have very limited
upload bandwidth (#3142). - Fixed a bug where calling
OutputSweeper::transactions_confirmed
with
transactions from anything but the latest block may have triggered a spurious
assertion in debug mode (#3524).
Performance Improvements
- LDK now verifies
channel_update
gossip messages without holding a lock,
allowing additional parallelism during gossip sync (#3310). - LDK now checks if it already has certain gossip messages before verifying the
message signatures, reducing CPU usage during gossip sync after the first
startup (#3305).
Node Compatibility
- LDK now handles fields in the experimental range of BOLT 12 messages (#3237).
Backwards Compatibility
- Nodes with pending forwarded HTLCs or unclaimed payments cannot be
upgraded directly from 0.0.123 or earlier to 0.1. Instead, they must
first either resolve all pending HTLCs (including those pending
resolution on-chain), or run 0.0.124 or 0.0.125 and resolve any HTLCs that
were originally forwarded or received running 0.0.123 or earlier (#3355). ChannelMonitor
s not being re-persisted after deserializing the
ChannelManager
only applies to upgraded nodes after a startup with the
old semantics completes at least once. In other words, you must deserialize
theChannelManager
with an upgraded LDK, persist theChannelMonitor
s as
you would on pre-0.1 versions of LDK, then continue to normal startup once,
and for startups thereafter you can take advantage of the new semantics
avoiding redundant persistence on startup (#3322).- Pending inbound payments paying a BOLT 12
invoice
issued prior to upgrade
to LDK 0.1 will fail. Issued BOLT 12offer
s remain payable (#3435). UserConfig::accept_mpp_keysend
was removed, thus the presence of pending
inbound MPP keysend payments will prevent downgrade to LDK 0.0.115 and
earlier (#3439).- Inbound payments initialized using the removed
ChannelManager::create_inbound_payment{,_for_hash}_legacy
API will no
longer be accepted by LDK 0.1 (#3383). - Do...
v0.1.0-beta1
Release notes forthcoming.
v0.0.125
0.0.125 - Oct 14, 2024 - "Delayed Beta Testing"
Bug Fixes
- On upgrade to 0.0.124, channels which were at a steady-state (i.e. for which
the counterparty has received our latestrevoke_and_ack
message) will
force-close upon receiving the next channel state update from our
counterparty. When built with debug assertions a debug assertion failure will
occur instead (#3362). - Listeners in a
ChainListenerSet
will now have theirblock_connected
method called, when appropriate, rather than always having their
filtered_block_connected
method called with full block data (#3354). - Routefinding historical liquidity channel scores were made more consistent
for channels which have very little data which has been decayed (#3362). - A debug assertion failure when adding nodes to the network graph after
removal of nodes from the network graph was fixed (#3362).
In total, this release features 6 files changed, 32 insertions, 7
deletions in 5 commits since 0.0.124 from 2 authors, in alphabetical order:
- Elias Rohrer
- Matt Corallo
v0.0.124
0.0.124 - Sep 3, 2024 - "Papercutting Feature Requests"
API Updates
rust-bitcoin
has been updated to 0.32. The newbitcoin-io
crate is now
used for all IO traits, irrespective of the features set on LDK crates.
LDK crates no longer automatically force features on dependent crates where
possible, allowing differentstd
/no-std
settings between LDK and
rust-bitcoin crates (e.g. to disablestd
on LDK to ensure system time is
not accessed while usingbitcoin-io
'sstd
feature). (#3063, #3239, #3249).- A new
lightning_types
crate was added which contains various top-level
types. Using types fromlightning::ln::features
or
Payment{Hash,Preimage,Secret}
fromlightning::ln
or
lightning::ln::types
is now deprecated. The new crate is re-exported as
lightning::types
(#3234, #3253). lightning
now depends onlightning-invoice
, rather than the other way
around. Thelightning_invoice::payment
module has moved to
lightning::ln::bolt11_payment
andlightning_invoice::utils
to
lightning::ln::invoice_utils
(#3234).- Event handlers may now return errors, causing most events to be replayed
immediately without blocking the background processor. See documentation on
individualEvent
s for more information on replay (#2995). ChannelDetails::balance_msat
is deprecated in favor of
ChainMonitor::get_claimable_balances
and theBalance
, which now contains
substantially more details and more accurately calculates a node-wide
balance whenBalance::claimable_amount_satoshis
are summed (#3212, #3247).ConfirmationTarget
has two new variants - aMaximumFeeEstimate
which can
help to avoid spurious force-closes by ensuring we always accept feerates up
to this value from peers as sane and aUrgentOnChainSweep
, replacing
OnChainSweep
and only being used when the on-chain sweep is urgent (#3268).- All
ChannelMonitor
s are no longer persisted after each block connection,
instead spreading them out over a handful of blocks to reduce load spikes.
Note that this will increase the incidence ofChannelMonitor
s that have
different best blocks on startup, requiring some additional chain replay
(but only on someChannelMonitor
s) on startup forListen
users (#2966). - A new format for Rapid Gossip Sync data is now supported which contains
additional node metadata and is more extensible (#3098). ChannelManager::send_payment_with_route
is now deprecated in favor of the
much easier to useChannelmanager::send_payment
. Those who wish to manually
select the route such payments go over should do so by matching the
payment_id
passed tosend_payment
inRouter::find_route_with_id
(#3224)lightning-transaction-sync
now takes mostConfirm
s as a genericDeref
.
You may need an explicitas &(dyn Confirm)
to update existing code (#3101).- HTLCs will now be forwarded over any channel with a peer, rather than only
the specific channel requested by the payment sender (#3127). Event::PaymentFailed
is now used in place ofEvent::InvoiceRequestFailed
,
holding anOption
for the payment hash, which will beNone
when no
invoice has been received (#3192).ChannelManager
now supports intercepting and manually paying
Bolt12Invoice
s, seeUserConfig::manually_handle_bolt12_invoices
(#3078).logger::Record
s now contain aPaymentHash
(#2930).ChainMonitor
no longer uses an opaqueMonitorUpdateId
, opting to reuse
theChannelMonitorUpdate::update_id
instead. Note that you no longer have
to callChainMonitor::channel_monitor_updated
for
ChannelMonitorUpdateStatus::InProgress
updates to a monitor that were
started without aChannelMonitorUpdate
(#2957).NodeAnnouncementInfo
is now an enum holding either a gossip message or
the important fields, reducing the memory usage ofNetworkGraph
(#3072).- Onion message handlers now include a message context, which allows for
blinded path authentication (#3085, #3202). ChannelManager
now supports funding with only a txid and output index, see
ChannelManager::unsafe_manual_funding_transaction_generated
(#3024).- BOLT 12 invoice requests now go out over, and accept responses over, multiple
paths (#3087). OnionMessenger
now supports intercepting and re-forwarding onion messages
for peers that are offline at the time of receipt when constructed with
new_with_offline_peer_interception
(#2973).- Onion message handling trait methods now generally take a
Responder
which
can be used to create aResponseInstruction
to better control how responses
are sent. TheResponseInstruction
can also be converted to
MessageSendInstructions
which can be passed toOnionMessenger
's
send_onion_message
to respond asynchronously (#2907, #2996, #3263). OnionMessenger::process_pending_events_async
was added (#3060).- Blinded paths used for BOLT 12
Offer
/Refund
s are now compact when they
expire relatively soon, making them somewhat smaller (#3011, #3080). ChannelManager::force_close_*
now take a err msg to send to peers (#2889).ChannelDetails::is_public
has been renamed tois_announced
and
ChannelHandshakeConfig::announced_channel
toannounce_for_forwarding
to
address various misconceptions about the purpose of announcement (#3257).BlindedPath
s are now split intoBlindedMessagePath
s and
BlindedPaymentPath
s andadvance_path_by_one
added to each (#3182).BlindedPaymentPath
now includes theBlindedPayInfo
(#3245).- BOLT 12
Offer
/Refund
builders no longer require a description, instead
allowing it to be set on the builder itself (#3018). - The
{Inbound,Outbound}HTLCState{,Details}
andChannelDetails
structs have
moved to theln::channel_state
module (#3089). Event::OpenChannelRequest
now containsparams
andis_announced
(#3019).- Peers are no longer disconnected when we force-close a channel (#3088).
- BOLT12
Offer
andRefund
now implementReadable
(#2965). RecipientOnionFields
is now included inEvent::PaymentClaimed
(#3084).ClosureReason::HolderForceClosed::broadcasted_latest_txn
was added (#3107).EcdsaChannelSigner
no longer needs to beWriteable
and the supertrait
WriteableEcdsaChannelSigner
has been removed (#3059).CustomMessageHandler::peer_{,dis}connected
were added (#3105).lightning_invoice::Description::as_inner()
was added (#3203).- Splice-related wire messages have been updated to the latest spec (#3129).
Bug Fixes
channel_update
messages are no longer extracted from failed payments and
applied to the network graph viaEvent::PaymentPathFailed
, preventing a
node along the path from identifying the sender of a payment (#3083).- In order to prevent senders from identifying the recipient of a BOLT 12 offer
that included a blinded path, cryptographic information from blinded paths
are now included in the invoice request verification (#3085, #3139, #3242). - Routes are now length-limited based on the actual onion contents rather than
a fixed value. This ensures no routes are generated that are unpayable when
sending HTLCs with custom TLVs, blinded paths, or metadata (#3026, #3156). - Unannounced LDK nodes (or ones without a network graph) will now include
unannounced peers as introduction points in blinded paths. This addresses
issues where test networks were not usable for BOLT 12 due to failures to
find paths over private channels to LDK nodes. It will also enable creating
BOLT 12 offers for nodes with no local network graph (#3132). - If a channel partner fails to update the feerate on a channel for some time
and prevailing network feerates increase, LDK will now force-close
automatically to avoid being unable to claim our funds on-chain. In order to
reduce false-positives, it does so by comparing the channel's fee against the
minimumConfirmationTarget::MinAllowed{,Non}AnchorChannelRemoteFee
we've
seen over the past day (and do not force-close if we haven't been running for
a full day, #3037). MonitorUpdatingPersister
did not readChannelMonitorUpdate
s when
archiving aChannelMonitor
, causing the archivedChannelMonitor
to be
missing some updates. Those updates were not removed from theKVStore
and
monitors being archived should have no pending updates as they were persisted
on each new block for some time before archiving (#3276).CoinSelection
s selected for commitment transactions which did not contain a
change output no longer result in broadcasting a non-standard transaction nor
in under-paying the target feerate (#3285). Note that such a transaction
would fail to propagate and LDK would have continued to bump the fee until a
differentCoinSelection
is used which did contain a change output.invoice_error
s from BOLT 12 recipients now fail payments (#3085, #3192).- Fixed a bug which may lead to a missing
Event::ChannelClosed
and missing
Error
messages for peers when a bogus funding transaction is provided for a
batch channel open (#3029). - Fixed an overflow in
RawBolt11Invoice::amount_pico_btc()
reachable via
Bolt11Invoice::amount_milli_satoshis()
, resulting in a debug panic or bogus
value for invoices with invalid values (#3032). - In incredibly rare circumstances, when using the beta asynchronous
persistence, it is possible that the preimage for an MPP claim could fail to
be persisted in theChannelMonitor
for one or more MPP parts, resulting in
only some of the payment's value being claimed (#3120). - A rare race was fixed which could lead to
ChannelMonitorUpdate
s appearing
after a fullChannelMonitor
persistence th...
v0.0.123
v0.0.123 - May 08, 2024 - "BOLT12 Dust Sweeping"
API Updates
- To reduce risk of force-closures and improve HTLC reliability the default
dust exposure limit has been increased to
MaxDustHTLCExposure::FeeRateMultiplier(10_000)
. Users with existing
channels might want to consider using
ChannelManager::update_channel_config
to apply the new default (#3045). ChainMonitor::archive_fully_resolved_channel_monitors
is now provided to
remove from memoryChannelMonitor
s that have been fully resolved on-chain
and are now not needed. It uses the newPersist::archive_persisted_channel
to inform the storage layer that such a monitor should be archived (#2964).- An
OutputSweeper
is now provided which will automatically sweep
SpendableOutputDescriptor
s, retrying until the sweep confirms (#2825). - After initiating an outbound channel, a peer disconnection no longer results
in immediate channel closure. Rather, if the peer is reconnected before the
channel times out LDK will automatically retry opening it (#2725). PaymentPurpose
now has separate variants for BOLT12 payments, which
include fields from theinvoice_request
as well as theOfferId
(#2970).ChannelDetails
now includes a list of in-flight HTLCs (#2442).Event::PaymentForwarded
now includesskimmed_fee_msat
(#2858).- The
hashbrown
dependency has been upgraded and the use ofahash
as the
no-std hash table hash function has been removed. As a consequence, LDK's
Hash{Map,Set}
s no longer feature several constructors when LDK is built
with no-std; see theutil::hash_tables
module instead. On platforms that
getrandom
supports, setting thepossiblyrandom/getrandom
feature flag
will ensure hash tables are resistant to HashDoS attacks, though the
possiblyrandom
crate should detect most common platforms (#2810, #2891). ChannelMonitor
-originated requests to theChannelSigner
can now fail and
be retried usingChannelMonitor::signer_unblocked
(#2816).SpendableOutputDescriptor::to_psbt_input
now includes thewitness_script
where available as well as new proprietary data which can be used to
re-derive some spending keys from the base key (#2761, #3004).OutPoint::to_channel_id
has been removed in favor of
ChannelId::v1_from_funding_outpoint
in preparation for v2 channels with a
differentChannelId
derivation scheme (#2797).PeerManager::get_peer_node_ids
has been replaced withlist_peers
and
peer_by_node_id
, which provide more details (#2905).Bolt11Invoice::get_payee_pub_key
is now provided (#2909).Default[Message]Router
now take anentropy_source
argument (#2847).ClosureReason::HTLCsTimedOut
has been separated out from
ClosureReason::HolderForceClosed
as it is the most common case (#2887).ClosureReason::CooperativeClosure
is now split into
{Counterparty,Locally}Initiated
variants (#2863).Event::ChannelPending::channel_type
is now provided (#2872).PaymentForwarded::{prev,next}_user_channel_id
are now provided (#2924).- Channel init messages have been refactored towards V2 channels (#2871).
BumpTransactionEvent
now contains the channel and counterparty (#2873).util::scid_utils
is now public, with some trivial utilities to examine
short channel ids (#2694).DirectedChannelInfo::{source,target}
are now public (#2870).- Bounds in
lightning-background-processor
were simplified by using
AChannelManager
(#2963). - The
Persist
impl forKVStore
no longer requiresSized
, allowing for
the use ofdyn KVStore
asPersist
(#2883, #2976). From<PaymentPreimage>
is now implemented forPaymentHash
(#2918).NodeId::from_slice
is now provided (#2942).ChannelManager
deserialization may now fail withDangerousValue
when
LDK's persistence API was violated (#2974).
Bug Fixes
- Excess fees on counterparty commitment transactions are now included in the
dust exposure calculation. This lines behavior up with some cases where
transaction fees can be burnt, making them effectively dust exposure (#3045). Future
s used as anstd::...::Future
could grow in size unbounded if it
was never woken. For those not using async persistence and using the async
lightning-background-processor
, this could cause a memory leak in the
ChainMonitor
(#2894).- Inbound channel requests that fail in
ChannelManager::accept_inbound_channel
would previously have stalled from
the peer's perspective as noerror
message was sent (#2953). - Blinded path construction has been tuned to select paths more likely to
succeed, improving BOLT12 payment reliability (#2911, #2912). - After a reorg,
lightning-transaction-sync
could have failed to follow a
transaction that LDK needed information about (#2946). RecipientOnionFields
'custom_tlvs
are now propagated to recipients when
paying with blinded paths (#2975).Event::ChannelClosed
is now properly generated and peers are properly
notified for all channels that as a part of a batch channel open fail to be
funded (#3029).- In cases where user event processing is substantially delayed such that we
complete multiple round-trips with our peers before aPaymentSent
event is
handled and then restart without persisting theChannelManager
after having
persisted aChannelMonitor[Update]
, on startup we may haveErr
d trying to
deserialize theChannelManager
(#3021). - If a peer has relatively high latency,
PeerManager
may have failed to
establish a connection (#2993). ChannelUpdate
messages broadcasted for our own channel closures are now
slightly more robust (#2731).- Deserializing malformed BOLT11 invoices may have resulted in an integer
overflow panic in debug builds (#3032). - In exceedingly rare cases (no cases of this are known), LDK may have created
an invalid serialization for aChannelManager
(#2998). - Message processing latency handling BOLT12 payments has been reduced (#2881).
- Latency in processing
Event::SpendableOutputs
may be reduced (#3033).
Node Compatibility
- LDK's blinded paths were inconsistent with other implementations in several
ways, which have been addressed (#2856, #2936, #2945). - LDK's messaging blinded paths now support the latest features which some
nodes may begin relying on soon (#2961). - LDK's BOLT12 structs have been updated to support some last-minute changes to
the spec (#3017, #3018). - CLN v24.02 requires the
gossip_queries
feature for all peers, however LDK
by default does not set it for those not using aP2PGossipSync
(e.g. those
using RGS). This change was reverted in CLN v24.02.2 however for now LDK
always sets thegossip_queries
feature. This change is expected to be
reverted in a future LDK release (#2959).
Security
0.0.123 fixes a denial-of-service vulnerability which we believe to be reachable
from untrusted input when parsing invalid BOLT11 invoices containing non-ASCII
characters.
- BOLT11 invoices with non-ASCII characters in the human-readable-part may
cause an out-of-bounds read attempt leading to a panic (#3054). Note that all
BOLT11 invoices containing non-ASCII characters are invalid.
In total, this release features 150 files changed, 19307 insertions, 6306
deletions in 360 commits since 0.0.121 from 17 authors, in alphabetical order:
- Arik Sosman
- Duncan Dean
- Elias Rohrer
- Evan Feenstra
- Jeffrey Czyz
- Keyue Bao
- Matt Corallo
- Orbital
- Sergi Delgado Segura
- Valentine Wallace
- Willem Van Lint
- Wilmer Paulino
- benthecarman
- jbesraa
- olegkubrakov
- optout
- shaavan
v0.0.122
0.0.122 - Apr 09, 2024 - "That Which Is Untested Is Broken"
Bug Fixes
Route
objects did not successfully round-trip through de/serialization
since LDK 0.0.117, which has now been fixed (#2897).- Correct deserialization of unknown future enum variants. This ensures
downgrades from future versions of LDK do not result in read failures or
corrupt reads in cases where enums are written (#2969). - When hitting lnd bug 6039, our workaround previously resulted in
ChannelManager
persistences on every round-trip with our peer. These
useless persistences are now skipped (#2937).
In total, this release features 4 files changed, 99 insertions, 55
deletions in 6 commits from 1 author, in alphabetical order:
- Matt Corallo
v0.0.121
0.0.121 - Jan 22, 2024 - "Unwraps are Bad"
Bug Fixes
- Fix a deadlock when calling
batch_funding_transaction_generated
with
invalid input (#2841).
Security
0.0.121 fixes a denial-of-service vulnerability which is reachable from
untrusted input from peers in rare cases if we have a public channel or in
common cases if P2PGossipSync
is used.
- A peer that failed to complete its handshake would cause a reachable
unwrap
in LDK since 0.0.119 when LDK attempts to broadcast gossip to all
peers (#2842).
In total, this release features 4 files changed, 52 insertions, 10
deletions in 4 commits from 2 authors, in alphabetical order:
- Jeffrey Czyz
- Matt Corallo
v0.0.120
v0.0.120 - Jan 17, 2024 - "Unblinded Fuzzers"
API Updates
- The
PeerManager
bound onUtxoLookup
was removed entirely. This enables
use ofUtxoLookup
in cases broken in 0.0.119 by #2773 (#2822). - LDK now exposes and fully implements the route blinding feature (#2812).
- The
lightning-transaction-sync
crate no longer relies on system time
without thetime
feature (#2799, #2817). lightning::onion_message
's module layout has changed (#2821).Event::ChannelClosed
now includes thechannel_funding_txo
(#2800).CandidateRouteHop
variants were destructured into individual structs,
hiding some fields which were not generally consumable (#2802).
Bug Fixes
- Fixed a rare issue where
lightning-net-tokio
may not fully flush its send
buffer, leading to connection hangs (#2832). - Fixed a panic which may occur when connecting to a peer if we opened a second
channel with that peer while they were disconnected (#2808). - Retries for a payment which previously failed in a blinded path will now
always use an alternative blinded path (#2818). Feature
'sEq
andHash
implementation now ignore dummy bytes (#2808).- Some missing
DiscardFunding
orChannelClosed
events are now generated in
rare funding-related failures (#2809). - Fixed a privacy issue in blinded path generation where the real
cltv_expiry_delta
would be exposed to senders (#2831).
Security
0.0.120 fixes a denial-of-service vulnerability which is reachable from
untrusted input from peers if the UserConfig::manually_accept_inbound_channels
option is enabled.
- A peer that sent an
open_channel
message with thechannel_type
field
unfilled would trigger a reachableunwrap
since LDK 0.0.117 (#2808). - In protocols where a funding output is shared with our counterparty before
it is given to LDK, a malicious peer could have caused a reachable panic
by reusing the same funding info in (#2809).
In total, this release features 67 files changed, 3016 insertions, 2473
deletions in 79 commits from 9 authors, in alphabetical order:
- Elias Rohrer
- Jeffrey Czyz
- José A.P
- Matt Corallo
- Tibo-lg
- Valentine Wallace
- benthecarman
- optout
- shuoer86
v0.0.119
v0.0.119 - Dec 15, 2023 - "Spring Cleaning for Christmas"
API Updates
- The LDK crate ecosystem MSRV has been increased to 1.63 (#2681).
- The
bitcoin
dependency has been updated to version 0.30 (#2740). lightning-invoice::payment::*
have been replaced with parameter generation
viapayment_parameters_from[_zero_amount]_invoice
(#2727).{CoinSelection,Wallet}Source::sign_tx
are nowsign_psbt
, providing more
information, incl spent outputs, about the transaction being signed (#2775).- Logger
Record
s now includechannel_id
andpeer_id
fields. These are
opportunistically filled in when a log record is specific to a given channel
and/or peer, and may occasionally be spuriously empty (#2314). - When handling send or reply onion messages (e.g. for BOLT12 payments), a new
Event::ConnectionNeeded
may be raised, indicating a direct connection
should be made to a payee or an introduction point. This event is expected to
be removed once onion message forwarding is widespread in the network (#2723) - Scoring data decay now happens via
ScoreUpDate::time_passed
, called from
lightning-background-processor
.process_events_async
now takes a new
time-fetch function, andScoreUpDate
methods now take the current time as a
Duration
argument. This avoids fetching time during pathfinding (#2656). - Receiving payments to multi-hop blinded paths is now supported (#2688).
MessageRouter
andRouter
now feature methods to generate blinded paths to
the local node for incoming messages and payments.Router
now extends
MessageRouter
, and both are used inChannelManager
when processing or
creating BOLT12 structures to generate multi-hop blinded paths (#1781).lightning-transaction-sync
now supports Electrum-based sync (#2685).Confirm::get_relevant_txids
now returns the height at which a transaction
was confirmed. This can be used to assist in reorg detection (#2685).ConfirmationTarget::MaxAllowedNonAnchorChannelRemoteFee
has been removed.
Non-anchor channel feerates are bounded indirectly through
ChannelConfig::max_dust_htlc_exposure
(#2696).lightning-invoice
Description
s now rely onUntrustedString
for
sanitization (#2730).ScoreLookUp::channel_penalty_msat
now usesCandidateRouteHop
(#2551).- The
EcdsaChannelSigner
trait was moved tolightning::sign::ecdsa
(#2512). SignerProvider::get_destination_script
now takeschannel_keys_id
(#2744)SpendableOutputDescriptor::StaticOutput
now haschannel_keys_id
(#2749).EcdsaChannelSigner::sign_counterparty_commitment
now takes HTLC preimages
for both inbound and outbound HTLCs (#2753).ClaimedHTLC
now includes acounterparty_skimmed_fee_msat
field (#2715).peel_payment_onion
was added to decode an encrypted onion for a payment
without receiving an HTLC. This allows for stateless verification of if a
theoretical payment would be accepted prior to receipt (#2700).create_payment_onion
was added to construct an encrypted onion for a
payment path without sending an HTLC immediately (#2677).- Various keys used in channels are now wrapped to provide type-safety for
specific usages of the keys (#2675). TaggedHash
now includes the rawtag
andmerkle_root
(#2687).Offer::is_expired_no_std
was added (#2689).PaymentPurpose::preimage()
was added (#2768).temporary_channel_id
can now be specified increate_channel
(#2699).- Wire definitions for splicing messages were added (#2544).
- Various
lightning-invoice
structs now implDisplay
, now have pub fields,
or implFrom
(#2730). - The
Hash
trait is now implemented for more structs, incl P2P msgs (#2716).
Performance Improvements
- Memory allocations (though not memory usage) have been substantially reduced,
meaning less overhead and hopefully less memory fragmentation (#2708, #2779).
Bug Fixes
- Since 0.0.117, calling
close_channel*
on a channel which has not yet been
funded would previously result in an infinite loop and hang (#2760). - Since 0.0.116, sending payments requiring data in the onion for the recipient
which was too large for the onion may have caused corruption which resulted
in payment failure (#2752). - Cooperative channel closure on channels with remaining output HTLCs may have
spuriously force-closed (#2529). - In LDK versions 0.0.116 through 0.0.118, in rare cases where skimmed fees are
present on shutdown theChannelManager
may fail to deserialize (#2735). ChannelConfig::max_dust_exposure
values which, converted to absolute fees,
exceeded 2^63 - 1 would result in an overflow and could lead to spurious
payment failures or channel closures (#2722).- In cases where LDK is operating with provably-stale state, it panics to
avoid funds loss. This may not have happened in cases where LDK was behind
only exactly one state, leading instead to a revoked broadcast and funds
loss (#2721). - Fixed a bug where decoding
Txid
s from Bitcoin Core JSON-RPC responses using
lightning-block-sync
would not properly byte-swap the hash. Note that LDK
does not use this API internally (#2796).
Backwards Compatibility
ChannelManager
s written with LDK 0.0.119 are no longer readable by versions
of LDK prior to 0.0.113. Users wishing to downgrade to LDK 0.0.112 or before
can read an 0.0.119-serializedChannelManager
with a version of LDK from
0.0.113 to 0.0.118, re-serialize it, and then downgrade (#2708).- Nodes that upgrade to 0.0.119 and subsequently downgrade after receiving a
payment to a blinded path may leak recipient information if one or more of
those HTLCs later fails (#2688). - Similarly, forwarding a blinded HTLC and subsequently downgrading to an LDK
version prior to 0.0.119 may result in leaking the path information to the
payment sender (#2540).
In total, this release features 148 files changed, 13780 insertions, 6279
deletions in 280 commits from 22 authors, in alphabetical order:
- Arik Sosman
- Chris Waterson
- Elias Rohrer
- Evan Feenstra
- Gursharan Singh
- Jeffrey Czyz
- John Cantrell
- Lalitmohansharma1
- Matt Corallo
- Matthew Rheaume
- Orbital
- Rachel Malonson
- Valentine Wallace
- Willem Van Lint
- Wilmer Paulino
- alexanderwiederin
- benthecarman
- henghonglee
- jbesraa
- olegkubrakov
- optout
- shaavan