Multi-Hop Route Hint now considered. Added in unit tests for same. by abhik-99 · Pull Request #1040 · lightningdevkit/rust-lightning

abhik-99 · 2021-08-09T15:09:36Z

This PR solves Issue #945 which deals with using multi-hop route hints from the invoice from payee. Previous behaviour was to only consider the last route hop hint per route. This PR solves the problems with PR #1030 and also includes the unit tests for testing out the Route Hint in a multi-hop setup.

Edit: Commit 914c159 solves a previously failing test where the channel capacity was calculated to be 0 which skipped certain hints.

Edit: The above has been squashed into fd4d3f

codecov · 2021-08-09T15:37:36Z

Codecov Report

Merging #1040 (4c5526b) into main (8530078) will increase coverage by 0.05%.
The diff coverage is 99.56%.

❗ Current head 4c5526b differs from pull request most recent head fd4d3bf. Consider uploading reports for the commit fd4d3bf to get more accurate results

@@ Coverage Diff @@## main #1040 +/- ##
==========================================
+ Coverage 90.80% 90.85% +0.05% 
==========================================
Files 61 65 +4 Lines 31582 33128 +1546 ==========================================
+ Hits 28678 30100 +1422 - Misses 2904 3028 +124

Impacted Files	Coverage Δ
lightning/src/routing/router.rs	`96.34% <99.56%> (+0.40%)`	⬆️
lightning/src/util/ser_macros.rs	`87.90% <0.00%> (-8.42%)`	⬇️
lightning/src/util/errors.rs	`67.30% <0.00%> (-4.13%)`	⬇️
lightning-background-processor/src/lib.rs	`93.93% <0.00%> (-1.65%)`	⬇️
lightning/src/util/enforcing_trait_impls.rs	`89.28% <0.00%> (-1.10%)`	⬇️
lightning/src/chain/keysinterface.rs	`94.68% <0.00%> (-0.68%)`	⬇️
lightning/src/ln/channel.rs	`88.73% <0.00%> (-0.50%)`	⬇️
lightning-net-tokio/src/lib.rs	`76.98% <0.00%> (-0.38%)`	⬇️
lightning/src/util/test_utils.rs	`82.33% <0.00%> (-0.22%)`	⬇️
lightning/src/ln/peer_handler.rs	`45.78% <0.00%> (-0.20%)`	⬇️
... and 18 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8530078...fd4d3bf. Read the comment docs.

TheBlueMatt

This is a lot less logic to review compared to the last version, thanks. Makes it much easier to find bugs when there's fewer branches and ifs in the code :).

jkczyz

Just some minor comments for now. Will do a more thorough review once you push your most recent changes.

TheBlueMatt

This is looking pretty good.

jkczyz

Getting late. Will take a close look at the tests tomorrow.

jkczyz

Noted some more ways to clean up the code and tests IIUC what's being tested (see comments). There's also some earlier comments that have not yet been addressed. Could you go through to get everything that was missed?

abhik-99 · 2021-08-23T14:34:17Z

@TheBlueMatt and @jkczyz any more suggestions?

TheBlueMatt

A few hiccups, but ACK aside from the comments.

TheBlueMatt

This LGTM. It'll need a second reviewers' ACK. Once a second reviewer ACKs, you'll also need to squash down the commits to not have any commits which, on their own, leave things either failing tests, or otherwise in an intermediary state. For this PR, that probably means squashing it all down into one commit, unless you want to put the new tests in a separate one.

TheBlueMatt · 2021-08-30T17:12:28Z

Cool! Can you squash the commits down to not have fixes in followup commits? https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md#squashing-commits should be helpful if you have never done this.

Bolt 12 details the process of picking up route hints from payee using the lightning invoice. This PR brings the changes to use multiple route hints from payee picked from the invoice. The route hints are processed in the following manner:- - `get_route()` receives the hints in `last_hops`. - Every `RouteHintHop` in `RouteHint` is processed based on feasiblity of channel capacity and fees. - If a `RouteHintHop` then preceeding `RouteHintHop`s are not processed. - A direct route is checked from `first_hops_targets` to the first `RouteHintHop` if the respective `RouteHint` is processed from the payee's end till the first `RouteHintHop`. `partial_route_hint_test`, `ignores_empty_last_hops_test`, `multi_hint_last_hops_test` and `last_hops_with_public_channel_test` test usage of partial route hints for building optimal route, processing empty route hint hops, complete usage of private route hints and presence of public channels in route hints respectively. Resolves: lightningdevkit#945

jkczyz · 2021-08-31T17:48:37Z

ACK fd4d3bf

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

jkczyz self-requested a review August 9, 2021 15:10

TheBlueMatt reviewed Aug 10, 2021
View reviewed changes

abhik-99 requested a review from TheBlueMatt August 10, 2021 08:45

TheBlueMatt reviewed Aug 10, 2021
View reviewed changes

jkczyz reviewed Aug 11, 2021
View reviewed changes

Comment threadlightning/src/routing/router.rs Outdated
Comment threadlightning/src/routing/router.rs Outdated
Comment threadlightning/src/routing/router.rs Outdated
Comment threadlightning/src/routing/router.rs Outdated
Comment threadlightning/src/routing/router.rs Outdated

TheBlueMatt reviewed Aug 16, 2021
View reviewed changes

Comment threadlightning/src/routing/router.rs Outdated
Comment threadlightning/src/routing/router.rs Outdated
Comment threadlightning/src/routing/router.rs Outdated

abhik-99 requested review from TheBlueMatt and jkczyz August 17, 2021 17:37

jkczyz reviewed Aug 18, 2021
View reviewed changes

Comment threadlightning/src/routing/router.rs
Comment threadlightning/src/routing/router.rs Outdated
Comment threadlightning/src/routing/router.rs Outdated

jkczyz reviewed Aug 19, 2021
View reviewed changes

jkczyz reviewed Aug 20, 2021
View reviewed changes

Comment threadlightning/src/routing/router.rs Outdated
Comment threadlightning/src/routing/router.rs
Comment threadlightning/src/routing/router.rs Outdated
Comment thread.gitignore
Comment threadlightning/src/routing/router.rs Outdated

abhik-99 requested a review from jkczyz August 20, 2021 15:23

TheBlueMatt reviewed Aug 24, 2021
View reviewed changes

Comment threadlightning/src/routing/router.rs Outdated
Comment threadlightning/src/routing/router.rs Outdated
Comment threadlightning/src/routing/router.rs Outdated
Comment threadlightning/src/routing/router.rs

TheBlueMatt approved these changes Aug 27, 2021
View reviewed changes

jkczyz approved these changes Aug 30, 2021
View reviewed changes

Comment threadlightning/src/routing/router.rs Outdated

abhik-99 force-pushed the Issue#945 branch from 4c5526b to fd4d3bfCompare August 31, 2021 05:52

TheBlueMatt merged commit a265f1e into lightningdevkit:mainAug 31, 2021

Uh oh!

Conversation

abhik-99 commented Aug 9, 2021• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecovBot commented Aug 9, 2021• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

TheBlueMatt left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jkczyz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

TheBlueMatt left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jkczyz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jkczyz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

abhik-99 commented Aug 23, 2021

Uh oh!

TheBlueMatt left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

TheBlueMatt left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

TheBlueMatt commented Aug 30, 2021

Uh oh!

jkczyz commented Aug 31, 2021

Uh oh!

Reviewers

Assignees

Labels

abhik-99 commented Aug 9, 2021•
edited
Loading

codecovBot commented Aug 9, 2021•
edited
Loading