chore(x/core): addressing review comments

- Stop distribution if data request escrow runs out.
- RevealBody.Reveal is now a byte slice instead of a base64 string.
- Core EndBlock now completes the full tally process of a given data request in
one loop iteration.
- Validate that a reveal's exit code can fit in a uint8.
- Validate version in PostDataRequest.
- Basic module parameter validation

Author: hacheigriega

go.mod

@@ -54,6 +54,7 @@ require (
 	go.uber.org/mock v0.4.0
 	golang.org/x/crypto v0.32.0
 	golang.org/x/exp v0.0.0-20240909161429-701f63a606c0
+	golang.org/x/mod v0.22.0
 	google.golang.org/genproto/googleapis/api v0.0.0-20241202173237-19429a94021a
 	google.golang.org/grpc v1.70.0
 	google.golang.org/protobuf v1.36.5

go.sum

@@ -1181,6 +1181,8 @@ golang.org/x/mod v0.4.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
 golang.org/x/mod v0.4.1/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
 golang.org/x/mod v0.4.2/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
 golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=
+golang.org/x/mod v0.22.0 h1:D4nJWe9zXqHOmWqj4VMOJhvzj7bEZg4wEYa759z1pH4=
+golang.org/x/mod v0.22.0/go.mod h1:6SkKJ3Xj0I0BrPOZoBy3bdMptDDU9oJrpohJ3eWZ1fY=
 golang.org/x/net v0.0.0-20180724234803-3673e40ba225/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
 golang.org/x/net v0.0.0-20180826012351-8a410e7b638d/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
 golang.org/x/net v0.0.0-20180906233101-161cd47e91fd/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=

proto/sedachain/core/v1/core.proto

@@ -108,11 +108,17 @@ enum DataRequestStatus {
 
 // RevealBody is the content of a reveal.
 message RevealBody {
+  // Hex-encoded ID of the data request
   string dr_id = 1;
+  // Block height of the data request posting
   uint64 dr_block_height = 2;
+  // Exit code of the data request execution (used as uint8)
   uint32 exit_code = 3;
+  // Gas used by the data request execution
   uint64 gas_used = 4;
-  string reveal = 5;
+  // Contents of the reveal
+  bytes reveal = 5;
+  // List of data proxy public keys used
   repeated string proxy_pub_keys = 6
       [ (gogoproto.jsontag) = "proxy_public_keys" ];
 }

x/core/keeper/endblock.go

@@ -58,18 +58,18 @@ func (k Keeper) ProcessTallies(ctx sdk.Context) error {
 
 	// Loop through the list to apply filter, execute tally, and post
 	// execution result.
-	tallyResults := make([]TallyResult, tallyLen)
-	dataResults := make([]batchingtypes.DataResult, tallyLen)
+	var tallyResult TallyResult
+	var dataResult batchingtypes.DataResult
 
-	for i, id := range drIDs {
+	for _, id := range drIDs {
 		dr, err := k.GetDataRequest(ctx, id)
 		if err != nil {
 			telemetry.SetGauge(1, types.TelemetryKeyDRFlowHalt)
 			k.Logger(ctx).Error("[HALTS_DR_FLOW] failed to retrieve data request", "err", err)
 			return nil
 		}
 
-		dataResults[i] = batchingtypes.DataResult{
+		dataResult = batchingtypes.DataResult{
 			DrId: dr.Id,
 			//nolint:gosec // G115: Block height is never negative.
 			DrBlockHeight: uint64(dr.PostedHeight),
@@ -92,19 +92,19 @@ func (k Keeper) ProcessTallies(ctx sdk.Context) error {
 		gasMeter := types.NewGasMeter(dr.TallyGasLimit, dr.ExecGasLimit, tallyConfig.MaxTallyGasLimit, dr.PostedGasPrice, tallyConfig.GasCostBase)
 
 		if len(dr.Commits) < int(dr.ReplicationFactor) {
-			dataResults[i].Result = []byte(fmt.Sprintf("need %d commits; received %d", dr.ReplicationFactor, len(dr.Commits)))
-			dataResults[i].ExitCode = types.TallyExitCodeNotEnoughCommits
+			dataResult.Result = []byte(fmt.Sprintf("need %d commits; received %d", dr.ReplicationFactor, len(dr.Commits)))
+			dataResult.ExitCode = types.TallyExitCodeNotEnoughCommits
 			k.Logger(ctx).Info("data request's number of commits did not meet replication factor", "request_id", dr.Id)
 
 			MeterExecutorGasFallback(dr, tallyConfig.ExecutionGasCostFallback, gasMeter)
 		} else {
-			_, tallyResults[i] = k.FilterAndTally(ctx, dr, tallyConfig, gasMeter)
-			dataResults[i].Result = tallyResults[i].Result
-			dataResults[i].ExitCode = tallyResults[i].ExitCode
-			dataResults[i].Consensus = tallyResults[i].Consensus
+			_, tallyResult = k.FilterAndTally(ctx, dr, tallyConfig, gasMeter)
+			dataResult.Result = tallyResult.Result
+			dataResult.ExitCode = tallyResult.ExitCode
+			dataResult.Consensus = tallyResult.Consensus
 
 			k.Logger(ctx).Info("completed tally", "request_id", dr.Id)
-			k.Logger(ctx).Debug("tally result", "request_id", dr.Id, "tally_result", tallyResults[i])
+			k.Logger(ctx).Debug("tally result", "request_id", dr.Id, "tally_result", tallyResult)
 		}
 
 		distributions := k.GetGasMeterResults(ctx, gasMeter, dr.Id, dr.PostedHeight, tallyConfig.BurnRatio)
@@ -128,35 +128,33 @@ func (k Keeper) ProcessTallies(ctx sdk.Context) error {
 			return err
 		}
 
-		dataResults[i].GasUsed = gasMeter.TotalGasUsed()
-		dataResults[i].Id, err = dataResults[i].TryHash()
+		dataResult.GasUsed = gasMeter.TotalGasUsed()
+		dataResult.Id, err = dataResult.TryHash()
 		if err != nil {
 			return err
 		}
-	}
 
-	// Store the data results for batching.
-	for i := range dataResults {
-		err := k.batchingKeeper.SetDataResultForBatching(ctx, dataResults[i])
+		// Store the data results for batching.
+		err = k.batchingKeeper.SetDataResultForBatching(ctx, dataResult)
 		// If writing to the store fails we should stop the node to prevent acting on invalid state.
 		if err != nil {
 			k.Logger(ctx).Error("failed to store data result for batching", "err", err)
 			return err
 		}
 
-		k.Logger(ctx).Info("tally flow completed", "request_id", dataResults[i].DrId)
+		k.Logger(ctx).Info("tally flow completed", "request_id", dataResult.DrId)
 		ctx.EventManager().EmitEvent(
 			sdk.NewEvent(
 				types.EventTypeTallyCompletion,
-				sdk.NewAttribute(types.AttributeDataResultID, dataResults[i].Id),
-				sdk.NewAttribute(types.AttributeDataRequestID, dataResults[i].DrId),
-				sdk.NewAttribute(types.AttributeTypeConsensus, strconv.FormatBool(dataResults[i].Consensus)),
-				sdk.NewAttribute(types.AttributeTallyVMStdOut, strings.Join(tallyResults[i].StdOut, "\n")),
-				sdk.NewAttribute(types.AttributeTallyVMStdErr, strings.Join(tallyResults[i].StdErr, "\n")),
-				sdk.NewAttribute(types.AttributeExecGasUsed, fmt.Sprintf("%v", tallyResults[i].ExecGasUsed)),
-				sdk.NewAttribute(types.AttributeTallyGasUsed, fmt.Sprintf("%v", tallyResults[i].TallyGasUsed)),
-				sdk.NewAttribute(types.AttributeTallyExitCode, fmt.Sprintf("%02x", dataResults[i].ExitCode)),
-				sdk.NewAttribute(types.AttributeProxyPubKeys, strings.Join(tallyResults[i].ProxyPubKeys, "\n")),
+				sdk.NewAttribute(types.AttributeDataResultID, dataResult.Id),
+				sdk.NewAttribute(types.AttributeDataRequestID, dataResult.DrId),
+				sdk.NewAttribute(types.AttributeTypeConsensus, strconv.FormatBool(dataResult.Consensus)),
+				sdk.NewAttribute(types.AttributeTallyVMStdOut, strings.Join(tallyResult.StdOut, "\n")),
+				sdk.NewAttribute(types.AttributeTallyVMStdErr, strings.Join(tallyResult.StdErr, "\n")),
+				sdk.NewAttribute(types.AttributeExecGasUsed, fmt.Sprintf("%v", tallyResult.ExecGasUsed)),
+				sdk.NewAttribute(types.AttributeTallyGasUsed, fmt.Sprintf("%v", tallyResult.TallyGasUsed)),
+				sdk.NewAttribute(types.AttributeTallyExitCode, fmt.Sprintf("%02x", dataResult.ExitCode)),
+				sdk.NewAttribute(types.AttributeProxyPubKeys, strings.Join(tallyResult.ProxyPubKeys, "\n")),
 			),
 		)
 	}