forked from streamflow-finance/js-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathStreamClient.html
25 lines (25 loc) · 37.1 KB
/
StreamClient.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>StreamClient | @streamflow/stream</title><meta name="description" content="Documentation for @streamflow/stream"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">@streamflow/stream</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><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</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">@streamflow/stream</a></li><li><a href="StreamClient.html">StreamClient</a></li></ul><h1>Class StreamClient</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">StreamClient</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="StreamClient.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-private tsd-is-private-protected"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="StreamClient.html#cluster" class="tsd-kind-icon">cluster</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="StreamClient.html#commitment" class="tsd-kind-icon">commitment</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="StreamClient.html#connection" class="tsd-kind-icon">connection</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="StreamClient.html#programId" class="tsd-kind-icon">program<wbr/>Id</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="StreamClient.html#cancel" class="tsd-kind-icon">cancel</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="StreamClient.html#create" class="tsd-kind-icon">create</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="StreamClient.html#createMultiple" class="tsd-kind-icon">create<wbr/>Multiple</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="StreamClient.html#get" class="tsd-kind-icon">get</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="StreamClient.html#getConnection" class="tsd-kind-icon">get<wbr/>Connection</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="StreamClient.html#getOne" class="tsd-kind-icon">get<wbr/>One</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="StreamClient.html#sign" class="tsd-kind-icon">sign</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="StreamClient.html#topup" class="tsd-kind-icon">topup</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="StreamClient.html#transfer" class="tsd-kind-icon">transfer</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="StreamClient.html#withdraw" class="tsd-kind-icon">withdraw</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 id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Stream<wbr/>Client<span class="tsd-signature-symbol">(</span>clusterUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, cluster<span class="tsd-signature-symbol">?: </span><a href="../modules.html#ClusterExtended" class="tsd-signature-type" data-tsd-kind="Type alias">ClusterExtended</a>, commitment<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Commitment</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ConnectionConfig</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="StreamClient.html" class="tsd-signature-type" data-tsd-kind="Class">StreamClient</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/streamflow-finance/js-sdk/blob/b5d6e3f/packages/stream/StreamClient.ts#L70">packages/stream/StreamClient.ts:70</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Create Stream instance</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>clusterUrl: <span class="tsd-signature-type">string</span></h5></li><li><h5>cluster: <a href="../modules.html#ClusterExtended" class="tsd-signature-type" data-tsd-kind="Type alias">ClusterExtended</a><span class="tsd-signature-symbol"> = Cluster.Mainnet</span></h5></li><li><h5>commitment: <span class="tsd-signature-type">Commitment</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ConnectionConfig</span><span class="tsd-signature-symbol"> = "confirmed"</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="StreamClient.html" class="tsd-signature-type" data-tsd-kind="Class">StreamClient</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="cluster" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagPrivate">Private</span> cluster<a href="#cluster" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">cluster<span class="tsd-signature-symbol">:</span> <a href="../modules.html#ClusterExtended" class="tsd-signature-type" data-tsd-kind="Type alias">ClusterExtended</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/streamflow-finance/js-sdk/blob/b5d6e3f/packages/stream/StreamClient.ts#L63">packages/stream/StreamClient.ts:63</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="commitment" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagPrivate">Private</span> commitment<a href="#commitment" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">commitment<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Commitment</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ConnectionConfig</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/streamflow-finance/js-sdk/blob/b5d6e3f/packages/stream/StreamClient.ts#L65">packages/stream/StreamClient.ts:65</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="connection" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagPrivate">Private</span> connection<a href="#connection" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">connection<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Connection</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/streamflow-finance/js-sdk/blob/b5d6e3f/packages/stream/StreamClient.ts#L62">packages/stream/StreamClient.ts:62</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="programId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagPrivate">Private</span> program<wbr/>Id<a href="#programId" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">program<wbr/>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PublicKey</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/streamflow-finance/js-sdk/blob/b5d6e3f/packages/stream/StreamClient.ts#L64">packages/stream/StreamClient.ts:64</a></li></ul></aside></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 id="cancel" class="tsd-anchor"></a><h3 class="tsd-anchor-link">cancel<a href="#cancel" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">cancel<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><a href="../interfaces/CancelParams.html" class="tsd-signature-type" data-tsd-kind="Interface">CancelParams</a><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/TxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TxResponse</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/streamflow-finance/js-sdk/blob/b5d6e3f/packages/stream/StreamClient.ts#L426">packages/stream/StreamClient.ts:426</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Attempts canceling the specified stream.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>data: <a href="../interfaces/CancelParams.html" class="tsd-signature-type" data-tsd-kind="Interface">CancelParams</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TxResponse</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="create" class="tsd-anchor"></a><h3 class="tsd-anchor-link">create<a href="#create" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">create<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><a href="../interfaces/CreateParams.html" class="tsd-signature-type" data-tsd-kind="Interface">CreateParams</a><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/CreateResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">CreateResponse</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/streamflow-finance/js-sdk/blob/b5d6e3f/packages/stream/StreamClient.ts#L108">packages/stream/StreamClient.ts:108</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Creates a new stream/vesting contract.
All fees are paid by sender (escrow metadata account rent, escrow token account rent, recipient's associated token account rent, Streamflow's service fee).</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>data: <a href="../interfaces/CreateParams.html" class="tsd-signature-type" data-tsd-kind="Interface">CreateParams</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/CreateResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">CreateResponse</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createMultiple" class="tsd-anchor"></a><h3 class="tsd-anchor-link">create<wbr/>Multiple<a href="#createMultiple" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">create<wbr/>Multiple<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><a href="../interfaces/CreateMultiParams.html" class="tsd-signature-type" data-tsd-kind="Interface">CreateMultiParams</a><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/CreateMultiResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">CreateMultiResponse</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/streamflow-finance/js-sdk/blob/b5d6e3f/packages/stream/StreamClient.ts#L234">packages/stream/StreamClient.ts:234</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Creates a new stream/vesting contract.
All fees are paid by sender (escrow metadata account rent, escrow token account rent, recipient's associated token account rent, Streamflow's service fee).</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>data: <a href="../interfaces/CreateMultiParams.html" class="tsd-signature-type" data-tsd-kind="Interface">CreateMultiParams</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/CreateMultiResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">CreateMultiResponse</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="get" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<a href="#get" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><a href="../interfaces/GetAllParams.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAllParams</a><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><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../interfaces/Stream.html" class="tsd-signature-type" data-tsd-kind="Interface">Stream</a><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/streamflow-finance/js-sdk/blob/b5d6e3f/packages/stream/StreamClient.ts#L614">packages/stream/StreamClient.ts:614</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Fetch streams/contracts by providing direction.
Streams are sorted by start time in ascending order.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>data: <a href="../interfaces/GetAllParams.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAllParams</a></h5></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><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../interfaces/Stream.html" class="tsd-signature-type" data-tsd-kind="Interface">Stream</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[]</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 id="getConnection" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Connection<a href="#getConnection" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Connection<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Connection</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/streamflow-finance/js-sdk/blob/b5d6e3f/packages/stream/StreamClient.ts#L81">packages/stream/StreamClient.ts:81</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Connection</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getOne" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>One<a href="#getOne" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>One<span class="tsd-signature-symbol">(</span>id<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/Stream.html" class="tsd-signature-type" data-tsd-kind="Interface">Stream</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/streamflow-finance/js-sdk/blob/b5d6e3f/packages/stream/StreamClient.ts#L594">packages/stream/StreamClient.ts:594</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Fetch stream data by its id (address).</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Identifier of a stream that is fetched.</p>
</div></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/Stream.html" class="tsd-signature-type" data-tsd-kind="Interface">Stream</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="sign" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagPrivate">Private</span> sign<a href="#sign" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">sign<span class="tsd-signature-symbol">(</span>invoker<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, tx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Transaction</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/streamflow-finance/js-sdk/blob/b5d6e3f/packages/stream/StreamClient.ts#L666">packages/stream/StreamClient.ts:666</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>invoker: <span class="tsd-signature-type">any</span></h5></li><li><h5>tx: <span class="tsd-signature-type">Transaction</span></h5></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></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="topup" class="tsd-anchor"></a><h3 class="tsd-anchor-link">topup<a href="#topup" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">topup<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><a href="../interfaces/TopupParams.html" class="tsd-signature-type" data-tsd-kind="Interface">TopupParams</a><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/TxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TxResponse</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/streamflow-finance/js-sdk/blob/b5d6e3f/packages/stream/StreamClient.ts#L538">packages/stream/StreamClient.ts:538</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Tops up stream account deposited amount.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>data: <a href="../interfaces/TopupParams.html" class="tsd-signature-type" data-tsd-kind="Interface">TopupParams</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TxResponse</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="transfer" class="tsd-anchor"></a><h3 class="tsd-anchor-link">transfer<a href="#transfer" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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>data<span class="tsd-signature-symbol">: </span><a href="../interfaces/TransferParams.html" class="tsd-signature-type" data-tsd-kind="Interface">TransferParams</a><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/TxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TxResponse</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/streamflow-finance/js-sdk/blob/b5d6e3f/packages/stream/StreamClient.ts#L485">packages/stream/StreamClient.ts:485</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Attempts changing the stream/vesting contract's recipient (effectively transferring the stream/vesting contract).
Potential associated token account rent fee (to make it rent-exempt) is paid by the transaction initiator.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>data: <a href="../interfaces/TransferParams.html" class="tsd-signature-type" data-tsd-kind="Interface">TransferParams</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TxResponse</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withdraw" class="tsd-anchor"></a><h3 class="tsd-anchor-link">withdraw<a href="#withdraw" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">withdraw<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><a href="../interfaces/WithdrawParams.html" class="tsd-signature-type" data-tsd-kind="Interface">WithdrawParams</a><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/TxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TxResponse</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/streamflow-finance/js-sdk/blob/b5d6e3f/packages/stream/StreamClient.ts#L368">packages/stream/StreamClient.ts:368</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Attempts withdrawal from the specified stream.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>data: <a href="../interfaces/WithdrawParams.html" class="tsd-signature-type" data-tsd-kind="Interface">WithdrawParams</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TxResponse</a><span class="tsd-signature-symbol">></span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="StreamClient.html" class="tsd-kind-icon">Stream<wbr/>Client</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="StreamClient.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="StreamClient.html#cluster" class="tsd-kind-icon">cluster</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="StreamClient.html#commitment" class="tsd-kind-icon">commitment</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="StreamClient.html#connection" class="tsd-kind-icon">connection</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="StreamClient.html#programId" class="tsd-kind-icon">program<wbr/>Id</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="StreamClient.html#cancel" class="tsd-kind-icon">cancel</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="StreamClient.html#create" class="tsd-kind-icon">create</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="StreamClient.html#createMultiple" class="tsd-kind-icon">create<wbr/>Multiple</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="StreamClient.html#get" class="tsd-kind-icon">get</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="StreamClient.html#getConnection" class="tsd-kind-icon">get<wbr/>Connection</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="StreamClient.html#getOne" class="tsd-kind-icon">get<wbr/>One</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="StreamClient.html#sign" class="tsd-kind-icon">sign</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="StreamClient.html#topup" class="tsd-kind-icon">topup</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="StreamClient.html#transfer" class="tsd-kind-icon">transfer</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="StreamClient.html#withdraw" class="tsd-kind-icon">withdraw</a></li></ul></li></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-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-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private 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></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></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/main.js"></script></body></html>