doc: document NMT wrapper in prepare_proposal (#1039)

Adds a small note to specify that the NMT wrapper is used to extend the shares
celestiaorg · Feb 1, 2023 · 4f9deb0 · 4f9deb0
1 parent bd68c46
commit 4f9deb0
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/app/prepare_proposal.go b/app/prepare_proposal.go
@@ -68,6 +68,8 @@ func (app *App) PrepareProposal(req abci.RequestPrepareProposal) abci.ResponsePr
 	}
 
 	// erasure the data square which we use to create the data root.
+	// Note: uses the nmt wrapper to construct the tree.
+	// checkout pkg/wrapper/nmt_wrapper.go for more information.
 	eds, err := da.ExtendShares(squareSize, shares.ToBytes(dataSquare))
 	if err != nil {
 		app.Logger().Error(

diff --git a/pkg/da/data_availability_header.go b/pkg/da/data_availability_header.go
@@ -69,6 +69,7 @@ func ExtendShares(squareSize uint64, shares [][]byte) (*rsmt2d.ExtendedDataSquar
 		)
 	}
 	// here we construct a tree
+	// Note: uses the nmt wrapper to construct the tree.
 	return rsmt2d.ComputeExtendedDataSquare(shares, appconsts.DefaultCodec(), wrapper.NewConstructor(squareSize))
 }