raiden-ts
Version:
Raiden Light Client Typescript/Javascript SDK
680 lines • 42.5 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>RaidenChannel | 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="RaidenChannel.html">RaidenChannel</a>
</li>
</ul>
<h1>Interface RaidenChannel</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Public exposed channels interface (Raiden.channels$)</p>
</div>
<p>This should be only used as a public view of the internal channel state
It contains some details about channel's current state, and some balances.
Most relevant are:</p>
<ul>
<li>state: one of 'open', 'closing', 'closed', 'settleable' or 'settling'</li>
<li>id: channel identifier</li>
<li>token: ERC20 token contract address</li>
<li>tokenNetwork: TokenNetwork contract address</li>
<li>openBlock: block number in which channel was opened</li>
<li>closeBlock: block in which channel got closed</li>
<li>partner: partner's address</li>
<li>balance: how much was sent (negative) plus received on this channel from partner</li>
<li>capacity: how much still can be transferred through this channel; increases with deposit</li>
<li>Balances [for each property, prefixed with either 'own' or 'partner']:<ul>
<li>Deposit: on-chain totalDeposit</li>
<li>Withdraw: on-chain totalWithdraw</li>
<li>Unlocked: how much was received and unlocked on this channel's end</li>
<li>Locked: how much is still locked off-chain on this channel's end</li>
<li>Balance: received minus sent off-chain</li>
<li>Capacity: channel end's liquidity</li>
<li>Withdrawable: amount which can still be withdrawn</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">ChannelBalances</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">RaidenChannel</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="RaidenChannel.html#balance" class="tsd-kind-icon">balance</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="RaidenChannel.html#capacity" class="tsd-kind-icon">capacity</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="RaidenChannel.html#closeBlock" class="tsd-kind-icon">close<wbr>Block</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="RaidenChannel.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="RaidenChannel.html#openBlock" class="tsd-kind-icon">open<wbr>Block</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="RaidenChannel.html#ownBalance" class="tsd-kind-icon">own<wbr>Balance</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="RaidenChannel.html#ownCapacity" class="tsd-kind-icon">own<wbr>Capacity</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="RaidenChannel.html#ownDeposit" class="tsd-kind-icon">own<wbr>Deposit</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="RaidenChannel.html#ownLocked" class="tsd-kind-icon">own<wbr>Locked</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="RaidenChannel.html#ownOnchainUnlocked" class="tsd-kind-icon">own<wbr>Onchain<wbr>Unlocked</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="RaidenChannel.html#ownTotalWithdrawable" class="tsd-kind-icon">own<wbr>Total<wbr>Withdrawable</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="RaidenChannel.html#ownTransferred" class="tsd-kind-icon">own<wbr>Transferred</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="RaidenChannel.html#ownUnlocked" class="tsd-kind-icon">own<wbr>Unlocked</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="RaidenChannel.html#ownWithdraw" class="tsd-kind-icon">own<wbr>Withdraw</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="RaidenChannel.html#ownWithdrawable" class="tsd-kind-icon">own<wbr>Withdrawable</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="RaidenChannel.html#partner" class="tsd-kind-icon">partner</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="RaidenChannel.html#partnerBalance" class="tsd-kind-icon">partner<wbr>Balance</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="RaidenChannel.html#partnerCapacity" class="tsd-kind-icon">partner<wbr>Capacity</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="RaidenChannel.html#partnerDeposit" class="tsd-kind-icon">partner<wbr>Deposit</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="RaidenChannel.html#partnerLocked" class="tsd-kind-icon">partner<wbr>Locked</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="RaidenChannel.html#partnerOnchainUnlocked" class="tsd-kind-icon">partner<wbr>Onchain<wbr>Unlocked</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="RaidenChannel.html#partnerTotalWithdrawable" class="tsd-kind-icon">partner<wbr>Total<wbr>Withdrawable</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="RaidenChannel.html#partnerTransferred" class="tsd-kind-icon">partner<wbr>Transferred</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="RaidenChannel.html#partnerUnlocked" class="tsd-kind-icon">partner<wbr>Unlocked</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="RaidenChannel.html#partnerWithdraw" class="tsd-kind-icon">partner<wbr>Withdraw</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="RaidenChannel.html#partnerWithdrawable" class="tsd-kind-icon">partner<wbr>Withdrawable</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="RaidenChannel.html#state" class="tsd-kind-icon">state</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="RaidenChannel.html#token" class="tsd-kind-icon">token</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="RaidenChannel.html#tokenNetwork" class="tsd-kind-icon">token<wbr>Network</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="RaidenChannel.html#totalCapacity" class="tsd-kind-icon">total<wbr>Capacity</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="balance" class="tsd-anchor"></a>
<h3>balance</h3>
<div class="tsd-signature tsd-kind-icon">balance<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">BigNumber</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/channels/state.ts#L155">channels/state.ts:155</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="capacity" class="tsd-anchor"></a>
<h3>capacity</h3>
<div class="tsd-signature tsd-kind-icon">capacity<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">BigNumber</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/channels/state.ts#L158">channels/state.ts:158</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="closeBlock" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> close<wbr>Block</h3>
<div class="tsd-signature tsd-kind-icon">close<wbr>Block<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/channels/state.ts#L150">channels/state.ts:150</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="id" class="tsd-anchor"></a>
<h3>id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/channels/state.ts#L146">channels/state.ts:146</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="openBlock" class="tsd-anchor"></a>
<h3>open<wbr>Block</h3>
<div class="tsd-signature tsd-kind-icon">open<wbr>Block<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/channels/state.ts#L149">channels/state.ts:149</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="ownBalance" class="tsd-anchor"></a>
<h3>own<wbr>Balance</h3>
<div class="tsd-signature tsd-kind-icon">own<wbr>Balance<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></div>
<aside class="tsd-sources">
<p>Inherited from ChannelBalances.ownBalance</p>
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/channels/state.ts#L101">channels/state.ts:101</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="ownCapacity" class="tsd-anchor"></a>
<h3>own<wbr>Capacity</h3>
<div class="tsd-signature tsd-kind-icon">own<wbr>Capacity<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></div>
<aside class="tsd-sources">
<p>Inherited from ChannelBalances.ownCapacity</p>
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/channels/state.ts#L102">channels/state.ts:102</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="ownDeposit" class="tsd-anchor"></a>
<h3>own<wbr>Deposit</h3>
<div class="tsd-signature tsd-kind-icon">own<wbr>Deposit<span class="tsd-signature-symbol">:</span> <a href="../modules.html#UInt" class="tsd-signature-type" data-tsd-kind="Function">UInt</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">32</span><span class="tsd-signature-symbol">></span></div>
<aside class="tsd-sources">
<p>Inherited from ChannelBalances.ownDeposit</p>
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/channels/state.ts#L97">channels/state.ts:97</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="ownLocked" class="tsd-anchor"></a>
<h3>own<wbr>Locked</h3>
<div class="tsd-signature tsd-kind-icon">own<wbr>Locked<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></div>
<aside class="tsd-sources">
<p>Inherited from ChannelBalances.ownLocked</p>
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/channels/state.ts#L100">channels/state.ts:100</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="ownOnchainUnlocked" class="tsd-anchor"></a>
<h3>own<wbr>Onchain<wbr>Unlocked</h3>
<div class="tsd-signature tsd-kind-icon">own<wbr>Onchain<wbr>Unlocked<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></div>
<aside class="tsd-sources">
<p>Inherited from ChannelBalances.ownOnchainUnlocked</p>
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/channels/state.ts#L103">channels/state.ts:103</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="ownTotalWithdrawable" class="tsd-anchor"></a>
<h3>own<wbr>Total<wbr>Withdrawable</h3>
<div class="tsd-signature tsd-kind-icon">own<wbr>Total<wbr>Withdrawable<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></div>
<aside class="tsd-sources">
<p>Inherited from ChannelBalances.ownTotalWithdrawable</p>
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/channels/state.ts#L105">channels/state.ts:105</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="ownTransferred" class="tsd-anchor"></a>
<h3>own<wbr>Transferred</h3>
<div class="tsd-signature tsd-kind-icon">own<wbr>Transferred<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></div>
<aside class="tsd-sources">
<p>Inherited from ChannelBalances.ownTransferred</p>
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/channels/state.ts#L99">channels/state.ts:99</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="ownUnlocked" class="tsd-anchor"></a>
<h3>own<wbr>Unlocked</h3>
<div class="tsd-signature tsd-kind-icon">own<wbr>Unlocked<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></div>
<aside class="tsd-sources">
<p>Inherited from ChannelBalances.ownUnlocked</p>
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/channels/state.ts#L104">channels/state.ts:104</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="ownWithdraw" class="tsd-anchor"></a>
<h3>own<wbr>Withdraw</h3>
<div class="tsd-signature tsd-kind-icon">own<wbr>Withdraw<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></div>
<aside class="tsd-sources">
<p>Inherited from ChannelBalances.ownWithdraw</p>
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/channels/state.ts#L98">channels/state.ts:98</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="ownWithdrawable" class="tsd-anchor"></a>
<h3>own<wbr>Withdrawable</h3>
<div class="tsd-signature tsd-kind-icon">own<wbr>Withdrawable<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></div>
<aside class="tsd-sources">
<p>Inherited from ChannelBalances.ownWithdrawable</p>
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/channels/state.ts#L106">channels/state.ts:106</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="partner" class="tsd-anchor"></a>
<h3>partner</h3>
<div class="tsd-signature tsd-kind-icon">partner<span class="tsd-signature-symbol">:</span> <a href="../modules.html#Address" class="tsd-signature-type" data-tsd-kind="Variable">Address</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/channels/state.ts#L151">channels/state.ts:151</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="partnerBalance" class="tsd-anchor"></a>
<h3>partner<wbr>Balance</h3>
<div class="tsd-signature tsd-kind-icon">partner<wbr>Balance<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></div>
<aside class="tsd-sources">
<p>Inherited from ChannelBalances.partnerBalance</p>
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/channels/state.ts#L111">channels/state.ts:111</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="partnerCapacity" class="tsd-anchor"></a>
<h3>partner<wbr>Capacity</h3>
<div class="tsd-signature tsd-kind-icon">partner<wbr>Capacity<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></div>
<aside class="tsd-sources">
<p>Inherited from ChannelBalances.partnerCapacity</p>
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/channels/state.ts#L112">channels/state.ts:112</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="partnerDeposit" class="tsd-anchor"></a>
<h3>partner<wbr>Deposit</h3>
<div class="tsd-signature tsd-kind-icon">partner<wbr>Deposit<span class="tsd-signature-symbol">:</span> <a href="../modules.html#UInt" class="tsd-signature-type" data-tsd-kind="Function">UInt</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">32</span><span class="tsd-signature-symbol">></span></div>
<aside class="tsd-sources">
<p>Inherited from ChannelBalances.partnerDeposit</p>
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/channels/state.ts#L107">channels/state.ts:107</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="partnerLocked" class="tsd-anchor"></a>
<h3>partner<wbr>Locked</h3>
<div class="tsd-signature tsd-kind-icon">partner<wbr>Locked<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></div>
<aside class="tsd-sources">
<p>Inherited from ChannelBalances.partnerLocked</p>
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/channels/state.ts#L110">channels/state.ts:110</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="partnerOnchainUnlocked" class="tsd-anchor"></a>
<h3>partner<wbr>Onchain<wbr>Unlocked</h3>
<div class="tsd-signature tsd-kind-icon">partner<wbr>Onchain<wbr>Unlocked<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></div>
<aside class="tsd-sources">
<p>Inherited from ChannelBalances.partnerOnchainUnlocked</p>
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/channels/state.ts#L113">channels/state.ts:113</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="partnerTotalWithdrawable" class="tsd-anchor"></a>
<h3>partner<wbr>Total<wbr>Withdrawable</h3>
<div class="tsd-signature tsd-kind-icon">partner<wbr>Total<wbr>Withdrawable<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></div>
<aside class="tsd-sources">
<p>Inherited from ChannelBalances.partnerTotalWithdrawable</p>
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/channels/state.ts#L115">channels/state.ts:115</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="partnerTransferred" class="tsd-anchor"></a>
<h3>partner<wbr>Transferred</h3>
<div class="tsd-signature tsd-kind-icon">partner<wbr>Transferred<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></div>
<aside class="tsd-sources">
<p>Inherited from ChannelBalances.partnerTransferred</p>
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/channels/state.ts#L109">channels/state.ts:109</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="partnerUnlocked" class="tsd-anchor"></a>
<h3>partner<wbr>Unlocked</h3>
<div class="tsd-signature tsd-kind-icon">partner<wbr>Unlocked<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></div>
<aside class="tsd-sources">
<p>Inherited from ChannelBalances.partnerUnlocked</p>
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/channels/state.ts#L114">channels/state.ts:114</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="partnerWithdraw" class="tsd-anchor"></a>
<h3>partner<wbr>Withdraw</h3>
<div class="tsd-signature tsd-kind-icon">partner<wbr>Withdraw<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></div>
<aside class="tsd-sources">
<p>Inherited from ChannelBalances.partnerWithdraw</p>
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/channels/state.ts#L108">channels/state.ts:108</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="partnerWithdrawable" class="tsd-anchor"></a>
<h3>partner<wbr>Withdrawable</h3>
<div class="tsd-signature tsd-kind-icon">partner<wbr>Withdrawable<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></div>
<aside class="tsd-sources">
<p>Inherited from ChannelBalances.partnerWithdrawable</p>
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/channels/state.ts#L116">channels/state.ts:116</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="state" class="tsd-anchor"></a>
<h3>state</h3>
<div class="tsd-signature tsd-kind-icon">state<span class="tsd-signature-symbol">:</span> <a href="../enums/ChannelState.html" class="tsd-signature-type" data-tsd-kind="Enumeration">ChannelState</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/channels/state.ts#L145">channels/state.ts:145</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="token" class="tsd-anchor"></a>
<h3>token</h3>
<div class="tsd-signature tsd-kind-icon">token<span class="tsd-signature-symbol">:</span> <a href="../modules.html#Address" class="tsd-signature-type" data-tsd-kind="Variable">Address</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/channels/state.ts#L147">channels/state.ts:147</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="tokenNetwork" class="tsd-anchor"></a>
<h3>token<wbr>Network</h3>
<div class="tsd-signature tsd-kind-icon">token<wbr>Network<span class="tsd-signature-symbol">:</span> <a href="../modules.html#Address" class="tsd-signature-type" data-tsd-kind="Variable">Address</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/channels/state.ts#L148">channels/state.ts:148</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="totalCapacity" class="tsd-anchor"></a>
<h3>total<wbr>Capacity</h3>
<div class="tsd-signature tsd-kind-icon">total<wbr>Capacity<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></div>
<aside class="tsd-sources">
<p>Inherited from ChannelBalances.totalCapacity</p>
<ul>
<li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/channels/state.ts#L117">channels/state.ts:117</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="label pp-nav pp-group">
<span>Get <wbr>Started</span>
</li>
<li class=" pp-nav pp-page">
<a href="../pages/Get Started/prerequisites.html">Prerequisites</a>
</li>
<li class=" pp-nav pp-page">
<a href="../pages/Get Started/installing-sdk.html">Installing the SDK</a>
</li>
<li class=" pp-nav pp-page">
<a href="../pages/Get Started/installing-dapp.html">Installing the d<wbr>App</a>
</li>
<li class=" pp-nav pp-page">
<a href="../pages/Get Started/connecting.html">Connecting</a>
</li>
<li class=" pp-nav pp-page">
<a href="../pages/Get Started/private-chain.html">Private chains</a>
</li>
<li class="label pp-nav pp-group">
<span>Usage</span>
</li>
<li class=" pp-nav pp-page">
<a href="../pages/Usage/opening-channel.html">Opening a channel</a>
</li>
<li class=" pp-nav pp-page">
<a href="../pages/Usage/funding-channel.html">Funding a channel</a>
</li>
<li class=" pp-nav pp-page">
<a href="../pages/Usage/direct-transfer.html">Transferring</a>
</li>
<li class=" pp-nav pp-page">
<a href="../pages/Usage/closing-channel.html">Closing a channel</a>
</li>
<li class=" pp-nav pp-page">
<a href="../pages/Usage/settling-channel.html">Settling a channel</a>
</li>
<li class="label pp-nav pp-group">
<span>Using the <wbr>Raiden d<wbr>App</span>
</li>
<li class=" pp-nav pp-page">
<a href="../pages/Using the Raiden dApp/using-dapp.html">Overview</a>
</li>
<li class=" pp-nav pp-page">
<a href="../pages/Using the Raiden dApp/navigate-dapp.html">Navigate the <wbr>Raiden d<wbr>App</a>
</li>
<li class=" pp-nav pp-page">
<a href="../pages/Using the Raiden dApp/hub-selection-channel-opening.html">Hub <wbr>Selection and <wbr>Channel <wbr>Opening</a>
</li>
<li class=" pp-nav pp-page">
<a href="../pages/Using the Raiden dApp/transfers.html">Transfers</a>
</li>
<li class=" pp-nav pp-page">
<a href="../pages/Using the Raiden dApp/channels.html">Channels</a>
</li>
<li class=" pp-nav pp-page">
<a href="../pages/Using the Raiden dApp/account.html">Accounts</a>
</li>
<li class="label pp-nav pp-group">
<span>Using the <wbr>Raiden CLI</span>
</li>
<li class=" pp-nav pp-page">
<a href="../pages/Using the Raiden CLI/README.html">Overview</a>
</li>
<li class=" pp-nav pp-page">
<a href="../pages/Using the Raiden CLI/raspberrypi.html">Running raiden-<wbr>cli on the raspberry pi</a>
</li>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="RaidenChannel.html" class="tsd-kind-icon">Raiden<wbr>Channel</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="RaidenChannel.html#balance" class="tsd-kind-icon">balance</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="RaidenChannel.html#capacity" class="tsd-kind-icon">capacity</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="RaidenChannel.html#closeBlock" class="tsd-kind-icon">close<wbr>Block</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="RaidenChannel.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="RaidenChannel.html#openBlock" class="tsd-kind-icon">open<wbr>Block</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="RaidenChannel.html#ownBalance" class="tsd-kind-icon">own<wbr>Balance</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="RaidenChannel.html#ownCapacity" class="tsd-kind-icon">own<wbr>Capacity</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="RaidenChannel.html#ownDeposit" class="tsd-kind-icon">own<wbr>Deposit</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="RaidenChannel.html#ownLocked" class="tsd-kind-icon">own<wbr>Locked</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="RaidenChannel.html#ownOnchainUnlocked" class="tsd-kind-icon">own<wbr>Onchain<wbr>Unlocked</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="RaidenChannel.html#ownTotalWithdrawable" class="tsd-kind-icon">own<wbr>Total<wbr>Withdrawable</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="RaidenChannel.html#ownTransferred" class="tsd-kind-icon">own<wbr>Transferred</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="RaidenChannel.html#ownUnlocked" class="tsd-kind-icon">own<wbr>Unlocked</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="RaidenChannel.html#ownWithdraw" class="tsd-kind-icon">own<wbr>Withdraw</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="RaidenChannel.html#ownWithdrawable" class="tsd-kind-icon">own<wbr>Withdrawable</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="RaidenChannel.html#partner" class="tsd-kind-icon">partner</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="RaidenChannel.html#partnerBalance" class="tsd-kind-icon">partner<wbr>Balance</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="RaidenChannel.html#partnerCapacity" class="tsd-kind-icon">partner<wbr>Capacity</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="RaidenChannel.html#partnerDeposit" class="tsd-kind-icon">partner<wbr>Deposit</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="RaidenChannel.html#partnerLocked" class="tsd-kind-icon">partner<wbr>Locked</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="RaidenChannel.html#partnerOnchainUnlocked" class="tsd-kind-icon">partner<wbr>Onchain<wbr>Unlocked</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="RaidenChannel.html#partnerTotalWithdrawable" class="tsd-kind-icon">partner<wbr>Total<wbr>Withdrawable</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="RaidenChannel.html#partnerTransferred" class="tsd-kind-icon">partner<wbr>Transferred</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="RaidenChannel.html#partnerUnlocked" class="tsd-kind-icon">partner<wbr>Unlocked</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="RaidenChannel.html#partnerWithdraw" class="tsd-kind-icon">partner<wbr>Withdraw</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="RaidenChannel.html#partnerWithdrawable" class="tsd-kind-icon">partner<wbr>Withdrawable</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="RaidenChannel.html#state" class="tsd-kind-icon">state</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="RaidenChannel.html#token" class="tsd-kind-icon">token</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="RaidenChannel.html#tokenNetwork" class="tsd-kind-icon">token<wbr>Network</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="RaidenChannel.html#totalCapacity" class="tsd-kind-icon">total<wbr>Capacity</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>