raiden-ts
Version:
Raiden Light Client Typescript/Javascript SDK
348 lines • 16.7 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Latest | 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="Latest.html">Latest</a>
</li>
</ul>
<h1>Interface Latest</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">Latest</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Latest.html#action" class="tsd-kind-icon">action</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Latest.html#blockTime" class="tsd-kind-icon">block<wbr>Time</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Latest.html#config" class="tsd-kind-icon">config</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Latest.html#rtc" class="tsd-kind-icon">rtc</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Latest.html#settleTimeout" class="tsd-kind-icon">settle<wbr>Timeout</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Latest.html#stale" class="tsd-kind-icon">stale</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Latest.html#state" class="tsd-kind-icon">state</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Latest.html#udcDeposit" class="tsd-kind-icon">udc<wbr>Deposit</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Latest.html#whitelisted" class="tsd-kind-icon">whitelisted</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="action" class="tsd-anchor"></a>
<h3>action</h3>
<div class="tsd-signature tsd-kind-icon">action<span class="tsd-signature-symbol">:</span> <a href="../modules.html#RaidenAction" class="tsd-signature-type" data-tsd-kind="Type alias">RaidenAction</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/types.ts#L40">types.ts:40</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="blockTime" class="tsd-anchor"></a>
<h3>block<wbr>Time</h3>
<div class="tsd-signature tsd-kind-icon">block<wbr>Time<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/types.ts#L46">types.ts:46</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="config" class="tsd-anchor"></a>
<h3>config</h3>
<div class="tsd-signature tsd-kind-icon">config<span class="tsd-signature-symbol">:</span> <a href="../modules.html#RaidenConfig" class="tsd-signature-type" data-tsd-kind="Variable">RaidenConfig</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/types.ts#L42">types.ts:42</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="rtc" class="tsd-anchor"></a>
<h3>rtc</h3>
<div class="tsd-signature tsd-kind-icon">rtc<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/types.ts#L44">types.ts:44</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-index-signature">
<h5><span class="tsd-signature-symbol">[</span>address: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">RTCDataChannel</span></h5>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="settleTimeout" class="tsd-anchor"></a>
<h3>settle<wbr>Timeout</h3>
<div class="tsd-signature tsd-kind-icon">settle<wbr>Timeout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/types.ts#L48">types.ts:48</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="stale" class="tsd-anchor"></a>
<h3>stale</h3>
<div class="tsd-signature tsd-kind-icon">stale<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/types.ts#L47">types.ts:47</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="state" class="tsd-anchor"></a>
<h3>state</h3>
<div class="tsd-signature tsd-kind-icon">state<span class="tsd-signature-symbol">:</span> <a href="../modules.html#RaidenState" class="tsd-signature-type" data-tsd-kind="Variable">RaidenState</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/types.ts#L41">types.ts:41</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="udcDeposit" class="tsd-anchor"></a>
<h3>udc<wbr>Deposit</h3>
<div class="tsd-signature tsd-kind-icon">udc<wbr>Deposit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>balance<span class="tsd-signature-symbol">: </span><a href="../modules.html#UInt" class="tsd-signature-type" data-tsd-kind="Function">UInt</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">32</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>totalDeposit<span class="tsd-signature-symbol">: </span><a href="../modules.html#UInt" class="tsd-signature-type" data-tsd-kind="Function">UInt</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">32</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/types.ts#L45">types.ts:45</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>balance<span class="tsd-signature-symbol">: </span><a href="../modules.html#UInt" class="tsd-signature-type" data-tsd-kind="Function">UInt</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">32</span><span class="tsd-signature-symbol">></span></h5>
</li>
<li class="tsd-parameter">
<h5>total<wbr>Deposit<span class="tsd-signature-symbol">: </span><a href="../modules.html#UInt" class="tsd-signature-type" data-tsd-kind="Function">UInt</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">32</span><span class="tsd-signature-symbol">></span></h5>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="whitelisted" class="tsd-anchor"></a>
<h3>whitelisted</h3>
<div class="tsd-signature tsd-kind-icon">whitelisted<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">readonly </span><a href="../modules.html#Address" class="tsd-signature-type" data-tsd-kind="Variable">Address</a><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/types.ts#L43">types.ts:43</a></li>
</ul>
</aside>
</section>
</section>
</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="../pages/Get Started/prerequisites.html">Prerequisites</a>
</li>
<li class=" pp-nav pp-page">
<a href="../pages/Get Started/installing-sdk.html">Installing the SDK</a>
</li>
<li class=" pp-nav pp-page">
<a href="../pages/Get Started/installing-dapp.html">Installing the d<wbr>App</a>
</li>
<li class=" pp-nav pp-page">
<a href="../pages/Get Started/connecting.html">Connecting</a>
</li>
<li class=" pp-nav pp-page">
<a href="../pages/Get Started/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="../pages/Usage/opening-channel.html">Opening a channel</a>
</li>
<li class=" pp-nav pp-page">
<a href="../pages/Usage/funding-channel.html">Funding a channel</a>
</li>
<li class=" pp-nav pp-page">
<a href="../pages/Usage/direct-transfer.html">Transferring</a>
</li>
<li class=" pp-nav pp-page">
<a href="../pages/Usage/closing-channel.html">Closing a channel</a>
</li>
<li class=" pp-nav pp-page">
<a href="../pages/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="../pages/Using the Raiden dApp/using-dapp.html">Overview</a>
</li>
<li class=" pp-nav pp-page">
<a href="../pages/Using the Raiden dApp/navigate-dapp.html">Navigate the <wbr>Raiden d<wbr>App</a>
</li>
<li class=" pp-nav pp-page">
<a href="../pages/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="../pages/Using the Raiden dApp/transfers.html">Transfers</a>
</li>
<li class=" pp-nav pp-page">
<a href="../pages/Using the Raiden dApp/channels.html">Channels</a>
</li>
<li class=" pp-nav pp-page">
<a href="../pages/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="../pages/Using the Raiden CLI/README.html">Overview</a>
</li>
<li class=" pp-nav pp-page">
<a href="../pages/Using the Raiden CLI/raspberrypi.html">Running raiden-<wbr>cli on the raspberry pi</a>
</li>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="Latest.html" class="tsd-kind-icon">Latest</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Latest.html#action" class="tsd-kind-icon">action</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Latest.html#blockTime" class="tsd-kind-icon">block<wbr>Time</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Latest.html#config" class="tsd-kind-icon">config</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Latest.html#rtc" class="tsd-kind-icon">rtc</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Latest.html#settleTimeout" class="tsd-kind-icon">settle<wbr>Timeout</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Latest.html#stale" class="tsd-kind-icon">stale</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Latest.html#state" class="tsd-kind-icon">state</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Latest.html#udcDeposit" class="tsd-kind-icon">udc<wbr>Deposit</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Latest.html#whitelisted" class="tsd-kind-icon">whitelisted</a>
</li>
</ul>
</li>
</ul>
<ul class="after-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>