Raiden Network 0.100.3 Documentation

This is the documentation for the 0.100.3 version of the Raiden Network. You can find the source code in our Github Repository.

What is the Raiden Network?

The Raiden Network is an off-chain scaling solution, enabling near-instant, low-fee and scalable payments. It’s complementary to the Ethereum blockchain and works with any ERC20 compatible token. The Raiden project is work in progress. Its goal is to research state channel technology, define protocols and develop reference implementations.

How to get started

Whether you’ve just heard of Raiden for the first time or you’re here looking for something specific here’s a short list of relevant resources and links.

New to Raiden?

If you’re new to Raiden and just want to install and try it out:

• Install and fire up a Raiden client.
• Check out the WebUI tutorial to quickly get started doing payments.

Developing on Raiden?

If you’re looking for documentation relevant for building on top of Raiden:

• Read the thorough guide to get started with the Raiden API.
• Checkout the complete API documentation.

Contributing to Raiden?

If you’re looking for a more in depth understanding of Raiden and are interested in contributing:

• Take a look at the onboarding guide.
• Check out the code in our Github repository.
• Read the Raiden specification.

Need help?

If you run in to any kind of problems or you discover bugs:

• Ask for help or project related questions in the Raiden gitter.
• Create a Github issue if you discover a bug or have a feature request.

Disclaimer

The following content may contain views and opinions, errors and omissions by which the content creator(s) and any represented organizations cannot be held liable. The wording and concepts regarding financial terminology (e.g. “payments”, “checks”, “currency”, “transfer” [of value]) are exclusively used in an exemplary way to describe technological principles and do not necessarily conform to the real world or legal equivalents of these terms and concepts.

Contents

Using Raiden

• System Requirements and Installation Guide
  • Introduction
  • Installation
  • For developers
  • Requirements for Safe Usage
  • Firing it up
• Raiden Red Eyes Mainnet Tutorial
  • Introduction
  • About W-ETH
  • Joining a token network
  • Payments
  • Depositing tokens
  • Channel status
  • Wrap-up
• Getting started with the Raiden API
  • Introduction
  • Scenarios
  • Bootstrapping a token network
  • Joining an already existing token network
  • Token payments
  • Interacting with the Raiden Echo Node
• Web Application Tutorial
  • Running the web application
  • The landing page
  • Tokens
  • Channels
• Raiden’s API Documentation
  • Introduction
  • JSON Object Encoding
  • Endpoints
• Raiden on Private Network Tutorial
  • Introduction
  • Creating a Virtual Environment
  • Install Raiden and dependencies
  • Launch a private network
  • Figure out the contract version
  • Define constants
  • Deploy contracts
  • Start Raiden Client
• Raiden Glossary

Develop & Contribute

• Raiden Developer Onboarding Guide
  • Introduction
  • The Raiden Protocol
  • Raiden Architecture
  • The WebUI
  • Frequently Asked Questions
• Description of the Raiden State Machines
  • Introduction
  • Kinds of State Machines
• Changelog

Other

• Raiden Config File
  • Location
  • Precedence
  • Format
  • Parameter Naming
  • Logging Configuration
• Trademark Attributions

ADRs

• Raiden ADRs