Skip to content

Commit

Permalink
fixup! DOC: add new README
Browse files Browse the repository at this point in the history
  • Loading branch information
@omidasadpour
omidasadpour committed Jan 26, 2024
1 parent 6e43f41 commit 9adb410
Showing 1 changed file with 29 additions and 29 deletions.
58 changes: 29 additions & 29 deletions charts/rollups-node/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -87,35 +87,35 @@ The command removes all the Kubernetes components associated with the chart and
| validator.affinity | object | `{}` | Affinity for validator pods assignment |
| validator.args | list | `[]` | Override default container args (useful when using custom images) |
| validator.command | list | `["cartesi-rollups-node"]` | Override default container command (useful when using custom images) |
| validator.config.auth.CARTESI_AUTH_AWS_KMS_KEY_ID | string | `nil` | 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`. |
| validator.config.auth.CARTESI_AUTH_AWS_KMS_REGION | string | `nil` | An AWS KMS Region. Must be set alongside `CARTESI_AUTH_AWS_KMS_KEY_ID`. |
| validator.config.auth.CARTESI_AUTH_MNEMONIC | string | `nil` | The node will use the private key generated from this mnemonic to sign transactions. Overrides `CARTESI_AUTH_MNEMONIC_FILE` and `CARTESI_AUTH_AWS_KMS_*`. |
| validator.config.auth.CARTESI_AUTH_MNEMONIC_ACCOUNT_INDEX | int | `0` | When using mnemonics to sign transactions, the node will use this account index to generate the private key. |
| validator.config.auth.CARTESI_AUTH_MNEMONIC_FILE | string | `nil` | The node will use the private key generated from the mnemonic contained in this file to sign transactions. Overrides `CARTESI_AUTH_AWS_KMS_*`. |
| validator.config.blockchain.CARTESI_BLOCKCHAIN_BLOCK_TIMEOUT | int | `60` | Block subscription timeout in seconds. |
| validator.config.blockchain.CARTESI_BLOCKCHAIN_FINALITY_OFFSET | int | `10` | The node assumes that blocks offseted by N from the current block have reached finality (N is the read depth). |
| validator.config.blockchain.CARTESI_BLOCKCHAIN_HTTP_ENDPOINT | string | `nil` | HTTP endpoint for the blockchain RPC provider. |
| validator.config.blockchain.CARTESI_BLOCKCHAIN_ID | string | `nil` | An unique identifier representing a blockchain network. |
| validator.config.blockchain.CARTESI_BLOCKCHAIN_IS_LEGACY | bool | `false` | If set to true the node will send transactions using the legacy gas fee model (instead of EIP-1559). |
| validator.config.blockchain.CARTESI_BLOCKCHAIN_WS_ENDPOINT | string | `nil` | WebSocket endpoint for the blockchain RPC provider. |
| validator.config.blockchain.CARTESI_CONTRACTS_INPUT_BOX_DEPLOYMENT_BLOCK_NUMBER | string | `nil` | The deployment block for the input box contract. The node will begin to read blockchain events from this block. |
| validator.config.contracts.CARTESI_CONTRACTS_AUTHORITY_ADDRESS | string | `nil` | Address of the Authority contract. |
| validator.config.contracts.CARTESI_CONTRACTS_DAPP_ADDRESS | string | `nil` | Address of the DApp's contract. |
| validator.config.contracts.CARTESI_CONTRACTS_DAPP_DEPLOYMENT_BLOCK_NUMBER | string | `nil` | Block in which the DApp's contract was deployed. |
| validator.config.contracts.CARTESI_CONTRACTS_HISTORY_ADDRESS | string | `nil` | Address of the History contract. |
| validator.config.contracts.CARTESI_CONTRACTS_INPUT_BOX_ADDRESS | string | `nil` | Address of the InputBox contract. |
| validator.config.experimental.CARTESI_EXPERIMENTAL_SUNODO_VALIDATOR_ENABLED | bool | `false` | When enabled, the node does not start the authority-claimer service and the Redis server. |
| validator.config.experimental.CARTESI_EXPERIMENTAL_SUNODO_VALIDATOR_REDIS_ENDPOINT | string | `nil` | External Redis endpoint for the node when running in the experimental sunodo validator mode. |
| validator.config.features.CARTESI_FEATURE_DISABLE_MACHINE_HASH_CHECK | bool | `false` | If set to true, the node will *not* check whether the Cartesi machine hash from the snapshot matches the hash in the Application contract. |
| validator.config.features.CARTESI_FEATURE_HOST_MODE | bool | `false` | 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! |
| validator.config.features.CARTESI_FEATURE_READER_MODE | bool | `false` | If set to true, the node will run in reader mode. In reader mode, the node does not make claims. |
| validator.config.http.CARTESI_HTTP_ADDRESS | string | `"127.0.0.1"` | HTTP address for the node. |
| validator.config.http.CARTESI_HTTP_PORT | int | `10000` | HTTP port for the node. The node will also use the 20 ports after this one for internal services. |
| validator.config.logging.CARTESI_LOG_LEVEL | string | `"info"` | One of "debug", "info", "warning", "error". |
| validator.config.logging.CARTESI_LOG_TIMESTAMP | bool | `false` | If set to true, the node will print the timestamp when logging. |
| validator.config.postgres.CARTESI_POSTGRES_ENDPOINT | string | `nil` | 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](https://www.postgresql.org/docs/current/libpq-envars.html) for more information. 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. |
| validator.config.rollups.CARTESI_EPOCH_DURATION | int | `86400` | Duration of a rollups epoch in seconds. At the end of each epoch, the node will send claims to the blockchain. |
| validator.config.snapshot.CARTESI_SNAPSHOT_DIR | string | `nil` | Path to the directory of the cartesi-machine snapshots. |
| validator.config.CARTESI_AUTH_AWS_KMS_KEY_ID | string | `""` | 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`. |
| validator.config.CARTESI_AUTH_AWS_KMS_REGION | string | `""` | An AWS KMS Region. Must be set alongside `CARTESI_AUTH_AWS_KMS_KEY_ID`. |
| validator.config.CARTESI_AUTH_MNEMONIC | string | `""` | The node will use the private key generated from this mnemonic to sign transactions. Overrides `CARTESI_AUTH_MNEMONIC_FILE` and `CARTESI_AUTH_AWS_KMS_*`. |
| validator.config.CARTESI_AUTH_MNEMONIC_ACCOUNT_INDEX | string | `"0"` | When using mnemonics to sign transactions, the node will use this account index to generate the private key. |
| validator.config.CARTESI_AUTH_MNEMONIC_FILE | string | `""` | The node will use the private key generated from the mnemonic contained in this file to sign transactions. Overrides `CARTESI_AUTH_AWS_KMS_*`. |
| validator.config.CARTESI_BLOCKCHAIN_BLOCK_TIMEOUT | string | `"60"` | Block subscription timeout in seconds. |
| validator.config.CARTESI_BLOCKCHAIN_FINALITY_OFFSET | string | `"10"` | The node assumes that blocks offseted by N from the current block have reached finality (N is the read depth). |
| validator.config.CARTESI_BLOCKCHAIN_HTTP_ENDPOINT | string | `""` | HTTP endpoint for the blockchain RPC provider. |
| validator.config.CARTESI_BLOCKCHAIN_ID | string | `""` | An unique identifier representing a blockchain network. |
| validator.config.CARTESI_BLOCKCHAIN_IS_LEGACY | string | `"false"` | If set to true the node will send transactions using the legacy gas fee model (instead of EIP-1559). |
| validator.config.CARTESI_BLOCKCHAIN_WS_ENDPOINT | string | `""` | WebSocket endpoint for the blockchain RPC provider. |
| validator.config.CARTESI_CONTRACTS_AUTHORITY_ADDRESS | string | `""` | Address of the Authority contract. |
| validator.config.CARTESI_CONTRACTS_DAPP_ADDRESS | string | `""` | Address of the DApp's contract. |
| validator.config.CARTESI_CONTRACTS_DAPP_DEPLOYMENT_BLOCK_NUMBER | string | `""` | Block in which the DApp's contract was deployed. |
| validator.config.CARTESI_CONTRACTS_HISTORY_ADDRESS | string | `""` | Address of the History contract. |
| validator.config.CARTESI_CONTRACTS_INPUT_BOX_ADDRESS | string | `""` | Address of the InputBox contract. |
| validator.config.CARTESI_CONTRACTS_INPUT_BOX_DEPLOYMENT_BLOCK_NUMBER | string | `""` | The deployment block for the input box contract. The node will begin to read blockchain events from this block. |
| validator.config.CARTESI_EPOCH_DURATION | string | `"86400"` | Duration of a rollups epoch in seconds. At the end of each epoch, the node will send claims to the blockchain. |
| validator.config.CARTESI_EXPERIMENTAL_SUNODO_VALIDATOR_ENABLED | string | `"false"` | When enabled, the node does not start the authority-claimer service and the Redis server. |
| validator.config.CARTESI_EXPERIMENTAL_SUNODO_VALIDATOR_REDIS_ENDPOINT | string | `""` | External Redis endpoint for the node when running in the experimental sunodo validator mode. |
| validator.config.CARTESI_FEATURE_DISABLE_MACHINE_HASH_CHECK | string | `"false"` | | If set to true, the node will *not* check whether the Cartesi machine hash from the snapshot matches the hash in the Application contract. |
| validator.config.CARTESI_FEATURE_HOST_MODE | string | `"false"` | 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! |
| validator.config.CARTESI_FEATURE_READER_MODE | string | `"false"` | If set to true, the node will run in reader mode. In reader mode, the node does not make claims. |
| validator.config.CARTESI_HTTP_ADDRESS | string | `"127.0.0.1"` | HTTP address for the node. |
| validator.config.CARTESI_HTTP_PORT | string | `"10000"` | HTTP port for the node. The node will also use the 20 ports after this one for internal services. |
| validator.config.CARTESI_LOG_LEVEL | string | `"info"` | One of "debug", "info", "warning", "error". |
| validator.config.CARTESI_LOG_TIMESTAMP | string | `"false"` | If set to true, the node will print the timestamp when logging. |
| validator.config.CARTESI_POSTGRES_ENDPOINT | string | `""` | 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](https://www.postgresql.org/docs/current/libpq-envars.html) for more information. 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. |
| validator.config.CARTESI_SNAPSHOT_DIR | string | `""` | Path to the directory with the cartesi-machine snapshot that will be loaded by the node. |
| validator.extraArgs | list | `[]` | Extra arguments for dispatcher |
| validator.extraEnvVars | list | `[]` | Array with extra environment variables to add to validator.validator Pod # e.g: # extraEnvVars: # - name: FOO # value: "bar" # |
| validator.extraEnvVarsCM | string | `""` | Name of existing ConfigMap containing extra env vars for validator Pod # |
Expand Down

0 comments on commit 9adb410

Please sign in to comment.