feat(prt): add PRT service boilerplate

Author: vfusco

.gitignore

@@ -14,6 +14,7 @@ machine-snapshot/**
 /cartesi-rollups-validator
 /cartesi-rollups-claimer
 /cartesi-rollups-jsonrpc-api
+/cartesi-rollups-prt
 /rollups-contracts
 /rollups-prt-contracts
 /applications

Makefile

@@ -59,7 +59,7 @@ DOCKER_PLATFORM=--platform $(BUILD_PLATFORM)
 endif
 
 # Go artifacts
-GO_ARTIFACTS := cartesi-rollups-node cartesi-rollups-cli cartesi-rollups-evm-reader cartesi-rollups-advancer cartesi-rollups-validator cartesi-rollups-claimer cartesi-rollups-jsonrpc-api
+GO_ARTIFACTS := $(addprefix cartesi-rollups-,node cli evm-reader advancer validator claimer jsonrpc-api prt)
 
 # fixme(vfusco): path on all oses
 CGO_CFLAGS:= -I$(PREFIX)/include

cmd/cartesi-rollups-prt/main.go

@@ -0,0 +1,17 @@
+// (c) Cartesi and individual authors (see AUTHORS)
+// SPDX-License-Identifier: Apache-2.0 (see LICENSE)
+
+package main
+
+import (
+	"os"
+
+	"github.com/cartesi/rollups-node/cmd/cartesi-rollups-prt/root"
+)
+
+func main() {
+	err := root.Cmd.Execute()
+	if err != nil {
+		os.Exit(1)
+	}
+}

cmd/cartesi-rollups-prt/root/root.go

@@ -0,0 +1,95 @@
+// (c) Cartesi and individual authors (see AUTHORS)
+// SPDX-License-Identifier: Apache-2.0 (see LICENSE)
+
+package root
+
+import (
+	"context"
+
+	"github.com/cartesi/rollups-node/internal/config"
+	"github.com/cartesi/rollups-node/internal/prt"
+	"github.com/cartesi/rollups-node/internal/repository/factory"
+	"github.com/cartesi/rollups-node/internal/version"
+	"github.com/cartesi/rollups-node/pkg/service"
+
+	"github.com/spf13/cobra"
+	"github.com/spf13/viper"
+)
+
+const serviceName = "prt"
+
+var (
+	logLevel           string
+	logColor           bool
+	databaseConnection string
+	pollInterval       string
+	maxStartupTime     string
+	telemetryAddress   string
+	cfg                *config.ValidatorConfig
+)
+
+var Cmd = &cobra.Command{
+	Use:     "cartesi-rollups-" + serviceName,
+	Short:   "Runs cartesi-rollups-" + serviceName,
+	Long:    "Runs cartesi-rollups-" + serviceName + " in standalone mode",
+	Run:     run,
+	Version: version.BuildVersion,
+}
+
+func init() {
+	Cmd.Flags().StringVar(&telemetryAddress, "telemetry-address", ":10003", "Health check and metrics address and port")
+	cobra.CheckErr(viper.BindPFlag(config.TELEMETRY_ADDRESS, Cmd.Flags().Lookup("telemetry-address")))
+
+	Cmd.Flags().StringVar(&logLevel, "log-level", "info", "Log level: debug, info, warn or error")
+	cobra.CheckErr(viper.BindPFlag(config.LOG_LEVEL, Cmd.Flags().Lookup("log-level")))
+
+	Cmd.Flags().BoolVar(&logColor, "log-color", true, "Tint the logs (colored output)")
+	cobra.CheckErr(viper.BindPFlag(config.LOG_COLOR, Cmd.Flags().Lookup("log-color")))
+
+	Cmd.Flags().StringVar(&databaseConnection, "database-connection", "",
+		"Database connection string in the URL format\n(eg.: 'postgres://user:password@hostname:port/database') ")
+	cobra.CheckErr(viper.BindPFlag(config.DATABASE_CONNECTION, Cmd.Flags().Lookup("database-connection")))
+
+	Cmd.Flags().StringVar(&pollInterval, "poll-interval", "7", "Poll interval")
+	cobra.CheckErr(viper.BindPFlag(config.VALIDATOR_POLLING_INTERVAL, Cmd.Flags().Lookup("poll-interval")))
+
+	Cmd.Flags().StringVar(&maxStartupTime, "max-startup-time", "15", "Maximum startup time in seconds")
+	cobra.CheckErr(viper.BindPFlag(config.MAX_STARTUP_TIME, Cmd.Flags().Lookup("max-startup-time")))
+
+	// TODO: validate on preRunE
+	Cmd.PreRunE = func(cmd *cobra.Command, args []string) error {
+		var err error
+		cfg, err = config.LoadValidatorConfig()
+		if err != nil {
+			return err
+		}
+		return nil
+	}
+}
+
+func run(cmd *cobra.Command, args []string) {
+	ctx, cancel := context.WithTimeout(context.Background(), cfg.MaxStartupTime)
+	defer cancel()
+
+	createInfo := prt.CreateInfo{
+		CreateInfo: service.CreateInfo{
+			Name:                 serviceName,
+			LogLevel:             cfg.LogLevel,
+			LogColor:             cfg.LogColor,
+			EnableSignalHandling: true,
+			TelemetryCreate:      true,
+			TelemetryAddress:     cfg.TelemetryAddress,
+			PollInterval:         cfg.ValidatorPollingInterval,
+		},
+		Config: *cfg,
+	}
+	var err error
+	createInfo.Repository, err = factory.NewRepositoryFromConnectionString(ctx, cfg.DatabaseConnection.String())
+	cobra.CheckErr(err)
+	defer createInfo.Repository.Close()
+
+	validatorService, err := prt.Create(ctx, &createInfo)
+	cobra.CheckErr(err)
+
+	cobra.CheckErr(validatorService.Serve())
+}

internal/config/generate/Config.toml

@@ -8,14 +8,14 @@ default = "info"
 go-type = "LogLevel"
 description = """
 One of "debug", "info", "warn", "error"."""
-used-by = ["advancer", "claimer", "evmreader", "validator", "jsonrpc", "node"]
+used-by = ["advancer", "claimer", "evmreader", "validator", "jsonrpc", "node", "prt"]
 
 [logging.CARTESI_LOG_COLOR]
 default = "true"
 go-type = "bool"
 description = """
 If set to true, the node will add colors to its log output."""
-used-by = ["advancer", "claimer", "evmreader", "validator", "jsonrpc", "node"]
+used-by = ["advancer", "claimer", "evmreader", "validator", "jsonrpc", "node", "prt"]
 
 #
 # Features
@@ -33,7 +33,7 @@ default = "true"
 go-type = "bool"
 description = """
 If set to false, the node will not submit claims (reader mode)."""
-used-by = ["claimer", "node"]
+used-by = ["claimer", "node", "prt"]
 
 [features.CARTESI_FEATURE_INSPECT_ENABLED]
 default = "true"
@@ -82,12 +82,19 @@ description = """
 How many seconds the node will wait before querying the database for new claims."""
 used-by = ["claimer", "node"]
 
+[rollups.CARTESI_PRT_POLLING_INTERVAL]
+default = "3"
+go-type = "Duration"
+description = """
+How many seconds the node will wait before trying to finish epochs for all applications."""
+used-by = ["prt", "node"]
+
 [rollups.CARTESI_MAX_STARTUP_TIME]
 default = "15"
 go-type = "Duration"
 description = """
 How many seconds the node expects services take initializing before aborting."""
-used-by = ["advancer", "claimer", "evmreader", "validator", "jsonrpc", "node"]
+used-by = ["advancer", "claimer", "evmreader", "validator", "jsonrpc", "node", "prt"]
 
 #
 # Blockchain
@@ -97,14 +104,14 @@ used-by = ["advancer", "claimer", "evmreader", "validator", "jsonrpc", "node"]
 go-type = "uint64"
 description = """
 An unique identifier representing a blockchain network."""
-used-by = ["evmreader", "claimer", "node"]
+used-by = ["evmreader", "claimer", "node", "prt"]
 
 [blockchain.CARTESI_BLOCKCHAIN_HTTP_ENDPOINT]
 file = true
 go-type = "URL"
 description = """
 HTTP endpoint for the blockchain RPC provider."""
-used-by = ["evmreader", "claimer", "node"]
+used-by = ["evmreader", "claimer", "node", "prt"]
 
 [blockchain.CARTESI_BLOCKCHAIN_HTTP_AUTHORIZATION]
 file = true
@@ -133,15 +140,15 @@ go-type = "bool"
 description = """
 If set to true the node will send transactions using the legacy gas fee model
 (instead of EIP-1559)."""
-used-by = ["claimer", "node", "cli"]
+used-by = ["claimer", "node", "cli", "prt"]
 
 [blockchain.CARTESI_BLOCKCHAIN_DEFAULT_BLOCK]
 default = "finalized"
 go-type = "DefaultBlock"
 description = """
 The default block to be used by EVM Reader and Claimer when requesting new blocks.
 One of 'latest', 'pending', 'safe', 'finalized'"""
-used-by = ["evmreader", "claimer", "node"]
+used-by = ["evmreader", "claimer", "node", "prt"]
 
 [blockchain.CARTESI_BLOCKCHAIN_SUBSCRIPTION_TIMEOUT]
 default = "60"
@@ -155,28 +162,28 @@ default = "4"
 go-type = "uint64"
 description = """
 Maximum number of retry attempts for HTTP blockchain requests after encountering an error."""
-used-by = ["evmreader", "claimer", "node"]
+used-by = ["evmreader", "claimer", "node", "prt"]
 
 [rollups.CARTESI_BLOCKCHAIN_HTTP_RETRY_MIN_WAIT]
 default = "1"
 go-type = "Duration"
 description = """
 Minimum wait time in seconds for the exponential backoff retry policy. This is the initial delay before the first retry for HTTP blockchain requests."""
-used-by = ["evmreader", "claimer", "node"]
+used-by = ["evmreader", "claimer", "node", "prt"]
 
 [rollups.CARTESI_BLOCKCHAIN_HTTP_RETRY_MAX_WAIT]
 default = "60"
 go-type = "Duration"
 description = """
 Maximum wait time in seconds for the exponential backoff retry policy. The delay between retries for HTTP blockchain requests will never exceed this value, regardless of the backoff calculation."""
-used-by = ["evmreader", "claimer", "node"]
+used-by = ["evmreader", "claimer", "node", "prt"]
 
 [rollups.CARTESI_BLOCKCHAIN_MAX_BLOCK_RANGE]
 default = "0"
 go-type = "uint64"
 description = """
 Maximum number of blocks in a single query to the provider. Queries with larger ranges will be broken into multiple smaller queries. Zero for unlimited."""
-used-by = ["evmreader", "claimer", "node"]
+used-by = ["evmreader", "claimer", "node", "prt"]
 
 #
 # Contracts
@@ -226,7 +233,7 @@ default = "/var/lib/cartesi-rollups-node/snapshots"
 go-type = "string"
 description = """
 Path to the directory where the snapshots will be written."""
-used-by = ["advancer", "node"]
+used-by = ["advancer", "node", "prt"]
 
 #
 # Auth
@@ -240,23 +247,23 @@ One of "private_key", "private_key_file", "mnemonic", "mnemonic_file", "aws".
 
 The auth variable for the kind defined here is required. Eg.: CARTESI_AUTH_MNEMONIC"""
 omit = true
-used-by = ["claimer", "node", "cli"]
+used-by = ["claimer", "node", "cli", "prt"]
 
 [auth.CARTESI_AUTH_PRIVATE_KEY]
 file = true
 go-type = "RedactedString"
 description = """
 The node will use this private key to sign transactions."""
 omit = true
-used-by = ["claimer", "node", "cli"]
+used-by = ["claimer", "node", "cli", "prt"]
 
 [auth.CARTESI_AUTH_MNEMONIC]
 file = true
 go-type = "RedactedString"
 description = """
 The node will use the private key generated from this mnemonic to sign transactions."""
 omit = true
-used-by = ["claimer", "node", "cli"]
+used-by = ["claimer", "node", "cli", "prt"]
 
 [auth.CARTESI_AUTH_MNEMONIC_ACCOUNT_INDEX]
 default = "0"
@@ -265,7 +272,7 @@ description = """
 When using mnemonics to sign transactions,
 the node will use this account index to generate the private key."""
 omit = true
-used-by = ["claimer", "node", "cli"]
+used-by = ["claimer", "node", "cli", "prt"]
 
 [auth.CARTESI_AUTH_AWS_KMS_KEY_ID]
 go-type = "RedactedString"
@@ -274,7 +281,7 @@ If set, the node will use the AWS KMS service with this key ID to sign transacti
 
 Must be set alongside `CARTESI_AUTH_AWS_KMS_REGION`."""
 omit = true
-used-by = ["claimer", "node", "cli"]
+used-by = ["claimer", "node", "cli", "prt"]
 
 [auth.CARTESI_AUTH_AWS_KMS_REGION]
 go-type = "RedactedString"
@@ -283,7 +290,7 @@ An AWS KMS Region.
 
 Must be set alongside `CARTESI_AUTH_AWS_KMS_KEY_ID`."""
 omit = true
-used-by = ["claimer", "node", "cli"]
+used-by = ["claimer", "node", "cli", "prt"]
 
 #
 # Database
@@ -302,7 +309,7 @@ See [this](https://www.postgresql.org/docs/current/libpq-envars.html) for more i
 It is also possible to set the endpoint without a password and load it from Postgres' passfile.
 See [this](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNECT-PASSFILE)
 for more information."""
-used-by = ["advancer", "claimer", "evmreader", "validator", "jsonrpc", "node", "cli"]
+used-by = ["advancer", "claimer", "evmreader", "validator", "jsonrpc", "node", "cli", "prt"]
 
 #
 # Telemetry http address
@@ -312,7 +319,7 @@ used-by = ["advancer", "claimer", "evmreader", "validator", "jsonrpc", "node", "
 go-type = "string"
 description = """
 HTTP address for telemetry service."""
-used-by = ["advancer", "claimer", "evmreader", "validator", "jsonrpc", "node", "cli"]
+used-by = ["advancer", "claimer", "evmreader", "validator", "jsonrpc", "node", "cli", "prt"]
 
 #
 # HTTP