Skip to content

Renepay use getroutes #8049

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Draft
wants to merge 22 commits into
base: master
Choose a base branch
from
Draft

Renepay use getroutes #8049

wants to merge 22 commits into from

Conversation

Lagrang3
Copy link
Collaborator

@Lagrang3 Lagrang3 commented Feb 4, 2025 •
edited
Loading

This PR removes the MCF code from renepay. Routes are computed using getroutes instead.

Depends on #7985 (merged)
Replaces #7633 (closed)
It would be nice to have on top of #7963 (closed) "temporary layers" and #8072 (merged) "bias stacking".

UPD.
Also #8129 (merged) "Big fake channels" would be nice to have.

@Lagrang3 Lagrang3 marked this pull request as draft February 4, 2025 08:58
@Lagrang3 Lagrang3 force-pushed the renepay-use-askrene branch 3 times, most recently from 1062510 to b2fcf5f Compare February 10, 2025 10:14
@Lagrang3 Lagrang3 force-pushed the renepay-use-askrene branch 3 times, most recently from ac2e0b1 to c2925cf Compare February 20, 2025 07:45
@Lagrang3 Lagrang3 force-pushed the renepay-use-askrene branch from 304bf67 to 313aecf Compare February 27, 2025 10:12
@Lagrang3
renepay: use getroutes
974600b 
Changelog-Added: renepay: use external call to [askrene-]getroutes instead of computing routes internally.

Signed-off-by: Lagrang3 <[email protected]>
@Lagrang3
renepay: hints using askrene
9ac2022 
Use askrene API to account for route-hints and blinded paths.

Changelog-None.

Signed-off-by: Lagrang3 <[email protected]>
@Lagrang3
renepay: add a global payment layer
9924a70 
Changelog-None.

Signed-off-by: Lagrang3 <[email protected]>
@Lagrang3
renepay: use askrene API for payment failures
91942b4 
The execution of the failure notification makes calls to askrene to
disable or bias channels that have returned weird errors.

Changelog-None.

Signed-off-by: Lagrang3 <[email protected]>
@Lagrang3
renepay: use askrene-age to relax knowledge
9cd868d 
Changelog-None.

Signed-off-by: Lagrang3 <[email protected]>
@Lagrang3
renepay: remove unnecessary rpc call
b9c824d 
Remove unnecessary rpc call to waitblockheight at the default payment's
ending.

Changelog-None.

Signed-off-by: Lagrang3 <[email protected]>
@Lagrang3
renepay: filter channels using askrene API
8252f5b 
Changelog-None.

Signed-off-by: Lagrang3 <[email protected]>
@Lagrang3
renepay: timer to remove payment layer after 1h
e7ad61c 
Changelog-None.

Signed-off-by: Lagrang3 <[email protected]>
@Lagrang3
renepay: remove MCF
1a3bc06 
Remove the MCF solver from renepay.
Offload the route computation on askrene.

Changelog-None

Signed-off-by: Lagrang3 <[email protected]>
@Lagrang3
renepay: add rpc batching utilities
b7d46c8 
Changelog-None

Signed-off-by: Lagrang3 <[email protected]>
@Lagrang3
renepay: use plugin_get_data API
2507a50 
Use plugin_get_data API and make less use of the access to the global
plugin state when possible.

Changelog-None

Signed-off-by: Lagrang3 <[email protected]>
@Lagrang3
renepay: use batches to send payment routes
2fddfba 
Sending requests with batches allow us to avoid race conditions
when the payment plugin goes to the next state before the sendpay RPC
have not yet completed.

Changelog-None

Signed-off-by: Lagrang3 <[email protected]>
@Lagrang3
renepay: reserve liquidity for routes
a797e00 
Use askrene-reserve API to lock-in the liquidity of the channels in use
for pending payment route.

Changelog-None

Signed-off-by: Lagrang3 <[email protected]>
@Lagrang3
renepay: unreserve completed routes
98e8fa0 
Use askrene-unreserve to remove reserved liquidity associated with
routes that have completed, either by success or failure.

Changelog-None

Signed-off-by: Lagrang3 <[email protected]>
@Lagrang3
renepay: refactor routefail functions
91abf5f 
Make extensive use of rpc batches so that we ensure all request have
been processed before the notification is closed as handled.

