Skip to content

Latest commit

 

History

History
69 lines (58 loc) · 3.09 KB

README.md

File metadata and controls

69 lines (58 loc) · 3.09 KB
Raw

Atlas Operations Relay

The Atlas operations relay is an infrastructure layer facilitating communication between parties involved in the Atlas ecosystem.

Specifications

For APIs specifications and human readable description of the relay's tasks/duties, please see the specifications.

Running the relay

Configuration

Config parameters can be set either in the config.json file, or as CLI flags, and some via environment variables. If a combination is used, the priority order is ENV var > CLI param > config file.

  • ETHEREUM RPC URL (required)
    • config.json: network.rpc_url (string)
    • CLI flag: --network.rpc_url
    • ENV var: ETH_RPC_URL
    • comment: the relay needs access to an operational node, it makes view calls only
  • ATLAS CONTRACT ADDRESS (required)
    • config.json: contracts.atlas (string)
    • CLI flag: --contracts.atlas
  • ATLAS VERIFICATION CONTRACT ADDRESS (required)
    • config.json: contracts.atlasVerification (string)
    • CLI flag: --contracts.atlasVerification
  • ATLAS SIMULATOR CONTRACT ADDRESS (required)
    • config.json: contracts.simulator (string)
    • CLI flag: --contracts.simulator
  • SIMULATIONS (optional)
    • config.json: relay.simulations (boolean)
    • CLI flag: --relay.simulations
    • default: false
    • comment: simulate user and solvers operations and bundles
  • AUCTION DURATION (optional)
    • config.json: relay.auction.duration (integer)
    • CLI flag: --relay.auction.duration
    • default: 500
    • comment: in milliseconds, values <= 0 are ignored
  • MAX SOLUTIONS PER AUCTION
    • config.json: relay.auction.max_solutions (integer)
    • CLI flag: --relay.auction.max_solutions
    • default: 10
    • comment: values <= 0 are ignored
  • MAX GAS PER USER OPERATION (optional)
    • config.json: relay.gas.max_per_user_operation (integer)
    • CLI flag: --relay.gas.max_per_user_operation
    • default: 1000000
    • comment: values <= 0 are ignored
  • MAX GAS PER DAPP OPERATION (optional)
    • config.json: relay.gas.max_per_dApp_operation (integer)
    • CLI flag: --relay.gas.max_per_dApp_operation
    • default: 1000000
    • comment: values <= 0 are ignored
  • SIGNATORIES PRIVATE KEYS (optional)
    • ENV var: SIGNATORIES_PKS
    • comment: comma separated list of hexadecimal private keys (without 0x prefix) to enable the relay to sign dApp operations when possible

Docker

Use Dockerfile to build a Docker image, and run it with port 8080 exposed.

docker build -t ops_relay:latest .
docker run --name ops_relay -p 127.0.0.1:8080:8080 ops_relay

Contributions

Contributions are welcomed, feel free to submit your pull requests.