Raiden Network |capitalized_version| Documentation
This is the documentation for the |version| version of the Raiden Network. You can find the source code in our Github Repository.
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.
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.
If you're new to Raiden and just want to install and try it out:
- :doc:`Install and fire up <overview_and_guide>` a Raiden client.
- Check out the :doc:`WebUI tutorial <webui_tutorial>` to quickly get started doing payments.
If you're looking for documentation relevant for building on top of Raiden:
- Read the thorough guide to :doc:`get started with the Raiden API <api_walkthrough>`.
- Checkout the complete :doc:`API documentation <rest_api>`.
If you're looking for a more in depth understanding of Raiden and are interested in contributing:
- Take a look at the :doc:`onboarding guide <onboarding>`.
- Check out the code in our Github repository.
- Read the Raiden specification.
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.
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.
.. toctree:: :maxdepth: 2 :caption: Using Raiden overview_and_guide red_eyes_mainnet_tutorial api_walkthrough webui_tutorial rest_api private_net_tutorial glossary
.. toctree:: :maxdepth: 2 :caption: Develop & Contribute onboarding state_machines changelog
.. toctree:: :maxdepth: 2 :caption: Other config_file trademarks Raiden Codebase Documentation <./_build/generated/modules>
.. toctree:: :maxdepth: 1 :caption: ADRs adr/overview