forked from lightningnetwork/lnd
-
Notifications
You must be signed in to change notification settings - Fork 0
htlcswitch: add FSM fuzz harness for channelLink commit protocol #1
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.
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
Open
MPins
wants to merge
9
commits into
master
Choose a base branch
from
link_fsm_fuzz
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
a4a3279
doc: create a diagram representing the link machine state
MPins aa3d301
htlcswitch: expose invoiceRegistry and add generateSingleHopHtlc
MPins ee70f80
htlcswitch: add mockMailBox and noopTicker test helpers
MPins 9c6814a
htlcswitch: add goroutine-free link factory for fuzz harness
MPins 6ddb676
htlcswitch: add FSM fuzz harness for channelLink commit protocol
MPins 706a576
lnwallet+htlcswitch: add fuzz-friendly signer and sig verifier hook
MPins c1d7fa0
lnwallet+htlcswitch: add fuzz-friendly commitment key deriver hook
MPins 31fba27
htlcswitch: stop SigPools in createTestChannel cleanup
MPins bea62c8
htlcswitch: stop InvoiceRegistry in newMockRegistry cleanup
MPins File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| ## States and Transitions | ||
| ```mermaid | ||
| --- | ||
| title: Channel Link State Machine | ||
| --- | ||
|
|
||
| stateDiagram-v2 | ||
|
|
||
| [*] --> Clean | ||
|
|
||
| Clean --> Pending : receive update_* (processRemoteUpdate*) | ||
| Pending --> Pending : more update_* | ||
|
|
||
| Pending --> TrySendCommitSig : BatchTicker / OweCommitment | ||
| TrySendCommitSig --> WaitingRevoke : SignNextCommitment ok + send CommitSig | ||
| TrySendCommitSig --> WindowExhausted : SignNextCommitment = ErrNoWindow | ||
|
|
||
| WaitingRevoke --> Pending : receive RevokeAndAck (ReceiveRevocation) | ||
| WaitingRevoke --> Clean : receive RevokeAndAck and channel clean | ||
|
|
||
| Pending --> RecvCommitSig : receive CommitSig (processRemoteCommitSig) | ||
| RecvCommitSig --> SendRevoke : ReceiveNewCommitment ok | ||
| SendRevoke --> Pending : RevokeCurrentCommitment + send RevokeAndAck | ||
|
|
||
| Pending --> TrySendCommitSig : after RevokeAndAck/RecvRevoke if OweCommitment | ||
|
|
||
| Clean --> Quiescent : STFU | ||
| Quiescent --> Clean : resume | ||
|
|
||
| state Failed <<terminal>> | ||
| Pending --> Failed : invalid sig/revocation / timeout | ||
| WaitingRevoke --> Failed : PendingCommitTicker timeout | ||
|
|
||
| ``` | ||
|
|
||
| ## Legend | ||
|
|
||
| | Term | Meaning | | ||
| |------|---------| | ||
| | `OweCommitment` | Boolean flag set on the link when there are pending local updates that have not yet been covered by a `CommitSig`. Triggers sending the next commitment signature after a `RevokeAndAck` is received or when the batch ticker fires. | | ||
| | `WindowExhausted` | `SignNextCommitment` returned `ErrNoWindow`, meaning the in-flight HTLC limit was reached. The link waits for a `RevokeAndAck` to free a slot before retrying. | | ||
| | `BatchTicker` | Periodic timer that coalesces multiple downstream updates into a single `CommitSig` round. Replaced by `noopTicker` in fuzz/test harnesses. | | ||
| | `PendingCommitTicker` | Watchdog timer that fires if a `RevokeAndAck` is not received within the allowed window, transitioning the link to `Failed`. | |
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
Oops, something went wrong.
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 was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
non-deterministic?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It might be good to use a corpus input with HTLC ID and sender ID to deterministically generate the preimage.