chore(chain, cmd, dot): Change retain blocks type to be uint32 (#2877)

Co-authored-by: Kishan Sagathiya <[email protected]>
Co-authored-by: Eclésio Junior <[email protected]>

Author: 3 people

chain/dev/defaults.go

@@ -31,7 +31,7 @@ var (
 	// DefaultPruningMode is the default pruning mode
 	DefaultPruningMode = "archive"
 	// DefaultRetainBlocks is the default retained blocks
-	DefaultRetainBlocks = int64(512)
+	DefaultRetainBlocks = uint32(512)
 
 	// DefaultTelemetryURLs is the default URL of the telemetry server to connect to.
 	DefaultTelemetryURLs []genesis.TelemetryEndpoint

chain/gssmr/defaults.go

@@ -33,7 +33,7 @@ var (
 	// DefaultPruningMode is the default pruning mode
 	DefaultPruningMode = "archive"
 	// DefaultRetainBlocks is the default retained blocks
-	DefaultRetainBlocks = int64(512)
+	DefaultRetainBlocks = uint32(512)
 
 	// DefaultTelemetryURLs is the default URL of the telemetry server to connect to.
 	DefaultTelemetryURLs []genesis.TelemetryEndpoint

chain/kusama/defaults.go

@@ -31,7 +31,7 @@ var (
 	// DefaultPruningMode is the default pruning mode
 	DefaultPruningMode = "archive"
 	// DefaultRetainBlocks is the default retained blocks
-	DefaultRetainBlocks = int64(512)
+	DefaultRetainBlocks = uint32(512)
 
 	// DefaultTelemetryURLs is the default URL of the telemetry server to connect to.
 	DefaultTelemetryURLs []genesis.TelemetryEndpoint

chain/polkadot/defaults.go

@@ -28,7 +28,7 @@ var (
 	// DefaultPruningMode is the default pruning mode
 	DefaultPruningMode = "archive"
 	// DefaultRetainBlocks is the default pruning mode
-	DefaultRetainBlocks = int64(512)
+	DefaultRetainBlocks = uint32(512)
 
 	// DefaultTelemetryURLs is the default URL of the telemetry server to connect to.
 	DefaultTelemetryURLs []genesis.TelemetryEndpoint

cmd/gossamer/config.go

@@ -482,7 +482,14 @@ func setDotGlobalConfigFromFlags(ctx *cli.Context, cfg *dot.GlobalConfig) error
 		cfg.MetricsAddress = metricsAddress
 	}
 
-	cfg.RetainBlocks = ctx.Int64(RetainBlockNumberFlag.Name)
+	const uint32Max = ^uint32(0)
+	flagValue := ctx.Uint64(RetainBlockNumberFlag.Name)
+
+	if uint64(uint32Max) < flagValue {
+		return fmt.Errorf("retain blocks value overflows uint32 boundaries, must be less than or equal to: %d", uint32Max)
+	}
+
+	cfg.RetainBlocks = uint32(flagValue)
 	cfg.Pruning = pruner.Mode(ctx.String(PruningFlag.Name))
 	cfg.NoTelemetry = ctx.Bool("no-telemetry")
 

cmd/gossamer/flags.go

@@ -359,10 +359,10 @@ var (
 
 	// RetainBlockNumberFlag retain number of block from latest block while pruning,
 	// valid for the use with prune-state subcommand
-	RetainBlockNumberFlag = cli.Int64Flag{
+	RetainBlockNumberFlag = cli.Uint64Flag{
 		Name:  "retain-blocks",
 		Usage: "Retain number of block from latest block while pruning",
-		Value: dev.DefaultRetainBlocks,
+		Value: uint64(dev.DefaultRetainBlocks),
 	}
 
 	// PruningFlag triggers the online pruning of historical state tries.

cmd/gossamer/main.go

@@ -425,7 +425,15 @@ func pruneState(ctx *cli.Context) error {
 	}
 
 	bloomSize := ctx.GlobalUint64(BloomFilterSizeFlag.Name)
-	retainBlocks := ctx.GlobalInt64(RetainBlockNumberFlag.Name)
+
+	const uint32Max = ^uint32(0)
+	flagValue := ctx.GlobalUint64(RetainBlockNumberFlag.Name)
+
+	if uint64(uint32Max) < flagValue {
+		return fmt.Errorf("retain blocks value overflows uint32 boundaries, must be less than or equal to: %d", uint32Max)
+	}
+
+	retainBlocks := uint32(flagValue)
 
 	pruner, err := state.NewOfflinePruner(inputDBPath, prunedDBPath, bloomSize, retainBlocks)
 	if err != nil {

cmd/gossamer/utils_test.go

@@ -36,6 +36,8 @@ func newTestContext(description string, flags []string, values []interface{}) (*
 			set.Uint(flags[i], v, "")
 		case int64:
 			set.Int64(flags[i], v, "")
+		case uint32:
+			set.Uint64(flags[i], uint64(v), "")
 		case []string:
 			set.Var(&cli.StringSlice{}, flags[i], "")
 		default:
@@ -67,6 +69,11 @@ func newTestContext(description string, flags []string, values []interface{}) (*
 			if err != nil {
 				return nil, fmt.Errorf("failed to set cli flag: %T, err: %w", flags[i], err)
 			}
+		case uint32:
+			err := ctx.Set(flags[i], strconv.Itoa(int(values[i].(uint32))))
+			if err != nil {
+				return nil, fmt.Errorf("failed to set cli flag: %T, err: %w", flags[i], err)
+			}
 		case []string:
 			for _, str := range values[i].([]string) {
 				err := ctx.Set(flags[i], str)

dot/config.go

@@ -47,7 +47,7 @@ type GlobalConfig struct {
 	MetricsAddress string
 	NoTelemetry    bool
 	TelemetryURLs  []genesis.TelemetryEndpoint
-	RetainBlocks   int64
+	RetainBlocks   uint32
 	Pruning        pruner.Mode
 }
 

dot/config/toml/config.go

@@ -23,7 +23,7 @@ type GlobalConfig struct {
 	BasePath       string `toml:"basepath,omitempty"`
 	LogLvl         string `toml:"log,omitempty"`
 	MetricsAddress string `toml:"metrics-address,omitempty"`
-	RetainBlocks   int64  `toml:"retain-blocks,omitempty"`
+	RetainBlocks   uint32 `toml:"retain-blocks,omitempty"`
 	Pruning        string `toml:"pruning,omitempty"`
 }
 

dot/state/offline_pruner.go

@@ -27,15 +27,15 @@ type OfflinePruner struct {
 	blockState     *BlockState
 	bloom          *bloomState
 	bestBlockHash  common.Hash
-	retainBlockNum int64
+	retainBlockNum uint32
 
 	inputDBPath  string
 	prunedDBPath string
 }
 
 // NewOfflinePruner creates an instance of OfflinePruner.
 func NewOfflinePruner(inputDBPath, prunedDBPath string, bloomSize uint64,
-	retainBlockNum int64) (*OfflinePruner, error) {
+	retainBlockNum uint32) (*OfflinePruner, error) {
 	db, err := utils.LoadChainDB(inputDBPath)
 	if err != nil {
 		return nil, fmt.Errorf("failed to load DB %w", err)

dot/state/pruner/pruner.go

@@ -46,7 +46,7 @@ func (p Mode) IsValid() bool {
 // Config holds state trie pruning mode and retained blocks
 type Config struct {
 	Mode           Mode
-	RetainedBlocks int64
+	RetainedBlocks uint32
 }
 
 // Pruner is implemented by FullNode and ArchiveNode.
@@ -82,7 +82,7 @@ type FullNode struct {
 	// pendingNumber is the block number to be pruned.
 	// Initial value is set to 1 and is incremented after every block pruning.
 	pendingNumber int64
-	retainBlocks  int64
+	retainBlocks  uint32
 	sync.RWMutex
 }
 
@@ -110,7 +110,7 @@ func newJournalRecord(hash common.Hash, insertedMerkleValues,
 }
 
 // NewFullNode creates a Pruner for full node.
-func NewFullNode(db, storageDB chaindb.Database, retainBlocks int64, l log.LeveledLogger) (Pruner, error) {
+func NewFullNode(db, storageDB chaindb.Database, retainBlocks uint32, l log.LeveledLogger) (Pruner, error) {
 	p := &FullNode{
 		deathList:    make([]deathRow, 0),
 		deathIndex:   make(map[string]int64),
@@ -216,7 +216,7 @@ func (p *FullNode) start() {
 	checkPruning := func() {
 		p.Lock()
 		defer p.Unlock()
-		if int64(len(p.deathList)) <= p.retainBlocks {
+		if uint32(len(p.deathList)) <= p.retainBlocks {
 			canPrune = false
 			return
 		}

dot/state/service_test.go

@@ -167,7 +167,7 @@ func TestService_StorageTriePruning(t *testing.T) {
 		LogLevel: log.Info,
 		PrunerCfg: pruner.Config{
 			Mode:           pruner.Full,
-			RetainedBlocks: int64(retainBlocks),
+			RetainedBlocks: uint32(retainBlocks),
 		},
 		Telemetry: telemetryMock,
 	}