Skip to content

Latest commit

 

History

History
254 lines (145 loc) · 5.56 KB

config.md

File metadata and controls

254 lines (145 loc) · 5.56 KB
Raw

Node Configuration

The node is configurable through environment variables. (There is no other way to configure it.)

This file documents the configuration options.

CARTESI_AUTH_AWS_KMS_KEY_ID

If set, the node will use the AWS KMS service with this key ID to sign transactions.

Must be set alongside CARTESI_AUTH_AWS_KMS_REGION.

  • Type: string

CARTESI_AUTH_AWS_KMS_REGION

An AWS KMS Region.

Must be set alongside CARTESI_AUTH_AWS_KMS_KEY_ID.

  • Type: string

CARTESI_AUTH_KIND

One of "private_key", "private_key_file", "mnemonic", "mnemonic_file", "aws".

  • Type: AuthKind
  • Default: "mnemonic"

CARTESI_AUTH_MNEMONIC

The node will use the private key generated from this mnemonic to sign transactions.

  • Type: string

CARTESI_AUTH_MNEMONIC_ACCOUNT_INDEX

When using mnemonics to sign transactions, the node will use this account index to generate the private key.

  • Type: int
  • Default: "0"

CARTESI_AUTH_MNEMONIC_FILE

The node will use the private key generated from the mnemonic contained in this file to sign transactions.

  • Type: string

CARTESI_AUTH_PRIVATE_KEY

The node will use this private key to sign transactions.

  • Type: string

CARTESI_AUTH_PRIVATE_KEY_FILE

The node will use the private key contained in this file to sign transactions.

  • Type: string

CARTESI_BLOCKCHAIN_BLOCK_TIMEOUT

Block subscription timeout in seconds.

  • Type: int
  • Default: "60"

CARTESI_BLOCKCHAIN_FINALITY_OFFSET

The node assumes that blocks offseted by N from the current block have reached finality (N is the read depth).

  • Type: int
  • Default: "10"

CARTESI_BLOCKCHAIN_HTTP_ENDPOINT

HTTP endpoint for the blockchain RPC provider.

  • Type: string

CARTESI_BLOCKCHAIN_ID

An unique identifier representing a blockchain network.

  • Type: uint64

CARTESI_BLOCKCHAIN_IS_LEGACY

If set to true the node will send transactions using the legacy gas fee model (instead of EIP-1559).

  • Type: bool
  • Default: "false"

CARTESI_BLOCKCHAIN_WS_ENDPOINT

WebSocket endpoint for the blockchain RPC provider.

  • Type: string

CARTESI_CONTRACTS_APPLICATION_ADDRESS

Address of the DApp's contract.

  • Type: string

CARTESI_CONTRACTS_AUTHORITY_ADDRESS

Address of the Authority contract.

  • Type: string

CARTESI_CONTRACTS_HISTORY_ADDRESS

Address of the History contract.

  • Type: string

CARTESI_CONTRACTS_INPUT_BOX_ADDRESS

Address of the InputBox contract.

  • Type: string

CARTESI_CONTRACTS_INPUT_BOX_DEPLOYMENT_BLOCK_NUMBER

The deployment block for the input box contract. The node will begin to read blockchain events from this block.

  • Type: int64

CARTESI_EXPERIMENTAL_SERVER_MANAGER_BYPASS_LOG

When enabled, prints server-manager output to stdout and stderr directly. All other log configurations are ignored.

  • Type: bool
  • Default: "false"

CARTESI_EXPERIMENTAL_SUNODO_VALIDATOR_ENABLED

When enabled, the node does not start Redis. It must be configured with an external Redis endpoint.

  • Type: bool
  • Default: "false"

CARTESI_EXPERIMENTAL_SUNODO_VALIDATOR_REDIS_ENDPOINT

External Redis endpoint for the node when running in the experimental sunodo validator mode.

  • Type: string

CARTESI_FEATURE_DISABLE_CLAIMER

If set to true, the authority-claimer service is disabled.

  • Type: bool
  • Default: "false"

CARTESI_FEATURE_DISABLE_MACHINE_HASH_CHECK

If set to true, the node will not check whether the Cartesi machine hash from the snapshot matches the hash in the Application contract.

  • Type: bool
  • Default: "false"

CARTESI_FEATURE_HOST_MODE

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!

  • Type: bool
  • Default: "false"

CARTESI_FEATURE_READER_MODE_ENABLED

If set to true, the node will not generate any claims.

  • Type: bool
  • Default: "false"

CARTESI_HTTP_ADDRESS

HTTP address for the node.

  • Type: string
  • Default: "127.0.0.1"

CARTESI_HTTP_PORT

HTTP port for the node. The node will also use the 20 ports after this one for internal services.

  • Type: int
  • Default: "10000"

CARTESI_LOG_LEVEL

One of "debug", "info", "warn", "error".

  • Type: LogLevel
  • Default: "info"

CARTESI_LOG_PRETTY

If set to true, the node will add colors to its log output.

  • Type: bool
  • Default: "false"

CARTESI_POSTGRES_ENDPOINT

Postgres endpoint in the 'postgres://user:password@hostname:port/database' format.

If not set, or set to empty string, will defer the behaviour to the PG driver. See this for more information.

It is also possible to set the endpoint without a password and load it from Postgres' passfile. See this for more information.

  • Type: string
  • Default: ""

CARTESI_EPOCH_LENGTH

Length of a rollups epoch in blocks.

At the end of each epoch, the node will send claims to the blockchain.

  • Type: uint64
  • Default: "7200"

CARTESI_SNAPSHOT_DIR

Path to the directory with the cartesi-machine snapshot that will be loaded by the node.

  • Type: string