Environment variables

Configure your relayer

Also take a look at the Agent Configuration page.
Your relayer takes as configuration the following environment variables:
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_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
HYP_BASE_CHAINS_[chain_name]_CONNECTION_URL
An RPC url for chain_name.
Example: HYP_BASE_CHAINS_ETHEREUM_CONNECTION_URL=http://localhost:8545

Relayers must set multiple connection URLs, one for the origin chain and one for each destination chain.

HYP_RELAYER_ORIGINCHAINNAME
The name of the origin chain to relay messages from.
Example: ethereum
HYP_RELAYER_DESTINATIONCHAINNAMES
Comma separated names of the destination chains to relay messages to.
Example: polygon,avalanche
HYP_RELAYER_WHITELIST
An optional whitelist. The relayer will only relay messages that match this whitelist. 

See Message filteringfor more info.

HYP_RELAYER_BLACKLIST
An optional blacklist. The relayer will not relay messages that match this blacklist. 

See Message filteringfor more info.
HYP_RELAYER_GASPAYMENTENFORCEMENT
Set to [{"type": "none"}]. Be aware that you may need to escape the quotes, e.g. \", depending on how your environment variables are parsed. The relayer will process all messages that fit the filtering criteria.
HYP_RELAYER_ALLOWLOCALCHECKPOINTSYNCERS
If true, this will allow the relayer to look for validator signatures on the relayer's local filesystem.
In a production environment, this should be false.
If you're running a validator on the same machine by following the validator Local setup instructions, set this to true so that your relayer can access the local validator signatures.
Key-specific environment variables
These required environment variables differ depending on which key setup instructions you followed.
Hexadecimal keys
AWS KMS keys
If you followed the Hexadecimal key setup, use these environment variables.
Environment variable
Description
HYP_BASE_CHAINS_[chain name]_SIGNER_TYPE
Set to hexKey.

Relayers must set this for each destination chain.
Example: HYP_BASE_CHAINS_POLYGON_SIGNER_TYPE=hexKey
HYP_BASE_CHAINS_[chain name]_SIGNER_KEY
A hexadecimal private key used to sign transactions for chain_name.

Relayers must set this for each destination chain.
Example: HYP_BASE_CHAINS_POLYGON_SIGNER_KEY=123...def
If you followed the AWS KMS key setup, use these environment variables.
Environment variable
Description
HYP_BASE_CHAINS_[chain name]_SIGNER_TYPE
Set to aws.

Relayers must set this for each destination chain.
Example: HYP_BASE_CHAINS_POLYGON_SIGNER_TYPE=aws
HYP_BASE_CHAINS_[chain name]_SIGNER_ID
The alias of your validator's AWS KMS key, prefixed with alias/.

Relayers must set this for each destination chain.
Example: HYP_BASE_SIGNERS_POLYGON_SIGNER_ID=alias/hyperlane-validator-signer-polygon
HYP_BASE_CHAINS_[chain name]_SIGNER_REGION
The region of your AWS KMS key.

Relayers must set this for each destination chain.
HYP_BASE_SIGNERS_POLYGON_SIGNER_REGION=us-east-1
AWS_ACCESS_KEY_ID
The access key ID of your relayer's AWS IAM user.
AWS_SECRET_ACCESS_KEY
The secret access key of your relayer's AWS IAM user.

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_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`
`HYP_BASE_CHAINS_[chain_name]_CONNECTION_URL`	An RPC url for `chain_name`. Example: `HYP_BASE_CHAINS_ETHEREUM_CONNECTION_URL=http://localhost:8545` Relayers must set multiple connection URLs, one for the origin chain and one for each destination chain.
`HYP_RELAYER_ORIGINCHAINNAME`	The name of the origin chain to relay messages from. Example: `ethereum`
`HYP_RELAYER_DESTINATIONCHAINNAMES`	Comma separated names of the destination chains to relay messages to. Example: `polygon,avalanche`
`HYP_RELAYER_WHITELIST`	An optional whitelist. The relayer will only relay messages that match this whitelist. See Message filteringfor more info.
`HYP_RELAYER_BLACKLIST`	An optional blacklist. The relayer will not relay messages that match this blacklist. See Message filteringfor more info.
`HYP_RELAYER_GASPAYMENTENFORCEMENT`	Set to `[{"type": "none"}]`. Be aware that you may need to escape the quotes, e.g. `\"`, depending on how your environment variables are parsed. The relayer will process all messages that fit the filtering criteria.
`HYP_RELAYER_ALLOWLOCALCHECKPOINTSYNCERS`	If true, this will allow the relayer to look for validator signatures on the relayer's local filesystem. In a production environment, this should be `false`. If you're running a validator on the same machine by following the validator Local setup instructions, set this to `true` so that your relayer can access the local validator signatures.

Environment variable	Description
`HYP_BASE_CHAINS_[chain name]_SIGNER_TYPE`	Set to `hexKey`. Relayers must set this for each destination chain. Example: `HYP_BASE_CHAINS_POLYGON_SIGNER_TYPE=hexKey`
`HYP_BASE_CHAINS_[chain name]_SIGNER_KEY`	A hexadecimal private key used to sign transactions for `chain_name`. Relayers must set this for each destination chain. Example: `HYP_BASE_CHAINS_POLYGON_SIGNER_KEY=123...def`

Environment variable	Description
`HYP_BASE_CHAINS_[chain name]_SIGNER_TYPE`	Set to `aws`. Relayers must set this for each destination chain. Example: `HYP_BASE_CHAINS_POLYGON_SIGNER_TYPE=aws`
`HYP_BASE_CHAINS_[chain name]_SIGNER_ID`	The alias of your validator's AWS KMS key, prefixed with `alias/`. Relayers must set this for each destination chain. Example: `HYP_BASE_SIGNERS_POLYGON_SIGNER_ID=alias/hyperlane-validator-signer-polygon`
`HYP_BASE_CHAINS_[chain name]_SIGNER_REGION`	The region of your AWS KMS key. Relayers must set this for each destination chain. `HYP_BASE_SIGNERS_POLYGON_SIGNER_REGION=us-east-1`
`AWS_ACCESS_KEY_ID`	The access key ID of your relayer's AWS IAM user.
`AWS_SECRET_ACCESS_KEY`	The secret access key of your relayer's AWS IAM user.

AWS KMS key setup

Message filtering

Last modified 4d ago