Configuration
Last updated
Last updated
The router is accepts configuration using the config file config.json
in the root directory of the .
The JSON schema accepts the following keys:
redis
: Required. Object containing the following keys to configure an external redis instance:
host
: Required. The hostname of the redis instance.
port
: Required. The port of the redis instance.
server
: Required. Object containing the following keys to configure the HTTP server:
adminToken
: Required. Secret token used to authenticate admin requests.
port
: Optional. The port the router will listen on. Defaults to 8080
.
host
: Optional. The host the router will listen on. Defaults to 0.0.0.0
.
web3SignerUrl
: Recommended. The URL for a running instance. This is the recommended approach to private key storage.
mnemonic
: Optional, Discouraged. The mnemonic used to generate the private key. Using the mnemonic directly in the config file is unsafe and not recommended.
chains
: Required. The chain configuration. A JSON object with the following keyed by Domain IDs with the following object schema as value:
providers
: Required. An array of providers URLs for a chain. Use a minimum of 1 URL, but additional URLs provide more fallback protection against provider issues.
assets
: Required. An array of assets. Each asset is a JSON object with the following keys:
assetId
: Required. The asset ID (ERC20 token address). This needs to represent the "local" asset which is the Connext bridge minted asset.
name
: Required. The Asset Name.
network
: Required. mainnet
or testnet
.
environment
: Optional. production
or staging
. mainnet
network config will always be production
.
logLevel
: Optional. The log level. Defaults to info
. Accepts debug
, info
, warn
, error
, fatal
, trace
, silent
.
sequencerUrl
: Optional. The URL for the sequencer. Only used to override defaults.
cartographerUrl
: Optional. The URL for the cartographer. Only used to override defaults.
These are example RPC URLs. Please get your own RPC URLs!