Skip to content

Latest commit

 

History

History
90 lines (66 loc) · 3.67 KB

index.rst

File metadata and controls

90 lines (66 loc) · 3.67 KB

Raiden Network Documentation

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

Note

We are currently reworking our documentation for Raiden. While this is still an ongoing process you can already view the updated parts in this new but incomplete version of the documentation.

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, you can either:

  • Use the Raiden Wizard for quickly installing and running a Raiden node.
  • Read about different options for installing and firing up <overview_and_guide> a Raiden client.
  • Check out the WebUI tutorial <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 <api_walkthrough>.
  • Checkout the complete API documentation <rest_api>.
  • Read the document How is Raiden Tested <testing>.

Contributing to Raiden?

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

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

Please note, that even though we do our best to ensure the quality and accuracy of the information provided, this publication may contain views and opinions, errors and omissions for which the content creator(s) and any represented organization 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

overview_and_guide alderaan_mainnet_tutorial api_walkthrough webui_tutorial rest_api raiden_services private_net_tutorial glossary

onboarding proxies changelog

config_file trademarks

adr/overview