Release notes from rust-lightning

v0.0.110: 0.0.110 - 2022-07-26

2022-07-26T23:41:43Z

API Updates

ChannelManager::send_probe and Score::probe_{failed,successful} have
been added to make probing more explicit, as well as new
Event::Probe{Failed,Successful} events (lightningdevkit#1567).
ProbabilisticScoringParameters::banned_nodes has been renamed
manual_node_penalties and changed to take msat penalties (lightningdevkit#1592).
Per-payment tracking of failed paths was added to enable configuration of
ProbabilisticScoringParameters::considered_impossible_penalty_msat (lightningdevkit#1600)
ProbabilisticScoringParameters::base_penalty_amount_multiplier_msat was
added to allow a penalty that is only amount-dependent (lightningdevkit#1617).
ProbabilisticScoringParameters::amount_penalty_multiplier_msat was renamed
liquidity_penalty_amount_multiplier_msat (lightningdevkit#1617).
A new Event::HTLCHandlingFailed has been added which provides visibility
into failures to forward/claim accepted HTLCs (lightningdevkit#1403).
Support has been added for DNS hostnames in the NetAddress type, see
BOLT PR #911 (lightningdevkit#1553).
GossipSync now has rapid, p2p, and none constructors (lightningdevkit#1618).
lightning-net-tokio no longer requires types to be in Arcs (lightningdevkit#1623).
The htlc_maximum_msat field is now required in ChannelUpdate gossip
messages. In tests this rejects < 1% of channels (lightningdevkit#1519).
ReadOnlyNetworkGraph::{channel,node} have been added to query for
individual channel/node data, primarily for bindings users (lightningdevkit#1543).
FeeEstimator implementations are now wrapped internally to ensure values
below 253 sats/kW are never used (lightningdevkit#1552).
Route selection no longer attempts to randomize path selection. This is
unlikely to lead to a material change in the paths selected (lightningdevkit#1610).

Bug Fixes

Fixed a panic when deserializing ChannelDetails objects (lightningdevkit#1588).
When routing, channels are no longer fully saturated before MPP splits are
generated, instead a configuration knob was added as
PaymentParameters::max_channel_saturation_power_of_half (lightningdevkit#1605).
Fixed a panic which occurred in ProbabilisticScorer when wallclock time
goes backwards across a restart (lightningdevkit#1603).

Serialization Compatibility

All new fields are ignored by prior versions of LDK. All new fields are not
present when reading objects serialized by prior versions of LDK.
Channel information written in the NetworkGraph which is missing
htlc_maximum_msat may be dropped on deserialization (lightningdevkit#1519).
Similarly, node information written in the NetworkGraph which contains an
invalid hostname may be dropped on deserialization (lightningdevkit#1519).

In total, this release features 79 files changed, 2935 insertions, 1363
deletions in 52 commits from 9 authors, in alphabetical order:

Duncan Dean
Elias Rohrer
Jeffrey Czyz
Matt Corallo
Max Fang
Viktor Tigerström
Willem Van Lint
Wilmer Paulino
jurvis

v0.0.109: 0.0.109 - 2022-07-01

2022-07-01T17:38:08Z

API Updates

ChannelManager::update_channel_config has been added to allow the fields
in ChannelConfig to be changed in a given channel after open (lightningdevkit#1527).
If we reconnect to a peer which proves we have a stale channel state, rather
than force-closing we will instead panic to provide an opportunity to switch
to the latest state and continue operating without channel loss (lightningdevkit#1564).
A NodeAlias struct has been added which handles string sanitization for
node aliases via the Display trait (lightningdevkit#1544).
ProbabilisticScoringParameters now has a banned_nodes set which we will
never route through during path finding (lightningdevkit#1550).
ProbabilisticScoringParameters now offers an anti_probing_penalty_msat
option to prefer channels which afford better privacy when routing (lightningdevkit#1555).
ProbabilisticScorer now provides access to its estimated liquidity range
for a given channel via estimated_channel_liquidity_range (lightningdevkit#1549).
Options which cannot be changed at runtime have been moved from
ChannelConfig to ChannelHandshakeConfig (lightningdevkit#1529).
find_route takes &NetworkGraph instead of `ReadOnlyNetworkGraph (lightningdevkit#1583).
ChannelDetails now contains a copy of the current ChannelConfig (lightningdevkit#1527).
The lightning-invoice crate now optionally depends on serde, with
Invoice implementing serde::{Deserialize,Serialize} if enabled (lightningdevkit#1548).
Several fields in UserConfig have been renamed for clarity (lightningdevkit#1540).

Bug Fixes

find_route no longer selects routes with more than
PaymentParameters::max_mpp_path_count paths, and
ChannelManager::send_payment no longer refuses to send along routes with
more than ten paths (lightningdevkit#1526).
Fixed two cases where HTLCs pending at the time a counterparty broadcasts a
revoked commitment transaction are considered resolved prior to their actual
resolution on-chain, possibly passing the update to another channel (lightningdevkit#1486).
HTLCs which are relayed through LDK may now have a total expiry time two
weeks in the future, up from one, reducing forwarding failures (lightningdevkit#1532).

Serialization Compatibility

All new fields are ignored by prior versions of LDK. All new fields are not
present when reading objects serialized by prior versions of LDK.
ChannelConfig's serialization format has changed and is not compatible
with any previous version of LDK. Attempts to read values written by a
previous version of LDK will fail and attempts to read newly written objects
using a previous version of LDK will fail. It is not expected that users are
serializing ChannelConfig using the LDK serialization API, however, if a
backward compatibility wrapper is required, please open an issue.

Security

0.0.109 fixes a denial-of-service vulnerability which is reachable from
untrusted input in some application deployments.

Third parties which are allowed to open channels with an LDK-based node may
fund a channel with a bogus and maliciously-crafted transaction which, when
spent, can cause a panic in the channel's corresponding ChannelMonitor.
Such a channel is never usable as it cannot be funded with a funding
transaction which matches the required output script, allowing the
ChannelMonitor for such channels to be safely purged as a workaround on
previous versions of LDK. Thanks to Eugene Siegel for reporting this issue.

In total, this release features 32 files changed, 1948 insertions, 532
deletions in 33 commits from 9 authors, in alphabetical order:

Antoine Riard
Daniel Granhão
Elias Rohrer
Jeffrey Czyz
Matt Corallo
Matt Faltyn
NicolaLS
Valentine Wallace
Wilmer Paulino

v0.0.108

2022-06-10T16:46:33Z

Bug Fixes

Fixed lightning-background-processor build in release mode.

In total, this release features 9 files changed, 120 insertions, 74
deletions in 5 commits from 4 authors, in alphabetical order:

Elias Rohrer
Matt Corallo
Max Fang
Viktor Tigerström

v0.0.107: 0.0.107 - 2022-06-08

2022-06-08T23:46:01Z

API Updates

Channels larger than 16777215 sats (Wumbo!) are now supported and can be
enabled for inbound channels using
ChannelHandshakeLimits::max_funding_satoshis (lightningdevkit#1425).
Support for feature option_zeroconf, allowing immediate forwarding of
payments after channel opening. This is configured for outbound channels
using ChannelHandshakeLimits::trust_own_funding_0conf whereas
ChannelManager::accept_inbound_channel_from_trusted_peer_0conf has to be
used for accepting inbound channels (lightningdevkit#1401, lightningdevkit#1505).
ChannelManager::claim_funds no longer returns a bool to indicate success.
Instead, an Event::PaymentClaimed is generated if the claim was successful.
Likewise, ChannelManager::fail_htlc_backwards no longer has a return value
(lightningdevkit#1434).
lightning-rapid-gossip-sync is a new crate for syncing gossip data from a
server, primarily aimed at mobile devices (lightningdevkit#1155).
RapidGossipSync can be passed to BackgroundProcessor in order to persist
the NetworkGraph and handle NetworkUpdates during event handling (lightningdevkit#1433,
lightningdevkit#1517).
NetGraphMsgHandler has been renamed to P2PGossipSync, the network_graph
module has been renamed to gossip, and NetworkUpdate::ChannelClosed has
been renamed NetworkUpdate::ChannelFailure (lightningdevkit#1159).
Added a filtered_block_connected method to chain::Listen and a default
implementation of block_connected for those fetching filtered instead of
full blocks (lightningdevkit#1453).
The lightning-block-sync crate's BlockSource trait methods now take
&self instead of &mut self (lightningdevkit#1307).
inbound_payment module is now public to allow for creating invoices without
a ChannelManager (lightningdevkit#1384).
lightning-block-sync's init and poll modules support &dyn BlockSource
which can be determined at runtime (lightningdevkit#1423).
lightning-invoice crate's utils now accept an expiration time (lightningdevkit#1422,
lightningdevkit#1474).
Event::PaymentForwarded includes prev_channel_id and next_channel_id
(lightningdevkit#1419, lightningdevkit#1475).
chain::Watch::release_pending_monitor_events' return type now associates
MonitorEvents with funding OutPoints (lightningdevkit#1475).
lightning-background-processor crate's Persister trait has been moved to
lightning crate's util::persist module, which now has a general
KVStorePersister trait. Blanket implementations of Persister and
chainmonitor::Persist are given for types implementing KVStorePersister.
lightning-persister's FilesystemPersister implements KVStorePersister
(lightningdevkit#1417).
ChannelDetails and ChannelCounterparty include fields for HTLC minimum
and maximum values (lightningdevkit#1378).
Added a max_inbound_htlc_value_in_flight_percent_of_channel field to
ChannelHandshakeConfig, capping the total value of outstanding inbound
HTLCs for a channel (lightningdevkit#1444).
ProbabilisticScorer is parameterized by a Logger, which it uses to log
channel liquidity updates or lack thereof (lightningdevkit#1405).
ChannelDetails has an outbound_htlc_limit_msat field, which should be
used in routing instead of outbound_capacity_msat (lightningdevkit#1435).
ProbabilisticScorer's channel liquidities can be logged via
debug_log_liquidity_stats (lightningdevkit#1460).
BackgroundProcessor now takes an optional WriteableScore which it will
persist using the Persister trait's new persist_scorer method (lightningdevkit#1416).
Upgraded to bitcoin crate version 0.28.1 (lightningdevkit#1389).
ShutdownScript::new_witness_program now takes a WitnessVersion instead of
a NonZeroU8 (lightningdevkit#1389).
Channels will no longer be automatically force closed when the counterparty
is disconnected due to incompatibility (lightningdevkit#1429).
ChannelManager methods for funding, accepting, and closing channels now
take a counterparty_node_id parameter, which has also been added as a field
to Event::FundingGenerationReady (lightningdevkit#1479, lightningdevkit#1485).
InvoicePayer::new now takes a Retry enum (replacing the RetryAttempts
struct), which supports both attempt- and timeout-based retrying (lightningdevkit#1418).
Score::channel_penalty_msat takes a ChannelUsage struct, which contains
the capacity as an EffectiveCapacity enum and any potential in-flight HTLC
value, rather than a single u64. Used by ProbabilisticScorer for more
accurate penalties (lightningdevkit#1456).
build_route_from_hops is a new function useful for constructing a Route
given a specific list of public keys (lightningdevkit#1491).
FundingLocked message has been renamed ChannelReady, and related
identifiers have been renamed accordingly (lightningdevkit#1506).
core2::io or std::io (depending on feature flags no-std or std) is
exported as a lightning::io module (lightningdevkit#1504).
The deprecated Scorer has been removed in favor or ProbabilisticScorer
(lightningdevkit#1512).

Performance Improvements

lightning-persister crate's FilesystemPersister is faster by 15x (lightningdevkit#1404).
Log gossip query messages at GOSSIP instead of TRACE to avoid
overwhelming default logging (lightningdevkit#1421).
PeerManager supports processing messages from different peers in parallel,
and this is taken advantage of in gossip processing (lightningdevkit#1023).
Greatly reduced per-channel and per-node memory usage due to upgrade of
secp256k1 crate to 0.22.1 and bitcoin crate to 0.28.1
Reduced per-peer memory usage in PeerManager (lightningdevkit#1472).

Spec Compliance

find_route now assumes variable-length onions by default for nodes where
support for the feature is unknown (lightningdevkit#1414).
A warn message is now sent when receiving a channel_reestablish with an
old commitment transaction number rather than immediately force-closing the
channel (lightningdevkit#1430).
When a channel_update message is included in an onion error's failuremsg,
its message type is now encoded. Reading such messages is also supported
(lightningdevkit#1465).

Bug Fixes

Fixed a bug where crashing while persisting a ChannelMonitorUpdate for a
part of a multi-path payment could cause loss of funds due to a partial
payment claim on restart (lightningdevkit#1434).
BackgroundProcessor has been fixed to improve serialization reliability on
slow systems which can avoid force-closes (lightningdevkit#1436).
gossip_timestamp_filter filters are now honored when sending gossip to
peers (lightningdevkit#1452).
During a reorg, only force-close a channel if its funding transaction is
unconfirmed rather than as it loses confirmations (lightningdevkit#1461).
Fixed a rare panic in lightning-net-tokio when fetching a peer's socket
address after the connection has been closed caused by a race condition
(lightningdevkit#1449).
find_route will no longer return routes that would cause onion construction
to fail in some cases (lightningdevkit#1476).
ProbabilisticScorer uses more precision when approximating log10 (lightningdevkit#1406).

Serialization Compatibility

All above new events/fields are ignored by prior clients. All above new
events/fields are not present when reading objects serialized by prior
versions of the library.
ChannelManager serialization is no longer compatible with versions prior to
0.0.99 (lightningdevkit#1401).
Channels with option_zeroconf feature enabled (not required for 0-conf
channel use) will be unreadable by versions prior to 0.0.107 (lightningdevkit#1401, lightningdevkit#1505).

In total, this release features 96 files changed, 9304 insertions, 4503
deletions in 153 commits from 18 authors, in alphabetical order:

Arik Sosman
Devrandom
Duncan Dean
Elias Rohrer
Jeffrey Czyz
John Cantrell
John Corser
Jurvis Tan
Justin Moon
KaFai Choi
Mateusz Faltyn
Matt Corallo
Valentine Wallace
Viktor Tigerström
Vincenzo Palazzo
atalw
dependabot[bot]
shamardy

v0.0.106

2022-04-03T16:33:23Z

API Updates

Minimum supported rust version (MSRV) is now 1.41.1 (lightningdevkit#1310).
Lightning feature option_scid_alias is now supported and may be negotiated
when opening a channel with a peer. It can be configured via
ChannelHandshakeConfig::negotiate_scid_privacy and is off by default but
will be on by default in the future (lightningdevkit#1351).
OpenChannelRequest now has a channel_type field indicating the features
the channel will operate with and should be used to filter channels with
undesirable features (lightningdevkit#1351). See the Serialization Compatibility section.
ChannelManager supports sending and receiving short channel id aliases in
the funding_locked message. These are used when forwarding payments and
constructing invoice route hints for improved privacy. ChannelDetails has a
inbound_scid_alias field and a get_inbound_payment_scid method to support
the latter (lightningdevkit#1311).
DefaultRouter and find_route take an additional random seed to improve
privacy by adding a random CLTV expiry offset to each path's final hop. This
helps obscure the intended recipient from adversarial intermediate hops
(lightningdevkit#1286). The seed is also used to randomize candidate paths during route
selection (lightningdevkit#1359).
The lightning-block-sync crate's init::synchronize_listeners method
interface has been relaxed to support multithreaded environments (lightningdevkit#1349).
ChannelManager::create_inbound_payment_for_hash's documentation has been
corrected to remove the one-year restriction on invoice_expiry_delta_secs,
which is only applicable to the deprecated create_inbound_payment_legacy
and create_inbound_payment_for_hash_legacy methods (lightningdevkit#1341).
Features mutator methods now take self by reference instead of by value
(lightningdevkit#1331).
The CLTV of the last hop in a path is now included when comparing against
RouteParameters::max_total_cltv_expiry_delta (lightningdevkit#1358).
Invoice creation functions in lightning-invoice crate's utils module
include versions that accept a description hash instead of only a description
(lightningdevkit#1361).
RoutingMessageHandler::sync_routing_table has been renamed peer_connected
(lightningdevkit#1368).
MessageSendEvent::SendGossipTimestampFilter has been added to indicate that
a gossip_timestamp_filter should be sent (lightningdevkit#1368).
PeerManager takes an optional NetAddress in new_outbound_connection and
new_inbound_connection, which is used to report back the remote address to
the connecting peer in the init message (lightningdevkit#1326).
ChannelManager::accept_inbound_channel now takes a user_channel_id, which
is used in a similar manner as in outbound channels. (lightningdevkit#1381).
BackgroundProcessor now persists NetworkGraph on a timer and upon
shutdown as part of a new Persister trait, which also includes
ChannelManager persistence (lightningdevkit#1376).
ProbabilisticScoringParameters now has a base_penalty_msat option, which
default to 500 msats. It is applied at each hop to help avoid longer paths
(lightningdevkit#1375).
ProbabilisticScoringParameters::liquidity_penalty_multiplier_msat's default
value is now 40,000 msats instead of 10,000 msats (lightningdevkit#1375).
The lightning crate has a grind_signatures feature used to produce
signatures with low r-values for more predictable transaction weight. This
feature is on by default (lightningdevkit#1388).
ProbabilisticScoringParameters now has a amount_penalty_multiplier_msat
option, which is used to further penalize large amounts (lightningdevkit#1399).
PhantomRouteHints, FixedPenaltyScorer, and ScoringParameters now
implement Clone (lightningdevkit#1346).

Bug Fixes

Fixed a compilation error in ProbabilisticScorer under --feature=no-std
(lightningdevkit#1347).
Invoice creation functions in lightning-invoice crate's utils module
filter invoice hints in order to limit the invoice size (lightningdevkit#1325).
Fixed a bug where a funding_locked message was delayed by a block if the
funding transaction was confirmed while offline, depending on the ordering
of Confirm::transactions_confirmed calls when brought back online (lightningdevkit#1363).
Fixed a bug in NetGraphMsgHandler where it didn't continue to receive
gossip messages from peers after initial connection (lightningdevkit#1368, lightningdevkit#1382).
ChannelManager::timer_tick_occurred will now timeout a received multi-path
payment (MPP) after three ticks if not received in full instead of waiting
until near the HTLC timeout block(lightningdevkit#1353).
Fixed an issue with find_route causing it to be overly aggressive in using
MPP over channels to the same first hop (lightningdevkit#1370).
Reduced time spent processing channel_update messages by checking
signatures after checking if no newer messages have already been processed
(lightningdevkit#1380).
Fixed a few issues in find_route which caused preferring paths with a
higher cost (lightningdevkit#1398).
Fixed an issue in ProbabilisticScorer where a channel with not enough
liquidity could still be used when retrying a failed payment if it was on a
path with an overall lower cost (lightningdevkit#1399).

Serialization Compatibility

Channels open with option_scid_alias negotiated will be incompatible with
prior releases (lightningdevkit#1351). This may occur in the following cases:
- Outbound channels when ChannelHandshakeConfig::negotiate_scid_privacy is
  enabled.
- Inbound channels when automatically accepted from an OpenChannel message
  with a channel_type that has ChannelTypeFeatures::supports_scid_privacy
  return true. See UserConfig::accept_inbound_channels.
- Inbound channels when manually accepted from an OpenChannelRequest with a
  channel_type that has ChannelTypeFeatures::supports_scid_privacy return
  true. See UserConfig::manually_accept_inbound_channels.

In total, this release features 43 files changed, 4052 insertions, 1274
deletions in 75 commits from 11 authors, in alphabetical order:

Devrandom
Duncan Dean
Elias Rohrer
Jeffrey Czyz
Jurvis Tan
Luiz Parreira
Matt Corallo
Omar Shamardy
Viktor Tigerström
dependabot[bot]
psycho-pirate

v0.0.105

2022-03-01T04:14:58Z

Phantom node payments are now supported, allowing receipt of a payment on
any one of multiple nodes without any coordination across the nodes being
required. See the new PhantomKeysManager's docs for more, as well as
requirements on KeysInterface::get_inbound_payment_key_material and
lightning_invoice::utils::create_phantom_invoice (lightningdevkit#1199).
In order to support phantom node payments, several KeysInterface methods
now accept a Recipient parameter to select between the local node_id and
a phantom-specific one.
ProbabilisticScorer, a Score based on learning the current balances of
channels in the network, was added. It attempts to better capture payment
success probability than the existing Scorer, though may underperform on
nodes with low payment volume. We welcome feedback on performance (lightningdevkit#1227).
Score::channel_penalty_msat now always takes the channel value, instead of
an Option (lightningdevkit#1227).
UserConfig::manually_accept_inbound_channels was added which, when set,
generates a new Event::OpenChannelRequest, which allows manual acceptance
or rejection of incoming channels on a per-channel basis (lightningdevkit#1281).
Payee has been renamed to PaymentParameters (lightningdevkit#1271).
PaymentParameters now has a max_total_cltv_expiry_delta field. This
defaults to 1008 and limits the maximum amount of time an HTLC can be pending
before it will either fail or be claimed (lightningdevkit#1234).
The lightning-invoice crate now supports no-std environments. This required
numerous API changes around timestamp handling and std+no-std versions of
several methods that previously assumed knowledge of the time (lightningdevkit#1223, lightningdevkit#1230).
lightning-invoice now supports parsing invoices with expiry times of more
than one year. This required changing the semantics of ExpiryTime (lightningdevkit#1273).
The CounterpartyCommitmentSecrets is now public, allowing external uses of
the BOLT 3 secret storage scheme (lightningdevkit#1299).
Several Sign methods now receive HTLC preimages as proof of state
transition, see new documentation for more (lightningdevkit#1251).
KeysInterface::sign_invoice now provides the HRP and other invoice data
separately to make it simpler for external signers to parse (lightningdevkit#1272).
Sign::sign_channel_announcement now returns both the node's signature and
the per-channel signature. InMemorySigner now requires the node's secret
key in order to implement this (lightningdevkit#1179).
ChannelManager deserialization will now fail if the KeysInterface used
has a different node_id than the ChannelManager expects (lightningdevkit#1250).
A new ErrorAction variant was added to send warning messages (lightningdevkit#1013).
Several references to chain::Listen objects in lightning-block-sync no
longer require a mutable reference (lightningdevkit#1304).
Fixed a regression introduced in 0.0.104 where ChannelManager's internal
locks could have an order violation leading to a deadlock (lightningdevkit#1238).
Fixed cases where slow code (including user I/O) could cause us to
disconnect peers with ping timeouts in BackgroundProcessor (lightningdevkit#1269).
Now persist the ChannelManager prior to BackgroundProcessor stopping,
preventing race conditions where channels are closed on startup even with a
clean shutdown. This requires that users stop network processing and
disconnect peers prior to BackgroundProcessor shutdown (lightningdevkit#1253).
Fields in ChannelHandshakeLimits provided via the override_config to
create_channel are now applied instead of the default config (lightningdevkit#1292).
Fixed the generation of documentation on docs.rs to include API surfaces
which are hidden behind feature flags (lightningdevkit#1303).
Added the channel_type field to accept_channel messages we send, which
may avoid some future compatibility issues with other nodes (lightningdevkit#1314).
Fixed a bug where, if a previous LDK run using lightning-persister crashed
while persisting updated data, we may have failed to initialize (lightningdevkit#1332).
Fixed a rare bug where having both pending inbound and outbound HTLCs on a
just-opened inbound channel could cause ChannelDetails::balance_msat to
underflow and be reported as large, or cause panics in debug mode (lightningdevkit#1268).
Moved more instances of verbose gossip logging from the Trace level to the
Gossip level (lightningdevkit#1220).
Delayed announcement_signatures until the channel has six confirmations,
slightly improving propagation of channel announcements (lightningdevkit#1179).
Several fixes in script and transaction weight calculations when anchor
outputs are enabled (lightningdevkit#1229).
Using ChannelManager data written by versions prior to 0.0.105 will result
in preimages for HTLCs that were pending at startup to be missing in calls
to KeysInterface methods (lightningdevkit#1251).
Any phantom invoice payments received on a node that is not upgraded to
0.0.105 will fail with an "unknown channel" error. Further, downgrading to
0.0.104 or before and then upgrading again will invalidate existing phantom
SCIDs which may be included in invoices (lightningdevkit#1199).

0.0.105 fixes two denial-of-service vulnerabilities which may be reachable from
untrusted input in certain application designs.

Route calculation spuriously panics when a routing decision is made for a
path where the second-to-last hop is a private channel, included due to a
multi-hop route hint in an invoice.
ChannelMonitor::get_claimable_balances spuriously panics in some scenarios
when the LDK application's local commitment transaction is confirmed while
HTLCs are still pending resolution.

In total, this release features 109 files changed, 7270 insertions, 2131
deletions in 108 commits from 15 authors, in alphabetical order:

Conor Okus
Devrandom
Elias Rohrer
Jeffrey Czyz
Jurvis Tan
Ken Sedgwick
Matt Corallo
Naveen
Tibo-lg
Valentine Wallace
Viktor Tigerström
dependabot[bot]
hackerrdave
naveen
vss96

v0.0.104

2021-12-17T23:34:13Z

API Updates

A PaymentFailed event is now provided to indicate a payment has failed
fully. This event is generated either after
ChannelManager::abandon_payment is called for a given payment, or the
payment times out, and there are no further pending HTLCs for the payment.
This event should be used to detect payment failure instead of
PaymentPathFailed::all_paths_failed, unless no payment retries occur via
ChannelManager::retry_payment (lightningdevkit#1202).
Payment secrets are now generated deterministically using material from
the new KeysInterface::get_inbound_payment_key_material (lightningdevkit#1177).
A PaymentPathSuccessful event has been added to ease passing success info
to a scorer, along with a Score::payment_path_successful method to accept
such info (lightningdevkit#1178, lightningdevkit#1197).
Score::channel_penalty_msat has additional arguments describing the
channel's capacity and the HTLC amount being sent over the channel (lightningdevkit#1166).
A new log level Gossip has been added, which is used for verbose
information generated during network graph sync. Enabling the
max_level_trace feature or ignoring Gossip log entries reduces log
growth during initial start up from many GiB to several MiB (lightningdevkit#1145).
The allow_wallclock_use feature has been removed in favor of only using
the std and no-std features (lightningdevkit#1212).
NetworkGraph can now remove channels that we haven't heard updates for in
two weeks with NetworkGraph::remove_stale_channels{,with_time}. The first
is called automatically if a NetGraphMsgHandler is passed to
BackgroundProcessor::start (lightningdevkit#1212).
InvoicePayer::pay_pubkey was added to enable sending "keysend" payments to
supported recipients, using the InvoicePayer to handle retires (lightningdevkit#1160).
user_payment_id has been removed from PaymentPurpose, and
ChannelManager::create_inbound_payment{,_for_hash} (lightningdevkit#1180).
Updated documentation for several ChannelManager functions to remove stale
references to panics which no longer occur (lightningdevkit#1201).
The Score and LockableScore objects have moved into the
routing::scoring module instead of being in the routing module (lightningdevkit#1166).
The Time parameter to ScorerWithTime is no longer longer exposed,
instead being fixed based on the std/no-std feature (lightningdevkit#1184).
ChannelDetails::balance_msat was added to fetch a channel's balance
without subtracting the reserve values, lining up with on-chain claim amounts
less on-chain fees (lightningdevkit#1203).
An explicit UserConfig::accept_inbound_channels flag is now provided,
removing the need to set min_funding_satoshis to > 21 million BTC (lightningdevkit#1173).
Inbound channels that fail to see the funding transaction confirm within
2016 blocks are automatically force-closed with
ClosureReason::FundingTimedOut (lightningdevkit#1083).
We now accept a channel_reserve value of 0 from counterparties, as it is
insecure for our counterparty but not us (lightningdevkit#1163).
NetAddress::OnionV2 parsing was removed as version 2 onion services are no
longer supported in modern Tor (lightningdevkit#1204).
Generation and signing of anchor outputs is now supported in the
KeysInterface, though no support for them exists in the channel itself (lightningdevkit#1176)

Bug Fixes

Fixed a race condition in InvoicePayer where paths may be retried after
the retry count has been exceeded. In this case the
Event::PaymentPathFailed::all_paths_failed field is not a reliable payment
failure indicator. There was no acceptable alternative indicator,
Event::PaymentFailed as been added to provide one (lightningdevkit#1202).
Reduced the blocks-before-timeout we expect of outgoing HTLCs before
refusing to forward. This check was overly strict and resulted in refusing
to forward som HTLCs to a next hop that had a lower security threshold than
us (lightningdevkit#1119).
LDK no longer attempt to update the channel fee for outbound channels when
we cannot afford the new fee. This could have caused force-closure by our
channel counterparty (lightningdevkit#1054).
Fixed several bugs which may have prevented the reliable broadcast of our
own channel announcements and updates (lightningdevkit#1169).
Fixed a rare bug which may have resulted in spurious route finding failures
when using last-hop hints and MPP with large value payments (lightningdevkit#1168).
KeysManager::spend_spendable_outputs no longer adds a change output that
is below the dust threshold for non-standard change scripts (lightningdevkit#1131).
Fixed a minor memory leak when attempting to send a payment that fails due
to an error when updating the ChannelMonitor (lightningdevkit#1143).
Fixed a bug where a FeeEstimator that returns values rounded to the next
sat/vbyte may result in force-closures (lightningdevkit#1208).
Handle MPP timeout HTLC error codes, instead of considering the recipient to
have sent an invalid error, removing them from the network graph (lightningdevkit#1148)

Serialization Compatibility

All above new events/fields are ignored by prior clients. All above new
events/fields are not present when reading objects serialized by prior
versions of the library.
Payment secrets are now generated deterministically. This reduces the memory
footprint for inbound payments, however, newly-generated inbound payments
using ChannelManager::create_inbound_payment{,_for_hash} will not be
receivable using versions prior to 0.0.104.
ChannelManager::create_inbound_payment{,_for_hash}_legacy are provided for
backwards compatibility (lightningdevkit#1177).
PaymentPurpose::InvoicePayment::user_payment_id will be 0 when reading
objects written with 0.0.104 when read by 0.0.103 and previous (lightningdevkit#1180).

In total, this release features 51 files changed, 5356 insertions, 2238
deletions in 107 commits from 9 authors, in alphabetical order:

Antoine Riard
Conor Okus
Devrandom
Duncan Dean
Elias Rohrer
Jeffrey Czyz
Ken Sedgwick
Matt Corallo
Valentine Wallace

v0.0.103

2021-11-03T03:31:49Z

This release is almost entirely focused on a new API in the
lightning-invoice crate - the InvoicePayer. InvoicePayer is a
struct which takes a reference to a ChannelManager and a NetworkGraph
and retries payments as paths fail. It limits retries to a configurable
number, but is not serialized to disk and may retry additional times across
a serialization/load. In order to learn about failed payments, it must
receive Events directly from the ChannelManager, wrapping a
user-provided EventHandler which it provides all unhandled events to
(lightningdevkit#1059).
get_route has been renamed find_route (lightningdevkit#1059) and now takes a Payee
struct in replacement of a number of its long list of arguments (lightningdevkit#1134).
Payee is further stored in the Route object returned and provided in the
RouteParameters contained in Event::PaymentPathFailed (lightningdevkit#1059).
ChannelMonitors must now be persisted after calls which provide new block
data, prior to MonitorEvents being passed back to ChannelManager for
processing. If you are using a ChainMonitor this is handled for you.
The Persist API has been updated to Optionally take the
ChannelMonitorUpdate as persistence events that result from chain data no
longer have a corresponding update (lightningdevkit#1108).
routing::Score now has a payment_path_failed method which it can use to
learn which channels often fail payments. It is automatically called by
InvoicePayer for failed payment paths (lightningdevkit#1144).
The default Scorer implementation is now a type alias to a type generic
across different clocks and supports serialization to persist scoring data
across restarts (lightningdevkit#1146).
Event::PaymentSent now includes the full fee which was spent across all
payment paths which were fulfilled or pending when the payment was fulfilled
(lightningdevkit#1142).
NetGraphMsgHandler now takes a Deref to the NetworkGraph, allowing for
shared references to the graph data to make serialization and references to
the graph data in the InvoicePayer's Router simpler (lightningdevkit#1149).
routing::Score::channel_penalty_msat has been updated to provide the
NodeId of both the source and destination nodes of a channel (lightningdevkit#1133).
Delay disconnecting peers if we receive messages from them even if it takes
a while to receive a pong from them. Further, avoid sending too many gossip
messages between pings to ensure we should always receive pongs in a timely
manner. Together, these should significantly reduce instances of us failing
to remain connected to a peer during initial gossip sync (lightningdevkit#1137).
If a payment is sent, creating an outbound HTLC and sending it to our
counterparty (implying the ChannelMonitor was persisted on disk), but the
ChannelManager was not persisted prior to shutdown/crash, no
Event::PaymentPathFailed event will be generated if the HTLC is eventually
failed on chain (lightningdevkit#1104).
All above new Events/fields are ignored by prior clients. All above new
Events/fields are not present when reading objects serialized by prior
versions of the library.
Payments for which a Route was generated using a previous version or for
which the payment was originally sent by a previous version of the library
will not be retried by an InvoicePayer.

This release was singularly focused and some contributions by third parties
were delayed.
In total, this release features 38 files changed, 4414 insertions, and 969
deletions in 71 commits from 2 authors, in alphabetical order:

Jeffrey Czyz
Matt Corallo

v0.0.102

2021-10-18T19:25:21Z

API Updates

get_route now takes a Score as an argument. Score is queried during
the route-finding process, returning the absolute amounts which you are
willing to pay to avoid routing over a given channel. As a default, a
Scorer is provided which returns a constant amount, with a suggested
default of 500 msat. This translates to a willingness to pay up to 500 msat
in additional fees per hop in order to avoid additional hops (lightningdevkit#1124).
Event::PaymentPathFailed now contains a short_channel_id field which may
be filled in with a channel that can be "blamed" for the payment failure.
Payment retries should likely avoid the given channel for some time (lightningdevkit#1077).
PublicKeys in NetworkGraph have been replaced with a NodeId struct
which contains only a simple [u8; 33], substantially improving
NetworkGraph deserialization performance (lightningdevkit#1107).
ChainMonitor's HashMap of ChannelMonitors is now private, exposed via
Chainmonitor::get_monitor and ChainMonitor::list_monitors instead
(lightningdevkit#1112).
When an outbound channel is closed prior to the broadcasting of its funding
transaction, but after you call
ChannelManager::funding_transaction_generated, a new event type,
Event::DiscardFunding, is generated, informing you the transaction was not
broadcasted and that you can spend the same inputs again elsewhere (lightningdevkit#1098).
ChannelManager::create_channel now returns the temporary channel ID which
may later appear in Event::ChannelClosed or ChannelDetails prior to the
channel being funded (lightningdevkit#1121).
Event::PaymentSent now contains the payment hash as well as the payment
preimage (lightningdevkit#1062).
ReadOnlyNetworkGraph::get_addresses now returns owned NetAddress rather
than references. As a side-effect this method is now exposed in foreign
language bindings (lightningdevkit#1115).
The Persist and ChannelMonitorUpdateErr types have moved to the
lightning::chain::chainmonitor and lightning::chain modules,
respectively (lightningdevkit#1112).
ChannelManager::send_payment now returns a PaymentId which identifies a
payment (whether MPP or not) and can be used to retry the full payment or
MPP parts through retry_payment (lightningdevkit#1096). Note that doing so is currently
not crash safe, and you may find yourself sending twice. It is recommended
that you not use the retry_payment API until the next release.

Bug Fixes

Due to an earlier fix for the Lightning dust inflation vulnerability tracked
in CVE-2021-41591/CVE-2021-41592/CVE-2021-41593 in 0.0.100, we required
counterparties to accept a dust limit slightly lower than the dust limit now
required by other implementations. This appeared as, at least, latest lnd
always refusing to accept channels opened by LDK clients (lightningdevkit#1065).
If there are multiple channels available to the same counterparty,
get_route would only consider the channel listed last as available for
sending (lightningdevkit#1100).
Persist implementations returning
ChannelMonitorUpdateErr::TemporaryFailure from watch_channel previously
resulted in the ChannelMonitor not being stored at all, resulting in a
panic after monitor updating is complete (lightningdevkit#1112).
If payments are pending awaiting forwarding at startup, an
Event::PendingHTLCsForwardable event will always be provided. This ensures
user code calls ChannelManager::process_pending_htlc_fowards even if it
shut down while awaiting the batching timer during the previous run (lightningdevkit#1076).
If a call to ChannelManager::send_payment failed due to lack of
availability of funds locally, LDK would store the payment as pending
forever, with no ability to retry or fail it, leaking memory (lightningdevkit#1109).

Serialization Compatibility

All above new Events/fields are ignored by prior clients. All above new
Events/fields, except for Event::PaymentSent::payment_hash are not present
when reading objects serialized by prior versions of the library.

In total, this release features 32 files changed, 2248 insertions, and 1483
deletions in 51 commits from 7 authors, in alphabetical order:

1nF0rmed
Duncan Dean
Elias Rohrer
Galder Zamarreño
Jeffrey Czyz
Matt Corallo
Valentine Wallace

v0.0.101

2021-09-23T18:46:45Z

v0.0.101