There are no hard software requirements. However, the following configuration is advised:
| Minimum | Recommended | |
|---|---|---|
| Operating System | Windows / Mac OS / Linux | Debian based Linux distribution |
| Memory | 8 GB RAM | 16 GB RAM |
| CPU | 4 cores | 8 cores |
| Disk | 25 GB | 500 GB |
| Bandwidth | 1 Gbps for Download/1 Gbps for Upload | 1 Gbps for Download/1 Gbps for Upload |
Ensure you have the following software installed on your machine:
In order to run a Relayer node, you will need to set up an Ethereum address, and get this address whitelisted.
Create an ethereum address. For example, this can be achieved using Metamask. Save the address and associated private key.
Currently, there is a whitelist requirement, may be replaced in the future, for running nodes on the testnet. In order to be whitelisted, you will need to send a request to [email protected]
Please clone the current respository on your machine:
git clone https://github.com/volmexfinance/volmex-relayers.git
cd volmex-relayers
Copy .env.example to .env and edit the .env file and update the parameters with your own information:
RELAYER_NAME="YOUR_RELAYER_NAME"
WALLET_ADDRESS="YOUR_WHITELISTED_WALLET_ADDRESS"
WALLET_PRIVATE_KEY="YOUR_WHITELISTED_WALLET_PRIVATE_KEY"
Run command: make config
The configuration of the node is all set up inside a config.json file. Please email [email protected] for more information.
Note: The wallet attached to the relayer will need gas tokens to submit orders to contract.
Network configuration will be specific to your individual set up. Generally, you want to ensure that the following ports are open (if you are using the default ones):
| Port | Protocol | Address | Description |
|---|---|---|---|
| 8080 | HTTP | localhost | Node Rest API |
| 10015 | TCP/IP | localhost | Node P2P communications |
To run the relayer in daemon mode, execute the command provided below:
make run-node
To reach a consensus, it is necessary to ensure that the node is always updated to the latest version.
make upgrade-node
In order to participate in the transaction matching process, you will need to fund the address associated with the relayer with at least 0.2 ETH on each Ethereum Layer 2 supported. Note that if you are running on Testnet, you will need Testnet Goerli ETH.