Changelog-None

Signed-off-by: Lagrang3 <[email protected]>
@Lagrang3
renepay: use askrene-inform-channel
45342a2 
Use askrene-inform-channel to update the knowledge of the liquidity when
a payment attempt fails.

Changelog-None

Signed-off-by: Lagrang3 <[email protected]>
@Lagrang3
renepay: split send routes into two steps
72cc777 
Splig send routes into two steps:
1. reserve liquidity,
2. call sendpay

Changelog-None

Signed-off-by: Lagrang3 <[email protected]>
@Lagrang3
renepay: define a new struct rpcaction
7f7d48e 
struct rpcaction: encapsulates the concept of an RPC action,
ie. an RPC call object.
It can be attached to an rpcbatch.

Changelog-None.

Signed-off-by: Lagrang3 <[email protected]>
@Lagrang3
renepay: use rpcActions to unreserve routes
4c815d2 
Calling askrene-unreserve using rpcActions.
Either:
- after geting a fail notification,
- or success notification,
- or if the route destructor is called.

Changelog-None

Signed-off-by: Lagrang3 <[email protected]>
@Lagrang3 Lagrang3 force-pushed the renepay-use-askrene branch 2 times, most recently from 2f08e74 to fbe8092 Compare March 4, 2025 07:07
@Lagrang3 Lagrang3 marked this pull request as ready for review March 4, 2025 07:08
@Lagrang3 Lagrang3 force-pushed the renepay-use-askrene branch 3 times, most recently from 3ea171c to a8edf18 Compare March 4, 2025 07:52
@Lagrang3 Lagrang3 requested a review from cdecker as a code owner March 5, 2025 06:43
@Lagrang3
Copy link
Collaborator Author

Lagrang3 commented Mar 5, 2025 •
edited
Loading

@rustyrussell: I would like to file a complain. The test "Update examples in doc schemas" is overzealous about the
command outputs. Now that I've added a new "renepay" persistent layer to askrene, we may have as result
of the command askrene-listlayers two possible orderings {"layers": ["xpay", "renepay"]} or
{"layers": ["renepay", "xpay"]}, and both are correct. But not one order is guaranteed.
The only solutions I see are either:

  • ignore "Update examples in doc schemas", the code is perfectly fine,
  • or to follow the rules of "Update examples in doc schemas", and add extra code to sort the listlayers output in a definite order just to be able to pass the tests,
  • or check the examples' outputs with other than just git diff.

UPD: I will not use a global "renepay" layer, instead I will use "xpay", it is a good choice I think, because
every piece of knowledge learnt from either the use of xpay and renepay will be available for both plugins.

@Lagrang3
renepay: fine tuning test_renepay
4eaa21d 
- skip test on local htlc max limits which is not supported by askrene, on privacy
  leak issue.
- skip very extreme flow cases, where sats per HTLC in reserve must be taken
  into account.
- adjust the expected error response for messages coming from askrene.
- on getroutes failure return a command fail with the same error code as
  getroutes response.

Changelog-None

Signed-off-by: Lagrang3 <[email protected]>
@Lagrang3 Lagrang3 force-pushed the renepay-use-askrene branch from bbd3ea4 to 8274c63 Compare March 5, 2025 07:35
@Lagrang3
renepay: use the same global layer as xpay
0b0c122 
Changelog-None

Signed-off-by: Lagrang3 <[email protected]>
@Lagrang3 Lagrang3 force-pushed the renepay-use-askrene branch from 8274c63 to 4c9bbe5 Compare March 5, 2025 07:53
@Lagrang3
Fix CI tests ...
2facae2 
that broke because of layers created by renepay

Changelog-None

Signed-off-by: Lagrang3 <[email protected]>
@Lagrang3 Lagrang3 force-pushed the renepay-use-askrene branch from 4c9bbe5 to 2facae2 Compare March 5, 2025 11:08
This was referenced Mar 11, 2025
Draft
Closed
@Lagrang3 Lagrang3 marked this pull request as draft May 15, 2025 08:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cdecker cdecker Awaiting requested review from cdecker

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@Lagrang3