Skip to main content

​
1) Clone the Repository

git clone https://github.com/fluton-io/fluton-relayer.git
cd fluton-relayer

​
2) Install Dependencies

yarn install

​
3) Configure environment variables

Copy the example env file and fill in your values: 
cp .env.example .env
VariableRequiredDescription
PRIVATE_KEYYesRelayer wallet private key (0x-prefixed)
BACKEND_URLYesFluton backend URL for Socket.IO
PORTNoServer port (default: 3001)
INFURA_API_KEYYesInfura API key for RPC endpoints
ONEINCH_API_KEYNo1inch API key (needed for 1inch aggregator)
ODOS_API_URLNoOdos API base URL (default: https://api.odos.xyz)
ONEINCH_API_URLNo1inch API base URL (default: https://api.1inch.dev)
SEPOLIA_RPC_URLYes*Sepolia HTTP RPC URL
SEPOLIA_WS_URLYes*Sepolia WebSocket URL
ARBITRUM_SEPOLIA_RPC_URLYes*Arbitrum Sepolia HTTP RPC URL
ARBITRUM_SEPOLIA_WS_URLYes*Arbitrum Sepolia WebSocket URL
BASE_SEPOLIA_RPC_URLYes*Base Sepolia HTTP RPC URL
BASE_SEPOLIA_WS_URLYes*Base Sepolia WebSocket URL
* Required for the chains you intend to relay on.

​
4) Configure fees

A fee schema (src/config/feeSchema.json) defines base fees, percentage fees, and decimals per chain/token pair. Generate or update it interactively: 
yarn generate-fee-schema

​
5) Start the relayer

docker build -t fluton-relayer .
docker run -p 3001:3001 fluton-relayer