Remove `PaymentPathFailed::retry` by valentinewallace · Pull Request #2063 · lightningdevkit/rust-lightning

valentinewallace · 2023-03-01T17:16:18Z

PaymentPathFailed::retry is no longer useful since we removed support for manual payment retries.

Closes#1932.

release note

TheBlueMatt · 2023-03-07T17:52:37Z

- }
-
- if payment_is_probe || !is_retryable_now || !payment_retryable || retry.is_none() {
+ if payment_is_probe || !is_retryable_now || !payment_retryable {


While I'm not sure its reachable today, if we somehow are missing a payment_params in our PendingOutboundPayment::Retryable we'll end up with a stuck payment here - check_retry_payments will ignore it cause it checks for the Some but we wont fail it here.
I remain kinda annoyed at how brittle this code is and how easy its going to be to add leaks in the future. Not sure what to do about it, just annoyed.
Let's maybe move the payment_params check into is_auto_retryable_now and also add some debug assertions on the retry path to make sure we don't have an issue like this.

I'm still looking for other debug assertions you may be thinking of (maybe something at the end of check_retry_payments to check for stuck payments?) but updated

codecov-commenter · 2023-03-08T19:48:14Z

Codecov Report

Patch coverage: 82.50% and project coverage change: -0.01⚠️

Comparison is base (23c1b46) 91.14% compared to head (f89b7d6) 91.14%.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files

@@ Coverage Diff @@## main #2063 +/- ##
==========================================
- Coverage 91.14% 91.14% -0.01% 
==========================================
Files 101 101 Lines 48888 48865 -23 Branches 48888 48865 -23 ==========================================
- Hits 44561 44540 -21 + Misses 4327 4325 -2

Impacted Files	Coverage Δ
lightning-background-processor/src/lib.rs	`78.29% <ø> (ø)`
lightning/src/ln/channel.rs	`89.36% <ø> (ø)`
lightning/src/ln/functional_test_utils.rs	`92.48% <ø> (-0.03%)`	⬇️
lightning/src/ln/outbound_payment.rs	`90.25% <54.54%> (-0.51%)`	⬇️
lightning/src/ln/channelmanager.rs	`88.85% <91.66%> (-0.02%)`	⬇️
lightning/src/ln/functional_tests.rs	`98.22% <100.00%> (-0.02%)`	⬇️
lightning/src/util/events.rs	`31.37% <100.00%> (+0.26%)`	⬆️

... and 8 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

TheBlueMatt

One nit on the release notes otherwise lgtm.

tnull · 2023-03-10T12:26:35Z

I'm afraid this needs a rebase now that #2092 has been merged.

We now support automatic retries in ChannelManager and no longer support manual retries, so the field is useless.

No longer used since it is no longer used to construct PaymentPathFailed events

It's unused since it no longer inserts it into HTLCSource

dunxen

With changes, still LGTM.

0.0.115 - Apr 24, 2023 - "Rebroadcast the Bugfixes" API Updates =========== * The MSRV of the main LDK crates has been increased to 1.48 (lightningdevkit#2107). * Attempting to claim an un-expired payment on a channel which has closed no longer fails. The expiry time of payments is exposed via `PaymentClaimable::claim_deadline` (lightningdevkit#2148). * `payment_metadata` is now supported in `Invoice` deserialization, sending, and receiving (via a new `RecipientOnionFields` struct) (lightningdevkit#2139, lightningdevkit#2127). * `Event::PaymentFailed` now exposes a failure reason (lightningdevkit#2142). * BOLT12 messages now support stateless generation and validation (lightningdevkit#1989). * The `NetworkGraph` is now pruned of stale data after RGS processing (lightningdevkit#2161). * Max inbound HTLCs in-flight can be changed in the handshake config (lightningdevkit#2138). * `lightning-transaction-sync` feature `esplora-async-https` was added (lightningdevkit#2085). * A `ChannelPending` event is now emitted after the initial handshake (lightningdevkit#2098). * `PaymentForwarded::outbound_amount_forwarded_msat` was added (lightningdevkit#2136). * `ChannelManager::list_channels_by_counterparty` was added (lightningdevkit#2079). * `ChannelDetails::feerate_sat_per_1000_weight` was added (lightningdevkit#2094). * `Invoice::fallback_addresses` was added to fetch `bitcoin` types (lightningdevkit#2023). * The offer/refund description is now exposed in `Invoice{,Request}` (lightningdevkit#2206). Backwards Compatibility ======================= * Payments sent with the legacy `*_with_route` methods on LDK 0.0.115+ will no longer be retryable via the LDK 0.0.114- `retry_payment` method (lightningdevkit#2139). * `Event::PaymentPathFailed::retry` was removed and will always be `None` for payments initiated on 0.0.115 which fail on an earlier version (lightningdevkit#2063). * `Route`s and `PaymentParameters` with blinded path information will not be readable on prior versions of LDK. Such objects are not currently constructed by LDK, but may be when processing BOLT12 data in a coming release (lightningdevkit#2146). * Providing `ChannelMonitorUpdate`s generated by LDK 0.0.115 to a `ChannelMonitor` on 0.0.114 or before may panic (lightningdevkit#2059). Note that this is in general unsupported, and included here only for completeness. Bug Fixes ========= * Fixed a case where `process_events_async` may `poll` a `Future` which has already completed (lightningdevkit#2081). * Fixed deserialization of `u16` arrays. This bug may have previously corrupted the historical buckets in a `ProbabilisticScorer`. Users relying on the historical buckets may wish to wipe their scorer on upgrade to remove corrupt data rather than waiting on it to decay (lightningdevkit#2191). * The `process_events_async` task is now `Send` and can thus be polled on a multi-threaded runtime (lightningdevkit#2199). * Fixed a missing macro export causing `impl_writeable_tlv_based_enum{,_upgradable}` calls to not compile (lightningdevkit#2091). * Fixed compilation of `lightning-invoice` with both `no-std` and serde (lightningdevkit#2187) * Fix an issue where the `background-processor` would not wake when a `ChannelMonitorUpdate` completed asynchronously, causing delays (lightningdevkit#2090). * Fix an issue where `process_events_async` would exit immediately (lightningdevkit#2145). * `Router` calls from the `ChannelManager` now call `find_route_with_id` rather than `find_route`, as was intended and described in the API (lightningdevkit#2092). * Ensure `process_events_async` always exits if any sleep future returns true, not just if all sleep futures repeatedly return true (lightningdevkit#2145). * `channel_update` messages no longer set the disable bit unless the peer has been disconnected for some time. This should resolve cases where channels are disabled for extended periods of time (lightningdevkit#2198). * We no longer remove CLN nodes from the network graph for violating the BOLT spec in some cases after failing to pay through them (lightningdevkit#2220). * Fixed a debug assertion which may panic under heavy load (lightningdevkit#2172). * `CounterpartyForceClosed::peer_msg` is now wrapped in UntrustedString (lightningdevkit#2114) * Fixed a potential deadlock in `funding_transaction_generated` (lightningdevkit#2158). Security ======== * Transaction re-broadcasting is now substantially more aggressive, including a new regular rebroadcast feature called on a timer from the `background-processor` or from `ChainMonitor::rebroadcast_pending_claims`. This should substantially increase transaction confirmation reliability without relying on downstream `TransactionBroadcaster` implementations for rebroadcasting (lightningdevkit#2203, lightningdevkit#2205, lightningdevkit#2208). * Implemented the changes from BOLT PRs lightningdevkit#1031, lightningdevkit#1032, and lightningdevkit#1040 which resolve a privacy vulnerability which allows an intermediate node on the path to discover the final destination for a payment (lightningdevkit#2062). In total, this release features 110 files changed, 11928 insertions, 6368 deletions in 215 commits from 21 authors, in alphabetical order: * Advait * Alan Cohen * Alec Chen * Allan Douglas R. de Oliveira * Arik Sosman * Elias Rohrer * Evan Feenstra * Jeffrey Czyz * John Cantrell * Lucas Soriano del Pino * Marc Tyndel * Matt Corallo * Paul Miller * Steven * Steven Williamson * Steven Zhao * Tony Giorgio * Valentine Wallace * Wilmer Paulino * benthecarman * munjesi

valentinewallace · 2023-03-01T17:16:18Z

PaymentPathFailed::retry is no longer useful since we removed support for manual payment retries.

Closes#1932.

release note

TheBlueMatt · 2023-03-07T17:52:37Z

- }
-
- if payment_is_probe || !is_retryable_now || !payment_retryable || retry.is_none() {
+ if payment_is_probe || !is_retryable_now || !payment_retryable {


While I'm not sure its reachable today, if we somehow are missing a payment_params in our PendingOutboundPayment::Retryable we'll end up with a stuck payment here - check_retry_payments will ignore it cause it checks for the Some but we wont fail it here.
I remain kinda annoyed at how brittle this code is and how easy its going to be to add leaks in the future. Not sure what to do about it, just annoyed.
Let's maybe move the payment_params check into is_auto_retryable_now and also add some debug assertions on the retry path to make sure we don't have an issue like this.

I'm still looking for other debug assertions you may be thinking of (maybe something at the end of check_retry_payments to check for stuck payments?) but updated

codecov-commenter · 2023-03-08T19:48:14Z

Codecov Report

Patch coverage: 82.50% and project coverage change: -0.01⚠️

Comparison is base (23c1b46) 91.14% compared to head (f89b7d6) 91.14%.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files

@@ Coverage Diff @@## main #2063 +/- ##
==========================================
- Coverage 91.14% 91.14% -0.01% 
==========================================
Files 101 101 Lines 48888 48865 -23 Branches 48888 48865 -23 ==========================================
- Hits 44561 44540 -21 + Misses 4327 4325 -2

Impacted Files	Coverage Δ
lightning-background-processor/src/lib.rs	`78.29% <ø> (ø)`
lightning/src/ln/channel.rs	`89.36% <ø> (ø)`
lightning/src/ln/functional_test_utils.rs	`92.48% <ø> (-0.03%)`	⬇️
lightning/src/ln/outbound_payment.rs	`90.25% <54.54%> (-0.51%)`	⬇️
lightning/src/ln/channelmanager.rs	`88.85% <91.66%> (-0.02%)`	⬇️
lightning/src/ln/functional_tests.rs	`98.22% <100.00%> (-0.02%)`	⬇️
lightning/src/util/events.rs	`31.37% <100.00%> (+0.26%)`	⬆️

... and 8 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

TheBlueMatt

One nit on the release notes otherwise lgtm.

tnull · 2023-03-10T12:26:35Z

I'm afraid this needs a rebase now that #2092 has been merged.

We now support automatic retries in ChannelManager and no longer support manual retries, so the field is useless.

No longer used since it is no longer used to construct PaymentPathFailed events

It's unused since it no longer inserts it into HTLCSource

dunxen

With changes, still LGTM.

0.0.115 - Apr 24, 2023 - "Rebroadcast the Bugfixes" API Updates =========== * The MSRV of the main LDK crates has been increased to 1.48 (lightningdevkit#2107). * Attempting to claim an un-expired payment on a channel which has closed no longer fails. The expiry time of payments is exposed via `PaymentClaimable::claim_deadline` (lightningdevkit#2148). * `payment_metadata` is now supported in `Invoice` deserialization, sending, and receiving (via a new `RecipientOnionFields` struct) (lightningdevkit#2139, lightningdevkit#2127). * `Event::PaymentFailed` now exposes a failure reason (lightningdevkit#2142). * BOLT12 messages now support stateless generation and validation (lightningdevkit#1989). * The `NetworkGraph` is now pruned of stale data after RGS processing (lightningdevkit#2161). * Max inbound HTLCs in-flight can be changed in the handshake config (lightningdevkit#2138). * `lightning-transaction-sync` feature `esplora-async-https` was added (lightningdevkit#2085). * A `ChannelPending` event is now emitted after the initial handshake (lightningdevkit#2098). * `PaymentForwarded::outbound_amount_forwarded_msat` was added (lightningdevkit#2136). * `ChannelManager::list_channels_by_counterparty` was added (lightningdevkit#2079). * `ChannelDetails::feerate_sat_per_1000_weight` was added (lightningdevkit#2094). * `Invoice::fallback_addresses` was added to fetch `bitcoin` types (lightningdevkit#2023). * The offer/refund description is now exposed in `Invoice{,Request}` (lightningdevkit#2206). Backwards Compatibility ======================= * Payments sent with the legacy `*_with_route` methods on LDK 0.0.115+ will no longer be retryable via the LDK 0.0.114- `retry_payment` method (lightningdevkit#2139). * `Event::PaymentPathFailed::retry` was removed and will always be `None` for payments initiated on 0.0.115 which fail on an earlier version (lightningdevkit#2063). * `Route`s and `PaymentParameters` with blinded path information will not be readable on prior versions of LDK. Such objects are not currently constructed by LDK, but may be when processing BOLT12 data in a coming release (lightningdevkit#2146). * Providing `ChannelMonitorUpdate`s generated by LDK 0.0.115 to a `ChannelMonitor` on 0.0.114 or before may panic (lightningdevkit#2059). Note that this is in general unsupported, and included here only for completeness. Bug Fixes ========= * Fixed a case where `process_events_async` may `poll` a `Future` which has already completed (lightningdevkit#2081). * Fixed deserialization of `u16` arrays. This bug may have previously corrupted the historical buckets in a `ProbabilisticScorer`. Users relying on the historical buckets may wish to wipe their scorer on upgrade to remove corrupt data rather than waiting on it to decay (lightningdevkit#2191). * The `process_events_async` task is now `Send` and can thus be polled on a multi-threaded runtime (lightningdevkit#2199). * Fixed a missing macro export causing `impl_writeable_tlv_based_enum{,_upgradable}` calls to not compile (lightningdevkit#2091). * Fixed compilation of `lightning-invoice` with both `no-std` and serde (lightningdevkit#2187) * Fix an issue where the `background-processor` would not wake when a `ChannelMonitorUpdate` completed asynchronously, causing delays (lightningdevkit#2090). * Fix an issue where `process_events_async` would exit immediately (lightningdevkit#2145). * `Router` calls from the `ChannelManager` now call `find_route_with_id` rather than `find_route`, as was intended and described in the API (lightningdevkit#2092). * Ensure `process_events_async` always exits if any sleep future returns true, not just if all sleep futures repeatedly return true (lightningdevkit#2145). * `channel_update` messages no longer set the disable bit unless the peer has been disconnected for some time. This should resolve cases where channels are disabled for extended periods of time (lightningdevkit#2198). * We no longer remove CLN nodes from the network graph for violating the BOLT spec in some cases after failing to pay through them (lightningdevkit#2220). * Fixed a debug assertion which may panic under heavy load (lightningdevkit#2172). * `CounterpartyForceClosed::peer_msg` is now wrapped in UntrustedString (lightningdevkit#2114) * Fixed a potential deadlock in `funding_transaction_generated` (lightningdevkit#2158). Security ======== * Transaction re-broadcasting is now substantially more aggressive, including a new regular rebroadcast feature called on a timer from the `background-processor` or from `ChainMonitor::rebroadcast_pending_claims`. This should substantially increase transaction confirmation reliability without relying on downstream `TransactionBroadcaster` implementations for rebroadcasting (lightningdevkit#2203, lightningdevkit#2205, lightningdevkit#2208). * Implemented the changes from BOLT PRs lightningdevkit#1031, lightningdevkit#1032, and lightningdevkit#1040 which resolve a privacy vulnerability which allows an intermediate node on the path to discover the final destination for a payment (lightningdevkit#2062). In total, this release features 110 files changed, 11928 insertions, 6368 deletions in 215 commits from 21 authors, in alphabetical order: * Advait * Alan Cohen * Alec Chen * Allan Douglas R. de Oliveira * Arik Sosman * Elias Rohrer * Evan Feenstra * Jeffrey Czyz * John Cantrell * Lucas Soriano del Pino * Marc Tyndel * Matt Corallo * Paul Miller * Steven * Steven Williamson * Steven Zhao * Tony Giorgio * Valentine Wallace * Wilmer Paulino * benthecarman * munjesi

valentinewallace · 2023-03-01T17:16:18Z

PaymentPathFailed::retry is no longer useful since we removed support for manual payment retries.

Closes#1932.

release note

TheBlueMatt · 2023-03-07T17:52:37Z

- }
-
- if payment_is_probe || !is_retryable_now || !payment_retryable || retry.is_none() {
+ if payment_is_probe || !is_retryable_now || !payment_retryable {


While I'm not sure its reachable today, if we somehow are missing a payment_params in our PendingOutboundPayment::Retryable we'll end up with a stuck payment here - check_retry_payments will ignore it cause it checks for the Some but we wont fail it here.
I remain kinda annoyed at how brittle this code is and how easy its going to be to add leaks in the future. Not sure what to do about it, just annoyed.
Let's maybe move the payment_params check into is_auto_retryable_now and also add some debug assertions on the retry path to make sure we don't have an issue like this.

I'm still looking for other debug assertions you may be thinking of (maybe something at the end of check_retry_payments to check for stuck payments?) but updated

codecov-commenter · 2023-03-08T19:48:14Z

Codecov Report

Patch coverage: 82.50% and project coverage change: -0.01⚠️

Comparison is base (23c1b46) 91.14% compared to head (f89b7d6) 91.14%.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files

@@ Coverage Diff @@## main #2063 +/- ##
==========================================
- Coverage 91.14% 91.14% -0.01% 
==========================================
Files 101 101 Lines 48888 48865 -23 Branches 48888 48865 -23 ==========================================
- Hits 44561 44540 -21 + Misses 4327 4325 -2

Impacted Files	Coverage Δ
lightning-background-processor/src/lib.rs	`78.29% <ø> (ø)`
lightning/src/ln/channel.rs	`89.36% <ø> (ø)`
lightning/src/ln/functional_test_utils.rs	`92.48% <ø> (-0.03%)`	⬇️
lightning/src/ln/outbound_payment.rs	`90.25% <54.54%> (-0.51%)`	⬇️
lightning/src/ln/channelmanager.rs	`88.85% <91.66%> (-0.02%)`	⬇️
lightning/src/ln/functional_tests.rs	`98.22% <100.00%> (-0.02%)`	⬇️
lightning/src/util/events.rs	`31.37% <100.00%> (+0.26%)`	⬆️

... and 8 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

TheBlueMatt

One nit on the release notes otherwise lgtm.

tnull · 2023-03-10T12:26:35Z

I'm afraid this needs a rebase now that #2092 has been merged.

We now support automatic retries in ChannelManager and no longer support manual retries, so the field is useless.

No longer used since it is no longer used to construct PaymentPathFailed events

It's unused since it no longer inserts it into HTLCSource

dunxen

With changes, still LGTM.

0.0.115 - Apr 24, 2023 - "Rebroadcast the Bugfixes" API Updates =========== * The MSRV of the main LDK crates has been increased to 1.48 (lightningdevkit#2107). * Attempting to claim an un-expired payment on a channel which has closed no longer fails. The expiry time of payments is exposed via `PaymentClaimable::claim_deadline` (lightningdevkit#2148). * `payment_metadata` is now supported in `Invoice` deserialization, sending, and receiving (via a new `RecipientOnionFields` struct) (lightningdevkit#2139, lightningdevkit#2127). * `Event::PaymentFailed` now exposes a failure reason (lightningdevkit#2142). * BOLT12 messages now support stateless generation and validation (lightningdevkit#1989). * The `NetworkGraph` is now pruned of stale data after RGS processing (lightningdevkit#2161). * Max inbound HTLCs in-flight can be changed in the handshake config (lightningdevkit#2138). * `lightning-transaction-sync` feature `esplora-async-https` was added (lightningdevkit#2085). * A `ChannelPending` event is now emitted after the initial handshake (lightningdevkit#2098). * `PaymentForwarded::outbound_amount_forwarded_msat` was added (lightningdevkit#2136). * `ChannelManager::list_channels_by_counterparty` was added (lightningdevkit#2079). * `ChannelDetails::feerate_sat_per_1000_weight` was added (lightningdevkit#2094). * `Invoice::fallback_addresses` was added to fetch `bitcoin` types (lightningdevkit#2023). * The offer/refund description is now exposed in `Invoice{,Request}` (lightningdevkit#2206). Backwards Compatibility ======================= * Payments sent with the legacy `*_with_route` methods on LDK 0.0.115+ will no longer be retryable via the LDK 0.0.114- `retry_payment` method (lightningdevkit#2139). * `Event::PaymentPathFailed::retry` was removed and will always be `None` for payments initiated on 0.0.115 which fail on an earlier version (lightningdevkit#2063). * `Route`s and `PaymentParameters` with blinded path information will not be readable on prior versions of LDK. Such objects are not currently constructed by LDK, but may be when processing BOLT12 data in a coming release (lightningdevkit#2146). * Providing `ChannelMonitorUpdate`s generated by LDK 0.0.115 to a `ChannelMonitor` on 0.0.114 or before may panic (lightningdevkit#2059). Note that this is in general unsupported, and included here only for completeness. Bug Fixes ========= * Fixed a case where `process_events_async` may `poll` a `Future` which has already completed (lightningdevkit#2081). * Fixed deserialization of `u16` arrays. This bug may have previously corrupted the historical buckets in a `ProbabilisticScorer`. Users relying on the historical buckets may wish to wipe their scorer on upgrade to remove corrupt data rather than waiting on it to decay (lightningdevkit#2191). * The `process_events_async` task is now `Send` and can thus be polled on a multi-threaded runtime (lightningdevkit#2199). * Fixed a missing macro export causing `impl_writeable_tlv_based_enum{,_upgradable}` calls to not compile (lightningdevkit#2091). * Fixed compilation of `lightning-invoice` with both `no-std` and serde (lightningdevkit#2187) * Fix an issue where the `background-processor` would not wake when a `ChannelMonitorUpdate` completed asynchronously, causing delays (lightningdevkit#2090). * Fix an issue where `process_events_async` would exit immediately (lightningdevkit#2145). * `Router` calls from the `ChannelManager` now call `find_route_with_id` rather than `find_route`, as was intended and described in the API (lightningdevkit#2092). * Ensure `process_events_async` always exits if any sleep future returns true, not just if all sleep futures repeatedly return true (lightningdevkit#2145). * `channel_update` messages no longer set the disable bit unless the peer has been disconnected for some time. This should resolve cases where channels are disabled for extended periods of time (lightningdevkit#2198). * We no longer remove CLN nodes from the network graph for violating the BOLT spec in some cases after failing to pay through them (lightningdevkit#2220). * Fixed a debug assertion which may panic under heavy load (lightningdevkit#2172). * `CounterpartyForceClosed::peer_msg` is now wrapped in UntrustedString (lightningdevkit#2114) * Fixed a potential deadlock in `funding_transaction_generated` (lightningdevkit#2158). Security ======== * Transaction re-broadcasting is now substantially more aggressive, including a new regular rebroadcast feature called on a timer from the `background-processor` or from `ChainMonitor::rebroadcast_pending_claims`. This should substantially increase transaction confirmation reliability without relying on downstream `TransactionBroadcaster` implementations for rebroadcasting (lightningdevkit#2203, lightningdevkit#2205, lightningdevkit#2208). * Implemented the changes from BOLT PRs lightningdevkit#1031, lightningdevkit#1032, and lightningdevkit#1040 which resolve a privacy vulnerability which allows an intermediate node on the path to discover the final destination for a payment (lightningdevkit#2062). In total, this release features 110 files changed, 11928 insertions, 6368 deletions in 215 commits from 21 authors, in alphabetical order: * Advait * Alan Cohen * Alec Chen * Allan Douglas R. de Oliveira * Arik Sosman * Elias Rohrer * Evan Feenstra * Jeffrey Czyz * John Cantrell * Lucas Soriano del Pino * Marc Tyndel * Matt Corallo * Paul Miller * Steven * Steven Williamson * Steven Zhao * Tony Giorgio * Valentine Wallace * Wilmer Paulino * benthecarman * munjesi

valentinewallace · 2023-03-01T17:16:18Z

PaymentPathFailed::retry is no longer useful since we removed support for manual payment retries.

Closes#1932.

release note

TheBlueMatt · 2023-03-07T17:52:37Z

- }
-
- if payment_is_probe || !is_retryable_now || !payment_retryable || retry.is_none() {
+ if payment_is_probe || !is_retryable_now || !payment_retryable {


While I'm not sure its reachable today, if we somehow are missing a payment_params in our PendingOutboundPayment::Retryable we'll end up with a stuck payment here - check_retry_payments will ignore it cause it checks for the Some but we wont fail it here.
I remain kinda annoyed at how brittle this code is and how easy its going to be to add leaks in the future. Not sure what to do about it, just annoyed.
Let's maybe move the payment_params check into is_auto_retryable_now and also add some debug assertions on the retry path to make sure we don't have an issue like this.

I'm still looking for other debug assertions you may be thinking of (maybe something at the end of check_retry_payments to check for stuck payments?) but updated

codecov-commenter · 2023-03-08T19:48:14Z

Codecov Report

Patch coverage: 82.50% and project coverage change: -0.01⚠️

Comparison is base (23c1b46) 91.14% compared to head (f89b7d6) 91.14%.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files

@@ Coverage Diff @@## main #2063 +/- ##
==========================================
- Coverage 91.14% 91.14% -0.01% 
==========================================
Files 101 101 Lines 48888 48865 -23 Branches 48888 48865 -23 ==========================================
- Hits 44561 44540 -21 + Misses 4327 4325 -2

Impacted Files	Coverage Δ
lightning-background-processor/src/lib.rs	`78.29% <ø> (ø)`
lightning/src/ln/channel.rs	`89.36% <ø> (ø)`
lightning/src/ln/functional_test_utils.rs	`92.48% <ø> (-0.03%)`	⬇️
lightning/src/ln/outbound_payment.rs	`90.25% <54.54%> (-0.51%)`	⬇️
lightning/src/ln/channelmanager.rs	`88.85% <91.66%> (-0.02%)`	⬇️
lightning/src/ln/functional_tests.rs	`98.22% <100.00%> (-0.02%)`	⬇️
lightning/src/util/events.rs	`31.37% <100.00%> (+0.26%)`	⬆️

... and 8 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

TheBlueMatt

One nit on the release notes otherwise lgtm.

tnull · 2023-03-10T12:26:35Z

I'm afraid this needs a rebase now that #2092 has been merged.

We now support automatic retries in ChannelManager and no longer support manual retries, so the field is useless.

No longer used since it is no longer used to construct PaymentPathFailed events

It's unused since it no longer inserts it into HTLCSource

dunxen

With changes, still LGTM.

0.0.115 - Apr 24, 2023 - "Rebroadcast the Bugfixes" API Updates =========== * The MSRV of the main LDK crates has been increased to 1.48 (lightningdevkit#2107). * Attempting to claim an un-expired payment on a channel which has closed no longer fails. The expiry time of payments is exposed via `PaymentClaimable::claim_deadline` (lightningdevkit#2148). * `payment_metadata` is now supported in `Invoice` deserialization, sending, and receiving (via a new `RecipientOnionFields` struct) (lightningdevkit#2139, lightningdevkit#2127). * `Event::PaymentFailed` now exposes a failure reason (lightningdevkit#2142). * BOLT12 messages now support stateless generation and validation (lightningdevkit#1989). * The `NetworkGraph` is now pruned of stale data after RGS processing (lightningdevkit#2161). * Max inbound HTLCs in-flight can be changed in the handshake config (lightningdevkit#2138). * `lightning-transaction-sync` feature `esplora-async-https` was added (lightningdevkit#2085). * A `ChannelPending` event is now emitted after the initial handshake (lightningdevkit#2098). * `PaymentForwarded::outbound_amount_forwarded_msat` was added (lightningdevkit#2136). * `ChannelManager::list_channels_by_counterparty` was added (lightningdevkit#2079). * `ChannelDetails::feerate_sat_per_1000_weight` was added (lightningdevkit#2094). * `Invoice::fallback_addresses` was added to fetch `bitcoin` types (lightningdevkit#2023). * The offer/refund description is now exposed in `Invoice{,Request}` (lightningdevkit#2206). Backwards Compatibility ======================= * Payments sent with the legacy `*_with_route` methods on LDK 0.0.115+ will no longer be retryable via the LDK 0.0.114- `retry_payment` method (lightningdevkit#2139). * `Event::PaymentPathFailed::retry` was removed and will always be `None` for payments initiated on 0.0.115 which fail on an earlier version (lightningdevkit#2063). * `Route`s and `PaymentParameters` with blinded path information will not be readable on prior versions of LDK. Such objects are not currently constructed by LDK, but may be when processing BOLT12 data in a coming release (lightningdevkit#2146). * Providing `ChannelMonitorUpdate`s generated by LDK 0.0.115 to a `ChannelMonitor` on 0.0.114 or before may panic (lightningdevkit#2059). Note that this is in general unsupported, and included here only for completeness. Bug Fixes ========= * Fixed a case where `process_events_async` may `poll` a `Future` which has already completed (lightningdevkit#2081). * Fixed deserialization of `u16` arrays. This bug may have previously corrupted the historical buckets in a `ProbabilisticScorer`. Users relying on the historical buckets may wish to wipe their scorer on upgrade to remove corrupt data rather than waiting on it to decay (lightningdevkit#2191). * The `process_events_async` task is now `Send` and can thus be polled on a multi-threaded runtime (lightningdevkit#2199). * Fixed a missing macro export causing `impl_writeable_tlv_based_enum{,_upgradable}` calls to not compile (lightningdevkit#2091). * Fixed compilation of `lightning-invoice` with both `no-std` and serde (lightningdevkit#2187) * Fix an issue where the `background-processor` would not wake when a `ChannelMonitorUpdate` completed asynchronously, causing delays (lightningdevkit#2090). * Fix an issue where `process_events_async` would exit immediately (lightningdevkit#2145). * `Router` calls from the `ChannelManager` now call `find_route_with_id` rather than `find_route`, as was intended and described in the API (lightningdevkit#2092). * Ensure `process_events_async` always exits if any sleep future returns true, not just if all sleep futures repeatedly return true (lightningdevkit#2145). * `channel_update` messages no longer set the disable bit unless the peer has been disconnected for some time. This should resolve cases where channels are disabled for extended periods of time (lightningdevkit#2198). * We no longer remove CLN nodes from the network graph for violating the BOLT spec in some cases after failing to pay through them (lightningdevkit#2220). * Fixed a debug assertion which may panic under heavy load (lightningdevkit#2172). * `CounterpartyForceClosed::peer_msg` is now wrapped in UntrustedString (lightningdevkit#2114) * Fixed a potential deadlock in `funding_transaction_generated` (lightningdevkit#2158). Security ======== * Transaction re-broadcasting is now substantially more aggressive, including a new regular rebroadcast feature called on a timer from the `background-processor` or from `ChainMonitor::rebroadcast_pending_claims`. This should substantially increase transaction confirmation reliability without relying on downstream `TransactionBroadcaster` implementations for rebroadcasting (lightningdevkit#2203, lightningdevkit#2205, lightningdevkit#2208). * Implemented the changes from BOLT PRs lightningdevkit#1031, lightningdevkit#1032, and lightningdevkit#1040 which resolve a privacy vulnerability which allows an intermediate node on the path to discover the final destination for a payment (lightningdevkit#2062). In total, this release features 110 files changed, 11928 insertions, 6368 deletions in 215 commits from 21 authors, in alphabetical order: * Advait * Alan Cohen * Alec Chen * Allan Douglas R. de Oliveira * Arik Sosman * Elias Rohrer * Evan Feenstra * Jeffrey Czyz * John Cantrell * Lucas Soriano del Pino * Marc Tyndel * Matt Corallo * Paul Miller * Steven * Steven Williamson * Steven Zhao * Tony Giorgio * Valentine Wallace * Wilmer Paulino * benthecarman * munjesi

valentinewallace · 2023-03-01T17:16:18Z

PaymentPathFailed::retry is no longer useful since we removed support for manual payment retries.

Closes#1932.

release note

TheBlueMatt · 2023-03-07T17:52:37Z

- }
-
- if payment_is_probe || !is_retryable_now || !payment_retryable || retry.is_none() {
+ if payment_is_probe || !is_retryable_now || !payment_retryable {


While I'm not sure its reachable today, if we somehow are missing a payment_params in our PendingOutboundPayment::Retryable we'll end up with a stuck payment here - check_retry_payments will ignore it cause it checks for the Some but we wont fail it here.
I remain kinda annoyed at how brittle this code is and how easy its going to be to add leaks in the future. Not sure what to do about it, just annoyed.
Let's maybe move the payment_params check into is_auto_retryable_now and also add some debug assertions on the retry path to make sure we don't have an issue like this.

I'm still looking for other debug assertions you may be thinking of (maybe something at the end of check_retry_payments to check for stuck payments?) but updated

codecov-commenter · 2023-03-08T19:48:14Z

Codecov Report

Patch coverage: 82.50% and project coverage change: -0.01⚠️

Comparison is base (23c1b46) 91.14% compared to head (f89b7d6) 91.14%.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files

@@ Coverage Diff @@## main #2063 +/- ##
==========================================
- Coverage 91.14% 91.14% -0.01% 
==========================================
Files 101 101 Lines 48888 48865 -23 Branches 48888 48865 -23 ==========================================
- Hits 44561 44540 -21 + Misses 4327 4325 -2

Impacted Files	Coverage Δ
lightning-background-processor/src/lib.rs	`78.29% <ø> (ø)`
lightning/src/ln/channel.rs	`89.36% <ø> (ø)`
lightning/src/ln/functional_test_utils.rs	`92.48% <ø> (-0.03%)`	⬇️
lightning/src/ln/outbound_payment.rs	`90.25% <54.54%> (-0.51%)`	⬇️
lightning/src/ln/channelmanager.rs	`88.85% <91.66%> (-0.02%)`	⬇️
lightning/src/ln/functional_tests.rs	`98.22% <100.00%> (-0.02%)`	⬇️
lightning/src/util/events.rs	`31.37% <100.00%> (+0.26%)`	⬆️

... and 8 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

TheBlueMatt

One nit on the release notes otherwise lgtm.

tnull · 2023-03-10T12:26:35Z

I'm afraid this needs a rebase now that #2092 has been merged.

We now support automatic retries in ChannelManager and no longer support manual retries, so the field is useless.

No longer used since it is no longer used to construct PaymentPathFailed events

It's unused since it no longer inserts it into HTLCSource

dunxen

With changes, still LGTM.

0.0.115 - Apr 24, 2023 - "Rebroadcast the Bugfixes" API Updates =========== * The MSRV of the main LDK crates has been increased to 1.48 (lightningdevkit#2107). * Attempting to claim an un-expired payment on a channel which has closed no longer fails. The expiry time of payments is exposed via `PaymentClaimable::claim_deadline` (lightningdevkit#2148). * `payment_metadata` is now supported in `Invoice` deserialization, sending, and receiving (via a new `RecipientOnionFields` struct) (lightningdevkit#2139, lightningdevkit#2127). * `Event::PaymentFailed` now exposes a failure reason (lightningdevkit#2142). * BOLT12 messages now support stateless generation and validation (lightningdevkit#1989). * The `NetworkGraph` is now pruned of stale data after RGS processing (lightningdevkit#2161). * Max inbound HTLCs in-flight can be changed in the handshake config (lightningdevkit#2138). * `lightning-transaction-sync` feature `esplora-async-https` was added (lightningdevkit#2085). * A `ChannelPending` event is now emitted after the initial handshake (lightningdevkit#2098). * `PaymentForwarded::outbound_amount_forwarded_msat` was added (lightningdevkit#2136). * `ChannelManager::list_channels_by_counterparty` was added (lightningdevkit#2079). * `ChannelDetails::feerate_sat_per_1000_weight` was added (lightningdevkit#2094). * `Invoice::fallback_addresses` was added to fetch `bitcoin` types (lightningdevkit#2023). * The offer/refund description is now exposed in `Invoice{,Request}` (lightningdevkit#2206). Backwards Compatibility ======================= * Payments sent with the legacy `*_with_route` methods on LDK 0.0.115+ will no longer be retryable via the LDK 0.0.114- `retry_payment` method (lightningdevkit#2139). * `Event::PaymentPathFailed::retry` was removed and will always be `None` for payments initiated on 0.0.115 which fail on an earlier version (lightningdevkit#2063). * `Route`s and `PaymentParameters` with blinded path information will not be readable on prior versions of LDK. Such objects are not currently constructed by LDK, but may be when processing BOLT12 data in a coming release (lightningdevkit#2146). * Providing `ChannelMonitorUpdate`s generated by LDK 0.0.115 to a `ChannelMonitor` on 0.0.114 or before may panic (lightningdevkit#2059). Note that this is in general unsupported, and included here only for completeness. Bug Fixes ========= * Fixed a case where `process_events_async` may `poll` a `Future` which has already completed (lightningdevkit#2081). * Fixed deserialization of `u16` arrays. This bug may have previously corrupted the historical buckets in a `ProbabilisticScorer`. Users relying on the historical buckets may wish to wipe their scorer on upgrade to remove corrupt data rather than waiting on it to decay (lightningdevkit#2191). * The `process_events_async` task is now `Send` and can thus be polled on a multi-threaded runtime (lightningdevkit#2199). * Fixed a missing macro export causing `impl_writeable_tlv_based_enum{,_upgradable}` calls to not compile (lightningdevkit#2091). * Fixed compilation of `lightning-invoice` with both `no-std` and serde (lightningdevkit#2187) * Fix an issue where the `background-processor` would not wake when a `ChannelMonitorUpdate` completed asynchronously, causing delays (lightningdevkit#2090). * Fix an issue where `process_events_async` would exit immediately (lightningdevkit#2145). * `Router` calls from the `ChannelManager` now call `find_route_with_id` rather than `find_route`, as was intended and described in the API (lightningdevkit#2092). * Ensure `process_events_async` always exits if any sleep future returns true, not just if all sleep futures repeatedly return true (lightningdevkit#2145). * `channel_update` messages no longer set the disable bit unless the peer has been disconnected for some time. This should resolve cases where channels are disabled for extended periods of time (lightningdevkit#2198). * We no longer remove CLN nodes from the network graph for violating the BOLT spec in some cases after failing to pay through them (lightningdevkit#2220). * Fixed a debug assertion which may panic under heavy load (lightningdevkit#2172). * `CounterpartyForceClosed::peer_msg` is now wrapped in UntrustedString (lightningdevkit#2114) * Fixed a potential deadlock in `funding_transaction_generated` (lightningdevkit#2158). Security ======== * Transaction re-broadcasting is now substantially more aggressive, including a new regular rebroadcast feature called on a timer from the `background-processor` or from `ChainMonitor::rebroadcast_pending_claims`. This should substantially increase transaction confirmation reliability without relying on downstream `TransactionBroadcaster` implementations for rebroadcasting (lightningdevkit#2203, lightningdevkit#2205, lightningdevkit#2208). * Implemented the changes from BOLT PRs lightningdevkit#1031, lightningdevkit#1032, and lightningdevkit#1040 which resolve a privacy vulnerability which allows an intermediate node on the path to discover the final destination for a payment (lightningdevkit#2062). In total, this release features 110 files changed, 11928 insertions, 6368 deletions in 215 commits from 21 authors, in alphabetical order: * Advait * Alan Cohen * Alec Chen * Allan Douglas R. de Oliveira * Arik Sosman * Elias Rohrer * Evan Feenstra * Jeffrey Czyz * John Cantrell * Lucas Soriano del Pino * Marc Tyndel * Matt Corallo * Paul Miller * Steven * Steven Williamson * Steven Zhao * Tony Giorgio * Valentine Wallace * Wilmer Paulino * benthecarman * munjesi

valentinewallace · 2023-03-01T17:16:18Z

PaymentPathFailed::retry is no longer useful since we removed support for manual payment retries.

Closes#1932.

release note

TheBlueMatt · 2023-03-07T17:52:37Z

- }
-
- if payment_is_probe || !is_retryable_now || !payment_retryable || retry.is_none() {
+ if payment_is_probe || !is_retryable_now || !payment_retryable {


While I'm not sure its reachable today, if we somehow are missing a payment_params in our PendingOutboundPayment::Retryable we'll end up with a stuck payment here - check_retry_payments will ignore it cause it checks for the Some but we wont fail it here.
I remain kinda annoyed at how brittle this code is and how easy its going to be to add leaks in the future. Not sure what to do about it, just annoyed.
Let's maybe move the payment_params check into is_auto_retryable_now and also add some debug assertions on the retry path to make sure we don't have an issue like this.

I'm still looking for other debug assertions you may be thinking of (maybe something at the end of check_retry_payments to check for stuck payments?) but updated

codecov-commenter · 2023-03-08T19:48:14Z

Codecov Report

Patch coverage: 82.50% and project coverage change: -0.01⚠️

Comparison is base (23c1b46) 91.14% compared to head (f89b7d6) 91.14%.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files

@@ Coverage Diff @@## main #2063 +/- ##
==========================================
- Coverage 91.14% 91.14% -0.01% 
==========================================
Files 101 101 Lines 48888 48865 -23 Branches 48888 48865 -23 ==========================================
- Hits 44561 44540 -21 + Misses 4327 4325 -2

Impacted Files	Coverage Δ
lightning-background-processor/src/lib.rs	`78.29% <ø> (ø)`
lightning/src/ln/channel.rs	`89.36% <ø> (ø)`
lightning/src/ln/functional_test_utils.rs	`92.48% <ø> (-0.03%)`	⬇️
lightning/src/ln/outbound_payment.rs	`90.25% <54.54%> (-0.51%)`	⬇️
lightning/src/ln/channelmanager.rs	`88.85% <91.66%> (-0.02%)`	⬇️
lightning/src/ln/functional_tests.rs	`98.22% <100.00%> (-0.02%)`	⬇️
lightning/src/util/events.rs	`31.37% <100.00%> (+0.26%)`	⬆️

... and 8 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

TheBlueMatt

One nit on the release notes otherwise lgtm.

tnull · 2023-03-10T12:26:35Z

I'm afraid this needs a rebase now that #2092 has been merged.

We now support automatic retries in ChannelManager and no longer support manual retries, so the field is useless.

No longer used since it is no longer used to construct PaymentPathFailed events

It's unused since it no longer inserts it into HTLCSource

dunxen

With changes, still LGTM.

0.0.115 - Apr 24, 2023 - "Rebroadcast the Bugfixes" API Updates =========== * The MSRV of the main LDK crates has been increased to 1.48 (lightningdevkit#2107). * Attempting to claim an un-expired payment on a channel which has closed no longer fails. The expiry time of payments is exposed via `PaymentClaimable::claim_deadline` (lightningdevkit#2148). * `payment_metadata` is now supported in `Invoice` deserialization, sending, and receiving (via a new `RecipientOnionFields` struct) (lightningdevkit#2139, lightningdevkit#2127). * `Event::PaymentFailed` now exposes a failure reason (lightningdevkit#2142). * BOLT12 messages now support stateless generation and validation (lightningdevkit#1989). * The `NetworkGraph` is now pruned of stale data after RGS processing (lightningdevkit#2161). * Max inbound HTLCs in-flight can be changed in the handshake config (lightningdevkit#2138). * `lightning-transaction-sync` feature `esplora-async-https` was added (lightningdevkit#2085). * A `ChannelPending` event is now emitted after the initial handshake (lightningdevkit#2098). * `PaymentForwarded::outbound_amount_forwarded_msat` was added (lightningdevkit#2136). * `ChannelManager::list_channels_by_counterparty` was added (lightningdevkit#2079). * `ChannelDetails::feerate_sat_per_1000_weight` was added (lightningdevkit#2094). * `Invoice::fallback_addresses` was added to fetch `bitcoin` types (lightningdevkit#2023). * The offer/refund description is now exposed in `Invoice{,Request}` (lightningdevkit#2206). Backwards Compatibility ======================= * Payments sent with the legacy `*_with_route` methods on LDK 0.0.115+ will no longer be retryable via the LDK 0.0.114- `retry_payment` method (lightningdevkit#2139). * `Event::PaymentPathFailed::retry` was removed and will always be `None` for payments initiated on 0.0.115 which fail on an earlier version (lightningdevkit#2063). * `Route`s and `PaymentParameters` with blinded path information will not be readable on prior versions of LDK. Such objects are not currently constructed by LDK, but may be when processing BOLT12 data in a coming release (lightningdevkit#2146). * Providing `ChannelMonitorUpdate`s generated by LDK 0.0.115 to a `ChannelMonitor` on 0.0.114 or before may panic (lightningdevkit#2059). Note that this is in general unsupported, and included here only for completeness. Bug Fixes ========= * Fixed a case where `process_events_async` may `poll` a `Future` which has already completed (lightningdevkit#2081). * Fixed deserialization of `u16` arrays. This bug may have previously corrupted the historical buckets in a `ProbabilisticScorer`. Users relying on the historical buckets may wish to wipe their scorer on upgrade to remove corrupt data rather than waiting on it to decay (lightningdevkit#2191). * The `process_events_async` task is now `Send` and can thus be polled on a multi-threaded runtime (lightningdevkit#2199). * Fixed a missing macro export causing `impl_writeable_tlv_based_enum{,_upgradable}` calls to not compile (lightningdevkit#2091). * Fixed compilation of `lightning-invoice` with both `no-std` and serde (lightningdevkit#2187) * Fix an issue where the `background-processor` would not wake when a `ChannelMonitorUpdate` completed asynchronously, causing delays (lightningdevkit#2090). * Fix an issue where `process_events_async` would exit immediately (lightningdevkit#2145). * `Router` calls from the `ChannelManager` now call `find_route_with_id` rather than `find_route`, as was intended and described in the API (lightningdevkit#2092). * Ensure `process_events_async` always exits if any sleep future returns true, not just if all sleep futures repeatedly return true (lightningdevkit#2145). * `channel_update` messages no longer set the disable bit unless the peer has been disconnected for some time. This should resolve cases where channels are disabled for extended periods of time (lightningdevkit#2198). * We no longer remove CLN nodes from the network graph for violating the BOLT spec in some cases after failing to pay through them (lightningdevkit#2220). * Fixed a debug assertion which may panic under heavy load (lightningdevkit#2172). * `CounterpartyForceClosed::peer_msg` is now wrapped in UntrustedString (lightningdevkit#2114) * Fixed a potential deadlock in `funding_transaction_generated` (lightningdevkit#2158). Security ======== * Transaction re-broadcasting is now substantially more aggressive, including a new regular rebroadcast feature called on a timer from the `background-processor` or from `ChainMonitor::rebroadcast_pending_claims`. This should substantially increase transaction confirmation reliability without relying on downstream `TransactionBroadcaster` implementations for rebroadcasting (lightningdevkit#2203, lightningdevkit#2205, lightningdevkit#2208). * Implemented the changes from BOLT PRs lightningdevkit#1031, lightningdevkit#1032, and lightningdevkit#1040 which resolve a privacy vulnerability which allows an intermediate node on the path to discover the final destination for a payment (lightningdevkit#2062). In total, this release features 110 files changed, 11928 insertions, 6368 deletions in 215 commits from 21 authors, in alphabetical order: * Advait * Alan Cohen * Alec Chen * Allan Douglas R. de Oliveira * Arik Sosman * Elias Rohrer * Evan Feenstra * Jeffrey Czyz * John Cantrell * Lucas Soriano del Pino * Marc Tyndel * Matt Corallo * Paul Miller * Steven * Steven Williamson * Steven Zhao * Tony Giorgio * Valentine Wallace * Wilmer Paulino * benthecarman * munjesi

valentinewallace · 2023-03-01T17:16:18Z

PaymentPathFailed::retry is no longer useful since we removed support for manual payment retries.

Closes#1932.

release note

TheBlueMatt · 2023-03-07T17:52:37Z

- }
-
- if payment_is_probe || !is_retryable_now || !payment_retryable || retry.is_none() {
+ if payment_is_probe || !is_retryable_now || !payment_retryable {


While I'm not sure its reachable today, if we somehow are missing a payment_params in our PendingOutboundPayment::Retryable we'll end up with a stuck payment here - check_retry_payments will ignore it cause it checks for the Some but we wont fail it here.
I remain kinda annoyed at how brittle this code is and how easy its going to be to add leaks in the future. Not sure what to do about it, just annoyed.
Let's maybe move the payment_params check into is_auto_retryable_now and also add some debug assertions on the retry path to make sure we don't have an issue like this.

I'm still looking for other debug assertions you may be thinking of (maybe something at the end of check_retry_payments to check for stuck payments?) but updated

codecov-commenter · 2023-03-08T19:48:14Z

Codecov Report

Patch coverage: 82.50% and project coverage change: -0.01⚠️

Comparison is base (23c1b46) 91.14% compared to head (f89b7d6) 91.14%.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files

@@ Coverage Diff @@## main #2063 +/- ##
==========================================
- Coverage 91.14% 91.14% -0.01% 
==========================================
Files 101 101 Lines 48888 48865 -23 Branches 48888 48865 -23 ==========================================
- Hits 44561 44540 -21 + Misses 4327 4325 -2

Impacted Files	Coverage Δ
lightning-background-processor/src/lib.rs	`78.29% <ø> (ø)`
lightning/src/ln/channel.rs	`89.36% <ø> (ø)`
lightning/src/ln/functional_test_utils.rs	`92.48% <ø> (-0.03%)`	⬇️
lightning/src/ln/outbound_payment.rs	`90.25% <54.54%> (-0.51%)`	⬇️
lightning/src/ln/channelmanager.rs	`88.85% <91.66%> (-0.02%)`	⬇️
lightning/src/ln/functional_tests.rs	`98.22% <100.00%> (-0.02%)`	⬇️
lightning/src/util/events.rs	`31.37% <100.00%> (+0.26%)`	⬆️

... and 8 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

TheBlueMatt

One nit on the release notes otherwise lgtm.

tnull · 2023-03-10T12:26:35Z

I'm afraid this needs a rebase now that #2092 has been merged.

We now support automatic retries in ChannelManager and no longer support manual retries, so the field is useless.

No longer used since it is no longer used to construct PaymentPathFailed events

It's unused since it no longer inserts it into HTLCSource

dunxen

With changes, still LGTM.

0.0.115 - Apr 24, 2023 - "Rebroadcast the Bugfixes" API Updates =========== * The MSRV of the main LDK crates has been increased to 1.48 (lightningdevkit#2107). * Attempting to claim an un-expired payment on a channel which has closed no longer fails. The expiry time of payments is exposed via `PaymentClaimable::claim_deadline` (lightningdevkit#2148). * `payment_metadata` is now supported in `Invoice` deserialization, sending, and receiving (via a new `RecipientOnionFields` struct) (lightningdevkit#2139, lightningdevkit#2127). * `Event::PaymentFailed` now exposes a failure reason (lightningdevkit#2142). * BOLT12 messages now support stateless generation and validation (lightningdevkit#1989). * The `NetworkGraph` is now pruned of stale data after RGS processing (lightningdevkit#2161). * Max inbound HTLCs in-flight can be changed in the handshake config (lightningdevkit#2138). * `lightning-transaction-sync` feature `esplora-async-https` was added (lightningdevkit#2085). * A `ChannelPending` event is now emitted after the initial handshake (lightningdevkit#2098). * `PaymentForwarded::outbound_amount_forwarded_msat` was added (lightningdevkit#2136). * `ChannelManager::list_channels_by_counterparty` was added (lightningdevkit#2079). * `ChannelDetails::feerate_sat_per_1000_weight` was added (lightningdevkit#2094). * `Invoice::fallback_addresses` was added to fetch `bitcoin` types (lightningdevkit#2023). * The offer/refund description is now exposed in `Invoice{,Request}` (lightningdevkit#2206). Backwards Compatibility ======================= * Payments sent with the legacy `*_with_route` methods on LDK 0.0.115+ will no longer be retryable via the LDK 0.0.114- `retry_payment` method (lightningdevkit#2139). * `Event::PaymentPathFailed::retry` was removed and will always be `None` for payments initiated on 0.0.115 which fail on an earlier version (lightningdevkit#2063). * `Route`s and `PaymentParameters` with blinded path information will not be readable on prior versions of LDK. Such objects are not currently constructed by LDK, but may be when processing BOLT12 data in a coming release (lightningdevkit#2146). * Providing `ChannelMonitorUpdate`s generated by LDK 0.0.115 to a `ChannelMonitor` on 0.0.114 or before may panic (lightningdevkit#2059). Note that this is in general unsupported, and included here only for completeness. Bug Fixes ========= * Fixed a case where `process_events_async` may `poll` a `Future` which has already completed (lightningdevkit#2081). * Fixed deserialization of `u16` arrays. This bug may have previously corrupted the historical buckets in a `ProbabilisticScorer`. Users relying on the historical buckets may wish to wipe their scorer on upgrade to remove corrupt data rather than waiting on it to decay (lightningdevkit#2191). * The `process_events_async` task is now `Send` and can thus be polled on a multi-threaded runtime (lightningdevkit#2199). * Fixed a missing macro export causing `impl_writeable_tlv_based_enum{,_upgradable}` calls to not compile (lightningdevkit#2091). * Fixed compilation of `lightning-invoice` with both `no-std` and serde (lightningdevkit#2187) * Fix an issue where the `background-processor` would not wake when a `ChannelMonitorUpdate` completed asynchronously, causing delays (lightningdevkit#2090). * Fix an issue where `process_events_async` would exit immediately (lightningdevkit#2145). * `Router` calls from the `ChannelManager` now call `find_route_with_id` rather than `find_route`, as was intended and described in the API (lightningdevkit#2092). * Ensure `process_events_async` always exits if any sleep future returns true, not just if all sleep futures repeatedly return true (lightningdevkit#2145). * `channel_update` messages no longer set the disable bit unless the peer has been disconnected for some time. This should resolve cases where channels are disabled for extended periods of time (lightningdevkit#2198). * We no longer remove CLN nodes from the network graph for violating the BOLT spec in some cases after failing to pay through them (lightningdevkit#2220). * Fixed a debug assertion which may panic under heavy load (lightningdevkit#2172). * `CounterpartyForceClosed::peer_msg` is now wrapped in UntrustedString (lightningdevkit#2114) * Fixed a potential deadlock in `funding_transaction_generated` (lightningdevkit#2158). Security ======== * Transaction re-broadcasting is now substantially more aggressive, including a new regular rebroadcast feature called on a timer from the `background-processor` or from `ChainMonitor::rebroadcast_pending_claims`. This should substantially increase transaction confirmation reliability without relying on downstream `TransactionBroadcaster` implementations for rebroadcasting (lightningdevkit#2203, lightningdevkit#2205, lightningdevkit#2208). * Implemented the changes from BOLT PRs lightningdevkit#1031, lightningdevkit#1032, and lightningdevkit#1040 which resolve a privacy vulnerability which allows an intermediate node on the path to discover the final destination for a payment (lightningdevkit#2062). In total, this release features 110 files changed, 11928 insertions, 6368 deletions in 215 commits from 21 authors, in alphabetical order: * Advait * Alan Cohen * Alec Chen * Allan Douglas R. de Oliveira * Arik Sosman * Elias Rohrer * Evan Feenstra * Jeffrey Czyz * John Cantrell * Lucas Soriano del Pino * Marc Tyndel * Matt Corallo * Paul Miller * Steven * Steven Williamson * Steven Zhao * Tony Giorgio * Valentine Wallace * Wilmer Paulino * benthecarman * munjesi

valentinewallace added this to the 0.0.115 milestone Mar 1, 2023

valentinewallace force-pushed the 2023-03-remove-paymentpathfailed-retry branch from 1dffe11 to c3b9d03Compare March 1, 2023 21:36

dunxen previously approved these changes Mar 6, 2023
View reviewed changes

tnull reviewed Mar 6, 2023
View reviewed changes

Comment threadlightning/src/util/events.rs

TheBlueMatt reviewed Mar 7, 2023
View reviewed changes

valentinewallace dismissed dunxen’s stale review via 69954bcMarch 8, 2023 19:09

valentinewallace force-pushed the 2023-03-remove-paymentpathfailed-retry branch from c3b9d03 to 69954bcCompare March 8, 2023 19:09

TheBlueMatt reviewed Mar 8, 2023
View reviewed changes

Comment threadlightning/src/ln/outbound_payment.rs Outdated

valentinewallace force-pushed the 2023-03-remove-paymentpathfailed-retry branch from 69954bc to e72a838Compare March 8, 2023 19:47

TheBlueMatt reviewed Mar 8, 2023
View reviewed changes

Comment threadlightning/src/ln/outbound_payment.rs Outdated

valentinewallace force-pushed the 2023-03-remove-paymentpathfailed-retry branch from e72a838 to 892de29Compare March 8, 2023 19:59

TheBlueMatt previously approved these changes Mar 8, 2023
View reviewed changes

Comment threadpending_changelog/2063.txt Outdated

tnull previously approved these changes Mar 9, 2023
View reviewed changes

valentinewallace dismissed stale reviews from tnull and TheBlueMatt via cf21416March 9, 2023 16:18

valentinewallace force-pushed the 2023-03-remove-paymentpathfailed-retry branch from 892de29 to cf21416Compare March 9, 2023 16:18

TheBlueMatt previously approved these changes Mar 9, 2023
View reviewed changes

valentinewallace added 4 commits March 13, 2023 11:59

Remove PaymentPathFailed::retry
753e4ce
We now support automatic retries in ChannelManager and no longer support manual retries, so the field is useless.

Remove HTLCSource::OutboundRoute::payment_params
2939649
No longer used since it is no longer used to construct PaymentPathFailed events

Remove payment_params from send_payent_along_path
f6823c5
It's unused since it no longer inserts it into HTLCSource

Ensure payment_params present when checking is_retryable_now
f89b7d6

valentinewallace dismissed TheBlueMatt’s stale review via f89b7d6March 13, 2023 16:05

valentinewallace force-pushed the 2023-03-remove-paymentpathfailed-retry branch from cf21416 to f89b7d6Compare March 13, 2023 16:05

TheBlueMatt assigned tnull, TheBlueMatt and dunxen Mar 13, 2023

dunxen approved these changes Mar 13, 2023
View reviewed changes

TheBlueMatt approved these changes Mar 13, 2023
View reviewed changes

TheBlueMatt merged commit 54f8895 into lightningdevkit:mainMar 13, 2023