Guide

Required setup instructions

Environments

Local Setup

The local setup is only intended for testing or development purposes.

This is intended to show how you can run a validator on your local machine, which is only for testing and development purposes. This also means that signatures from local validators are only able to be accessed by locally ran relayers.

For running a validator in a production environment, see the AWS setup guide.

Create a hexadecimal key for your validator to sign with

Create a local directory for your validator's signatures

When running a validator locally, your validator will write its signatures to a local directory. This directory can be named whatever you like, just remember to use this directory when setting your Configuration.

# Pick an informative name specific to the chain you're validating
MY_VALIDATOR_SIGNATURES_DIRECTORY=/tmp/hyperlane-validator-signatures-ethereum

# Create the directory
mkdir $MY_VALIDATOR_SIGNATURES_DIRECTORY

Production Setup

For running a validator in a production environment, see the AWS setup guide.

Configuration

Take a look at the Agent configuration page and the Configuration reference for a full list of configuration possibilities. The list below is not complete, however it should be enough to get started.

Your validator takes arguments and environment variables as configuration. See below for both the general configurations and those that are specific to the setup instructions you followed.

Setup-specific configuration

These required environment variables differ based on which of the Environments you set up.

These are required for the Local Setup.

Note that relayers must be configured with --allowLocalCheckpointSyncers to be able to read signatures from this validator.

Installation

The recommended installation method for a production environment is using a Docker image.

Docker image

To download the docker image, run:

docker pull gcr.io/abacus-labs-dev/hyperlane-agent:8127fa5-20230823-161309

Start Validating

Running multiple validators

We encourage folks to validate on as many chains as they are interested in supporting. We recommend that resources are not shared between validator instances.

Running the binary

Refer to the Installation instructions to access the validator binary.

Configuration can be placed in a validator.env file, for example:

validator.env
# These are example values to roughly illustrate
# what a .env file should look like

HYP_BASE_ORIGINCHAINNAME=ethereum
HYP_BASE_REORGPERIOD=20
# ...
# ...

To run the validator binary with the environment variables specified in validator.env:

Find the latest Docker image and set it to the environment variable $DOCKER_IMAGE.

Using the --env-file flag, we can pass in the environment variables to the validator:

docker run -it --env-file validator.env $DOCKER_IMAGE ./validator

If you're running with a Local Setup validator on the same machine, which requires a locally ran relayer to be able to access these validator signatures, be sure to mount your local validator's signature directory on your host machine into your Docker container.

For example, if your local validator is writing signatures to /tmp/hyperlane-validator-signatures-ethereum, you should mount a directory for the Docker container. This is the same directory set in the $HYP_BASE_CHECKPOINTSYNCER_PATH environment variable.

If the command below fails with docker: invalid reference format, the whitespaces may have been malformed and you should remove them from the command.

docker run \
    -it \
    --env-file validator.env \
    --mount type=bind,source="$(pwd)"/hyperlane-validator-signatures-ethereum,target=/tmp/hyperlane-validator-signatures-ethereum \
    # you can pass multiple `--mount` flags to mount several directories
    $DOCKER_IMAGE \
    ./validator

If everything is configured correctly, you should see json files being written to your S3 bucket (if you followed the AWS setup) or to your local signatures directory (if you followed the Local Setup). New json files get written every time a new outbound message is inserted into the Mailbox.

Announcing your validator

Relayers need to know where to find your validator's signatures. Your validator will automatically attempt to announce itself by writing to the ValidatorAnnounce contract on the chain that you're validating.

To do this, your validator must have a small amount of tokens to pay for the gas for this transaction.

If your validator has not yet announced itself, and does not have enough tokens to pay for gas, it will log a message specifying how many tokens are needed.

Last updated