diff --git a/CHANGELOG.md b/CHANGELOG.md index 467d281a4a0..ee3283b2930 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,94 @@ +# 0.0.118 - Oct 23, 2023 - "Just the Twelve Sinks" + +## API Updates + * BOLT12 sending and receiving is now supported as an alpha feature. You may + run into unexpected issues and will need to have a direct connection with + the offer's blinded path introduction points as messages are not yet routed. + We are seeking feedback from early testers (#2578, #2039). + * `ConfirmationTarget` has been rewritten to provide information about the + specific use LDK needs the feerate estimate for, rather than the generic + low-, medium-, and high-priority estimates. This allows LDK users to more + accurately target their feerate estimates (#2660). For those wishing to + retain their existing behavior, see the table below for conversion. + * `ChainHash` is now used in place of `BlockHash` where it represents the + genesis block (#2662). + * `lightning-invoice` payment utilities now take a `Deref` to + `AChannelManager` (#2652). + * `peel_onion` is provided to statelessly decode an `OnionMessage` (#2599). + * `ToSocketAddrs` + `Display` are now impl'd for `SocketAddress` (#2636, #2670) + * `Display` is now implemented for `OutPoint` (#2649). + * `Features::from_be_bytes` is now provided (#2640). + +For those moving to the new `ConfirmationTarget`, the new variants in terms of +the old mempool/low/medium/high priorities are as follows: + * `OnChainSweep` = `HighPriority` + * `MaxAllowedNonAnchorChannelRemoteFee` = `max(25 * 250, HighPriority * 10)` + * `MinAllowedAnchorChannelRemoteFee` = `MempoolMinimum` + * `MinAllowedNonAnchorChannelRemoteFee` = `Background - 250` + * `AnchorChannelFee` = `Background` + * `NonAnchorChannelFee` = `Normal` + * `ChannelCloseMinimum` = `Background` + +## Bug Fixes + * Calling `ChannelManager::close_channel[_with_feerate_and_script]` on a + channel which did not exist would immediately hang holding several key + `ChannelManager`-internal locks (#2657). + * Channel information updates received from a failing HTLC are no longer + applied to our `NetworkGraph`. This prevents a node which we attempted to + route a payment through from being able to learn the sender of the payment. + In some rare cases, this may result in marginally reduced payment success + rates (#2666). + * Anchor outputs are now properly considered when calculating the amount + available to send in HTLCs. This can prevent force-closes in anchor channels + when sending payments which overflow the available balance (#2674). + * A peer that sends an `update_fulfill_htlc` message for a forwarded HTLC, + then reconnects prior to sending a `commitment_signed` (thus retransmitting + their `update_fulfill_htlc`) may result in the channel stalling and being + unable to make progress (#2661). + * In exceedingly rare circumstances, messages intended to be sent to a peer + prior to reconnection can be sent after reconnection. This could result in + undefined channel state and force-closes (#2663). + +## Backwards Compatibility + + * Creating a blinded path to receive a payment then downgrading to LDK prior to + 0.0.117 may result in failure to receive the payment (#2413). + * Calling `ChannelManager::pay_for_offer` or + `ChannelManager::create_refund_builder` may prevent downgrading to LDK prior + to 0.0.118 until the payment times out and has been removed (#2039). + +## Node Compatibility + * LDK now sends a bogus `channel_reestablish` message to peers when they ask to + resume an unknown channel. This should cause LND nodes to force-close and + broadcast the latest channel state to the chain. In order to trigger this + when we wish to force-close a channel, LDK now disconnects immediately after + sending a channel-closing `error` message. This should result in cooperative + peers also working to confirm the latest commitment transaction when we wish + to force-close (#2658). + +## Security +0.0.118 expands mitigations against transaction cycling attacks to non-anchor +channels, though note that no mitigations which exist today are considered robust +to prevent the class of attacks. + * In order to mitigate against transaction cycling attacks, non-anchor HTLC + transactions are now properly re-signed before broadcasting (#2667). + +In total, this release features 61 files changed, 3470 insertions, 1503 +deletions in 85 commits from 12 authors, in alphabetical order: + * Antonio Yang + * Elias Rohrer + * Evan Feenstra + * Fedeparma74 + * Gursharan Singh + * Jeffrey Czyz + * Matt Corallo + * Sergi Delgado Segura + * Vladimir Fomene + * Wilmer Paulino + * benthecarman + * slanesuke + + # 0.0.117 - Oct 3, 2023 - "Everything but the Twelve Sinks" ## API Updates diff --git a/lightning-background-processor/Cargo.toml b/lightning-background-processor/Cargo.toml index b0bfff38f02..59f77ac5fa4 100644 --- a/lightning-background-processor/Cargo.toml +++ b/lightning-background-processor/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "lightning-background-processor" -version = "0.0.117" +version = "0.0.118" authors = ["Valentine Wallace "] license = "MIT OR Apache-2.0" repository = "https://github.com/lightningdevkit/rust-lightning" @@ -22,11 +22,11 @@ default = ["std"] [dependencies] bitcoin = { version = "0.29.0", default-features = false } -lightning = { version = "0.0.117", path = "../lightning", default-features = false } -lightning-rapid-gossip-sync = { version = "0.0.117", path = "../lightning-rapid-gossip-sync", default-features = false } +lightning = { version = "0.0.118", path = "../lightning", default-features = false } +lightning-rapid-gossip-sync = { version = "0.0.118", path = "../lightning-rapid-gossip-sync", default-features = false } [dev-dependencies] tokio = { version = "1.14", features = [ "macros", "rt", "rt-multi-thread", "sync", "time" ] } -lightning = { version = "0.0.117", path = "../lightning", features = ["_test_utils"] } -lightning-invoice = { version = "0.25.0", path = "../lightning-invoice" } -lightning-persister = { version = "0.0.117", path = "../lightning-persister" } +lightning = { version = "0.0.118", path = "../lightning", features = ["_test_utils"] } +lightning-invoice = { version = "0.26.0", path = "../lightning-invoice" } +lightning-persister = { version = "0.0.118", path = "../lightning-persister" } diff --git a/lightning-block-sync/Cargo.toml b/lightning-block-sync/Cargo.toml index be066c8577f..d9bb4ee7b1e 100644 --- a/lightning-block-sync/Cargo.toml +++ b/lightning-block-sync/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "lightning-block-sync" -version = "0.0.117" +version = "0.0.118" authors = ["Jeffrey Czyz", "Matt Corallo"] license = "MIT OR Apache-2.0" repository = "https://github.com/lightningdevkit/rust-lightning" @@ -19,11 +19,11 @@ rpc-client = [ "serde_json", "chunked_transfer" ] [dependencies] bitcoin = "0.29.0" -lightning = { version = "0.0.117", path = "../lightning" } +lightning = { version = "0.0.118", path = "../lightning" } tokio = { version = "1.0", features = [ "io-util", "net", "time" ], optional = true } serde_json = { version = "1.0", optional = true } chunked_transfer = { version = "1.4", optional = true } [dev-dependencies] -lightning = { version = "0.0.117", path = "../lightning", features = ["_test_utils"] } +lightning = { version = "0.0.118", path = "../lightning", features = ["_test_utils"] } tokio = { version = "1.14", features = [ "macros", "rt" ] } diff --git a/lightning-custom-message/Cargo.toml b/lightning-custom-message/Cargo.toml index 9283d804d9f..2efce6bcd2c 100644 --- a/lightning-custom-message/Cargo.toml +++ b/lightning-custom-message/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "lightning-custom-message" -version = "0.0.117" +version = "0.0.118" authors = ["Jeffrey Czyz"] license = "MIT OR Apache-2.0" repository = "https://github.com/lightningdevkit/rust-lightning" @@ -15,4 +15,4 @@ rustdoc-args = ["--cfg", "docsrs"] [dependencies] bitcoin = "0.29.0" -lightning = { version = "0.0.117", path = "../lightning" } +lightning = { version = "0.0.118", path = "../lightning" } diff --git a/lightning-invoice/Cargo.toml b/lightning-invoice/Cargo.toml index 472674c1311..a34bd63b7f2 100644 --- a/lightning-invoice/Cargo.toml +++ b/lightning-invoice/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "lightning-invoice" description = "Data structures to parse and serialize BOLT11 lightning invoices" -version = "0.25.0" +version = "0.26.0" authors = ["Sebastian Geisler "] documentation = "https://docs.rs/lightning-invoice/" license = "MIT OR Apache-2.0" @@ -21,7 +21,7 @@ std = ["bitcoin_hashes/std", "num-traits/std", "lightning/std", "bech32/std"] [dependencies] bech32 = { version = "0.9.0", default-features = false } -lightning = { version = "0.0.117", path = "../lightning", default-features = false } +lightning = { version = "0.0.118", path = "../lightning", default-features = false } secp256k1 = { version = "0.24.0", default-features = false, features = ["recovery", "alloc"] } num-traits = { version = "0.2.8", default-features = false } bitcoin_hashes = { version = "0.11", default-features = false } @@ -30,6 +30,6 @@ serde = { version = "1.0.118", optional = true } bitcoin = { version = "0.29.0", default-features = false } [dev-dependencies] -lightning = { version = "0.0.117", path = "../lightning", default-features = false, features = ["_test_utils"] } +lightning = { version = "0.0.118", path = "../lightning", default-features = false, features = ["_test_utils"] } hex = "0.4" serde_json = { version = "1"} diff --git a/lightning-net-tokio/Cargo.toml b/lightning-net-tokio/Cargo.toml index 8a4ebd5d950..6cd3a1fa382 100644 --- a/lightning-net-tokio/Cargo.toml +++ b/lightning-net-tokio/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "lightning-net-tokio" -version = "0.0.117" +version = "0.0.118" authors = ["Matt Corallo"] license = "MIT OR Apache-2.0" repository = "https://github.com/lightningdevkit/rust-lightning/" @@ -16,9 +16,9 @@ rustdoc-args = ["--cfg", "docsrs"] [dependencies] bitcoin = "0.29.0" -lightning = { version = "0.0.117", path = "../lightning" } +lightning = { version = "0.0.118", path = "../lightning" } tokio = { version = "1.0", features = [ "rt", "sync", "net", "time" ] } [dev-dependencies] tokio = { version = "1.14", features = [ "macros", "rt", "rt-multi-thread", "sync", "net", "time" ] } -lightning = { version = "0.0.117", path = "../lightning", features = ["_test_utils"] } +lightning = { version = "0.0.118", path = "../lightning", features = ["_test_utils"] } diff --git a/lightning-persister/Cargo.toml b/lightning-persister/Cargo.toml index 1a5ce6b7b4d..525b9507329 100644 --- a/lightning-persister/Cargo.toml +++ b/lightning-persister/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "lightning-persister" -version = "0.0.117" +version = "0.0.118" authors = ["Valentine Wallace", "Matt Corallo"] license = "MIT OR Apache-2.0" repository = "https://github.com/lightningdevkit/rust-lightning" @@ -15,7 +15,7 @@ rustdoc-args = ["--cfg", "docsrs"] [dependencies] bitcoin = "0.29.0" -lightning = { version = "0.0.117", path = "../lightning" } +lightning = { version = "0.0.118", path = "../lightning" } [target.'cfg(windows)'.dependencies] windows-sys = { version = "0.48.0", default-features = false, features = ["Win32_Storage_FileSystem", "Win32_Foundation"] } @@ -24,5 +24,5 @@ windows-sys = { version = "0.48.0", default-features = false, features = ["Win32 criterion = { version = "0.4", optional = true, default-features = false } [dev-dependencies] -lightning = { version = "0.0.117", path = "../lightning", features = ["_test_utils"] } +lightning = { version = "0.0.118", path = "../lightning", features = ["_test_utils"] } bitcoin = { version = "0.29.0", default-features = false } diff --git a/lightning-rapid-gossip-sync/Cargo.toml b/lightning-rapid-gossip-sync/Cargo.toml index 8c04f3a0d31..7853c32e70c 100644 --- a/lightning-rapid-gossip-sync/Cargo.toml +++ b/lightning-rapid-gossip-sync/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "lightning-rapid-gossip-sync" -version = "0.0.117" +version = "0.0.118" authors = ["Arik Sosman "] license = "MIT OR Apache-2.0" repository = "https://github.com/lightningdevkit/rust-lightning" @@ -15,11 +15,11 @@ no-std = ["lightning/no-std"] std = ["lightning/std"] [dependencies] -lightning = { version = "0.0.117", path = "../lightning", default-features = false } +lightning = { version = "0.0.118", path = "../lightning", default-features = false } bitcoin = { version = "0.29.0", default-features = false } [target.'cfg(ldk_bench)'.dependencies] criterion = { version = "0.4", optional = true, default-features = false } [dev-dependencies] -lightning = { version = "0.0.117", path = "../lightning", features = ["_test_utils"] } +lightning = { version = "0.0.118", path = "../lightning", features = ["_test_utils"] } diff --git a/lightning-transaction-sync/Cargo.toml b/lightning-transaction-sync/Cargo.toml index 02c94a3eb57..24f9c687a08 100644 --- a/lightning-transaction-sync/Cargo.toml +++ b/lightning-transaction-sync/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "lightning-transaction-sync" -version = "0.0.117" +version = "0.0.118" authors = ["Elias Rohrer"] license = "MIT OR Apache-2.0" repository = "https://github.com/lightningdevkit/rust-lightning" @@ -21,7 +21,7 @@ esplora-blocking = ["esplora-client/blocking"] async-interface = [] [dependencies] -lightning = { version = "0.0.117", path = "../lightning", default-features = false } +lightning = { version = "0.0.118", path = "../lightning", default-features = false } bitcoin = { version = "0.29.0", default-features = false } bdk-macros = "0.6" futures = { version = "0.3", optional = true } @@ -29,7 +29,7 @@ esplora-client = { version = "0.4", default-features = false, optional = true } reqwest = { version = "0.11", optional = true, default-features = false, features = ["json"] } [dev-dependencies] -lightning = { version = "0.0.117", path = "../lightning", features = ["std"] } +lightning = { version = "0.0.118", path = "../lightning", features = ["std"] } electrsd = { version = "0.22.0", features = ["legacy", "esplora_a33e97e1", "bitcoind_23_0"] } electrum-client = "0.12.0" tokio = { version = "1.14.0", features = ["full"] } diff --git a/lightning/Cargo.toml b/lightning/Cargo.toml index 77d1fdba377..11ac2967eeb 100644 --- a/lightning/Cargo.toml +++ b/lightning/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "lightning" -version = "0.0.117" +version = "0.0.118" authors = ["Matt Corallo"] license = "MIT OR Apache-2.0" repository = "https://github.com/lightningdevkit/rust-lightning/" diff --git a/pending_changelog/1-hop-bps.txt b/pending_changelog/1-hop-bps.txt deleted file mode 100644 index aca22600073..00000000000 --- a/pending_changelog/1-hop-bps.txt +++ /dev/null @@ -1,4 +0,0 @@ -## Backwards Compatibility - -* Creating a blinded path to receive a payment over and then downgrading to a version of LDK prior - to 0.0.117 may result in failure to receive the payment (#2413). diff --git a/pending_changelog/invoice_request_failed_downgrade.txt b/pending_changelog/invoice_request_failed_downgrade.txt deleted file mode 100644 index d701cef04b5..00000000000 --- a/pending_changelog/invoice_request_failed_downgrade.txt +++ /dev/null @@ -1,3 +0,0 @@ -## Backwards Compatibility - -* If an `Event::InvoiceRequestFailed` was generated for a BOLT 12 payment (#2371), downgrading will result in the payment silently failing if the event had not been processed yet.