Skip to content
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

Document view state proofs #7714

Open
3 tasks
mina86 opened this issue Sep 28, 2022 · 0 comments
Open
3 tasks

Document view state proofs #7714

mina86 opened this issue Sep 28, 2022 · 0 comments
Assignees
Labels
C-good-first-issue Category: issues that are self-contained and easy for newcomers to work on.

Comments

@mina86
Copy link
Contributor

mina86 commented Sep 28, 2022

#7603 added include_proof option to view_state RPC request. Once 1.30 hits mainnet, this option needs to be documented. Furthermore, we also need to document format of the proof.

  • Release 1.30 to mainnet
  • Document include_proof in docs repository.
  • Document how to verify proof.

Documenting include_proof just means mentioning that it’s an optional argument and if it’s set to true the proof in response will be populated. Documenting how to verify proofs is a bit more work and may require touching Nomicon to document format of the trie.

I’m going to mark this as C-good-first-issue because I think this may be a good first issue for anyone who’d like to dig into how the state is stored in the trie without having to write any code.

@mina86 mina86 added the C-good-first-issue Category: issues that are self-contained and easy for newcomers to work on. label Sep 28, 2022
@mina86 mina86 removed their assignment Oct 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-good-first-issue Category: issues that are self-contained and easy for newcomers to work on.
Projects
None yet
Development

No branches or pull requests

2 participants