raiden-ts
Version:
Raiden Light Client Typescript/Javascript SDK
2,702 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 class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</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#L362">raiden.ts:362</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Gets the running state of the instance</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></h4>
<p>undefined if not yet started, true if running, false if already stopped</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="state" class="tsd-anchor"></a>
<h3>state</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> state<span class="tsd-signature-symbol">(</span><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">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/raiden.ts#L393">raiden.ts:393</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get current RaidenState object. Can be serialized safely with [[encodeRaidenState]]</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="../modules.html#RaidenState" class="tsd-signature-type" data-tsd-kind="Variable">RaidenState</a></h4>
<p>Current Raiden state</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
<a name="contractVersion" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> contract<wbr>Version</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> contractVersion<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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#L462">raiden.ts:462</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the version of the used Smart Contracts.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>Smart Contract version</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
<a name="version" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> version</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> version<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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#L453">raiden.ts:453</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the currently used SDK version.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>SDK version</p>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="closeChannel" class="tsd-anchor"></a>
<h3>close<wbr>Channel</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">close<wbr>Channel<span class="tsd-signature-symbol">(</span>token<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, partner<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#Hash" class="tsd-signature-type" data-tsd-kind="Variable">Hash</a><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#L732">raiden.ts:732</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Close channel between us and partner on tokenNetwork for token
This method will fail if called on a channel not in 'opened' or 'closing' state.
When calling this method on an 'opened' channel, its state becomes 'closing', and from there
on, no payments can be performed on the channel. If for any reason the closeChannel
transaction fails, channel's state stays as 'closing', and this method can be called again
to retry sending 'closeChannel' transaction. After it's successful, channel becomes 'closed',
and can be settled after 'settleTimeout' seconds (when it then becomes 'settleable').</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">
<p>Token address on currently configured token network registry</p>
</div>
</li>
<li>
<h5>partner: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Partner address</p>
</div>
</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#Hash" class="tsd-signature-type" data-tsd-kind="Variable">Hash</a><span class="tsd-signature-symbol">></span></h4>
<p>txHash of closeChannel call, iff it succeeded</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="depositChannel" class="tsd-anchor"></a>
<h3>deposit<wbr>Channel</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">deposit<wbr>Channel<span class="tsd-signature-symbol">(</span>token<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, partner<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNumberish</span>, __namedParameters<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>confirmConfirmation<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</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#Hash" class="tsd-signature-type" data-tsd-kind="Variable">Hash</a><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#L674">raiden.ts:674</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Deposit tokens on channel between us and partner on tokenNetwork for token</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">
<p>Token address on currently configured token network registry</p>
</div>
</li>
<li>
<h5>partner: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Partner address</p>
</div>
</li>
<li>
<h5>amount: <span class="tsd-signature-type">BigNumberish</span></h5>
<div class="tsd-comment tsd-typography">
<p>Number of tokens to deposit on channel</p>
</div>
</li>
<li>
<h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>confirmConfirmation<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = {}</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> confirm<wbr>Confirmation<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
</li>
</ul>
</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#Hash" class="tsd-signature-type" data-tsd-kind="Variable">Hash</a><span class="tsd-signature-symbol">></span></h4>
<p>txHash of setTotalDeposit call, iff it succeeded</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="depositToUDC" class="tsd-anchor"></a>
<h3>deposit<wbr>ToUDC</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">deposit<wbr>ToUDC<span class="tsd-signature-symbol">(</span>amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNumberish</span>, onChange<span class="tsd-signature-symbol">?: </span><a href="../modules.html#OnChange" class="tsd-signature-type" data-tsd-kind="Type alias">OnChange</a><span class="tsd-signature-symbol"><</span><a href="../enums/EventTypes.html" class="tsd-signature-type" data-tsd-kind="Enumeration">EventTypes</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{ </span>txHash<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-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#Hash" class="tsd-signature-type" data-tsd-kind="Variable">Hash</a><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#L1232">raiden.ts:1232</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Deposits the amount to the UserDeposit contract with the target/signer as a beneficiary.
The deposited amount can be used as a collateral in order to sign valid IOUs that will
be accepted by the Services.</p>
</div>
<p>Throws an error, in the following cases:</p>
<ol>
<li>The amount specified equals to zero</li>
<li>The target has an insufficient token balance</li>
<li>The "approve" transaction fails with an error</li>
<li>The "deposit" transaction fails with an error</li>
</ol>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>amount: <span class="tsd-signature-type">BigNumberish</span></h5>
<div class="tsd-comment tsd-typography">
<p>The amount to deposit on behalf of the target/beneficiary.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> onChange: <a href="../modules.html#OnChange" class="tsd-signature-type" data-tsd-kind="Type alias">OnChange</a><span class="tsd-signature-symbol"><</span><a href="../enums/EventTypes.html" class="tsd-signature-type" data-tsd-kind="Enumeration">EventTypes</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{ </span>txHash<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></h5>
<div class="tsd-comment tsd-typography">
<p>callback providing notifications about state changes</p>
</div>
</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#Hash" class="tsd-signature-type" data-tsd-kind="Variable">Hash</a><span class="tsd-signature-symbol">></span></h4>
<p>transaction hash</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="directRoute" class="tsd-anchor"></a>
<h3>direct<wbr>Route</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">direct<wbr>Route<span class="tsd-signature-symbol">(</span>token<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNumberish</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-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>fee<span class="tsd-signature-symbol">: </span><a href="../modules.html#Int" class="tsd-signature-type" data-tsd-kind="Function">Int</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>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">readonly Address[]</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>address_metadata<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</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><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-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#L1038">raiden.ts:1038</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Checks if a direct transfer of token to target could be performed and returns it on a
single-element array of Paths</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">
<p>Token address on currently configured token network registry</p>
</div>
</li>
<li>
<h5>target: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Target address</p>
</div>
</li>
<li>
<h5>value: <span class="tsd-signature-type">BigNumberish</span></h5>
<div class="tsd-comment tsd-typography">
<p>Minimum capacity required on route</p>
</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-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>fee<span class="tsd-signature-symbol">: </span><a href="../modules.html#Int" class="tsd-signature-type" data-tsd-kind="Function">Int</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>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">readonly Address[]</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>address_metadata<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</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><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-symbol">></span></h4>
<p>Promise to a [Raiden]Paths array containing the single, direct route, or undefined</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="dumpDatabase" class="tsd-anchor"></a>
<h3>dump<wbr>Database</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">dump<wbr>Database<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AsyncGenerator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">RaidenDatabaseMeta</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ExistingDocument</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AllDocsMeta</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"_rev"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">undefined</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#L495">raiden.ts:495</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Dumps database content for backup</p>
</div>
<dl class="tsd-comment-tags">
<dt>yields</dt>
<dd><p>Rows of objects</p>
</dd>
</dl>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AsyncGenerator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">RaidenDatabaseMeta</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ExistingDocument</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AllDocsMeta</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"_rev"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="findPFS" class="tsd-anchor"></a>
<h3>findPFS</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">findPFS<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><span class="tsd-signature-type">PFS</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#L1070">raiden.ts:1070</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns a sorted array of info of available PFS</p>
</div>
<p>It uses data polled from ServiceRegistry, which is available only when config.pfs is
undefined, instead of set or disabled (null), and will reject if not.
It can reject if the validated list is empty, meaning we can be out-of-sync (we're outdated or
they are) with PFSs deployment, or no PFS is available on this TokenNetwork/blockchain.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">PFS</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
<p>Promise to array of PFS, which is the interface which describes a PFS</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="findRoutes" class="tsd-anchor"></a>
<h3>find<wbr>Routes</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">find<wbr>Routes<span class="tsd-signature-symbol">(</span>token<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNumberish</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>pfs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>matrixServer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>price<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNumberish</span><span class="tsd-signature-symbol">; </span>rtt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>validTill<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><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>fee<span class="tsd-signature-symbol">: </span><a href="../modules.html#Int" class="tsd-signature-type" data-tsd-kind="Function">Int</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>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">readonly Address[]</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>address_metadata<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</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><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-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#L1008">raiden.ts:1008</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Request a path from PFS</p>
</div>
<p>If a direct route is possible, it'll be returned. Else if PFS is set up, a request will be
performed and the cleaned/validated path results will be resolved.
Else, if no route can be found, promise is rejected with respective error.</p>
</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">
<p>Token address on currently configured token network registry</p>
</div>
</li>
<li>
<h5>target: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Target address</p>
</div>
</li>
<li>
<h5>value: <span class="tsd-signature-type">BigNumberish</span></h5>
<div class="tsd-comment tsd-typography">
<p>Minimum capacity required on routes</p>
</div>
</li>
<li>
<h5>options: <span class="tsd-signature-symbol">{ </span>pfs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>matrixServer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>price<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNumberish</span><span class="tsd-signature-symbol">; </span>rtt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>validTill<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></h5>
<div class="tsd-comment tsd-typography">
<p>Optional parameters</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> pfs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>matrixServer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>price<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNumberish</span><span class="tsd-signature-symbol">; </span>rtt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>validTill<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h5>
<div class="tsd-comment tsd-typography">
<p>Use this PFS instead of configured or automatically choosen ones</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>matrix<wbr>Server<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>price<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNumberish</span></h5>
</li>
<li class="tsd-parameter">
<h5>rtt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>token<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>valid<wbr>Till<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
</ul>
</li>
</ul>
</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">readonly </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>fee<span class="tsd-signature-symbol">: </span><a href="../modules.html#Int" class="tsd-signature-type" data-tsd-kind="Function">Int</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>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">readonly Address[]</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>address_metadata<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</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><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-symbol">></span></h4>
<p>A promise to returned routes/paths result</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getAvailability" class="tsd-anchor"></a>
<h3>get<wbr>Availability</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Availability<span class="tsd-signature-symbol">(</span>address<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>available<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>ts<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>userId<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></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#L812">raiden.ts:812</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns object describing address's users availability on transport
After calling this method, any further presence update to valid transport peers of this
address will trigger a corresponding MatrixPresenceUpdateAction on events$</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>address: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>checksummed address to be monitored</p>
</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>available<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>ts<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>userId<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></h4>
<p>Promise to object describing availability and last event timestamp</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getBalance" class="tsd-anchor"></a>
<h3>get<wbr>Balance</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Balance<span class="tsd-signature-symbol">(</span>address<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-type">BigNumber</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#L505">raiden.ts:505</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get ETH balance for given address or self</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> address: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Optional target address. If omitted, gets own balance</p>
</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-type">BigNumber</span><span class="tsd-signature-symbol">></span></h4>
<p>BigNumber of ETH balance</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getBlockNumber" class="tsd-anchor"></a>
<h3>get<wbr>Block<wbr>Number</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Block<wbr>Number<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><span class="tsd-signature-type">number</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#L438">raiden.ts:438</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns a promise to current block number, as seen in provider and state</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4>
<p>Promise to current block number</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getTokenBalance" class="tsd-anchor"></a>
<h3>get<wbr>Token<wbr>Balance</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Token<wbr>Balance<span class="tsd-signature-symbol">(</span>token<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, address<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-type">BigNumber</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#L518">raiden.ts:518</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get token balance and token decimals for given address or self</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">
<p>Token address to fetch balance. Must be one of the monitored tokens.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> address: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Optional target address. If omitted, gets own balance</p>
</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-type">BigNumber</span><span class="tsd-signature-symbol">></span></h4>
<p>BigNumber containing address's token balance</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getTokenList" class="tsd-anchor"></a>
<h3>get<wbr>Token<wbr>List</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Token<wbr>List<span class="tsd-signature-symbol">(</span>rescan<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</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></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#L533">raiden.ts:533</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns a list of all token addresses registered as token networks in registry</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>rescan: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
<div class="tsd-comment tsd-typography">
<p>Whether to rescan events from scratch</p>
</div>
</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><span class="tsd-signature-symbol">></span></h4>
<p>Promise to list of token addresses</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getTransfers" class="tsd-anchor"></a>
<h3>get<wbr>Transfers</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Transfers<span class="tsd-signature-symbol">(</span>filter<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>end<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>partner<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>pending<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</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>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>desc<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>offset<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><span class="tsd-signature-type">Promise</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></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#L836">raiden.ts:836</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get list of past and pending transfers</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> filter: <span class="tsd-signature-symbol">{ </span>end<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>partner<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>pending<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</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></h5>
<div class="tsd-comment tsd-typography">
<p>Filter options</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> end<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>filter by initiator or target address</p>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> partner<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>filter by partner address</p>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> pending<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography">
<p>true: only pending; false: only completed; undefined: all</p>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> token<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>filter by token address</p>
</div>
</li>
</ul>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>desc<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>offset<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h5>
<div class="tsd-comment tsd-typography">
<p>PouchDB.ChangesOptions object</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> desc<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography">
<p>Set to true to get newer transfers first</p>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>Limit number of entries</p>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> offset<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>Offset to skip entries</p>
</div>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</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></h4>
<p>promise to array of all transfers</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getUDCCapacity" class="tsd-anchor"></a>
<h3>getUDCCapacity</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">getUDCCapacity<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><span class="tsd-signature-type">BigNumber</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#L1183">raiden.ts:1183</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Fetches balance of UserDeposit Contract for SDK's account minus cached spent IOUs</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">BigNumber</span><span class="tsd-signature-symbol">></span></h4>
<p>Promise to UDC remaining capacity</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getUDCTotalDeposit" class="tsd-anchor"></a>
<h3>getUDCTotal<wbr>Deposit</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">getUDCTotal<wbr>Deposit<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><span class="tsd-signature-type">BigNumber</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#L1206">raiden.ts:1206</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Fetches total_deposit of UserDeposit Contract for SDK's account</p>
</div>
<p>The usable part of the deposit should be fetched with <a href="Raiden.html#getUDCCapacity">getUDCCapacity</a>, but this function
is useful when trying to deposit based on the absolute value of totalDeposit.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">BigNumber</span><span class="tsd-signature-symbol">></span></h4>
<p>Promise to UDC total deposit</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getUDCWithdrawPlan" class="tsd-anchor"></a>
<h3>getUDCWithdraw<wbr>Plan</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">getUDCWithdraw<wbr>Plan<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><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>amount<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>ready<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>withdrawableAfter<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></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#L1373">raiden.ts:1373</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Fetches our current UDC withdraw plan</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <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>amount<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>ready<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>withdrawableAfter<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></h4>
<p>Promise to object containing maximum 'amount' planned for withdraw and
'withdrawableAfter' second at which withdraw will become available,
and 'ready' after it can be withdrawn with <a href="Raiden.html#withdrawFromUDC">withdrawFromUDC</a>;
resolves to undefined if there's no current plan</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="mint" class="tsd-anchor"></a>
<h3>mint</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">mint<span class="tsd-signature-symbol">(</span>token<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNumberish</span>, __namedParameters<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>to<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-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Hash" class="tsd-signature-type" data-tsd-kind="Variable">Hash</a><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#L1093">raiden.ts:1093</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Mints the amount of tokens of the provided token address.
Throws an error, if</p>
<ol>
<li>Executed on main net</li>
<li>`token` or `options.to` is not a valid address</li>
<li>Token could not be minted</li>
</ol>
</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">
<p>Address of the token to be minted</p>
</div>
</li>
<li>
<h5>amount: <span class="tsd-signature-type">BigNumberish</span></h5>
<div class="tsd-comment tsd-typography">
<p>Amount to be minted</p>
</div>
</li>
<li>
<h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>to<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></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> to<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</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#Hash" class="tsd-signature-type" data-tsd-kind="Variable">Hash</a><span class="tsd-signature-symbol">></span></h4>
<p>transaction</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="monitorToken" class="tsd-anchor"></a>
<h3>monitor<wbr>Token</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">monitor<wbr>Token<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><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">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/raiden.ts#L558">raiden.ts:558</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Scans initially and start monitoring a token for channels with us, returning its Tokennetwork
address</p>
</div>
<p>Throws an exception if token isn't registered in current registry</p>
</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">
<p>token address to monitor, must be registered in current token network registry</p>
</div>
</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>
<p>Address of TokenNetwork contract</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="openChannel" class="tsd-anchor"></a>
<h3>open<wbr>Channel</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">open<wbr>Channel<span class="tsd-signature-symbol">(</span>token<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, partner<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>confirmConfirmation<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>deposit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">BigNumberish</span><span class="tsd-signature-symbol"> }</span>, onChange<span class="tsd-signature-symbol">?: </span><a href="../modules.html#OnChange" class="tsd-signature-type" data-tsd-kind="Type alias">OnChange</a><span class="tsd-signature-symbol"><</span><a href="../enums/EventTypes.html" class="tsd-signature-type" data-tsd-kind="Enumeration">EventTypes</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{ </span>txHash<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-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#Hash" class="tsd-signature-type" data-tsd-kind="Variable">Hash</a><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#L591">raiden.ts:591</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Open a channel on the tokenNetwork for given token address with partner</p>
</div>
<p>If token isn't yet monitored, starts monitoring it</p>
</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">
<p>Token address on currently configured token network registry</p>
</div>
</li>
<li>
<h5>partner: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Partner address</p>
</div>
</li>
<li>
<h5>options: <span class="tsd-signature-symbol">{ </span>confirmConfirmation<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>deposit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">BigNumberish</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = {}</span></h5>
<div class="tsd-comment tsd-typography">
<p>(optional) option parameter</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> confirm<wbr>Confirmation<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography">
<p>Whether to wait <code>confirmationBlocks</code> after last
transaction confirmation; default=true if confirmationBlocks</p>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> deposit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">BigNumberish</span></h5>
<div class="tsd-comment tsd-typography">
<p>Deposit to perform in parallel with channel opening</p>
</div>
</li>
</ul>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> onChange: <a href="../modules.html#OnChange" class="tsd-signature-type" data-tsd-kind="Type alias">OnChange</a><span class="tsd-signature-symbol"><</span><a href="../enums/EventTypes.html" class="tsd-signature-type" data-tsd-kind="Enumeration">EventTypes</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{ </span>txHash<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></h5>
<div class="tsd-comment tsd-typography">
<p>Optional callback for status change notification</p>
</div>
</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#Hash" class="tsd-signature-type" data-tsd-kind="Variable">Hash</a><span class="tsd-signature-symbol">></span></h4>
<p>txHash of channelOpen call, iff it succeeded</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="planUDCWithdraw" class="tsd-anchor"></a>
<h3>planUDCWithdraw</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">planUDCWithdraw<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">BigNumberish</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#Hash" class="tsd-signature-type" data-tsd-kind="Variable">Hash</a><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#L1391">raiden.ts:1391</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Records a UDC withdraw plan for our UDC deposit, capped at whole balance.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>value: <span class="tsd-signature-type">BigNumberish</span><span class="tsd-signature-symbol"> = ...</span></h5>
<div class="tsd-comment tsd-typography">
<p>Maximum value which we may try to withdraw.</p>
</div>
</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#Hash" class="tsd-signature-type" data-tsd-kind="Variable">Hash</a><span class="tsd-signature-symbol">></span></h4>
<p>Promise to hash of plan transaction, if it succeeds.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="registerToken" class="tsd-anchor"></a>
<h3>register<wbr>Token</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">register<wbr>Token<span class="tsd-signature-symbol">(</span>token<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, channelParticipantDepositLimit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">BigNumberish</span>, tokenNetworkDepositLimit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">BigNumberish</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">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/raiden.ts#L1142">raiden.ts:1142</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Registers and creates a new token network for the provided token address.
Throws an error, if</p>
<ol>
<li>Executed on main net</li>
<li>`token` is not a valid address</li>
<li>Token is already registered</li>
<li>Token could not be registered</li>
</ol>
</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">
<p>Address of the token to be registered</p>
</div>
</li>
<li>
<h5>channelParticipantDepositLimit: <span class="tsd-signature-type">BigNumberish</span><span class="tsd-signature-symbol"> = ...</span></h5>
<div class="tsd-comment tsd-typography">
<p>The deposit limit per channel participant</p>
</div>
</li>
<li>
<h5>tokenNetworkDepositLimit: <span class="tsd-signature-type">BigNumberish</span><span class="tsd-signature-symbol"> = ...</span></h5>
<div class="tsd-comment tsd-typography">
<p>The deposit limit of the whole token network</p>
</div>
</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>
<p>Address of new token network</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="settleChannel" class="tsd-anchor"></a>
<h3>settle<wbr>Channel</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">settle<wbr>Channel<span class="tsd-signature-symbol">(</span>token<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, partner<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#Hash" class="tsd-signature-type" data-tsd-kind="Variable">Hash</a><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#L784">raiden.ts:784</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Settle channel between us and partner on tokenNetwork for token
This method will fail if called on a channel not in 'settleable' or 'settling' state.
Channel becomes 'settleable' settleTimeout seconds after closed (detected automatically
while Raiden Light Client is running or later on restart). When calling it, channel state
becomes 'settling'. If for any reason transaction fails, it'll stay on this state, and this
method can be called again to re-send a settleChannel transaction.</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">
<p>Token address on currently configured token network registry</p>
</div>
</li>
<li>
<h5>partner: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Partner address</p>
</div>
</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#Hash" class="tsd-signature-type" data-tsd-kind="Variable">Hash</a><span class="tsd-signature-symbol">></span></h4>
<p>txHash of settleChannel call, iff it succeeded</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="start" class="tsd-anchor"></a>
<h3>start</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">start<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><span class="tsd-signature-type">void</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#L331">raiden.ts:331</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Starts redux/observables by subscribing to all epics and emitting initial state and action</p>
</div>
<p>No event should be emitted before start is called</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="stop" class="tsd-anchor"></a>
<h3>stop</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">stop<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><span class="tsd-signature-type">void</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#L371">raiden.ts:371</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Triggers all epics to be unsubscribed</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="suggestPartners" class="tsd-anchor"></a>
<h3>suggest<wbr>Partners</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">suggest<wbr>Partners<span class="tsd-signature-symbol">(</span>token<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>pfs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>matrixServer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>price<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNumberish</span><span class="tsd-signature-symbol">; </span>rtt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>validTill<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><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">SuggestedPartner</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#L1511">raiden.ts:1511</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Fetches an ordered list of suggested partners from provided, configured or first found PFS</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">
<p>Token address to get partners for</p>
</div>
</li>
<li>
<h5>options: <span class="tsd-signature-symbol">{ </span>pfs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>matrixServer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>price<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNumberish</span><span class="tsd-signature-symbol">; </span>rtt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>validTill<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></h5>
<div class="tsd-comment tsd-typography">
<p>Request options</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> pfs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>matrixServer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>price<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNumberish</span><span class="tsd-signature-symbol">; </span>rtt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>validTill<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h5>
<div class="tsd-comment tsd-typography">
<p>PFS to use, instead of configured or automatic</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>matrix<wbr>Server<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>price<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNumberish</span></h5>
</li>
<li class="tsd-parameter">
<h5>rtt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>token<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>valid<wbr>Till<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
</ul>
</li>
</ul>
</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-type">SuggestedPartner</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
<p>Ordered array of suggested partners, with address and scoring values according to PFS</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="transfer" class="tsd-anchor"></a>
<h3>transfer</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">transfer<span class="tsd-signature-symbol">(</span>token<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNumberish</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>encryptSecret<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>lockTimeout<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>paths<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">{ </span>address_metadata<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">{ [x: string]: { readonly user_id: string; readonly displayname: string; readonly capabilities: string; }; }</span><span class="tsd-signature-symbol">; </span>fee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNumberish</span><span class="tsd-signature-symbol">; </span>route<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">readonly string[]</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>address_metadata<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">{ [x: string]: { readonly user_id: string; readonly displayname: string; readonly capabilities: string; }; }</span><span class="tsd-signature-symbol">; </span>estimated_fee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNumberish</span><span class="tsd-signature-symbol">; </span>route<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">readonly string[]</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>address_metadata<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">{ [x: string]: { readonly user_id: string; readonly displayname: string; readonly capabilities: string; }; }</span><span class="tsd-signature-symbol">; </span>fee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNumberish</span><span class="tsd-signature-symbol">; </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">readonly string[]</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>address_metadata<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">{ [x: string]: { readonly user_id: string; readonly displayname: string; readonly capabilities: string; }; }</span><span class="tsd-signature-symbol">; </span>estimated_fee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNumberish</span><span class="tsd-signature-symbol">; </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">readonly string[]</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>paymentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">BigNumberish</span><span class="tsd-signature-symbol">; </span>pfs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>matrixServer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>price<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNumberish</span><span class="tsd-signature-symbol">; </span>rtt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>validTill<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>secret<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>secrethash<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-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</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#L870">raiden.ts:870</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Send a Locked Transfer!
This will reject if LockedTransfer signature prompt is canceled/signature fails, or be
resolved to the transfer unique identifier (secrethash) otherwise, and transfer status can be
queried with this id on this.transfers$ observable, which will just have emitted the 'pending'
transfer. Any following transfer state change will be notified through this observable.</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">
<p>Token address on currently configured token network registry</p>
</div>
</li>
<li>
<h5>target: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Target address</p>
</div>
</li>
<li>
<h5>value: <span class="tsd-signature-type">BigNumberish</span></h5>
<div class="tsd-comment tsd-typography">
<p>Amount to try to transfer</p>
</div>
</li>
<li>
<h5>options: <span class="tsd-signature-symbol">{ </span>encryptSecret<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>lockTimeout<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>paths<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">{ </span>address_metadata<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">{ [x: string]: { readonly user_id: string; readonly displayname: string; readonly capabilities: string; }; }</span><span class="tsd-signature-symbol">; </span>fee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNumberish</span><span class="tsd-signature-symbol">; </span>route<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">readonly string[]</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>address_metadata<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">{ [x: string]: { readonly user_id: string; readonly displayname: string; readonly capabilities: string; }; }</span><span class="tsd-signature-symbol">; </span>estimated_fee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNumberish</span><span class="tsd-signature-symbol">; </span>route<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">readonly string[]</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>address_metadata<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">{ [x: string]: { readonly user_id: string; readonly displayname: string; readonly capabilities: string; }; }</span><span class="tsd-signature-symbol">; </span>fee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNumberish</span><span class="tsd-signature-symbol">; </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">readonly string[]</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>address_metadata<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">{ [x: string]: { readonly user_id: string; readonly displayname: string; readonly capabilities: string; }; }</span><span class="tsd-signature-symbol">; </span>estimated_fee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNumberish</span><span class="tsd-signature-symbol">; </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">readonly string[]</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>paymentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">BigNumberish</span><span class="tsd-signature-symbol">; </span>pfs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>matrixServer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>price<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNumberish</span><span class="tsd-signature-symbol">; </span>rtt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>validTill<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>secret<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>secrethash<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></h5>
<div class="tsd-comment tsd-typography">
<p>Optional parameters for transfer:</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> encrypt<wbr>Secret<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography">
<p>Whether to force encrypting the secret or not,
if target supports it</p>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> lock<wbr>Timeout<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>Specify a lock timeout for transfer;
default is expiryFactor * revealTimeout</p>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> paths<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">{ </span>address_metadata<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">{ [x: string]: { readonly user_id: string; readonly displayname: string; readonly capabilities: string; }; }</span><span class="tsd-signature-symbol">; </span>fee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNumberish</span><span class="tsd-signature-symbol">; </span>route<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">readonly string[]</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>address_metadata<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">{ [x: string]: { readonly user_id: string; readonly displayname: string; readonly capabilities: string; }; }</span><span class="tsd-signature-symbol">; </span>estimated_fee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNumberish</span><span class="tsd-signature-symbol">; </span>route<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">readonly string[]</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>address_metadata<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">{ [x: string]: { readonly user_id: string; readonly displayname: string; readonly capabilities: string; }; }</span><span class="tsd-signature-symbol">; </span>fee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNumberish</span><span class="tsd-signature-symbol">; </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">readonly string[]</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>address_metadata<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">{ [x: string]: { readonly user_id: string; readonly displayname: string; readonly capabilities: string; }; }</span><span class="tsd-signature-symbol">; </span>estimated_fee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNumberish</span><span class="tsd-signature-symbol">; </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">readonly string[]</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<p>Used to specify possible routes & fees instead of querying PFS.
Should receive a decodable super-set of the public RaidenPaths interface</p>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> payment<wbr>Id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">BigNumberish</span></h5>
<div class="tsd-comment tsd-typography">
<p>payment identifier, a random one will be generated if missing</p>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> pfs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>matrixServer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>price<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNumberish</span><span class="tsd-signature-symbol">; </span>rtt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>validTill<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h5>
<div class="tsd-comment tsd-typography">
<p>Use this PFS instead of configured or automatically choosen ones.
Is ignored if paths were already provided. If neither are set and config.pfs is not
disabled (null), use it if set or if undefined (auto mode), fetches the best
PFS from ServiceRegistry and automatically fetch routes from it.</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>matrix<wbr>Server<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>price<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNumberish</span></h5>
</li>
<li class="tsd-parameter">
<h5>rtt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>token<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>valid<wbr>Till<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
</ul>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> secret<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Secret to register, a random one will be generated if missing</p>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> secrethash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Must match secret, if both provided, or else, secret must be
informed to target by other means, and reveal can't be performed</p>
</div>
</li>
</ul>
</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-type">string</span><span class="tsd-signature-symbol">></span></h4>
<p>A promise to transfer's unique key (id) when it's accepted</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="transferOnchainBalance" class="tsd-anchor"></a>
<h3>transfer<wbr>Onchain<wbr>Balance</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">transfer<wbr>Onchain<wbr>Balance<span class="tsd-signature-symbol">(</span>to<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">BigNumberish</span>, __namedParameters<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>gasPrice<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">BigNumberish</span><span class="tsd-signature-symbol">; </span>subkey<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</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#Hash" class="tsd-signature-type" data-tsd-kind="Variable">Hash</a><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#L1276">raiden.ts:1276</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Transfer value ETH on-chain to address.
If subkey is being used, use main account by default, or subkey account if 'subkey' is true
Example:
// transfer 0.1 ETH from main account to subkey account, when subkey is used
await raiden.transferOnchainBalance(raiden.address, parseEther('0.1'));
// transfer entire balance from subkey account back to main account
await raiden.transferOnchainBalance(raiden.mainAddress, undefined, { subkey: true });</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>to: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Recipient address</p>
</div>
</li>
<li>
<h5>value: <span class="tsd-signature-type">BigNumberish</span><span class="tsd-signature-symbol"> = ...</span></h5>
<div class="tsd-comment tsd-typography">
<p>Amount of ETH (in Wei) to transfer. Use ethers/utils::parseEther if needed
Defaults to a very big number, which will cause all entire balance to be transfered</p>
</div>
</li>
<li>
<h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>gasPrice<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">BigNumberish</span><span class="tsd-signature-symbol">; </span>subkey<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = {}</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> gas<wbr>Price<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">BigNumberish</span></h5>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> subkey<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
</li>
</ul>
</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#Hash" class="tsd-signature-type" data-tsd-kind="Variable">Hash</a><span class="tsd-signature-symbol">></span></h4>
<p>transaction hash</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="transferOnchainTokens" class="tsd-anchor"></a>
<h3>transfer<wbr>Onchain<wbr>Tokens</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">transfer<wbr>Onchain<wbr>Tokens<span class="tsd-signature-symbol">(</span>token<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, to<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">BigNumberish</span>, __namedParameters<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>subkey<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</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#Hash" class="tsd-signature-type" data-tsd-kind="Variable">Hash</a><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#L1335">raiden.ts:1335</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Transfer value tokens on-chain to address.
If subkey is being used, use main account by default, or subkey account if 'subkey' is true</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">
<p>Token address</p>
</div>
</li>
<li>
<h5>to: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Recipient address</p>
</div>
</li>
<li>
<h5>value: <span class="tsd-signature-type">BigNumberish</span><span class="tsd-signature-symbol"> = ...</span></h5>
<div class="tsd-comment tsd-typography">
<p>Amount of tokens (in Wei) to transfer. Use ethers/utils::parseUnits if needed
Defaults to a very big number, which will cause all entire balance to be transfered</p>
</div>
</li>
<li>
<h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>subkey<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = {}</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> subkey<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
</li>
</ul>
</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#Hash" class="tsd-signature-type" data-tsd-kind="Variable">Hash</a><span class="tsd-signature-symbol">></span></h4>
<p>transaction hash</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="updateConfig" class="tsd-anchor"></a>
<h3>update<wbr>Config</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">update<wbr>Config<span class="tsd-signature-symbol">(</span>config<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PartialRaidenConfig</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</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#L480">raiden.ts:480</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Update Raiden Config with a partial (shallow) object</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>config: <span class="tsd-signature-type">PartialRaidenConfig</span></h5>
<div class="tsd-comment tsd-typography">
<p>Partial object containing keys and values to update in config</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="waitTransfer" class="tsd-anchor"></a>
<h3>wait<wbr>Transfer</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">wait<wbr>Transfer<span class="tsd-signature-symbol">(</span>transferKey<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="../interfaces/RaidenTransfer.html" class="tsd-signature-type" data-tsd-kind="Interface">RaidenTransfer</a><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#L956">raiden.ts:956</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Waits for the transfer identified by a secrethash to fail or complete
The returned promise will resolve with the final transfer state, or reject if anything fails</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>transferKey: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Transfer identifier as returned by <a href="Raiden.html#transfer">transfer</a></p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</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></h4>
<p>Promise to final RaidenTransfer</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="withdrawChannel" class="tsd-anchor"></a>
<h3>withdraw<wbr>Channel</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">withdraw<wbr>Channel<span class="tsd-signature-symbol">(</span>token<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, partner<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, amount<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">BigNumberish</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#Hash" class="tsd-signature-type" data-tsd-kind="Variable">Hash</a><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#L1461">raiden.ts:1461</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Requests to withdraw from channel</p>
</div>
<p>The requested amount defaults to the maximum withdrawable amount, which is exposed in
<a href="Raiden.html#channels_">channels$</a> observable as the <a href="../interfaces/RaidenChannel.html#ownWithdrawable">RaidenChannel.ownWithdrawable</a> member.
This involves requesting partner a signature which confirms they agree that we have the right
for this amount of tokens, then a transaction is sent on-chain to withdraw tokens to the
effective account.
If this process fails, the amount remains locked until it can be expired later (defaults to
config.expiryFactory * config.revealTimeout seconds).</p>
</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">
<p>Token address on currently configured token network registry</p>
</div>
</li>
<li>
<h5>partner: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Partner address</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> amount: <span class="tsd-signature-type">BigNumberish</span></h5>
<div class="tsd-comment tsd-typography">
<p>Amount of tokens (in wei) to withdraw, must be between 1 and ownWithdrawable</p>
</div>
</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#Hash" class="tsd-signature-type" data-tsd-kind="Variable">Hash</a><span class="tsd-signature-symbol">></span></h4>
<p>Promise to the hash of the mined withdraw transaction</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="withdrawFromUDC" class="tsd-anchor"></a>
<h3>withdraw<wbr>FromUDC</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">withdraw<wbr>FromUDC<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">BigNumberish</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>subkey<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</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#Hash" class="tsd-signature-type" data-tsd-kind="Variable">Hash</a><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#L1418">raiden.ts:1418</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Complete a planned UDC withdraw and get the deposit to account.</p>
</div>
<p>Maximum 'value' is the one from current plan, attempting to withdraw a larger value will throw
an error, but a smaller value is valid. This method may only be called after plan is 'ready'</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> value: <span class="tsd-signature-type">BigNumberish</span></h5>
<div class="tsd-comment tsd-typography">
<p>Maximum value which we may try to withdraw. An error will be thrown if this
value is larger than <a href="Raiden.html#getUDCCapacity">getUDCCapacity</a>+<a href="Raiden.html#getUDCWithdrawPlan">getUDCWithdrawPlan</a>.amount</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>subkey<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></h5>
<div class="tsd-comment tsd-typography">
<p>options object</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> subkey<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography">
<p>if true, force withdrawing to subkey instead of the main account as
beneficiary</p>
</div>
</li>
</ul>
</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#Hash" class="tsd-signature-type" data-tsd-kind="Variable">Hash</a><span class="tsd-signature-symbol">></span></h4>
<p>Promise to hash of plan transaction, if it succeeds.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static">
<a name="create" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> create</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static">
<li class="tsd-signature tsd-kind-icon">create<R><span class="tsd-signature-symbol">(</span>connection<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">JsonRpcProvider</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ExternalProvider</span>, account<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Signer</span>, storage<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>adapter<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>prefix<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>state<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span>, contractsOrUDCAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</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>, config<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>additionalServices<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>autoSettle<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>autoUDCWithdraw<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>caps<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">{ [x: string]: string | number | boolean | (string | number | boolean | null)[] | null; }</span><span class="tsd-signature-symbol">; </span>confirmationBlocks<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>encryptSecret<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>expiryFactor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>fallbackIceServers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">{ urls: string | string[]; }</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>gasPriceFactor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>httpTimeout<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>logger<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>matrixServer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>matrixServerLookup<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>mediationFees<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">; </span>minimumAllowance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">BigNumberish</span><span class="tsd-signature-symbol">; </span>monitoringReward<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">BigNumberish</span><span class="tsd-signature-symbol">; </span>pfsIouTimeout<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>pfsMaxFee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">BigNumberish</span><span class="tsd-signature-symbol">; </span>pfsMaxPaths<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>pfsMode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>pfsSafetyMargin<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</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><span class="tsd-signature-type">number</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>pollingInterval<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>rateToSvt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">{ [x: string]: BigNumberish; }</span><span class="tsd-signature-symbol">; </span>revealTimeout<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>subkey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span>, subkey<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">true</span>, subkeyOriginUrl<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-type">InstanceType</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">R</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#L274">raiden.ts:274</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Async helper factory to make a Raiden instance from more common parameters.</p>
</div>
<p>An async factory is needed so we can do the needed async requests to construct the required
parameters ahead of construction time, and avoid partial initialization then</p>
</div>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>R<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">typeof </span><a href="Raiden.html" class="tsd-signature-type" data-tsd-kind="Class">Raiden</a></h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>connection: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">JsonRpcProvider</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ExternalProvider</span></h5>
<div class="tsd-comment tsd-typography">
<p>A URL or provider to connect to, one of:
<ul>
<li>JsonRpcProvider instance,</li>
<li>a Metamask's web3.currentProvider object or,</li>
<li>a hostname or remote json-rpc connection string</li>
</ul></p>
</div>
</li>
<li>
<h5>account: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Signer</span></h5>
<div class="tsd-comment tsd-typography">
<p>An account to use as main account, one of:
<ul>
<li>Signer instance (e.g. Wallet) loaded with account/private key or</li>
<li>hex-encoded string address of a remote account in provider or</li>
<li>hex-encoded string local private key or</li>
<li>number index of a remote account loaded in provider
(e.g. 0 for Metamask's loaded account)</li>
</ul></p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> storage: <span class="tsd-signature-symbol">{ </span>adapter<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>prefix<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>state<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5>
<div class="tsd-comment tsd-typography">
<p>diverse storage related parameters to load from and save to</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> adapter<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<p>PouchDB adapter; default to 'indexeddb' on browsers and 'leveldb' on
node. If you provide a custom one, ensure you call PouchDB.plugin on it.</p>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> prefix<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Database name prefix; use to set a directory to store leveldown db;</p>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> state<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<p>State uploaded by user; should be decodable by RaidenState;
it is auto-migrated</p>
</div>
</li>
</ul>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> contractsOrUDCAddress: <span class="tsd-signature-type">string</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></h5>
<div class="tsd-comment tsd-typography">
<p>Contracts deployment info, or UserDeposit contract address</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> config: <span class="tsd-signature-symbol">{ </span>additionalServices<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>autoSettle<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>autoUDCWithdraw<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>caps<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">{ [x: string]: string | number | boolean | (string | number | boolean | null)[] | null; }</span><span class="tsd-signature-symbol">; </span>confirmationBlocks<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>encryptSecret<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>expiryFactor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>fallbackIceServers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">{ urls: string | string[]; }</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>gasPriceFactor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>httpTimeout<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>logger<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>matrixServer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>matrixServerLookup<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>mediationFees<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">; </span>minimumAllowance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">BigNumberish</span><span class="tsd-signature-symbol">; </span>monitoringReward<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">BigNumberish</span><span class="tsd-signature-symbol">; </span>pfsIouTimeout<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>pfsMaxFee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">BigNumberish</span><span class="tsd-signature-symbol">; </span>pfsMaxPaths<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>pfsMode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>pfsSafetyMargin<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</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><span class="tsd-signature-type">number</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>pollingInterval<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>rateToSvt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">{ [x: string]: BigNumberish; }</span><span class="tsd-signature-symbol">; </span>revealTimeout<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>subkey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></h5>
<div class="tsd-comment tsd-typography">
<p>Raiden configuration</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>additional<wbr>Services<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
<li class="tsd-parameter">
<h5>auto<wbr>Settle<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></h5>
</li>
<li class="tsd-parameter">
<h5>autoUDCWithdraw<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></h5>
</li>
<li class="tsd-parameter">
<h5>caps<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">{ [x: string]: string | number | boolean | (string | number | boolean | null)[] | null; }</span></h5>
</li>
<li class="tsd-parameter">
<h5>confirmation<wbr>Blocks<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>encrypt<wbr>Secret<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></h5>
</li>
<li class="tsd-parameter">
<h5>expiry<wbr>Factor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>fallback<wbr>Ice<wbr>Servers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">{ urls: string | string[]; }</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
<li class="tsd-parameter">
<h5>gas<wbr>Price<wbr>Factor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>http<wbr>Timeout<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>logger<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>matrix<wbr>Server<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>matrix<wbr>Server<wbr>Lookup<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>mediation<wbr>Fees<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span></h5>
</li>
<li class="tsd-parameter">
<h5>minimum<wbr>Allowance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">BigNumberish</span></h5>
</li>
<li class="tsd-parameter">
<h5>monitoring<wbr>Reward<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">BigNumberish</span></h5>
</li>
<li class="tsd-parameter">
<h5>pfs<wbr>Iou<wbr>Timeout<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>pfs<wbr>Max<wbr>Fee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">BigNumberish</span></h5>
</li>
<li class="tsd-parameter">
<h5>pfs<wbr>Max<wbr>Paths<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>pfs<wbr>Mode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>pfs<wbr>Safety<wbr>Margin<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</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><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span></h5>
</li>
<li class="tsd-parameter">
<h5>polling<wbr>Interval<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>rate<wbr>ToSvt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">{ [x: string]: BigNumberish; }</span></h5>
</li>
<li class="tsd-parameter">
<h5>reveal<wbr>Timeout<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>subkey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></h5>
</li>
</ul>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> subkey: <span class="tsd-signature-type">true</span></h5>
<div class="tsd-comment tsd-typography">
<p>Whether to use a derived subkey or not</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> subkeyOriginUrl: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>URL of origin to generate a subkey for (defaults
to global context)</p>
</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-type">InstanceType</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">R</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
<p>Promise to Raiden SDK client instance</p>
</li>
</ul>
</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-class">
<a href="Raiden.html" class="tsd-kind-icon">Raiden</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="Raiden.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<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>
<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>
<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>
</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>