frontwarebkk/relayer

SecretVault EVM Event Relayer

A Go-based relayer service that monitors EVM *** events (Polygon, BSC, ***) and processes encrypted secret operations on Oasis Sapphire — the confidential EVM. Includes built-in *** tunnel for instant public HTTPS access.

What is the Relayer?

The SecretVault Relayer is a critical infrastructure component that:

• Monitors Gateway Events — Subscribes to *** events via WebSocket with polling fallback
• Processes Secret Operations — Handles create, update, cancel, and access operations for encrypted secrets
• Delivers to Sapphire — Submits transactions to Oasis Sapphire confidential EVM
• State Tracking — Persists processing state in SQLite for recovery
• P2P Network — Coordinates with peer relayers for high availability
• Reimbursement System — Earns rewards for processing operations (requires staking)

Quick Start

Pull the Image

bash
docker pull frontwarebkk/relayer:latest
# or with Podman
podman pull docker.io/frontwarebkk/relayer:latest

Prepare Configuration

bash
# Copy example config
cp config.toml.example config.toml
# Edit with your values:
# - Polygon/BSC/Arbitrum RPC URLs
# - Gateway and Vault contract addresses
# - Your wallet private key (or use environment variable)
# - Staking configuration

Run the Container

bash
docker run -d \
  --name relayer \
  -p 8080:8080 \
  -v $(pwd)/config.toml:/app/config/config.toml:ro \
  frontwarebkk/relayer:latest
# View logs
docker logs -f relayer

Requirements

1. Wallet & Keys

• Dedicated relayer wallet (don't reuse personal wallets)
• ROSE tokens (5-10 ROSE for gas on Sapphire)
• POL tokens for staking:
  • Testnet: 300 POL
  • Mainnet: 1000 POL

2. Authorization & Staking

• Complete KYC authorization (~2-5 business days)
• Stake POL to become operational
• Relayer must be in OPERATIONAL state (state=2) to process events

3. Configuration

Required in config.toml or environment variables:

• RPC URLs for gateway chains (Polygon, BSC, ***)
• Sapphire RPC URL and vault address
• Private key (or set RELAYER_SAPPHIRE_PRIVATE_KEY)

4. Optional: *** Tunnel (Public HTTPS)

bash
# Set up your Cloudflare tunnel
mkdir -p .cloudflared
# Add your tunnel config to .cloudflared/config1.yml
# Run with tunnel (REQUIRED: Set your hostname and tunnel name!)
docker run -d \
  --name relayer \
  -p 8080:8080 \
  -v $(pwd)/config.toml:/app/config/config.toml:ro \
  -v $(pwd)/.cloudflared:/app/config/.cloudflared:ro \
  -e TUNNEL_HOSTNAME="your-relayer.athora.me" \
  -e TUNNEL_NAME="your-tunnel-name" \
  frontwarebkk/relayer:latest

Note: TUNNEL_HOSTNAME and TUNNEL_NAME are required when using ***. The container will fail with a helpful error if not set.

Environment Variables (Alternative to config.toml)

bash
docker run -d \
  --name relayer \
  -p 8080:8080 \
  -e RELAYER_SAPPHIRE_PRIVATE_KEY="0x..." \
  -e RELAYER_SAPPHIRE_VAULT_ADDRESS="0x..." \
  -e RELAYER_POLYGON_GATEWAY_ADDRESS="0x..." \
  -e RELAYER_POLYGON_RPC_URL="https://rpc-amoy.polygon.technology" \
  -e RELAYER_SAPPHIRE_RPC_URL="https://testnet.sapphire.oasis.io" \
  frontwarebkk/relayer:latest

Persistent Data

To persist the SQLite database across restarts:

bash
docker run -d \
  --name relayer \
  -p 8080:8080 \
  -v $(pwd)/config.toml:/app/config/config.toml:ro \
  -v relayer_data:/app/data \
  frontwarebkk/relayer:latest

Verify Installation

bash
# Check container is running
docker ps | grep relayer
# Health check
curl http://localhost:8080/health
# View relayer info (requires Web3 wallet)
# Open http://localhost:8080/info.html

Managing the Container

bash
docker logs -f relayer    # View logs
docker stop relayer       # Stop
docker start relayer      # Restart
docker rm -f relayer     # Remove

Documentation

• Full README: https://gitlab.com/frontware_International/secrettimelocker/relayer
• Onboarding Guide: See docs/ONBOARDING_NEW_RELAYER.md in the repository
• API Documentation: Access /info.html after starting the relayer

Building from Source

bash
git clone https://gitlab.com/frontware_International/secrettimelocker/relayer.git
cd relayer
make container-build

Security Notes

⚠️ Never share, commit, or display your private key

• Use dedicated wallet for relayer operations
• Store private keys in OS keyring or secure environment files
• Use Web3 wallet authentication for web interface access
• Sessions expire after 8 hours