feat(devnet): add devnet devnet-finalization-offset config

cartesi · Sep 9, 2024 · c71013f · c71013f
1 parent 84e4f2e
commit c71013f
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 13 deletions.
diff --git a/cmd/cartesi-rollups-cli/root/deps/deps.go b/cmd/cartesi-rollups-cli/root/deps/deps.go
@@ -54,11 +54,15 @@ func init() {
 
 	Cmd.Flags().StringVar(&depsConfig.Devnet.BlockTime, "devnet-block-time",
 		deps.DefaultDevnetBlockTime,
-		"Devnet mining block time")
+		"Devnet mining block time in seconds when 'interval mining' is enabled.")
 
 	Cmd.Flags().BoolVar(&depsConfig.Devnet.NoMining, "devnet-no-mining",
 		deps.DefaultDevnetNoMining,
-		"Devnet disable mining")
+		"Disable Devnet 'auto/interval mining'.")
+
+	Cmd.Flags().StringVar(&depsConfig.Devnet.BlockFinalizationOffset, "devnet-finalization-offset",
+		deps.DefaultSlotsInAnEpoch,
+		"Devnet finalization block offset in blocks")
 
 	Cmd.Flags().BoolVar(&disablePostgres, "disable-postgres", false, "Disable Postgres")
 

diff --git a/docs/cli/cartesi-rollups-cli_run-deps.md b/docs/cli/cartesi-rollups-cli_run-deps.md
@@ -16,17 +16,18 @@ cartesi-rollups-cli run-deps
 ### Options
 
 ```
-      --devnet-block-time string       Devnet mining block time (default "1")
-      --devnet-docker-image string     Devnet docker image name (default "cartesi/rollups-node-devnet:devel")
-      --devnet-mapped-port string      Devnet local listening port number (default "8545")
-      --devnet-no-mining               Devnet disable mining
-      --disable-devnet                 Disable Devnet
-      --disable-postgres               Disable Postgres
-  -h, --help                           help for run-deps
-      --postgres-docker-image string   Postgres docker image name (default "postgres:16-alpine")
-      --postgres-mapped-port string    Postgres local listening port number (default "5432")
-      --postgres-password string       Postgres password (default "password")
-  -v, --verbose                        verbose logs
+      --devnet-block-time string            Devnet mining block time in seconds when 'interval mining' is enabled. (default "1")
+      --devnet-docker-image string          Devnet docker image name (default "cartesi/rollups-node-devnet:devel")
+      --devnet-finalization-offset string   Devnet finalization block offset in blocks (default "1")
+      --devnet-mapped-port string           Devnet local listening port number (default "8545")
+      --devnet-no-mining                    Disable Devnet 'auto/interval mining'.
+      --disable-devnet                      Disable Devnet
+      --disable-postgres                    Disable Postgres
+  -h, --help                                help for run-deps
+      --postgres-docker-image string        Postgres docker image name (default "postgres:16-alpine")
+      --postgres-mapped-port string         Postgres local listening port number (default "5432")
+      --postgres-password string            Postgres password (default "password")
+  -v, --verbose                             verbose logs
 ```
 
 ### SEE ALSO

diff --git a/internal/deps/deps.go b/internal/deps/deps.go
@@ -28,6 +28,7 @@ const (
 	DefaultDevnetDockerImage             = "cartesi/rollups-node-devnet:devel"
 	DefaultDevnetPort                    = "8545"
 	DefaultDevnetBlockTime               = "1"
+	DefaultSlotsInAnEpoch                = "1"
 	DefaultDevnetBlockToWaitForOnStartup = "21"
 	DefaultDevnetNoMining                = false
 
@@ -61,6 +62,7 @@ type DevnetConfig struct {
 	DockerImage             string
 	Port                    string
 	BlockTime               string
+	BlockFinalizationOffset string
 	BlockToWaitForOnStartup string
 	NoMining                bool
 }
@@ -77,6 +79,7 @@ func NewDefaultDepsConfig() *DepsConfig {
 			DefaultDevnetDockerImage,
 			DefaultDevnetPort,
 			DefaultDevnetBlockTime,
+			DefaultSlotsInAnEpoch,
 			DefaultDevnetBlockToWaitForOnStartup,
 			DefaultDevnetNoMining,
 		},
@@ -257,6 +260,14 @@ func Run(ctx context.Context, depsConfig DepsConfig) (*DepsContainers, error) {
 			"--load-state",
 			"/usr/share/devnet/anvil_state.json",
 		}
+
+		if depsConfig.Devnet.BlockFinalizationOffset != "" {
+			cmd = append(cmd,
+				"--slots-in-an-epoch",
+				depsConfig.Devnet.BlockFinalizationOffset,
+			)
+		}
+
 		var waitStrategy *wait.LogStrategy
 		if depsConfig.Devnet.NoMining {
 			cmd = append(cmd, "--no-mining")