Environment variables

Configure your validator

Make sure that you have completed Local Setup or AWS Setup​
Also take a look at the Agent Configuration page.
Environment variables
Your validator takes environment variables as configuration. See below for these environment variables & those that are specific to the setup instructions you followed.
Environment variable
Description
CONFIG_FILES
If you want support your own chain that you permissionlessly deployed, you specify the path to that agent config file here as well.
HYP_VALIDATOR_ORIGINCHAINNAME
The name of the chain being validated (e.g. ethereum)
HYP_VALIDATOR_REORGPERIOD
The number of block confirmations a validator should wait before signing the Mailbox merkle root. Note that signing a root that is later invalidated (i.e. due to a re-org) is considered fraudulent behavior and will eventually be slashable.
Suggestions below.
HYP_VALIDATOR_INTERVAL
In seconds, the frequency with which the validator should poll the Mailbox merkle root.
Suggestions below.
HYP_BASE_CHAINS_[origin chain name]_CONNECTION_URL
The RPC URL of the node for the chain you are validating. Note Polygon mainnet requires an RPC URL of an archive node (see An RPC nodefor details).
e.g. HYP_BASE_CHAINS_ETHEREUM_CONNECTION_URL or HYP_BASE_CHAINS_POLYGON_CONNECTION_URL
HYP_BASE_METRICS
Set to 9090, or any other port number you wish to expose Prometheus metrics on. Not specifying a value will result in metrics not being exposed.
HYP_BASE_TRACING_LEVEL
Specifies the log level, set to info
HYP_BASE_TRACING_FMT
Specifies the format of the logs, set it to either pretty or json
Setup-specific environment variables
These required environment variables differ based on which setup instructions you followed.
AWS setup
Local setup
These are required environment variables that are specific to the AWS setup.
Environment variable
Description
HYP_VALIDATOR_VALIDATOR_TYPE
Set to aws.
HYP_VALIDATOR_VALIDATOR_ID
The alias of your validator's AWS KMS key, prefixed with alias/.
Example: alias/hyperlane-validator-signer-${chain_name}
HYP_VALIDATOR_VALIDATOR_REGION
The region of your AWS KMS key.
Example: us-east-1.
HYP_VALIDATOR_CHECKPOINTSYNCER_TYPE
Set to s3.
HYP_VALIDATOR_CHECKPOINTSYNCER_BUCKET
The AWS S3 bucket name.
HYP_VALIDATOR_CHECKPOINTSYNCER_REGION
The region of your AWS S3 bucket.
Example: us-east-1.
AWS_ACCESS_KEY_ID
The access key ID of your validator's AWS IAM user.
AWS_SECRET_ACCESS_KEY
The secret access key of your validator's AWS IAM user.
These are required environment variables that are specific to the Local setup.
Environment variable
Description
HYP_VALIDATOR_VALIDATOR_TYPE
Set to hexKey.
HYP_VALIDATOR_VALIDATOR_KEY
Your validator's private key, which is used to sign merkle roots.
HYP_VALIDATOR_CHECKPOINTSYNCER_TYPE
Set to localStorage.
HYP_VALIDATOR_CHECKPOINTSYNCER_PATH
The path to your local directory where validator signatures will be written. This should be the value of $MY_VALIDATOR_SIGNATURES_DIRECTORY from the Local setup.
Example: /tmp/hyperlane-validator-signatures-ethereum
Suggested Reorg Periods
Latencies
Next
Next, in the Start validating section we will get the validator up and running.
Start validating

Environment variable	Description
`CONFIG_FILES`	If you want support your own chain that you permissionlessly deployed, you specify the path to that agent config file here as well.
`HYP_VALIDATOR_ORIGINCHAINNAME`	The name of the chain being validated (e.g. `ethereum`)
`HYP_VALIDATOR_REORGPERIOD`	The number of block confirmations a validator should wait before signing the `Mailbox` merkle root. Note that signing a root that is later invalidated (i.e. due to a re-org) is considered fraudulent behavior and will eventually be slashable. Suggestions below.
`HYP_VALIDATOR_INTERVAL`	In seconds, the frequency with which the validator should poll the `Mailbox` merkle root. Suggestions below.
`HYP_BASE_CHAINS_[origin chain name]_CONNECTION_URL`	The RPC URL of the node for the chain you are validating. Note Polygon mainnet requires an RPC URL of an archive node (see An RPC nodefor details). e.g. `HYP_BASE_CHAINS_ETHEREUM_CONNECTION_URL` or `HYP_BASE_CHAINS_POLYGON_CONNECTION_URL`
`HYP_BASE_METRICS`	Set to `9090`, or any other port number you wish to expose Prometheus metrics on. Not specifying a value will result in metrics not being exposed.
`HYP_BASE_TRACING_LEVEL`	Specifies the log level, set to `info`
`HYP_BASE_TRACING_FMT`	Specifies the format of the logs, set it to either `pretty` or `json`

Environment variable	Description
`HYP_VALIDATOR_VALIDATOR_TYPE`	Set to `aws`.
`HYP_VALIDATOR_VALIDATOR_ID`	The alias of your validator's AWS KMS key, prefixed with `alias/`. Example: `alias/hyperlane-validator-signer-${chain_name}`
`HYP_VALIDATOR_VALIDATOR_REGION`	The region of your AWS KMS key. Example: `us-east-1`.
`HYP_VALIDATOR_CHECKPOINTSYNCER_TYPE`	Set to `s3`.
`HYP_VALIDATOR_CHECKPOINTSYNCER_BUCKET`	The AWS S3 bucket name.
`HYP_VALIDATOR_CHECKPOINTSYNCER_REGION`	The region of your AWS S3 bucket. Example: `us-east-1`.
`AWS_ACCESS_KEY_ID`	The access key ID of your validator's AWS IAM user.
`AWS_SECRET_ACCESS_KEY`	The secret access key of your validator's AWS IAM user.

Environment variable	Description
`HYP_VALIDATOR_VALIDATOR_TYPE`	Set to `hexKey`.
`HYP_VALIDATOR_VALIDATOR_KEY`	Your validator's private key, which is used to sign merkle roots.
`HYP_VALIDATOR_CHECKPOINTSYNCER_TYPE`	Set to `localStorage`.
`HYP_VALIDATOR_CHECKPOINTSYNCER_PATH`	The path to your local directory where validator signatures will be written. This should be the value of `$MY_VALIDATOR_SIGNATURES_DIRECTORY` from the Local setup. Example: `/tmp/hyperlane-validator-signatures-ethereum`

AWS setup

Start validating

Last modified 4d ago