Skip to content

Installation

rrelayer installation process is straightforward and can be done with a few steps.

rrelayer CLI

rrelayer operates as a CLI toolset to make it easy to create new rrelayer projects or run existing ones.

Installing

latest
curl -L https://rrelayer.xyz/install.sh | bash

Once installed, you can run the following command to check the installation was successful:

rrelayer --help
Blazing fast EVM relayer tool built in rust
 
Usage: rrelayer [COMMAND]
 
Commands:
  new        Create a new rrelayer project
  clone      Clone an existing relayer private key to another network
  auth       Authenticate with rrelayer
  start      Start the relayer service
  network    Manage network configurations and settings
  list       List all configured relayers
  config     Configure operations for a specific relayer
  balance    Check the balance of a relayer's account
  allowlist  Manage allowlist addresses for restricted access
  create     Create a new relayer client instance
  sign       Sign messages and typed data alongside get history of signing
  tx         Send, manage and monitor transactions
  help       Print this message or the help of the given subcommand(s)
 
Options:
  -h, --help     Print help
  -V, --version  Print version

you can also get help on any of the commands, for example, to get help on the new command you can run:

rrelayer new --help

To upgrade to the latest version of rrelayer, you can run the following command:

rrelayerup

To uninstall rrelayer, you can run the following command:

rrelayerdown

Docker

A pre-built Docker image is available for rrelayer, hosted on GitHub Container Registry at ghcr.io/joshstevens19/rrelayer.

Usage

To use rrelayer with Docker, you can run the CLI commands by mounting your project directory:

docker run -it -v $PWD:/app/project ghcr.io/joshstevens19/rrelayer --help

Example: Creating a new project

docker run -it -v $PWD:/app/project ghcr.io/joshstevens19/rrelayer new

Running with existing project

export PROJECT_PATH=/path/to/your/project
 
docker run -it -v $PROJECT_PATH:/app/project ghcr.io/joshstevens19/rrelayer start