Skip to content

Commit

Permalink
chore: fix MerkleRoot#Sum function signature in the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
h5law committed Jan 9, 2024
1 parent 19afe35 commit 8682379
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/merkle-sum-trie.md
Original file line number Diff line number Diff line change
Expand Up @@ -255,8 +255,8 @@ The root of the tree is a slice of bytes. `MerkleRoot` is an alias for `[]byte`.
This design enables easily passing around the data (e.g. on-chain)
while maintaining primitive usage in different use cases (e.g. proofs).

`MerkleRoot` provides helpers, such as retrieving the `Sum(sumTrie bool)uint64`
to interface with data it captures.
`MerkleRoot` provides helpers, such as retrieving the `Sum() uint64` to
interface with data it captures.

## Nil Values

Expand Down
4 changes: 2 additions & 2 deletions docs/smt.md
Original file line number Diff line number Diff line change
Expand Up @@ -349,8 +349,8 @@ The root of the tree is a slice of bytes. `MerkleRoot` is an alias for `[]byte`.
This design enables easily passing around the data (e.g. on-chain)
while maintaining primitive usage in different use cases (e.g. proofs).

`MerkleRoot` provides helpers, such as retrieving the `Sum(sumTrie bool)uint64`
to interface with data it captures. However, for the SMT it **always** panics,
`MerkleRoot` provides helpers, such as retrieving the `Sum() uint64` to
interface with data it captures. However, for the SMT it **always** panics,
as there is no sum.

## Proofs
Expand Down

0 comments on commit 8682379

Please sign in to comment.