docs
Relayers
Running a Relayer
Configuration Options

Configuration Options

Note: You can also review the different chain configurations for EVM and Substrate.

Chain Configuration

FieldDescriptionOptionality
http-endpointHttp(s) Endpoint for quick Request and ResponseRequired
ws-endpointWebsocket Endpoint for long living connectionsRequired
nameThe chain nameRequired
explorerBlock explorer, used for generating clickable links for transactions that happens on this chain.Optional
chain-idChain specific id.Required
private-keyThe Private Key of this account on this network. See PrivateKey Docs for secure setupRequired
beneficiaryThe address of the account that will receive relayer fees.Optional
runtimeIndicates Substrate runtime to useRequired for Substrate
suriInterprets a string in order to generate a key Pair. In the case that the pair can be expressed as a direct derivation from a seedRequired for Substrate
palletsSupported pallets for a particular Substrate nodeOptional

Contract Configuration

FieldDescriptionOptionality
contractChain contract. Must be either: - VAnchor - SignatureBridgeRequired
addressThe address of this contract on this chain.Required
deployed-atThe block number where this contract got deployed at.Required
events-watcherControl the events watcher for this contract.Optional
withdraw-configConfig the fees and gas limits of your private transaction relayer.Optional
proposal-signing-backenda value of ProposalSigingBackend (for example { type = "DKGNode", node = "dkg-node" })Optional

For specific examples, please refer to either data-querying setup, private transaction setup, or signature relaying setup docs.