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.

Sign up for GitHub

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

Jump to bottom

docs: godoc for computeRowProof #228

Closed
wants to merge 3 commits into from
Closed

docs: godoc for computeRowProof #228

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eb6be35
docs: godoc for computeRowProof
rootulp Jul 5, 2023
8974a5a
Merge branch 'main' into rp/godoc-compute-row-proof
rootulp Jul 6, 2023
93fac88
refactor: use named return params
rootulp Jul 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions datasquare_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,12 +271,12 @@ func TestDefaultTreeProofs(t *testing.T) {
if err != nil {
panic(err)
}
_, proof, proofIndex, numLeaves, err := computeRowProof(result, 1, 1)
_, proofSet, proofIndex, numLeaves, err := computeRowProof(result, 1, 1)
if err != nil {
t.Errorf("Got unexpected error: %v", err)
}

if len(proof) != 2 {
if len(proofSet) != 2 {
t.Errorf("computing row proof for (1, 1) in 2x2 square failed; expecting proof set of length 2")
}
if proofIndex != 1 {
Expand Down Expand Up @@ -418,7 +418,10 @@ func BenchmarkEDSRoots(b *testing.B) {
}
}

func computeRowProof(ds *dataSquare, x uint, y uint) ([]byte, [][]byte, uint, uint, error) {
// computeRowProof returns the merkleRoot, proofSet, proofIndex, and numLeaves
// for the share at coordinates (x, y). Returns an error if the shares in the
// row fail to push to the Merkle tree.
func computeRowProof(ds *dataSquare, x uint, y uint) (merkleRoot []byte, proofSet [][]byte, proofIndex uint64, numLeaves uint64, err error) {
tree := ds.createTreeFn(Row, x)
data := ds.row(x)

Expand All @@ -429,10 +432,12 @@ func computeRowProof(ds *dataSquare, x uint, y uint) ([]byte, [][]byte, uint, ui
}
}

merkleRoot, proof, proofIndex, numLeaves := treeProve(tree.(*DefaultTree), int(y))
return merkleRoot, proof, uint(proofIndex), uint(numLeaves), nil
merkleRoot, proofSet, proofIndex, numLeaves = treeProve(tree.(*DefaultTree), int(y))
return merkleRoot, proofSet, proofIndex, numLeaves, nil
}

// treeProve returns the merkleRoot, proofSet, proofIndex, and numLeaves
// for the node at index idx in the tree d.
func treeProve(d *DefaultTree, idx int) (merkleRoot []byte, proofSet [][]byte, proofIndex uint64, numLeaves uint64) {
if err := d.Tree.SetIndex(uint64(idx)); err != nil {
panic(fmt.Sprintf("don't call prove on a already used tree: %v", err))
Expand Down