Configuration reference
All configuration
Description: (Env only) List of additional configuration file paths to load in order (such as those in
hyperlane-monorepo/rust/config
). They will be merged first to last, so if both the first one and the last one specify a specific config path, the value set in the last file listed will be used.These files must be accessible within the filesystem your agent has access to. If you're running in Docker, see Config files with Docker for tips on mounting your config files into your Docker container.
Optional: Yes
Agents: All
Type:
string
(Comma separated list of file paths)As Env
As Config
export CONFIG_FILES='./config/ethereum/my-config.json,./config/ethereum/my-validator-config.json'
Not supported in configuration files
Description: Configuration for each of the chains that must be used by an agent.
Optional: No
Agents: All
Type:
Map<string, ChainSetup (Object)>
(See chains.*
for ChainSetup
values)As Env
As Config
HYP_BASE_CHAINS_${CHAIN_NAME}_*
HYP_BASE_CHAINS_ETHEREUM_*
{
"chains": {
"<chain_name>": {},
"ethereum": {}
}
}
Description: Name of the domain. Allows specifying a different name for the domain than the chain's true name. This should almost always be the same as
chain_name
.Requires: Alignment with domain id if it is a known domain name.
Optional: No
Agents: All
Type:
string
As Env
As Config
HYP_BASE_${CHAIN_NAME}_NAME="$DOMAIN_NAME"
HYP_BASE_ETHEREUM_NAME="ethereum"
{
"chains": {
"<chain_name>": {
"name": "<domain_name>"
},
"ethereum": {
"name": "ethereum"
}
}
}
Requires: Alignment with domain name if it is a known domain.
Optional: No
Agents: All
Type:
Numeric (string | number)
As Env
As Config
export HYP_BASE_${CHAIN_NAME}_DOMAIN="$DOMAIN_NAME"
export HYP_BASE_ETHEREUM_DOMAIN=1
{
"chains": {
"<chain_name>": {
"domain": "<domain_id>"
},
"ethereum": {
"domain": 1
}
}
}
Description: Number of blocks to wait before considering the blockchain state to be final. See also latencies for help choosing an appropriate finality.
Optional: Defaults to
0
Agents: All
Type:
Numeric (string | number)
As Env
As Config
export HYP_BASE_${CHAIN_NAME}_FINALITY_BLOCKS="$FINALITY_BLOCKS"
export HYP_BASE_ETHEREUM_FINALITY_BLOCKS=20
{
"chains": {
"<chain_name>": {
"finalityBlocks": "<finality_blocks>"
},
"ethereum": {
"finalityBlocks": 20
}
}
}
Optional: No
Agents: All
Type:
Hash (string)
As Env
As Config
export HYP_BASE_CHAINS_${CHAIN_NAME}_ADDRESSES_MAILBOX="$MAILBOX_ADDRESS"
export HYP_BASE_CHAINS_ETHEREUM_ADDRESSES_MAILBOX="0x35231d4c2D8B8ADcB5617A638A0c4548684c7C70"
{
"chains": {
"<chain_name>": {
"addresses": {
"mailbox": "<mailbox_address>"
}
},
"ethereum": {
"addresses": {
"mailbox": "0x35231d4c2D8B8ADcB5617A638A0c4548684c7C70"
}
}
}
}
Description: Address of the interchain gas paymaster contract on the chain. See also contract addresses.
Optional: No
Agents: All
Type:
Hash (string)
As Env
As Config
export HYP_BASE_CHAINS_${CHAIN_NAME}_ADDRESSES_INTERCHAIN_GAS_PAYMASTER="$IGP_ADDRESS"
export HYP_BASE_CHAINS_ETHEREUM_ADDRESSES_INTERCHAIN_GAS_PAYMASTER="0x6cA0B6D22da47f091B7613223cD4BB03a2d77918"
{
"chains": {
"<chain_name>": {
"addresses": {
"interchainGasPaymaster": "<igp_address>"
}
},
"ethereum": {
"addresses": {
"interchainGasPaymaster": "0x6cA0B6D22da47f091B7613223cD4BB03a2d77918"
}
}
}
}
Optional: No
Agents: All
Type:
Hash (string)
As Env
As Config
export HYP_BASE_CHAINS_${CHAIN_NAME}_ADDRESSES_VALIDATOR_ANNOUNCE="$VALIDATOR_ANNOUNCE_ADDRESS"
export HYP_BASE_CHAINS_ETHEREUM_ADDRESSES_VALIDATOR_ANNOUNCE="0x9bBdef63594D5FFc2f370Fe52115DdFFe97Bc524"
{
"chains": {
"<chain_name>": {
"addresses": {
"validatorAnnounce": "<validator_announce_address>"
}
},
"ethereum": {
"addresses": {
"validatorAnnounce": "0x9bBdef63594D5FFc2f370Fe52115DdFFe97Bc524"
}
}
}
}
Description: The signer that should be used this chain
Optional: Yes (Will use
defaultsigner
if not specified)Agents: All
Type:
SignerConf (Object)
As Env
As Config
HYP_BASE_${CHAIN_NAME}_SIGNER_*
{
"chains": {
"<chain_name>": {
"signer": {}
},
"ethereum": {
"signer": {}
}
}
}
Description: The type of signer that is defined. A
HexKey
signer uses a private key, an Aws
signer uses an AWS based KMS, and Node
assumes the local node will sign RPC calls.Optional: Yes; Defaults to
node
unless a key
is specified in which case it defaults to hexKey
Agents: All
Type:
Enum ("hexKey" | "aws" | "node")
As Env
As Config
export HYP_BASE_${CHAIN_NAME}_SIGNER_TYPE="hexKey"
{
"chains": {
"<chain_name>": {
"signer": {
"type": "hexKey"
}
},
"ethereum": {
"signer": {
"type": "node"
}
}
}
}
Description: A local hex key. The hex string of a private key.
Requires:
chains.<chain_name>.signer.type = "hexKey" | undefined
Optional: No (iff requirements are met)
Agents: All
Type:
string
As Env
As Config
export HYP_BASE_${CHAIN_NAME}_SIGNER_KEY="8166f546bab6da521a8369cab06c5d2b9e46670292d85c875ee9ec20e84ffb61"
{
"chains": {
"<chain_name>": {
"signer": {
"key": "<key_in_hex>"
}
},
"ethereum": {
"signer": {
"key": "8166f546bab6da521a8369cab06c5d2b9e46670292d85c875ee9ec20e84ffb61"
}
}
}
}
Description: The UUID identifying the AWS KMS key
Requires:
chains.<chain_name>.signer.type = "aws"
Optional: No (iff requirements are met)
Agents: All
Type:
string
As Env
As Config
export HYP_BASE_${CHAIN_NAME}_SIGNER_ID="alias/validator-signer-ethereum"
{
"chains": {
"ethereum": {
"signer": {
"type": "aws",
"id": "alias/validator-signer-ethereum"
}
}
}
}
Description: The AWS region
Requires:
chains.<chain_name>.signer.type = "aws"
Optional: No (iff requirements are met)
Agents: All
Type:
string
As Env
As Config
export HYP_BASE_${CHAIN_NAME}_SIGNER_REGION="us-east-1"
{
"chains": {
"<chain_name>": {
"signer": {
"type": "aws",
"region": "us-east-1"
}
}
}
}
Description: Connection protocol to use.
Optional: Defaults to
"ethereum"
Agents: All
Type:
Enum ("ethereum" | "fuel")
As Env
As Config
export HYP_BASE_${CHAIN_NAME}_PROTOCOL="ethereum"
export HYP_BASE_ARBITRUM_PROTOCOL="ethereum"
{
"chains": {
"<chain_name>": {
"protocol": "<protocol>"
},
"arbitrum": {
"protocol": "ethereum"
}
}
}
Description: How to communicate with the provider
"http"
uses a basic http connection"ws"
uses a basic websocket connection"httpFallback"
will try the first URL and then automatically "fall back" on a connection or other provider failure to the next provider; this should only retry calls which fail due to the provider and not the call itself such; an insufficient gas error for instance would not fall back."httpQuorum"
requires a majority of the URLs to agree with the exception of submitting transactions; it will automatically coordinate the "latest" block if not specified to reduce sync errors.
Requires:
chains.<chain_name>.protocol = "ethereum" | undefined
Optional: Defaults to
"http"
Agents: All
Type:
Enum ("http", "ws", "httpFallback", "httpQuorum")
As Env
As Config
export HYP_BASE_${CHAIN_NAME}_CONNECTION_TYPE="url"
export HYP_BASE_ETHEREUM_CONNECTION_TYPE="httpFallback"
{
"chains": {
"<chain_name>": {
"connectionType": "http"
},
"ethereum": {
"connectionType": "httpFallback"
}
}
}
Description: Url to connect to
Requires:
((chains.<chain_name>.protocol = "ethereum" | undefined)
AND (chains.<chain_name>.connectionType = "http" | "ws" | undefined)
) OR chains.<chain_name>.protocol = "fuel"
Optional: No (iff requirements are met)
Agents: All
Type:
string
As Env
As Config
export HYP_BASE_${CHAIN_NAME}_URL="$CONNECTION_URL"
export HYP_BASE_ETHEREUM_URL="http://127.0.0.1:8545"
{
"chains": {
"<chain_name>": {
"url": "<connection_url>"
},
"ethereum": {
"url": "http://127.0.0.1:8545"
}
}
}
Description:
Requires:
(chains.<chain_name>.protocol = "ethereum" | undefined)
AND (chains.<chain_name>.connectionType = "httpFallback" | "httpQuorum")
Optional: No (iff requirements are met)
Agents:
Type:
string
(comma separated list of urls without spaces)As Env
As Config
export HYP_BASE_${CHAIN_NAME}_URLS="$CONNECTION_URLS"
export HYP_BASE_ETHEREUM_URLS="http://127.0.0.1:8545,http://127.0.0.1:8546,http://127.0.0.1:8547"
{
"chains": {
"<chain_name>": {
"urls": "<connection_urls>"
},
"ethereum": {
"urls": "http://127.0.0.1:8545,http://127.0.0.1:8546,http://127.0.0.1:8547"
}
}
}
Description: Height at which to start indexing contracts.
Optional: Defaults to
0
Agents: Relayer & Scraper
Type:
Numeric (string | number)
As Env
As Config
export HYP_BASE_${CHAIN_NAME}_INDEX_FROM=0
export HYP_BASE_ETHEREUM_INDEX_FROM=16271503
{
"chains": {
"<chain_name>": {
"index": {
"from": 0
}
},
"ethereum": {
"index": {
"from": 16271503
}
}
}
}
Description: Number of blocks to query at once when indexing contracts. Note that the configured providers must support whatever value is set. The default should work with nearly all providers.
Optional: Defaults to
1999
Agents: Relayer & Scraper
Type:
Numeric (string | number)
As Env
As Config
export HYP_BASE_${CHAIN_NAME}_INDEX_CHUNK=1999
export HYP_BASE_ETHEREUM_INDEX_CHUNK=1999
{
"chains": {
"<chain_name>": {
"index": {
"chunk": 1999
}
},
"ethereum": {
"index": {
"chunk": 1999
}
}
}
}
Description: The default signer that should be used for all chains which did not specify their own.
Optional: Yes
Agents: All
Type:
SignerConf (Object)
As Env
As Config
HYP_BASE_DEFAULTSIGNER_*
{
"defaultsigner": {}
}
Description: The type of signer that is defined. A
HexKey
signer uses a private key, an Aws
signer uses an AWS based KMS, and Node
assumes the local node will sign RPC calls.Optional: Yes; Defaults to
node
unless a key
is specified in which case it defaults to hexKey
Agents: All
Type:
Enum ("hexKey" | "aws" | "node")
As Env
As Config
export HYP_BASE_DEFAULTSIGNER_TYPE="hexKey"
{
"defaultsigner": {
"type": "hexKey"
}
}
Description: A local hex key. The hex string of a private key.
Requires:
defaultsigner.type = "hexKey" | undefined
Optional: No (iff requirements are met)
Agents: All
Type:
string
As Env
As Config
export HYP_BASE_DEFAULTSIGNER_KEY="8166f546bab6da521a8369cab06c5d2b9e46670292d85c875ee9ec20e84ffb61"
{
"defaultsigner": {
"type": "hexKey",
"key": "8166f546bab6da521a8369cab06c5d2b9e46670292d85c875ee9ec20e84ffb61"
}
}
Description: The UUID identifying the AWS KMS key
Requires:
defaultsigner.type = "aws"
Optional: No (iff requirements are met)
Agents: All
Type:
string
As Env
As Config
export HYP_BASE_DEFAULTSIGNER_ID="alias/validator-signer-ethereum"
{
"defaultsigner": {
"type": "aws",
"id": "alias/validator-signer-ethereum"
}
}
Description: The AWS region
Requires:
defaultsigner.type = "aws"
Optional: No (iff requirements are met)
Agents: All
Type:
string
As Env
As Config
export HYP_BASE_DEFAULTSIGNER_REGION="us-east-1"
{
"defaultsigner": {
"type": "aws",
"region": "us-east-1"
}
}
Description: Port to expose prometheus metrics on
Optional: Defaults to
9090
Agents: All
Type:
Numeric (string | number)
As Env
As Config
export HYP_BASE_METRICS=9090
{
"metrics": 9090
}
Description: Configuration for the tracing module. This controls logging.
Optional: Defaults to
pretty
Agents: All
Type:
Enum ("pretty" | "json" | "full" | "compact")
As Env
As Config
export HYP_BASE_TRACING_FMT="pretty"
{
"tracing": {
"fmt": "pretty"
}
}
Description: Configuration for the tracing module. This controls logging.
Optional: Defaults to
info
Agents: All
Type:
Enum ("trace" | "debug" | "info" | "warn" | "error" | "off")
As Env
As Config
HYP_BASE_TRACING_LEVEL="info"
{
"tracing": {
"level": "info"
}
}
Description: Name of the chain a validator should validate for and name of the chain a relayer should relayer messages from.
Optional: No
Agents: Validator & Relayer
Type:
string
As Env
As Config
export HYP_BASE_ORIGINCHAINNAME="ethereum"
{
"originchainname": "ethereum"
}
Description: The signer that should be used by the validator.
Optional: Yes
Agents: All
Type:
SignerConf (Object)
As Env
As Config
HYP_BASE_VALIDATOR_*
{
"validator": {}
}
Description: The type of signer that is defined. A
HexKey
signer uses a private key, an Aws
signer uses an AWS based KMS, and Node
assumes the local node will sign RPC calls.Optional: Yes; Defaults to
node
unless a key
is specified in which case it defaults to hexKey
Agents: All
Type:
Enum ("hexKey" | "aws" | "node")
As Env
As Config
export HYP_BASE_VALIDATOR_TYPE="hexKey"
{
"validator": {
"type": "hexKey"
}
}
Description: A local hex key. The hex string of a private key.
Requires:
validator.type = "hexKey" | undefined
Optional: No (iff requirements are met)
Agents: All
Type:
string
As Env
As Config
export HYP_BASE_VALIDATOR_KEY="8166f546bab6da521a8369cab06c5d2b9e46670292d85c875ee9ec20e84ffb61"
{
"validator": {
"type": "hexKey",
"key": "8166f546bab6da521a8369cab06c5d2b9e46670292d85c875ee9ec20e84ffb61"
}
}
Description: The UUID identifying the AWS KMS key
Requires:
validator.type = "aws"
Optional: No (iff requirements are met)
Agents: All
Type:
string
As Env
As Config
export HYP_BASE_VALIDATOR_ID="alias/validator-signer-ethereum"
{
"validator": {
"type": "aws",
"id": "alias/validator-signer-ethereum"
}
}
Description: The AWS region
Requires:
validator.type = "aws"
Optional: No (iff requirements are met)
Agents: All
Type:
string
As Env
As Config
export HYP_BASE_VALIDATOR_REGION="us-east-1"
{
"validator": {
"type": "aws",
"region": "us-east-1"
}
}
Description: Defines the method of syncing checkpoints
Optional: No
Agents: Validator
Type:
Enum ("localStorage" | "s3")
As Env
As Config
export HYP_BASE_CHECKPOINTSYNCER_TYPE="localStorage"
{
"checkpointsyncer": {
"type": "localStorage"
}
}
Description: Path on the local disk of a local storage type checkpoint syncer configuration.
Requires:
checkpointsyncer.type = "localStorage"
Optional: No (iff conditions are met)
Agents: Validator
Type:
string
As Env
As Config
export HYP_BASE_CHECKPOINTSYNCER_PATH="/tmp/syncer"
{
"checkpointsyncer": {
"type": "localStorage",
"path": "/tmp/syncer"
}
}
Description: S3 bucket name
Requires:
checkpointsyncer.type = "s3"
Optional: No (iff conditions are met)
Agents: Validator
Type:
string
As Env
As Config
export HYP_BASE_CHECKPOINTSYNCER_BUCKET="signatures-ethereum"
{
"checkpointsyncer": {
"type": "s3",
"bucket": "signatures-ethereum"
}
}
Description: S3 bucket region
Requires:
checkpointsyncer.type = "s3"
Optional: No (iff conditions are met)
Agents: Validator
Type:
string
As Env
As Config
export HYP_BASE_CHECKPOINTSYNCER_REGION="us-east-1"