chore: add configurable tick rate from envar or toml config file

cardinal/config.go

@@ -47,6 +47,7 @@ var (
 		BaseShardSequencerAddress: DefaultBaseShardSequencerAddress,
 		BaseShardRouterKey:        "",
 		TelemetryTraceEnabled:     false,
+		CardinalTickRate:          0,
 	}
 )
 
@@ -77,6 +78,9 @@ type WorldConfig struct {
 
 	// TelemetryTraceEnabled When true, Cardinal will collect OpenTelemetry traces
 	TelemetryTraceEnabled bool `mapstructure:"TELEMETRY_TRACE_ENABLED"`
+
+	// CardinalTickRate The number of ticks per second
+	CardinalTickRate uint64 `mapstructure:"CARDINAL_TICK_RATE"`
 }
 
 func loadWorldConfig() (*WorldConfig, error) {

cardinal/config_test.go

@@ -36,6 +36,7 @@ func TestWorldConfig_LoadFromEnv(t *testing.T) {
 		RedisPassword:             "bar",
 		BaseShardSequencerAddress: "localhost:8080",
 		BaseShardRouterKey:        "abcdefghijklmnopqrstuvwxyz0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ01",
+		CardinalTickRate:          10,
 	}
 
 	// Set env vars to target config values
@@ -47,7 +48,7 @@ func TestWorldConfig_LoadFromEnv(t *testing.T) {
 	t.Setenv("REDIS_PASSWORD", wantCfg.RedisPassword)
 	t.Setenv("BASE_SHARD_SEQUENCER_ADDRESS", wantCfg.BaseShardSequencerAddress)
 	t.Setenv("BASE_SHARD_ROUTER_KEY", wantCfg.BaseShardRouterKey)
-
+	t.Setenv("CARDINAL_TICK_RATE", strconv.FormatUint(wantCfg.CardinalTickRate, 10))
 	gotCfg, err := loadWorldConfig()
 	assert.NilError(t, err)
 

cardinal/world.go

@@ -179,6 +179,12 @@ func NewWorld(opts ...WorldOption) (*World, error) {
 		}
 	}
 
+	// Set tick rate if provided
+	// it will be overridden by WithTickChannel option if provided
+	if cfg.CardinalTickRate > 0 {
+		world.tickChannel = time.Tick(time.Second / time.Duration(cfg.CardinalTickRate)) //nolint:staticcheck // its ok.
+	}
+
 	// Apply options
 	for _, opt := range cardinalOptions {
 		opt(world)