raiden-ts
Version:
Raiden Light Client Typescript/Javascript SDK
700 lines • 224 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Raiden | 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="Raiden.html">Raiden</a>
</li>
</ul>
<h1>Class Raiden</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">Raiden</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>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="Raiden.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="Raiden.html#action_" class="tsd-kind-icon">action$</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="Raiden.html#blockTime_" class="tsd-kind-icon">block<wbr>Time$</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="Raiden.html#channels_" class="tsd-kind-icon">channels$</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="Raiden.html#config" class="tsd-kind-icon">config</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="Raiden.html#config_" class="tsd-kind-icon">config$</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="Raiden.html#events_" class="tsd-kind-icon">events$</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="Raiden.html#getTokenInfo" class="tsd-kind-icon">get<wbr>Token<wbr>Info</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="Raiden.html#resolveName" class="tsd-kind-icon">resolve<wbr>Name</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="Raiden.html#state_" class="tsd-kind-icon">state$</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="Raiden.html#synced" class="tsd-kind-icon">synced</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="Raiden.html#transfers_" class="tsd-kind-icon">transfers$</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="Raiden.html#userDepositTokenAddress" class="tsd-kind-icon">user<wbr>Deposit<wbr>Token<wbr>Address</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Raiden.html#address" class="tsd-kind-icon">address</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Raiden.html#contractsInfo" class="tsd-kind-icon">contracts<wbr>Info</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Raiden.html#log" class="tsd-kind-icon">log</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Raiden.html#mainAddress" class="tsd-kind-icon">main<wbr>Address</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Raiden.html#network" class="tsd-kind-icon">network</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Raiden.html#provider" class="tsd-kind-icon">provider</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Raiden.html#settleTimeout" class="tsd-kind-icon">settle<wbr>Timeout</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Raiden.html#started" class="tsd-kind-icon">started</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Raiden.html#state" class="tsd-kind-icon">state</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-static"><a href="Raiden.html#contractVersion" class="tsd-kind-icon">contract<wbr>Version</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-static"><a href="Raiden.html#version" class="tsd-kind-icon">version</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Raiden.html#closeChannel" class="tsd-kind-icon">close<wbr>Channel</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Raiden.html#depositChannel" class="tsd-kind-icon">deposit<wbr>Channel</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Raiden.html#depositToUDC" class="tsd-kind-icon">deposit<wbr>ToUDC</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Raiden.html#directRoute" class="tsd-kind-icon">direct<wbr>Route</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Raiden.html#dumpDatabase" class="tsd-kind-icon">dump<wbr>Database</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Raiden.html#findPFS" class="tsd-kind-icon">findPFS</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Raiden.html#findRoutes" class="tsd-kind-icon">find<wbr>Routes</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Raiden.html#getAvailability" class="tsd-kind-icon">get<wbr>Availability</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Raiden.html#getBalance" class="tsd-kind-icon">get<wbr>Balance</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Raiden.html#getBlockNumber" class="tsd-kind-icon">get<wbr>Block<wbr>Number</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Raiden.html#getTokenBalance" class="tsd-kind-icon">get<wbr>Token<wbr>Balance</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Raiden.html#getTokenList" class="tsd-kind-icon">get<wbr>Token<wbr>List</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Raiden.html#getTransfers" class="tsd-kind-icon">get<wbr>Transfers</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Raiden.html#getUDCCapacity" class="tsd-kind-icon">getUDCCapacity</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Raiden.html#getUDCTotalDeposit" class="tsd-kind-icon">getUDCTotal<wbr>Deposit</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Raiden.html#getUDCWithdrawPlan" class="tsd-kind-icon">getUDCWithdraw<wbr>Plan</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Raiden.html#mint" class="tsd-kind-icon">mint</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Raiden.html#monitorToken" class="tsd-kind-icon">monitor<wbr>Token</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Raiden.html#openChannel" class="tsd-kind-icon">open<wbr>Channel</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Raiden.html#planUDCWithdraw" class="tsd-kind-icon">planUDCWithdraw</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Raiden.html#registerToken" class="tsd-kind-icon">register<wbr>Token</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Raiden.html#settleChannel" class="tsd-kind-icon">settle<wbr>Channel</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Raiden.html#start" class="tsd-kind-icon">start</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Raiden.html#stop" class="tsd-kind-icon">stop</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Raiden.html#suggestPartners" class="tsd-kind-icon">suggest<wbr>Partners</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Raiden.html#transfer" class="tsd-kind-icon">transfer</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Raiden.html#transferOnchainBalance" class="tsd-kind-icon">transfer<wbr>Onchain<wbr>Balance</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Raiden.html#transferOnchainTokens" class="tsd-kind-icon">transfer<wbr>Onchain<wbr>Tokens</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Raiden.html#updateConfig" class="tsd-kind-icon">update<wbr>Config</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Raiden.html#waitTransfer" class="tsd-kind-icon">wait<wbr>Transfer</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Raiden.html#withdrawChannel" class="tsd-kind-icon">withdraw<wbr>Channel</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Raiden.html#withdrawFromUDC" class="tsd-kind-icon">withdraw<wbr>FromUDC</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static"><a href="Raiden.html#create" class="tsd-kind-icon">create</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Raiden<span class="tsd-signature-symbol">(</span>state<span class="tsd-signature-symbol">: </span><a href="../modules.html#RaidenState" class="tsd-signature-type" data-tsd-kind="Variable">RaidenState</a>, deps<span class="tsd-signature-symbol">: </span><a href="../interfaces/RaidenEpicDeps.html" class="tsd-signature-type" data-tsd-kind="Interface">RaidenEpicDeps</a>, epic<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RaidenEpic</span>, reducer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>state<span class="tsd-signature-symbol">?: </span><a href="../modules.html#RaidenState" class="tsd-signature-type" data-tsd-kind="Variable">RaidenState</a>, action<span class="tsd-signature-symbol">: </span><a href="../modules.html#RaidenAction" class="tsd-signature-type" data-tsd-kind="Type alias">RaidenAction</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="../modules.html#RaidenState" class="tsd-signature-type" data-tsd-kind="Variable">RaidenState</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Raiden.html" class="tsd-signature-type" data-tsd-kind="Class">Raiden</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/raiden.ts#L192">raiden.ts:192</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Constructs a Raiden instance from state machine parameters</p>
</div>
<p>It expects ready Redux and Epics params, with some async members already resolved and set in
place, therefore this constructor is expected to be used only for tests and advancecd usage
where finer control is needed to tweak how some of these members are initialized;
Most users should usually prefer the <a href="Raiden.html#create">create</a> async factory, which already takes care of
these async initialization steps and accepts more common parameters.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>state: <a href="../modules.html#RaidenState" class="tsd-signature-type" data-tsd-kind="Variable">RaidenState</a></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Validated and decoded initial/rehydrated RaidenState</p>
</div>
</div>
</li>
<li>
<h5>deps: <a href="../interfaces/RaidenEpicDeps.html" class="tsd-signature-type" data-tsd-kind="Interface">RaidenEpicDeps</a></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Constructed epics dependencies object, including signer, provider, fetched
network and contracts information.</p>
</div>
</div>
</li>
<li>
<h5>epic: <span class="tsd-signature-type">RaidenEpic</span><span class="tsd-signature-symbol"> = ...</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>State machine root epic</p>
</div>
</div>
</li>
<li>
<h5>reducer: <span class="tsd-signature-symbol">(</span>state<span class="tsd-signature-symbol">?: </span><a href="../modules.html#RaidenState" class="tsd-signature-type" data-tsd-kind="Variable">RaidenState</a>, action<span class="tsd-signature-symbol">: </span><a href="../modules.html#RaidenAction" class="tsd-signature-type" data-tsd-kind="Type alias">RaidenAction</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="../modules.html#RaidenState" class="tsd-signature-type" data-tsd-kind="Variable">RaidenState</a><span class="tsd-signature-symbol"> = ...</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>State machine root reducer</p>
</div>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>state<span class="tsd-signature-symbol">?: </span><a href="../modules.html#RaidenState" class="tsd-signature-type" data-tsd-kind="Variable">RaidenState</a>, action<span class="tsd-signature-symbol">: </span><a href="../modules.html#RaidenAction" class="tsd-signature-type" data-tsd-kind="Type alias">RaidenAction</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules.html#RaidenState" class="tsd-signature-type" data-tsd-kind="Variable">RaidenState</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Raiden root reducer
Apply action over each submodule root reducer in a flattened manner (iteratively).
Notice the submodules reducers aren't handled only a partial/deep property of the state
(as combineReducers), but instead receive the whole state, so they can act on any part of the
state. This approach is similar to <code>reduce-reducers</code> util.
Each submodule root reducer may then choose to split its concerns into nested or flattened
reducers (like this one).</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>state: <a href="../modules.html#RaidenState" class="tsd-signature-type" data-tsd-kind="Variable">RaidenState</a><span class="tsd-signature-symbol"> = ...</span></h5>
<div class="tsd-comment tsd-typography">
<p>Current RaidenState to reduce</p>
</div>
</li>
<li>
<h5>action: <a href="../modules.html#RaidenAction" class="tsd-signature-type" data-tsd-kind="Type alias">RaidenAction</a></h5>
<div class="tsd-comment tsd-typography">
<p>RaidenAction to apply over state</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../modules.html#RaidenState" class="tsd-signature-type" data-tsd-kind="Variable">RaidenState</a></h4>
<p>New RaidenState</p>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="Raiden.html" class="tsd-signature-type" data-tsd-kind="Class">Raiden</a></h4>
</li>
</ul>
</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-class">
<a name="action_" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> action$</h3>
<div class="tsd-signature tsd-kind-icon">action$<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Observable</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#RaidenAction" class="tsd-signature-type" data-tsd-kind="Type alias">RaidenAction</a><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/raiden.ts#L104">raiden.ts:104</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>action$ exposes the internal events pipeline. It's intended for debugging, and its interface
must not be relied on, as its actions interfaces and structures can change without warning.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<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">Observable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</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/raiden.ts#L142">raiden.ts:142</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Observable of latest average (10) block times</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="channels_" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> channels$</h3>
<div class="tsd-signature tsd-kind-icon">channels$<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Observable</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/RaidenChannels.html" class="tsd-signature-type" data-tsd-kind="Interface">RaidenChannels</a><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/raiden.ts#L117">raiden.ts:117</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>channels$ is public interface, exposing a view of the currently known channels
Its format is expected to be kept backwards-compatible, and may be relied on</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<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/raiden.ts#L138">raiden.ts:138</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>RaidenConfig object</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="config_" class="tsd-anchor"></a>
<h3>config$</h3>
<div class="tsd-signature tsd-kind-icon">config$<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Observable</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#RaidenConfig" class="tsd-signature-type" data-tsd-kind="Variable">RaidenConfig</a><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/raiden.ts#L140">raiden.ts:140</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>RaidenConfig observable (for reactive use)</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="events_" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> events$</h3>
<div class="tsd-signature tsd-kind-icon">events$<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Observable</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#RaidenEvent" class="tsd-signature-type" data-tsd-kind="Type alias">RaidenEvent</a><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/raiden.ts#L126">raiden.ts:126</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A subset ot RaidenActions exposed as public events.
The interface of the objects emitted by this Observable are expected not to change internally,
but more/new events may be added over time.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="getTokenInfo" class="tsd-anchor"></a>
<h3>get<wbr>Token<wbr>Info</h3>
<div class="tsd-signature tsd-kind-icon">get<wbr>Token<wbr>Info<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>token<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>decimals<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>name<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>symbol<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>totalSupply<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNumber</span><span class="tsd-signature-symbol"> }</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/raiden.ts#L156">raiden.ts:156</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get constant token details from token contract, caches it.
Rejects only if 'token' contract doesn't define totalSupply and decimals methods.
name and symbol may be undefined, as they aren't actually part of ERC20 standard, although
very common and defined on most token contracts.</p>
</div>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>token<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>decimals<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>name<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>symbol<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>totalSupply<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNumber</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get constant token details from token contract, caches it.
Rejects only if 'token' contract doesn't define totalSupply and decimals methods.
name and symbol may be undefined, as they aren't actually part of ERC20 standard, although
very common and defined on most token contracts.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>token: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>address to fetch info from</p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>decimals<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>name<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>symbol<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>totalSupply<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNumber</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h4>
<p>Memoized function to fetch token info</p>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="resolveName" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> resolve<wbr>Name</h3>
<div class="tsd-signature tsd-kind-icon">resolve<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Address" class="tsd-signature-type" data-tsd-kind="Variable">Address</a><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/raiden.ts#L161">raiden.ts:161</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Address" class="tsd-signature-type" data-tsd-kind="Variable">Address</a><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Expose ether's Provider.resolveName for ENS support</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>name: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Address" class="tsd-signature-type" data-tsd-kind="Variable">Address</a><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="state_" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> state$</h3>
<div class="tsd-signature tsd-kind-icon">state$<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Observable</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#RaidenState" class="tsd-signature-type" data-tsd-kind="Variable">RaidenState</a><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/raiden.ts#L112">raiden.ts:112</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>state$ is exposed only so user can listen to state changes and persist them somewhere else.
Format/content of the emitted objects are subject to changes and not part of the public API</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="synced" class="tsd-anchor"></a>
<h3>synced</h3>
<div class="tsd-signature tsd-kind-icon">synced<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>currentBlock<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>initialBlock<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>tookMs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</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/raiden.ts#L145">raiden.ts:145</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>When started, is set to a promise which resolves when node finishes syncing</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="transfers_" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> transfers$</h3>
<div class="tsd-signature tsd-kind-icon">transfers$<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Observable</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/RaidenTransfer.html" class="tsd-signature-type" data-tsd-kind="Interface">RaidenTransfer</a><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/raiden.ts#L135">raiden.ts:135</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Observable of completed and pending transfers
Every time a transfer state is updated, it's emitted here. 'key' property is unique and
may be used as identifier to know which transfer got updated.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="userDepositTokenAddress" class="tsd-anchor"></a>
<h3>user<wbr>Deposit<wbr>Token<wbr>Address</h3>
<div class="tsd-signature tsd-kind-icon">user<wbr>Deposit<wbr>Token<wbr>Address<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Address" class="tsd-signature-type" data-tsd-kind="Variable">Address</a><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/raiden.ts#L166">raiden.ts:166</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The address of the token that is used to pay the services (SVT/RDN).</p>
</div>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Address" class="tsd-signature-type" data-tsd-kind="Variable">Address</a><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The address of the token that is used to pay the services (SVT/RDN).</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Address" class="tsd-signature-type" data-tsd-kind="Variable">Address</a><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="address" class="tsd-anchor"></a>
<h3>address</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> address<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules.html#Address" class="tsd-signature-type" data-tsd-kind="Variable">Address</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/raiden.ts#L411">raiden.ts:411</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get current account address (subkey's address, if subkey is being used)</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="../modules.html#Address" class="tsd-signature-type" data-tsd-kind="Variable">Address</a></h4>
<p>Instance address</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="contractsInfo" class="tsd-anchor"></a>
<h3>contracts<wbr>Info</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> contractsInfo<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>MonitoringService<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>OneToN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>SecretRegistry<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>ServiceRegistry<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>TokenNetworkRegistry<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>UserDeposit<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/raiden.ts#L471">raiden.ts:471</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the Smart Contracts addresses and deployment blocks</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>MonitoringService<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>OneToN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>SecretRegistry<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>ServiceRegistry<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>TokenNetworkRegistry<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>UserDeposit<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h4>
<p>Smart Contracts info</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="log" class="tsd-anchor"></a>
<h3>log</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> log<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Logger</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/raiden.ts#L384">raiden.ts:384</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Instance's Logger, compatible with console's API</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Logger</span></h4>
<p>Logger object</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="mainAddress" class="tsd-anchor"></a>
<h3>main<wbr>Address</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> mainAddress<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#Address" class="tsd-signature-type" data-tsd-kind="Variable">Address</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/raiden.ts#L420">raiden.ts:420</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get main account address (if subkey is being used, undefined otherwise)</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#Address" class="tsd-signature-type" data-tsd-kind="Variable">Address</a></h4>
<p>Main account address</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="network" class="tsd-anchor"></a>
<h3>network</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> network<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Network</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/raiden.ts#L429">raiden.ts:429</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get current network from provider</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Network</span></h4>
<p>Network object containing blockchain's name & chainId</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="provider" class="tsd-anchor"></a>
<h3>provider</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> provider<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">JsonRpcProvider</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/raiden.ts#L402">raiden.ts:402</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Current provider getter</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">JsonRpcProvider</span></h4>
<p>ether's provider instance</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="settleTimeout" class="tsd-anchor"></a>
<h3>settle<wbr>Timeout</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> settleTimeout<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/raiden.ts#L1565">raiden.ts:1565</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Fetches contract's settleTimeout</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
<p>settleTimeout constant value from contracts</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="started" class="tsd-anchor"></a>
<h3>started</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> started<span class="tsd-signature-symbol">(</span><span cl