chore: add documentation for edge case of fetching min/max square size

celestiaorg · Dec 21, 2022 · 0a296c1 · 0a296c1
1 parent 0fca546
commit 0a296c1
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/x/blob/keeper/params.go b/x/blob/keeper/params.go
@@ -22,6 +22,8 @@ func (k Keeper) SetParams(ctx sdk.Context, params types.Params) {
 
 // MinSquareSize returns the MinSquareSize param
 func (k Keeper) MinSquareSize(ctx sdk.Context) (res uint32) {
+	// use the default size for the first block so that we return a value on the
+	// first block in PrepareProposal
 	if ctx.BlockHeader().Height < 1 {
 		return appconsts.DefaultMinSquareSize
 	}
@@ -31,6 +33,8 @@ func (k Keeper) MinSquareSize(ctx sdk.Context) (res uint32) {
 
 // MaxSquareSize returns the MaxSquareSize param
 func (k Keeper) MaxSquareSize(ctx sdk.Context) (res uint32) {
+	// use the default size for the first block so that we return a value on the
+	// first block in PrepareProposal
 	if ctx.BlockHeader().Height < 1 {
 		return appconsts.DefaultMaxSquareSize
 	}