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 23-commitment and MerklePath better #7628

Open
gjermundgaraba opened this issue Dec 7, 2024 · 0 comments
Open

Document 23-commitment and MerklePath better #7628

gjermundgaraba opened this issue Dec 7, 2024 · 0 comments
Labels
docs Improvements or additions to documentation

Comments

@gjermundgaraba
Copy link
Contributor

Document how MerklePath should be constructed and what the values mean in different contexts. In particular, the prefix use case we should document more clearly what is expected, and when the last element should be empty. One useful comment from the audit we should incorporate is something along the lines of "the merkle path tells us the number of trees we are dealing with".

We can also consider if we want to have two separate types for MerklePrefix and MerklePath to make the distinction and use cases clearer. It might make the current context more obvious when reading code that uses these types.

In any case, I suggest we add some more, and clearer, documentation in both the go code and in the proto files.

@gjermundgaraba gjermundgaraba added the docs Improvements or additions to documentation label Dec 7, 2024
@github-project-automation github-project-automation bot moved this to Backlog in IBC-GO Eureka Dec 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
Status: Backlog
Development

No branches or pull requests

1 participant