docs: add qgb module readme #1052
Merged
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
rach-id
commented
Nov 22, 2022
rootulp
reviewed
Nov 22, 2022
Co-authored-by: Rootul P <rootulp@gmail.com>
Co-authored-by: Rootul P <rootulp@gmail.com>
Co-authored-by: Rootul P <rootulp@gmail.com>
rach-id
force-pushed
the
qgb_module_readme
branch
from
db4822c
to
1a75526
Compare
evan-forbes
reviewed
Nov 23, 2022
evan-forbes
requested changes
Nov 23, 2022
x/qgb/README.md
Outdated
|
|
||
| #### Data commitment panics | ||
|
|
||
| During EndBlock, if the block height corresponds to a `DataCommitmentWindow`, it will generate a new data commitment, during which, the state machine can panic, if it finds invalid state, in the following case: |
There was a problem hiding this comment.
Suggested change
| During EndBlock, if the block height corresponds to a `DataCommitmentWindow`, it will generate a new data commitment, during which, the state machine can panic, if it finds invalid state, in the following case: | |
| During EndBlock, if the block height corresponds to a `DataCommitmentWindow`, it will generate a new data commitment. Note that the state machine can panic if invalid state is introduced. |
I would also then either remove
- An unexpected behavior happened while getting the current data commitment:
or clarify with more precise details of what could cause that. Like if the last nonce's key is missing or something not sure. Also, if we only have a single entry, I'm not sure we need a list
There was a problem hiding this comment.
I'll remove the data commitment panic section because currently, the GetDataCommitment will never return an error => no panics.
x/qgb/README.md
Outdated
|
|
||
| #### Valset panics | ||
|
|
||
| Similar to data commitments, when checking if the state machine needs to generate a new valset, it might panic, if it finds invalid state, in the following cases: |
There was a problem hiding this comment.
Suggested change
| Similar to data commitments, when checking if the state machine needs to generate a new valset, it might panic, if it finds invalid state, in the following cases: | |
| Note that, similar to data commitments, the state machine can panic if the required valset is not stored in the state db. |
There was a problem hiding this comment.
doesn't it make sense to keep the list? we have three cases where the state machine can panic...
evan-forbes
approved these changes
Nov 24, 2022
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.
Overview
Closes #501
Checklist