-
Notifications
You must be signed in to change notification settings - Fork 79
docs: Update and clarify invariants #694
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
johnsaigle
wants to merge
4
commits into
wormhole-foundation:main
Choose a base branch
from
johnsaigle:invariants-md-paused-detail
base: main
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
docs: Update and clarify invariants #694
johnsaigle
wants to merge
4
commits into
wormhole-foundation:main
from
johnsaigle:invariants-md-paused-detail
+30
−20
Conversation
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
Collaborator
johnsaigle
commented
Sep 10, 2025
- Make Pause invariant more explicit in terms of what pausing should limit
- Make it clear that the transceiver count should never go back to 0 after initial deployment
- Add information about registering vs enabling transceivers, why transceivers can't be deleted, and how it relates to business logic
nvsriram
reviewed
Sep 10, 2025
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.
We can maybe add a Maximum Threshold Requirement invariant as well since the threshold is always (after initial deployment):
1 <= threshold <= num_enabled_transceivers
nvsriram
previously approved these changes
Sep 10, 2025
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.
LGTM!
djb15
previously approved these changes
Sep 12, 2025
385e06f to
a3d2747
Compare
5d538f7 to
bc10ee5
Compare
d9f15cf to
9529690
Compare
djb15
approved these changes
Oct 30, 2025
9529690 to
658d497
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.