raiden-ts

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>Installing the dApp | 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="installing-dapp.html">Installing the dApp</a> </li> </ul> <h1>Installing the dApp</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="#install-and-run-the-dapp" id="install-and-run-the-dapp" style="color: inherit; text-decoration: none;"> <h1>Install and Run the dApp</h1> </a> <p>Clone the Raiden Light Client repository.</p> <pre><code class="language-bash"><span style="color: #000000">git clone --recurse-submodules https://github.com/raiden-network/light-client.git</span> </code></pre> <a href="#build-the-sdk" id="build-the-sdk" style="color: inherit; text-decoration: none;"> <h2>Build the SDK</h2> </a> <pre><code class="language-bash"><span style="color: #795E26">cd</span><span style="color: #000000"> light-client</span> <span style="color: #000000">yarn workspace raiden-ts build</span> </code></pre> <a href="#run-the-dapp-locally" id="run-the-dapp-locally" style="color: inherit; text-decoration: none;"> <h2>Run the dApp locally</h2> </a> <p>Start the development server by running the following command:</p> <pre><code class="language-bash"><span style="color: #000000">yarn workspace raiden-dapp run serve</span> </code></pre> <p>Once the development server has been started, navigate to <code>http://localhost:8080</code> to start using the Raiden dApp.</p> <blockquote> <p>Note that the Raiden dApp requires MetaMask or another Web3 provider (wallet apps with dApp support) to be installed on your browser.</p> </blockquote> <a href="#recover-backup-locally" id="recover-backup-locally" style="color: inherit; text-decoration: none;"> <h2>Recover Backup locally</h2> </a> <p>You might have a backup by a dApp instance that was provided by a service that is not available anymore. You can not import this backup to another dApp provider if you were using a Raiden subkey (configuration option). The subkey generation is dependent on the origin URL which is serving the dApp and the Ethereum chain it is connected to. Therefore this will result into a different key for each dApp provider and chain.</p> <p>To still being able to recover your backup you can run the dApp locally and tell it to act like it would be served by a specific origin. Therefore you need to edit the <code>raiden-dapp/.env.development</code> file and add the following line:</p> <pre><code class="language-sh"><span style="color: #000000">VUE_APP_SUBKEY_ORIGIN_URL=https://<url-of-old-service></span> </code></pre> <p>Afterwards continue to run the dApp locally <a href="#install-and-run-the-dapp">as describe earlier</a>. Remember that you need to restart the dApp if you have it already running to reload the environment variables.</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="current pp-nav pp-page"> <a href="installing-dapp.html">Installing the d<wbr>App</a> </li> <li class=" 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>