Wake up wallet nodes before relaying messages or payments #2865
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
t-bast
commented
Jun 11, 2024
eclair-core/src/main/scala/fr/acinq/eclair/payment/relay/ChannelRelay.scala
Outdated
Show resolved
Hide resolved
eclair-core/src/main/scala/fr/acinq/eclair/payment/relay/NodeRelay.scala
Outdated
Show resolved
Hide resolved
eclair-core/src/main/scala/fr/acinq/eclair/payment/relay/NodeRelay.scala
Outdated
Show resolved
Hide resolved
eclair-core/src/main/scala/fr/acinq/eclair/payment/relay/NodeRelay.scala
Outdated
Show resolved
Hide resolved
eclair-core/src/test/scala/fr/acinq/eclair/io/MessageRelaySpec.scala
Outdated
Show resolved
Hide resolved
eclair-core/src/main/scala/fr/acinq/eclair/io/MessageRelay.scala
Outdated
Show resolved
Hide resolved
eclair-core/src/main/scala/fr/acinq/eclair/payment/send/BlindedPathsResolver.scala
Outdated
Show resolved
Hide resolved
t-bast
force-pushed
the
wake-up-before-relay
branch
from
6131cff
to
8da0fc6
Compare
t-bast
force-pushed
the
wake-up-before-relay
branch
2 times, most recently
from
89d3a1d
to
b5a8d98
Compare
eclair-core/src/main/scala/fr/acinq/eclair/payment/relay/NodeRelay.scala
Outdated
Show resolved
Hide resolved
t-bast
force-pushed
the
wake-up-before-relay
branch
from
b5a8d98
to
fa5b437
Compare
t-bast
commented
Jun 18, 2024
| def start(): Behavior[Command] = { | ||
| r.payload.outgoing match { | ||
| case Left(walletNodeId) => wakeUp(walletNodeId) | ||
| case Right(requestedShortChannelId) => |
There was a problem hiding this comment.
Note how this can be extended to detect "custom" scids and insert the wake-up step, by resolving the walletNodeId using our push notifications DB (or an existing channel if we have one, which avoids a DB call).
eclair-core/src/main/scala/fr/acinq/eclair/payment/relay/NodeRelay.scala
Outdated
Show resolved
Hide resolved
thomash-acinq
previously approved these changes
Jun 19, 2024
t-bast
force-pushed
the
wake-up-before-relay
branch
from
fa5b437
to
fe35e13
Compare
|
I amended the last commit which contained a bug in |
t-bast
commented
Jun 19, 2024
Comment on lines
+143
to
+144
| // When relaying to a trampoline node, the next node may be a wallet node directly connected to us, but we don't | ||
| // want to have false positives. Feature branches should check an internal DB/cache to confirm. | ||
| case r: ClearRecipient if r.nextTrampolineOnion_opt.nonEmpty => None |
There was a problem hiding this comment.
This case can be extended to wake-up current Phoenix wallets: we should check our push notifications DB here and if it has an entry for the next node, we should return it, otherwise we should return None (this is a trampoline relay to a non-wallet node).
thomash-acinq
previously approved these changes
Jun 20, 2024
t-bast
force-pushed
the
wake-up-before-relay
branch
2 times, most recently
from
9477caf
to
b02d00a
Compare
This commit doesn't contain any logical change, we just move code to align with the FSM flow. It makes it easier to follow the progress of the state machine to always scroll down when advancing states.
We refactor `NodeRelay.scala` to re-order some steps, without making meaningful functional changes. The steps are: 1. Fully receive the incoming payment 2. Resolve the next node (unwrap blinded paths if needed) 3. Wake-up the next node if necessary (mobile wallet) 4. Relay outgoing payment Note that we introduce a wake-up step, that will be enriched in future commits and can be extended to include mobile notifications. The file is now also easier to follow, as steps are done linearly by simply scrolling down.
We allow relaying data to contain a wallet `node_id` instead of an scid. When that's the case, we start by waking up that wallet node before we try relaying onion messages or payments.
t-bast
force-pushed
the
wake-up-before-relay
branch
from
b02d00a
to
3619ce9
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR ports some of the architecture related to wallet wake-up from feature branches to
master. It should be reviewed commit-by-commit, while comparing to feature branches to get a feel for the changes that will be needed on the feature branches to adapt to this architecture.Note how the
PeerReadyNotifiercan easily be extended to send push notifications to wallet nodes before waiting for an incoming connection from them.