Add a context to interactive tx session #2849
Draft
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
There are three closely related, but separate parameters: - `InteractiveTxParams`: low-level bitcoin parameters (amounts, outputs, locktime, confirmations) - `Purpose`: whether the interactive-tx is an initial funding, a splice, a rbf - `SessionContext`: higher level meta information about the interactive-tx (why are we opening or splicing this channel?) This PR adds a `SessionContext` and carries it all the way to the completion (success or failure) of the interactive-tx process.
pm47
commented
Apr 19, 2024
| /** The splice transaction has been negotiated, we're exchanging signatures. */ | ||
| case class SpliceWaitingForSigs(signingSession: InteractiveTxSigningSession.WaitingForSigs) extends QuiescentSpliceStatus | ||
| case class SpliceWaitingForSigs(sessionContext: SessionContext, signingSession: InteractiveTxSigningSession.WaitingForSigs) extends QuiescentSpliceStatus |
There was a problem hiding this comment.
I'm not sure whether sessionContext should be (a) in [Rbf/Splice]WaitingForSigs, or (b) in InteractiveTxSigningSession.WaitingForSigs.
(a) is somewhat more consistent at the [Rbf/Splice]Status level, because we have to add sessionContext to [Rbf/Splice]InProgress in any case
(b) allows for better factorization between rbf and splice, and simpler codecs.
I went with (a) for this first shot, lmk what you think 🙏
| def sessionId: ByteVector32 | ||
| } | ||
| object SessionContext { | ||
| case class Unspecified(sessionId: ByteVector32) extends SessionContext |
There was a problem hiding this comment.
For example, we could have a LiquidityRequest context which contains the requested LiquidityAds.Lease. There are various other cases in feature branches.
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.
There are three closely related, but separate parameters:
InteractiveTxParams: low-level bitcoin parameters (amounts, outputs, locktime, confirmations)Purpose: whether the interactive-tx is an initial funding, a splice, a rbfSessionContext: higher level meta information about the interactive-tx (why are we opening or splicing this channel?)This PR adds a
SessionContextand carries it all the way to the completion (success or failure) of the interactive-tx process. It is useful for better debugging, diagnostics, metrics.