feat(config): add reader mode

While here, fix advance-runner configuration

docs/config.md

@@ -187,6 +187,15 @@ You should only use host mode for development and debugging!
 * **Type:** `bool`
 * **Default:** `"false"`
 
+## `CARTESI_FEATURE_READER_MODE_ENABLED`
+
+If set to true, the node will run in reader mode.
+
+In reader mode, the authority-claimer is disabled. Thus, no claims are generated.
+
+* **Type:** `bool`
+* **Default:** `"false"`
+
 ## `CARTESI_HTTP_ADDRESS`
 
 HTTP address for the node.

internal/node/config/config.go

@@ -32,6 +32,7 @@ type NodeConfig struct {
 	HttpAddress                              string
 	HttpPort                                 int
 	FeatureHostMode                          bool
+	FeatureReaderModeEnabled                 bool
 	FeatureDisableClaimer                    bool
 	FeatureDisableMachineHashCheck           bool
 	ExperimentalServerManagerBypassLog       bool
@@ -96,13 +97,17 @@ func FromEnv() NodeConfig {
 	config.FeatureDisableMachineHashCheck = getFeatureDisableMachineHashCheck()
 	config.ExperimentalServerManagerBypassLog = getExperimentalServerManagerBypassLog()
 	config.FeatureDisableClaimer = getFeatureDisableClaimer()
+	config.FeatureReaderModeEnabled = getFeatureReaderModeEnabled()
 	config.ExperimentalSunodoValidatorEnabled = getExperimentalSunodoValidatorEnabled()
+	// The experimental mode overrides the reader mode and claimer configuration
 	if config.ExperimentalSunodoValidatorEnabled {
 		config.ExperimentalSunodoValidatorRedisEndpoint =
 			Redacted[string]{getExperimentalSunodoValidatorRedisEndpoint()}
 		config.FeatureDisableClaimer = true
+		config.FeatureReaderModeEnabled = false
 	}
-	if !config.FeatureDisableClaimer && !getExperimentalSunodoValidatorEnabled() {
+	// Authentication is only available when the claimer is enabled
+	if !config.FeatureDisableClaimer {
 		config.Auth = authFromEnv()
 	}
 	return config

internal/node/config/config_test.go

@@ -32,22 +32,31 @@ func TestConfigTest(t *testing.T) {
 }
 
 func (s *ConfigTestSuite) TestExperimentalSunodoValidatorModeDisablesClaimer() {
-	os.Setenv("CARTESI_EXPERIMENTAL_SUNODO_VALIDATOR_ENABLED", "true")
-	os.Setenv("CARTESI_EXPERIMENTAL_SUNODO_VALIDATOR_REDIS_ENDPOINT", "redis://")
+	enableSunodoValidatorMode()
 	c := FromEnv()
 	assert.Equal(s.T(), true, c.FeatureDisableClaimer)
 }
 
+func (s *ConfigTestSuite) TestExperimentalSunodoValidatorModeDisablesReaderMode() {
+	enableSunodoValidatorMode()
+	c := FromEnv()
+	assert.Equal(s.T(), false, c.FeatureReaderModeEnabled)
+}
+
 func (s *ConfigTestSuite) TestAuthIsNotSetWhenClaimerIsDisabled() {
 	os.Setenv("CARTESI_FEATURE_DISABLE_CLAIMER", "true")
 	c := FromEnv()
 	assert.Nil(s.T(), c.Auth)
 }
 
 func (s *ConfigTestSuite) TestExperimentalSunodoValidatorRedisEndpointIsRedacted() {
+	enableSunodoValidatorMode()
+	c := FromEnv()
+	assert.Equal(s.T(), "[REDACTED]", c.ExperimentalSunodoValidatorRedisEndpoint.String())
+}
+
+func enableSunodoValidatorMode() {
 	os.Setenv("CARTESI_EXPERIMENTAL_SUNODO_VALIDATOR_ENABLED", "true")
 	os.Setenv("CARTESI_EXPERIMENTAL_SUNODO_VALIDATOR_REDIS_ENDPOINT",
 		"redis://username:p@ssw0rd@hostname:9999")
-	c := FromEnv()
-	assert.Equal(s.T(), "[REDACTED]", c.ExperimentalSunodoValidatorRedisEndpoint.String())
 }

internal/node/config/generate/Config.toml

@@ -28,6 +28,14 @@ If set to true, the node will run in host mode.
 In host mode, computations will not be performed by the cartesi machine.
 You should only use host mode for development and debugging!"""
 
+[features.CARTESI_FEATURE_READER_MODE_ENABLED]
+default = "false"
+go-type = "bool"
+description = """
+If set to true, the node will run in reader mode.
+
+In reader mode, the authority-claimer is disabled. Thus, no claims are generated."""
+
 [features.CARTESI_FEATURE_DISABLE_CLAIMER]
 default = "false"
 go-type = "bool"

internal/node/services.go

@@ -87,7 +87,7 @@ func newAdvanceRunner(c config.NodeConfig, workDir string) services.CommandServi
 		c.BlockchainHttpEndpoint.Value))
 	s.Env = append(s.Env, fmt.Sprintf("ADVANCE_RUNNER_HEALTHCHECK_PORT=%v",
 		getPort(c, portOffsetAdvanceRunner)))
-	s.Env = append(s.Env, fmt.Sprintf("READER_MODE=%v", c.FeatureDisableClaimer))
+	s.Env = append(s.Env, fmt.Sprintf("READER_MODE=%v", c.FeatureReaderModeEnabled))
 	if c.FeatureHostMode || c.FeatureDisableMachineHashCheck {
 		s.Env = append(s.Env, "SNAPSHOT_VALIDATION_ENABLED=false")
 	}