docs: document GetDataRootTupleInclusionProof and GetDataRootTupleRoot

celestiaorg · Jul 19, 2024 · 2c53cb0 · 2c53cb0
1 parent 76a1aaf
commit 2c53cb0
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/nodebuilder/header/header.go b/nodebuilder/header/header.go
@@ -46,11 +46,13 @@ type Module interface {
 
 	// GetDataRootTupleRoot collects the data roots over a provided ordered range of blocks,
 	// and then creates a new Merkle root of those data roots. The range is end exclusive.
+	// It's in the header module because it only needs access to the headers to generate the proof.
 	GetDataRootTupleRoot(ctx context.Context, start, end uint64) (*DataRootTupleRoot, error)
 
-	// GetDataRootTupleInclusionProof creates an inclusion proof for the data root of block
-	// height `height` in the set of blocks defined by `start` and `end`. The range
+	// GetDataRootTupleInclusionProof creates an inclusion proof, for the data root tuple of block
+	// height `height`, in the set of blocks defined by `start` and `end`. The range
 	// is end exclusive.
+	// It's in the header module because it only needs access to the headers to generate the proof.
 	GetDataRootTupleInclusionProof(
 		ctx context.Context,
 		height int64,