System Requirements and Installation Guide¶
Raiden is a payment channel implementation which provides scalable, low latency, and cheap token payments for Ethereum.
If you are just switching from an old installation of raiden which was using python 2, then you should make sure to remove your raiden directory. By default that would mean:
rm -rf ~/.raiden
The preferred way to install Raiden is downloading a self contained application bundle from the GitHub release page.
Download the latest
raiden-<version>-linux.tar.gz, and extract it:
tar -xvzf raiden-<version>-linux.tar.gz
The Raiden binary should work on most 64bit GNU/Linux distributions without any specific system dependencies, other
than an Ethereum client installed in your system (see below). The Raiden binary takes the same command line
arguments as the
Download the latest
raiden-<version>-macOS.zip, and extract it:
The resulting binary will work on any version of macOS from 10.12 onwards without any other dependencies.
Or you can use Homebrew to install the most up to date binary:
brew tap raiden-network/raiden brew install raiden
An Ethereum client is required in both cases. The Raiden binary takes the same command line
arguments as the
You will need to have an Ethereum client installed in your system. Alternatively, you can skip the setup of an ethereum node and use the –eth-rpc-endpoint argument to remotely use an ethereum node of your choice.
- Check this link for instructions on the go-ethereum client.
- Follow these instructions for the parity client.
Now you are ready to get started.
If you plan to develop on the Raiden source code, or the binary distributions do not work for your system, you can follow these steps to install a development version.
Additional dependencies for development installations¶
- You need to make sure that your system has
solc, the ethereum solidity compiler installed. Refer to its documentation for the installation steps.
- You will also need to obtain the system dependencies for pyethapp.
- For running
raiden smoketest, you will need to have
tkas a dependency).
Installation from source¶
Clone the repository:
git clone https://github.com/raiden-network/raiden.git
Navigate to the directory:
It’s advised to create a virtualenv for Raiden and install all python dependencies there.
After you have done that you can proceed to install the dependencies:
pip install -c constraints.txt --upgrade -r requirements-dev.txt python setup.py develop
You will also need to connect your Ethereum client to the Ropsten testnet. See below for guidelines on how to connect with both Parity and Geth.
Please refer to the detailed step-by-step guide for setting up a macOS development environment.
Requirements for Safe Usage¶
In order to use Raiden correctly and safely there are some things that need to be taken care of by the user:
- Layer 1 works reliably: That means that you have a local ethereum node, either geth or parity, that is always synced and working reliably. If there are any problems or bugs on the client then Raiden can not work reliably.
- Unique account for Raiden: We need to have a specific ethereum account dedicated to Raiden. Creating any manual transaction with the account that Raiden uses, while the Raiden client is running, can result in undefined behaviour
- Raiden account has sufficient ETH: Raiden will try to warn you if there is not enough ETH in your raiden account in order to maintain your current open chanels and go through their entire cycle. But it is your job as the user to refill your account with ETH and always have it filled.
- Persistency of local DB: Your local state database is located at
~/.raiden. This data should not be deleted by the user or tampered with in any way. Frequent backups are also recommended. Deleting this directory could mean losing funds.
- Raiden Always online: Make sure that your node is always working, your network connection is stable and that the Raiden node is always online. If it crashes for whatever reason you are responsible to restart it and keep it always online. We recommend running it inside some form of monitor that will restart if for some reason the raiden node crashes.
- Ethereum Client Always Online: Make sure that your ethereum client is always running and is synced. We recommend running it inside some form of monitor that will restart if for some reason it crashes.
- Ethereum Client can not be changed: Swapping the ethereum client while transactions are not mined is considered unsafe. We recommend avoiding switching ethereum clients once the Raiden node is running.
- Never expose the Raiden REST API to the public: For Raiden’s operation, the client needs to be able to sign transactions at any point in time. Therefore you should never expose the Raiden Rest API to the public. Be very careful when changing the –rpc and –rpccorsdomain values.
Firing it up¶
Run the Ethereum client and let it sync with the Ropsten testnet:
geth --testnet --fast --rpc --rpcapi eth,net,web3 --bootnodes "enode://firstname.lastname@example.org:30303,enode://email@example.com:30303"
Unless you already have an account you can also create one in the console by invoking
If problems arise for above method, please see the Ropsten README for further instructions.
Then launch Raiden with the default testnet keystore path:
raiden --keystore-path ~/.ethereum/testnet/keystore
Run the client and let it sync with the Ropsten testnet:
parity --chain ropsten --bootnodes "enode://firstname.lastname@example.org:30303,enode://email@example.com:30303"
Parity sometimes loses its historical DB (potentially after updates). Due to this some events might be lost which will result in Raiden not being able to fetch all events. Therefore it is recommended to make sure to have Parity fully synced with the –no-warp option.
After syncing the chain, an existing Ethereum account can be used or a new one can be generated using
After account creation, launch Raiden with the path of your keystore supplied:
raiden --keystore-path ~/.local/share/io.parity.ethereum/keys/test
In order to use Raiden with an rpc-endpoint provided by an Infura Ethereum node, sign up with Infura to get an API token. After that you can start using Raiden on Ropsten directly:
raiden --keystore-path ~/.ethereum/testnet/keystore --eth-rpc-endpoint "https://ropsten.infura.io/v3/<yourToken>"
Select the desired Ethereum account when prompted, and type in the account’s password.
See the API walkthrough for further instructions on how to interact with Raiden.