raiden-ts

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>Connecting | raiden-ts - v3.1.1</title> <meta name="description" content="Documentation for raiden-ts - v3.1.1"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../../assets/css/main.css"> <link rel="stylesheet" href="../../assets/css/pages.css"> <script async src="../../assets/js/search.js" id="search-script"></script> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../../assets/js/search.json" data-base="../.."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="../../index.html" class="title">raiden-ts - v3.1.1</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="../../modules.html">raiden-ts - v3.1.1</a> </li> <li> <a href="prerequisites.html">Get Started</a> </li> <li> <a href="connecting.html">Connecting</a> </li> </ul> <h1>Connecting</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <div class="tsd-panel tsd-typography"> <a href="#connecting" id="connecting" style="color: inherit; text-decoration: none;"> <h1>Connecting</h1> </a> <p>The SDK provides out of the box support for the deployed networks on <code>Görli</code>, <code>Ropsten</code>, and <code>Rinkeby</code>.</p> <p>If you need to use the SDK on a private network, or a custom deployment you can find more information in the following <a href="../private-chain/README.md">guide</a>.</p> <a href="#raiden-light-client-test-environment" id="raiden-light-client-test-environment" style="color: inherit; text-decoration: none;"> <h2>Raiden Light Client test environment</h2> </a> <p>For development purposes, the Light Client uses a standalone environment. The dApp deployment <a href="https://lightclient.raiden.network/">lightclient.raiden.network</a> and the development version served by 'pnpm run serve' also conforms to this configuration. </p> <p>This environment uses:</p> <ul> <li>A specific version of <a href="https://github.com/raiden-network/raiden/commit/ea7025739b460f940c26616ca1fccdb739b218ed">Raiden</a></li> <li>A matrix transport server - <code>https://transport.demo001.env.raiden.network</code></li> <li>A PFS server - <code>https://pfs.demo001.env.raiden.network</code></li> </ul> <p>You can find the raiden version tagged on Docker Hub under <code>raidennetwork/raiden:demoenv001</code>. To pull the image you need to run the following: </p> <pre><code class="language-bash"><span style="color: #000000">docker pull raidennetwork/raiden:demoenv001</span> </code></pre> <p>The transport server does not participate in the matrix federation. For this reason, you have to explicitly specify it when starting raiden. You can use the following flag:</p> <pre><code class="language-bash"><span style="color: #000000">--matrix-server=https://transport.demo001.env.raiden.network</span> </code></pre> <p>Similarly, you also have to specify the path-finding server:</p> <pre><code class="language-bash"><span style="color: #000000">--pathfinding-service-address https://pfs.demo001.env.raiden.network</span> </code></pre> <a href="#running-a-raiden-node-in-the-test-environment" id="running-a-raiden-node-in-the-test-environment" style="color: inherit; text-decoration: none;"> <h2>Running a Raiden node in the test environment</h2> </a> <p>You can easily run a python node in the test environment by using Docker. To get the supported Raiden version from <a href="https://hub.docker.com/r/raidennetwork/raiden">Docker Hub</a> you need to run the following command:</p> <pre><code class="language-bash"><span style="color: #000000">docker pull raidennetwork/raiden:demoenv001</span> </code></pre> <p>The test environment uses the <strong>Görli</strong> testnet. For the purposes of this guide, we assume that a <a href="https://geth.ethereum.org/docs/">geth</a> node runs locally on your computer. If you use a different ethereum client or RPC provider, please adjust accordingly. </p> <pre><code class="language-bash"><span style="color: #000000">geth --goerli console --cache=512 --port 30303 --rpc --rpcapi eth,net,web3,txpool --rpccorsdomain </span><span style="color: #A31515">"*"</span><span style="color: #000000"> --rpcaddr </span><span style="color: #A31515">"0.0.0.0"</span> </code></pre> <a href="#using-docker-run" id="using-docker-run" style="color: inherit; text-decoration: none;"> <h3>Using docker run</h3> </a> <p>You can start the container, by using the following command:</p> <pre><code class="language-bash"><span style="color: #000000">docker run --rm -it \</span> <span style="color: #000000"> --network=host \</span> <span style="color: #000000"> --mount src=/path/to/keystore,target=/keystore,type=bind \</span> <span style="color: #000000"> raidennetwork/raiden:demoenv001 \</span> <span style="color: #000000"> --keystore-path /keystore \</span> <span style="color: #000000"> --network-id 5 \</span> <span style="color: #000000"> --environment-type development \</span> <span style="color: #000000"> --eth-rpc-endpoint http://127.0.0.1:8545 \</span> <span style="color: #000000"> --accept-disclaimer \</span> <span style="color: #000000"> --matrix-server=https://transport.demo001.env.raiden.network \</span> <span style="color: #000000"> --pathfinding-service-address https://pfs.demo001.env.raiden.network \</span> <span style="color: #000000"> --api-address </span><span style="color: #A31515">"http://0.0.0.0:5001"</span> </code></pre> <p>We use <code>--network=host</code> if the ethereum node runs locally on the host machine, to provide access to it from the container. </p> <a href="#running-the-python-client-from-source" id="running-the-python-client-from-source" style="color: inherit; text-decoration: none;"> <h3>Running the python client from source</h3> </a> <p>If you want to use raiden from source code you can start by cloning the raiden repository, and checkout the suggested commit:</p> <pre><code class="language-bash"><span style="color: #000000">git clone https://github.com/raiden-network/raiden</span> <span style="color: #795E26">cd</span><span style="color: #000000"> raiden</span> <span style="color: #000000">git checkout 2e741dfdf4bfa564dec760abd5e3d8b2c9d30715</span> </code></pre> <p>Then you need to create a virtual environment using python 3.7 and activate it:</p> <pre><code class="language-bash"><span style="color: #000000">python3.7 -m venv .venv</span> <span style="color: #795E26">source</span><span style="color: #000000"> .venv/bin/activate</span> </code></pre> <p>Before starting Raiden, you need to install its dependencies. You can install them by running:</p> <pre><code><span style="color: #001080">make</span><span style="color: #000000"> </span><span style="color: #001080">install</span><span style="color: #000000">-</span><span style="color: #001080">dev</span> </code></pre> <p>After the installation, you can start Raiden by running:</p> <pre><code class="language-bash"><span style="color: #000000">raiden --keystore-path ~/.keystore \</span> <span style="color: #000000"> --log-config raiden:INFO \</span> <span style="color: #000000"> --api-address </span><span style="color: #A31515">"http://0.0.0.0:5001"</span><span style="color: #000000"> \</span> <span style="color: #000000"> --eth-rpc-endpoint http://localhost:8545 \</span> <span style="color: #000000"> --accept-disclaimer \</span> <span style="color: #000000"> --network-id 5 \</span> <span style="color: #000000"> --environment-type development \</span> <span style="color: #000000"> --routing-mode=pfs \</span> <span style="color: #000000"> --matrix-server=https://transport.demo001.env.raiden.network \</span> <span style="color: #000000"> --pathfinding-service-address https://pfs.demo001.env.raiden.network </span> </code></pre> <p>After you get your node running, you will be able to receive token transfers from the Light Client dApp and SDK.</p> </div> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="label pp-nav pp-group"> <span>Get <wbr>Started</span> </li> <li class=" pp-nav pp-page"> <a href="prerequisites.html">Prerequisites</a> </li> <li class=" pp-nav pp-page"> <a href="installing-sdk.html">Installing the SDK</a> </li> <li class=" pp-nav pp-page"> <a href="installing-dapp.html">Installing the d<wbr>App</a> </li> <li class="current pp-nav pp-page"> <a href="connecting.html">Connecting</a> </li> <li class=" pp-nav pp-page"> <a href="private-chain.html">Private chains</a> </li> <li class="label pp-nav pp-group"> <span>Usage</span> </li> <li class=" pp-nav pp-page"> <a href="../Usage/opening-channel.html">Opening a channel</a> </li> <li class=" pp-nav pp-page"> <a href="../Usage/funding-channel.html">Funding a channel</a> </li> <li class=" pp-nav pp-page"> <a href="../Usage/direct-transfer.html">Transferring</a> </li> <li class=" pp-nav pp-page"> <a href="../Usage/closing-channel.html">Closing a channel</a> </li> <li class=" pp-nav pp-page"> <a href="../Usage/settling-channel.html">Settling a channel</a> </li> <li class="label pp-nav pp-group"> <span>Using the <wbr>Raiden d<wbr>App</span> </li> <li class=" pp-nav pp-page"> <a href="../Using the Raiden dApp/using-dapp.html">Overview</a> </li> <li class=" pp-nav pp-page"> <a href="../Using the Raiden dApp/navigate-dapp.html">Navigate the <wbr>Raiden d<wbr>App</a> </li> <li class=" pp-nav pp-page"> <a href="../Using the Raiden dApp/hub-selection-channel-opening.html">Hub <wbr>Selection and <wbr>Channel <wbr>Opening</a> </li> <li class=" pp-nav pp-page"> <a href="../Using the Raiden dApp/transfers.html">Transfers</a> </li> <li class=" pp-nav pp-page"> <a href="../Using the Raiden dApp/channels.html">Channels</a> </li> <li class=" pp-nav pp-page"> <a href="../Using the Raiden dApp/account.html">Accounts</a> </li> <li class="label pp-nav pp-group"> <span>Using the <wbr>Raiden CLI</span> </li> <li class=" pp-nav pp-page"> <a href="../Using the Raiden CLI/README.html">Overview</a> </li> <li class=" pp-nav pp-page"> <a href="../Using the Raiden CLI/raspberrypi.html">Running raiden-<wbr>cli on the raspberry pi</a> </li> <li class="label pp-nav pp-group"> <span>API</span> </li> <li class=" "> <a href="../../modules.html">Exports</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> </nav> </div> </div> </div> <footer class="with-border-bottom"> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li> </ul> </div> </div> </footer> <div class="container tsd-generator"> <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p> </div> <div class="overlay"></div> <script src="../../assets/js/main.js"></script> </body> </html>