Rlay Client - Getting Started
The Rlay Client serves to provide multiple functions:
- A simple to use interface for interacting with Rlay's smart contracts via JSONRPC (as established by Ethereum clients)
- Mirror the state of Rlay's smart contracts for quick data retrieval
- Calculate the payout rewards for propositions in the Rlay network
Install
Requirements
Before continuing with the installation, make sure you have at following dependencies and their required versions installed correctly.
- Rust 1.29.0 or newer (Install via rustup)
Download & Install
git clone git@github.com:rlay-project/rlay-client.git && cd rlay-client
cargo install --git https://github.com/rlay-project/rlay-client.git --tag 0.2.4
If you want to enable the
Neo4J
backend you need to pass--features backend_neo4j
tocargo install
, like so:cargo install --git https://github.com/rlay-project/rlay-client.git --tag 0.2.4 --features backend_neo4j
Run
Before running the Rlay Client
make sure that the client connects to the specified Rlay testnet correctly.
You can run a Rlay testnet locally, by following the instructions at Rlay Protocol.
To check if the Rlay Client
can correctly connect to the testnet run:
rlay-client doctor
You can change the addresses that point to the Rlay smart contracts in rlay.config.toml
.
Once you confirmed that the client can connect properly Rlay Client
can connect properly, you can run it by executing
rlay-client client