npm - @0xkaleab/sdk-js - Versions diffs - 0.2.7 - Mend

@0xkaleab/sdk-js 0.2.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1378) hide show

package/docs/api/classes/BlockchainActionAdapter.html ADDED Viewed

@@ -0,0 +1,49 @@
+<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BlockchainActionAdapter | @lumera/sdk-js</title><meta name="description" content="Documentation for @lumera/sdk-js"/><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 defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@lumera/sdk-js</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">BlockchainActionAdapter</a></li></ul><h1>Class BlockchainActionAdapter</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Adapter implementing CascadeChainPort using a BlockchainClient.</p>
+<p>This adapter:</p>
+<ul>
+<li>Fetches and caches action parameters with a configurable TTL</li>
+<li>Provides a single-call transaction flow (simulate → sign → broadcast)</li>
+<li>Maps blockchain responses to plain DTOs for Cascade</li>
+</ul>
+</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="typescript"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">adapter</span><span class="hl-1"> = </span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-0">BlockchainActionAdapter</span><span class="hl-1">(</span><span class="hl-4">blockchainClient</span><span class="hl-1">, </span><span class="hl-4">signerAddress</span><span class="hl-1">, {</span><br/><span class="hl-1">  </span><span class="hl-4">paramsCacheTtlMs:</span><span class="hl-1"> </span><span class="hl-9">300000</span><span class="hl-1">, </span><span class="hl-5">// 5 minutes</span><br/><span class="hl-1">  </span><span class="hl-4">defaultGasPrice:</span><span class="hl-1"> </span><span class="hl-2">&quot;0.025ulume&quot;</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-4">gasMultiplier:</span><span class="hl-1"> </span><span class="hl-9">1.3</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-5">// Cascade can now use the adapter</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">params</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">adapter</span><span class="hl-1">.</span><span class="hl-0">getActionParams</span><span class="hl-1">();</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">outcome</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">adapter</span><span class="hl-1">.</span><span class="hl-0">requestActionTx</span><span class="hl-1">({</span><br/><span class="hl-1">  </span><span class="hl-4">actionId:</span><span class="hl-1"> </span><span class="hl-2">&#39;my-action&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-4">msg:</span><span class="hl-1"> { </span><span class="hl-4">data_hash:</span><span class="hl-1"> </span><span class="hl-2">&#39;...&#39;</span><span class="hl-1">, ... }</span><br/><span class="hl-1">});</span>
+</code><button type="button">Copy</button></pre>
+</div></div></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/CascadeChainPort.html" class="tsd-signature-type tsd-kind-interface">CascadeChainPort</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/LumeraProtocol/sdk-js/blob/5af750cf0bb28561d99b5e911d3ea93d4356c2c2/src/blockchain/adapters/cascade-port.ts#L73">src/blockchain/adapters/cascade-port.ts:73</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
+</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#getactionparams" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Action<wbr/>Params</span></a>
+<a href="#invalidatecache" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>invalidate<wbr/>Cache</span></a>
+<a href="#iscachevalid" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Cache<wbr/>Valid</span></a>
+<a href="#requestactiontx" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>request<wbr/>Action<wbr/>Tx</span></a>
+</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructorblockchainactionadapter"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">BlockchainActionAdapter</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">blockchainClient</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/BlockchainClient.html" class="tsd-signature-type tsd-kind-interface">BlockchainClient</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">signerAddress</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/BlockchainActionAdapterOptions.html" class="tsd-signature-type tsd-kind-interface">BlockchainActionAdapterOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">BlockchainActionAdapter</a><a href="#constructorblockchainactionadapter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a new blockchain action adapter.</p>
+</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">blockchainClient</span>: <a href="../interfaces/BlockchainClient.html" class="tsd-signature-type tsd-kind-interface">BlockchainClient</a></span><div class="tsd-comment tsd-typography"><p>The blockchain client to use for queries and transactions</p>
+</div></li><li><span><span class="tsd-kind-parameter">signerAddress</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Address of the account that will sign transactions</p>
+</div></li><li><span><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/BlockchainActionAdapterOptions.html" class="tsd-signature-type tsd-kind-interface">BlockchainActionAdapterOptions</a><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>Configuration options</p>
+</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">BlockchainActionAdapter</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/LumeraProtocol/sdk-js/blob/5af750cf0bb28561d99b5e911d3ea93d4356c2c2/src/blockchain/adapters/cascade-port.ts#L87">src/blockchain/adapters/cascade-port.ts:87</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getactionparams"><span>get<wbr/>Action<wbr/>Params</span><a href="#getactionparams" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getactionparams-1"><span class="tsd-kind-call-signature">getActionParams</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">&lt;</span><a href="../interfaces/CascadeActionParams.html" class="tsd-signature-type tsd-kind-interface">CascadeActionParams</a><span class="tsd-signature-symbol">&gt;</span><a href="#getactionparams-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get action module parameters with TTL caching and single-flight protection.</p>
+<p>This method caches the action parameters for the configured TTL to avoid
+repeated LCD queries. If multiple calls are made before the first completes,
+they will all wait for and share the same underlying fetch promise (single-flight).</p>
+</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/CascadeActionParams.html" class="tsd-signature-type tsd-kind-interface">CascadeActionParams</a><span class="tsd-signature-symbol">&gt;</span></h4><p>Action parameters including max_raptor_q_symbols</p>
+<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws">Throws<a href="#throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If the query fails</p>
+</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/CascadeChainPort.html">CascadeChainPort</a>.<a href="../interfaces/CascadeChainPort.html#getactionparams">getActionParams</a></p><ul><li>Defined in <a href="https://github.com/LumeraProtocol/sdk-js/blob/5af750cf0bb28561d99b5e911d3ea93d4356c2c2/src/blockchain/adapters/cascade-port.ts#L107">src/blockchain/adapters/cascade-port.ts:107</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="invalidatecache"><span>invalidate<wbr/>Cache</span><a href="#invalidatecache" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="invalidatecache-1"><span class="tsd-kind-call-signature">invalidateCache</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#invalidatecache-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Invalidate the cached action parameters.</p>
+<p>Forces the next call to getActionParams() to fetch fresh data from the blockchain.
+Useful if you know the parameters have changed on-chain.</p>
+</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/LumeraProtocol/sdk-js/blob/5af750cf0bb28561d99b5e911d3ea93d4356c2c2/src/blockchain/adapters/cascade-port.ts#L303">src/blockchain/adapters/cascade-port.ts:303</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="iscachevalid"><span>is<wbr/>Cache<wbr/>Valid</span><a href="#iscachevalid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="iscachevalid-1"><span class="tsd-kind-call-signature">isCacheValid</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#iscachevalid-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Check if the cache is currently valid.</p>
+</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>true if cached params exist and haven't expired, false otherwise</p>
+<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/LumeraProtocol/sdk-js/blob/5af750cf0bb28561d99b5e911d3ea93d4356c2c2/src/blockchain/adapters/cascade-port.ts#L312">src/blockchain/adapters/cascade-port.ts:312</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="requestactiontx"><span>request<wbr/>Action<wbr/>Tx</span><a href="#requestactiontx" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="requestactiontx-1"><span class="tsd-kind-call-signature">requestActionTx</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/RequestActionTxInput.html" class="tsd-signature-type tsd-kind-interface">RequestActionTxInput</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">fileSize</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/TxOutcome.html" class="tsd-signature-type tsd-kind-interface">TxOutcome</a><span class="tsd-signature-symbol">&gt;</span><a href="#requestactiontx-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Request an action transaction (single-call: simulate → sign → broadcast).</p>
+<p>This method orchestrates the complete transaction flow:</p>
+<ol>
+<li>Fetches the action fee from the blockchain based on file size</li>
+<li>Builds the RequestAction message with the provided payload</li>
+<li>Simulates the transaction to get the exact gas required</li>
+<li>Calculates the fee based on simulated gas and gas price</li>
+<li>Signs the transaction</li>
+<li>Broadcasts the transaction</li>
+<li>Returns the transaction outcome</li>
+</ol>
+</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">input</span>: <a href="../interfaces/RequestActionTxInput.html" class="tsd-signature-type tsd-kind-interface">RequestActionTxInput</a></span><div class="tsd-comment tsd-typography"><p>Transaction input parameters</p>
+</div></li><li><span><span class="tsd-kind-parameter">fileSize</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Size of the file in bytes</p>
+</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/TxOutcome.html" class="tsd-signature-type tsd-kind-interface">TxOutcome</a><span class="tsd-signature-symbol">&gt;</span></h4><p>Transaction outcome with hash, height, code, gas, and fee</p>
+<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-1">Throws<a href="#throws-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If any step fails (simulation, signing, or broadcast)</p>
+</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-1">Example<a href="#example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="typescript"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">outcome</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">adapter</span><span class="hl-1">.</span><span class="hl-0">requestActionTx</span><span class="hl-1">({</span><br/><span class="hl-1">  </span><span class="hl-4">actionId:</span><span class="hl-1"> </span><span class="hl-2">&#39;cascade-123&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-4">msg:</span><span class="hl-1"> {</span><br/><span class="hl-1">    </span><span class="hl-4">data_hash:</span><span class="hl-1"> </span><span class="hl-2">&#39;abc...&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">    </span><span class="hl-4">file_name:</span><span class="hl-1"> </span><span class="hl-2">&#39;example.txt&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">    </span><span class="hl-4">rq_ids_ic:</span><span class="hl-1"> </span><span class="hl-9">100</span><span class="hl-1">,</span><br/><span class="hl-1">    </span><span class="hl-4">signatures:</span><span class="hl-1"> </span><span class="hl-2">&#39;sig...&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">    </span><span class="hl-4">public:</span><span class="hl-1"> </span><span class="hl-6">false</span><br/><span class="hl-1">  }</span><br/><span class="hl-1">}, </span><span class="hl-9">1024000</span><span class="hl-1">); </span><span class="hl-5">// 1MB file</span><br/><br/><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">`TX </span><span class="hl-6">${</span><span class="hl-4">outcome</span><span class="hl-8">.</span><span class="hl-4">txHash</span><span class="hl-6">}</span><span class="hl-2"> succeeded with code </span><span class="hl-6">${</span><span class="hl-4">outcome</span><span class="hl-8">.</span><span class="hl-4">code</span><span class="hl-6">}</span><span class="hl-2">`</span><span class="hl-1">);</span>
+</code><button type="button">Copy</button></pre>
+</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/CascadeChainPort.html">CascadeChainPort</a>.<a href="../interfaces/CascadeChainPort.html#requestactiontx">requestActionTx</a></p><ul><li>Defined in <a href="https://github.com/LumeraProtocol/sdk-js/blob/5af750cf0bb28561d99b5e911d3ea93d4356c2c2/src/blockchain/adapters/cascade-port.ts#L195">src/blockchain/adapters/cascade-port.ts:195</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#getactionparams"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Action<wbr/>Params</span></a><a href="#invalidatecache"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>invalidate<wbr/>Cache</span></a><a href="#iscachevalid"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Cache<wbr/>Valid</span></a><a href="#requestactiontx"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>request<wbr/>Action<wbr/>Tx</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@lumera/sdk-js</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

package/docs/api/classes/CascadeDownloader.html ADDED Viewed

@@ -0,0 +1,55 @@
+<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CascadeDownloader | @lumera/sdk-js</title><meta name="description" content="Documentation for @lumera/sdk-js"/><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 defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@lumera/sdk-js</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">CascadeDownloader</a></li></ul><h1>Class CascadeDownloader</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>CascadeDownloader manages the complete file download workflow.</p>
+<p>This class integrates the SNApiClient and TaskManager to provide
+a simple, high-level API for downloading files from Cascade. It handles:</p>
+<ul>
+<li>Download authentication for private files</li>
+<li>Download task initiation</li>
+<li>Task status monitoring until file is ready</li>
+<li>File stream retrieval</li>
+</ul>
+</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks">Remarks<a href="#remarks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The current implementation uses a simulated signature for <code>download_auth</code>.
+In production, this should be replaced with a real wallet signature over
+the action ID using ADR-036 signArbitrary for private downloads.</p>
+</div></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/LumeraProtocol/sdk-js/blob/5af750cf0bb28561d99b5e911d3ea93d4356c2c2/src/cascade/downloader.ts#L74">src/cascade/downloader.ts:74</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
+</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#download" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>download</span></a>
+<a href="#downloadfile" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>download<wbr/>File</span></a>
+<a href="#downloadprivate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>download<wbr/>Private</span></a>
+</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructorcascadedownloader"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">CascadeDownloader</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">client</span><span class="tsd-signature-symbol">:</span> <a href="SNApiClient.html" class="tsd-signature-type tsd-kind-class">SNApiClient</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">signerAddress</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">signer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">UniversalSigner</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">chainId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">CascadeDownloader</a><a href="#constructorcascadedownloader" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a new CascadeDownloader instance</p>
+</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">client</span>: <a href="SNApiClient.html" class="tsd-signature-type tsd-kind-class">SNApiClient</a></span><div class="tsd-comment tsd-typography"><p>SNApiClient for making sn-api requests</p>
+</div></li><li><span><span class="tsd-kind-parameter">signerAddress</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Bech32 address of the signer</p>
+</div></li><li><span><span class="tsd-kind-parameter">signer</span>: <span class="tsd-signature-type">UniversalSigner</span></span><div class="tsd-comment tsd-typography"><p>Universal signer for signing operations</p>
+</div></li><li><span><span class="tsd-kind-parameter">chainId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Chain ID for signing operations</p>
+</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">CascadeDownloader</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/LumeraProtocol/sdk-js/blob/5af750cf0bb28561d99b5e911d3ea93d4356c2c2/src/cascade/downloader.ts#L83">src/cascade/downloader.ts:83</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="download"><span>download</span><a href="#download" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="download-1"><span class="tsd-kind-call-signature">download</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">actionId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">taskOptions</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/TaskManagerOptions.html" class="tsd-signature-type tsd-kind-interface">TaskManagerOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ReadableStream</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><a href="#download-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Convenience method to download a file by action ID</p>
+<p>This is a shorthand for calling downloadFile with just an action ID.
+Defaults to public download (no authentication).</p>
+</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">actionId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The blockchain action ID to download</p>
+</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">taskOptions</span>: <a href="../interfaces/TaskManagerOptions.html" class="tsd-signature-type tsd-kind-interface">TaskManagerOptions</a></span><div class="tsd-comment tsd-typography"><p>Optional task monitoring configuration</p>
+</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ReadableStream</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><p>Promise resolving to a ReadableStream of the file data</p>
+<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="typescript"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">downloader</span><span class="hl-1"> = </span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-0">CascadeDownloader</span><span class="hl-1">(</span><span class="hl-4">snapiClient</span><span class="hl-1">);</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">stream</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">downloader</span><span class="hl-1">.</span><span class="hl-0">download</span><span class="hl-1">(</span><span class="hl-2">&#39;action-123&#39;</span><span class="hl-1">);</span>
+</code><button type="button">Copy</button></pre>
+</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/LumeraProtocol/sdk-js/blob/5af750cf0bb28561d99b5e911d3ea93d4356c2c2/src/cascade/downloader.ts#L192">src/cascade/downloader.ts:192</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="downloadfile"><span>download<wbr/>File</span><a href="#downloadfile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="downloadfile-1"><span class="tsd-kind-call-signature">downloadFile</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/DownloadParams.html" class="tsd-signature-type tsd-kind-interface">DownloadParams</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">&lt;</span><span class="tsd-signature-type">ReadableStream</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><a href="#downloadfile-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Download a file from Cascade storage</p>
+<p>This method orchestrates the complete download workflow:</p>
+<ol>
+<li>Prepares the download_auth signature (for private downloads)</li>
+<li>Initiates a download task via sn-api</li>
+<li>Monitors the task using SSE until the file is ready</li>
+<li>Retrieves and returns the file as a ReadableStream</li>
+</ol>
+<p>The returned stream can be processed incrementally, making it suitable
+for large files without loading them entirely into memory.</p>
+</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">params</span>: <a href="../interfaces/DownloadParams.html" class="tsd-signature-type tsd-kind-interface">DownloadParams</a></span><div class="tsd-comment tsd-typography"><p>Download parameters including action ID and options</p>
+</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ReadableStream</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><p>Promise resolving to a ReadableStream of the file data</p>
+<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws">Throws<a href="#throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If any step of the download workflow fails</p>
+</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-1">Example<a href="#example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="typescript"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">downloader</span><span class="hl-1"> = </span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-0">CascadeDownloader</span><span class="hl-1">(</span><span class="hl-4">snapiClient</span><span class="hl-1">, </span><span class="hl-4">signerAddress</span><span class="hl-1">, </span><span class="hl-4">signer</span><span class="hl-1">, </span><span class="hl-4">chainId</span><span class="hl-1">);</span><br/><br/><span class="hl-5">// Download a public file</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">stream</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">downloader</span><span class="hl-1">.</span><span class="hl-0">downloadFile</span><span class="hl-1">({</span><br/><span class="hl-1">  </span><span class="hl-4">actionId:</span><span class="hl-1"> </span><span class="hl-2">&#39;action-123&#39;</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-5">// Download a private file (requires authentication)</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">privateStream</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">downloader</span><span class="hl-1">.</span><span class="hl-0">downloadFile</span><span class="hl-1">({</span><br/><span class="hl-1">  </span><span class="hl-4">actionId:</span><span class="hl-1"> </span><span class="hl-2">&#39;action-456&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-4">isPrivate:</span><span class="hl-1"> </span><span class="hl-6">true</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-4">taskOptions:</span><span class="hl-1"> {</span><br/><span class="hl-1">    </span><span class="hl-4">pollInterval:</span><span class="hl-1"> </span><span class="hl-9">2000</span><span class="hl-1">,</span><br/><span class="hl-1">    </span><span class="hl-4">timeout:</span><span class="hl-1"> </span><span class="hl-9">300000</span><br/><span class="hl-1">  }</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-5">// Process the stream</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">reader</span><span class="hl-1"> = </span><span class="hl-4">stream</span><span class="hl-1">.</span><span class="hl-0">getReader</span><span class="hl-1">();</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">chunks</span><span class="hl-1">: </span><span class="hl-10">Uint8Array</span><span class="hl-1">[] = [];</span><br/><br/><span class="hl-3">while</span><span class="hl-1"> (</span><span class="hl-6">true</span><span class="hl-1">) {</span><br/><span class="hl-1">  </span><span class="hl-6">const</span><span class="hl-1"> { </span><span class="hl-7">done</span><span class="hl-1">, </span><span class="hl-7">value</span><span class="hl-1"> } = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">reader</span><span class="hl-1">.</span><span class="hl-0">read</span><span class="hl-1">();</span><br/><span class="hl-1">  </span><span class="hl-3">if</span><span class="hl-1"> (</span><span class="hl-4">done</span><span class="hl-1">) </span><span class="hl-3">break</span><span class="hl-1">;</span><br/><span class="hl-1">  </span><span class="hl-4">chunks</span><span class="hl-1">.</span><span class="hl-0">push</span><span class="hl-1">(</span><span class="hl-4">value</span><span class="hl-1">);</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-5">// Combine chunks into a single Uint8Array</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">totalLength</span><span class="hl-1"> = </span><span class="hl-4">chunks</span><span class="hl-1">.</span><span class="hl-0">reduce</span><span class="hl-1">((</span><span class="hl-4">acc</span><span class="hl-1">, </span><span class="hl-4">chunk</span><span class="hl-1">) </span><span class="hl-6">=&gt;</span><span class="hl-1"> </span><span class="hl-4">acc</span><span class="hl-1"> + </span><span class="hl-4">chunk</span><span class="hl-1">.</span><span class="hl-4">length</span><span class="hl-1">, </span><span class="hl-9">0</span><span class="hl-1">);</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">fileData</span><span class="hl-1"> = </span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-0">Uint8Array</span><span class="hl-1">(</span><span class="hl-4">totalLength</span><span class="hl-1">);</span><br/><span class="hl-6">let</span><span class="hl-1"> </span><span class="hl-4">offset</span><span class="hl-1"> = </span><span class="hl-9">0</span><span class="hl-1">;</span><br/><span class="hl-3">for</span><span class="hl-1"> (</span><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">chunk</span><span class="hl-1"> </span><span class="hl-6">of</span><span class="hl-1"> </span><span class="hl-4">chunks</span><span class="hl-1">) {</span><br/><span class="hl-1">  </span><span class="hl-4">fileData</span><span class="hl-1">.</span><span class="hl-0">set</span><span class="hl-1">(</span><span class="hl-4">chunk</span><span class="hl-1">, </span><span class="hl-4">offset</span><span class="hl-1">);</span><br/><span class="hl-1">  </span><span class="hl-4">offset</span><span class="hl-1"> += </span><span class="hl-4">chunk</span><span class="hl-1">.</span><span class="hl-4">length</span><span class="hl-1">;</span><br/><span class="hl-1">}</span>
+</code><button type="button">Copy</button></pre>
+</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/LumeraProtocol/sdk-js/blob/5af750cf0bb28561d99b5e911d3ea93d4356c2c2/src/cascade/downloader.ts#L146">src/cascade/downloader.ts:146</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="downloadprivate"><span>download<wbr/>Private</span><a href="#downloadprivate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="downloadprivate-1"><span class="tsd-kind-call-signature">downloadPrivate</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">actionId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">taskOptions</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/TaskManagerOptions.html" class="tsd-signature-type tsd-kind-interface">TaskManagerOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ReadableStream</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><a href="#downloadprivate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Convenience method to download a private file</p>
+<p>This is a shorthand for downloading a file that requires authentication.</p>
+</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">actionId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The blockchain action ID to download</p>
+</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">taskOptions</span>: <a href="../interfaces/TaskManagerOptions.html" class="tsd-signature-type tsd-kind-interface">TaskManagerOptions</a></span><div class="tsd-comment tsd-typography"><p>Optional task monitoring configuration</p>
+</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ReadableStream</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><p>Promise resolving to a ReadableStream of the file data</p>
+<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-2">Example<a href="#example-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="typescript"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">downloader</span><span class="hl-1"> = </span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-0">CascadeDownloader</span><span class="hl-1">(</span><span class="hl-4">snapiClient</span><span class="hl-1">);</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">stream</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">downloader</span><span class="hl-1">.</span><span class="hl-0">downloadPrivate</span><span class="hl-1">(</span><span class="hl-2">&#39;action-456&#39;</span><span class="hl-1">);</span>
+</code><button type="button">Copy</button></pre>
+</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/LumeraProtocol/sdk-js/blob/5af750cf0bb28561d99b5e911d3ea93d4356c2c2/src/cascade/downloader.ts#L218">src/cascade/downloader.ts:218</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#download"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>download</span></a><a href="#downloadfile"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>download<wbr/>File</span></a><a href="#downloadprivate"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>download<wbr/>Private</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@lumera/sdk-js</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

package/docs/api/classes/CascadeUploader.html ADDED Viewed

@@ -0,0 +1,41 @@
+<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CascadeUploader | @lumera/sdk-js</title><meta name="description" content="Documentation for @lumera/sdk-js"/><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 defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@lumera/sdk-js</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">CascadeUploader</a></li></ul><h1>Class CascadeUploader</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>CascadeUploader manages the complete file upload workflow.</p>
+<p>This class integrates all components of the storage layer to provide
+a simple, high-level API for uploading files to Cascade. It handles:</p>
+<ul>
+<li>File hashing and integrity verification</li>
+<li>RaptorQ layout generation</li>
+<li>LEP-1 compliant index file construction</li>
+<li>Upload task initiation and monitoring</li>
+</ul>
+</div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/LumeraProtocol/sdk-js/blob/5af750cf0bb28561d99b5e911d3ea93d4356c2c2/src/cascade/uploader.ts#L108">src/cascade/uploader.ts:108</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
+</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#uploadfile" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>upload<wbr/>File</span></a>
+</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructorcascadeuploader"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">CascadeUploader</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">client</span><span class="tsd-signature-symbol">:</span> <a href="SNApiClient.html" class="tsd-signature-type tsd-kind-class">SNApiClient</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">chainPort</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/CascadeChainPort.html" class="tsd-signature-type tsd-kind-interface">CascadeChainPort</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">signerAddress</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">signer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">UniversalSigner</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">chainId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/CascadeUploaderOptions.html" class="tsd-signature-type tsd-kind-interface">CascadeUploaderOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">CascadeUploader</a><a href="#constructorcascadeuploader" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a new CascadeUploader instance</p>
+</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">client</span>: <a href="SNApiClient.html" class="tsd-signature-type tsd-kind-class">SNApiClient</a></span><div class="tsd-comment tsd-typography"><p>SNApiClient for making sn-api requests</p>
+</div></li><li><span><span class="tsd-kind-parameter">chainPort</span>: <a href="../interfaces/CascadeChainPort.html" class="tsd-signature-type tsd-kind-interface">CascadeChainPort</a></span><div class="tsd-comment tsd-typography"><p>Port for accessing blockchain capabilities</p>
+</div></li><li><span><span class="tsd-kind-parameter">signerAddress</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Bech32 address of the signer</p>
+</div></li><li><span><span class="tsd-kind-parameter">signer</span>: <span class="tsd-signature-type">UniversalSigner</span></span><div class="tsd-comment tsd-typography"><p>Universal signer for signing operations</p>
+</div></li><li><span><span class="tsd-kind-parameter">chainId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Chain ID for signing operations</p>
+</div></li><li><span><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/CascadeUploaderOptions.html" class="tsd-signature-type tsd-kind-interface">CascadeUploaderOptions</a><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>Optional configuration</p>
+</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">CascadeUploader</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/LumeraProtocol/sdk-js/blob/5af750cf0bb28561d99b5e911d3ea93d4356c2c2/src/cascade/uploader.ts#L120">src/cascade/uploader.ts:120</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="uploadfile"><span>upload<wbr/>File</span><a href="#uploadfile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="uploadfile-1"><span class="tsd-kind-call-signature">uploadFile</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">file</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ArrayBuffer</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ArrayBufferLike</span><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Blob</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/UploadParams.html" class="tsd-signature-type tsd-kind-interface">UploadParams</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">progress</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">taskId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span><a href="#uploadfile-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Upload a file to Cascade storage</p>
+<p>This method orchestrates the complete upload workflow:</p>
+<ol>
+<li>Fetches action parameters from the blockchain (max_raptor_q_symbols)</li>
+<li>Generates a random initial counter (rq_ids_ic) for layout ID derivation</li>
+<li>Converts the file to bytes and calculates data_hash (BLAKE3)</li>
+<li>Generates a single-block RaptorQ layout using rq-wasm</li>
+<li>Derives layout IDs per LEP-1 specification</li>
+<li>Constructs the index file with layout metadata</li>
+<li>Registers the action on-chain via single-call transaction flow</li>
+<li>Signs hash of file bytes to create start_signature</li>
+<li>Initiates upload via sn-api with multipart form data</li>
+<li>Monitors the upload task until completion</li>
+<li>Returns the completed task details</li>
+</ol>
+</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">file</span>: <span class="tsd-signature-type">ArrayBuffer</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ArrayBufferLike</span><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Blob</span></span><div class="tsd-comment tsd-typography"><p>The file to upload (as Blob, ArrayBuffer, or Uint8Array)</p>
+</div></li><li><span><span class="tsd-kind-parameter">params</span>: <a href="../interfaces/UploadParams.html" class="tsd-signature-type tsd-kind-interface">UploadParams</a></span><div class="tsd-comment tsd-typography"><p>Upload parameters including action ID</p>
+</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">progress</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">taskId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span></h4><p>Promise resolving to the completed upload task</p>
+<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws">Throws<a href="#throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If any step of the upload workflow fails</p>
+</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="typescript"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">uploader</span><span class="hl-1"> = </span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-0">CascadeUploader</span><span class="hl-1">(</span><span class="hl-4">snapiClient</span><span class="hl-1">, </span><span class="hl-4">chainPort</span><span class="hl-1">);</span><br/><br/><span class="hl-5">// Upload from a file input</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">fileInput</span><span class="hl-1"> = </span><span class="hl-4">document</span><span class="hl-1">.</span><span class="hl-0">querySelector</span><span class="hl-1">(</span><span class="hl-2">&#39;input[type=&quot;file&quot;]&#39;</span><span class="hl-1">);</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">file</span><span class="hl-1"> = </span><span class="hl-4">fileInput</span><span class="hl-1">.</span><span class="hl-4">files</span><span class="hl-1">[</span><span class="hl-9">0</span><span class="hl-1">];</span><br/><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">result</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">uploader</span><span class="hl-1">.</span><span class="hl-0">uploadFile</span><span class="hl-1">(</span><span class="hl-4">file</span><span class="hl-1">, {</span><br/><span class="hl-1">  </span><span class="hl-4">actionId:</span><span class="hl-1"> </span><span class="hl-2">&#39;action-123&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-4">taskOptions:</span><span class="hl-1"> {</span><br/><span class="hl-1">    </span><span class="hl-4">pollInterval:</span><span class="hl-1"> </span><span class="hl-9">2000</span><span class="hl-1">,</span><br/><span class="hl-1">    </span><span class="hl-4">timeout:</span><span class="hl-1"> </span><span class="hl-9">300000</span><br/><span class="hl-1">  }</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">&#39;Upload complete:&#39;</span><span class="hl-1">, </span><span class="hl-4">result</span><span class="hl-1">);</span>
+</code><button type="button">Copy</button></pre>
+</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/LumeraProtocol/sdk-js/blob/5af750cf0bb28561d99b5e911d3ea93d4356c2c2/src/cascade/uploader.ts#L170">src/cascade/uploader.ts:170</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#uploadfile"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>upload<wbr/>File</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@lumera/sdk-js</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

package/docs/api/classes/CosmjsRpcBlockchainClient.html ADDED Viewed

@@ -0,0 +1,24 @@
+<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CosmjsRpcBlockchainClient | @lumera/sdk-js</title><meta name="description" content="Documentation for @lumera/sdk-js"/><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 defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@lumera/sdk-js</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">CosmjsRpcBlockchainClient</a></li></ul><h1>Class CosmjsRpcBlockchainClient</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Implementation of BlockchainClient using CosmJS for transactions and RPC for queries.</p>
+<p>This class provides a complete RPC-based blockchain interaction interface, using
+CosmJS for transaction signing and broadcasting, and Telescope-generated RPC clients
+for type-safe module queries. It serves as the facade for all blockchain operations.</p>
+</div></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/BlockchainClient.html" class="tsd-signature-type tsd-kind-interface">BlockchainClient</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/LumeraProtocol/sdk-js/blob/5af750cf0bb28561d99b5e911d3ea93d4356c2c2/src/blockchain/client.ts#L164">src/blockchain/client.ts:164</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
+</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#action" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Action</span></a>
+<a href="#supernode" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Supernode</span></a>
+<a href="#tx" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Tx</span></a>
+</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#getaddress" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Address</span></a>
+<a href="#getchainid" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Chain<wbr/>Id</span></a>
+</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructorcosmjsrpcblockchainclient"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">CosmjsRpcBlockchainClient</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">Tx</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/TxClient.html" class="tsd-signature-type tsd-kind-interface">TxClient</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">Action</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/ActionQuery.html" class="tsd-signature-type tsd-kind-interface">ActionQuery</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">Supernode</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/SupernodeQuery.html" class="tsd-signature-type tsd-kind-interface">SupernodeQuery</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">chainId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">bech32Address</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">CosmjsRpcBlockchainClient</a><a href="#constructorcosmjsrpcblockchainclient" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a new blockchain client instance.</p>
+</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">Tx</span>: <a href="../interfaces/TxClient.html" class="tsd-signature-type tsd-kind-interface">TxClient</a></span><div class="tsd-comment tsd-typography"><p>Transaction client for signing and broadcasting</p>
+</div></li><li><span><span class="tsd-kind-parameter">Action</span>: <a href="../interfaces/ActionQuery.html" class="tsd-signature-type tsd-kind-interface">ActionQuery</a></span><div class="tsd-comment tsd-typography"><p>Action module query client</p>
+</div></li><li><span><span class="tsd-kind-parameter">Supernode</span>: <a href="../interfaces/SupernodeQuery.html" class="tsd-signature-type tsd-kind-interface">SupernodeQuery</a></span><div class="tsd-comment tsd-typography"><p>Supernode module query client</p>
+</div></li><li><span><span class="tsd-kind-parameter">chainId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Blockchain network identifier</p>
+</div></li><li><span><span class="tsd-kind-parameter">bech32Address</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Signer's bech32 address</p>
+</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">CosmjsRpcBlockchainClient</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/LumeraProtocol/sdk-js/blob/5af750cf0bb28561d99b5e911d3ea93d4356c2c2/src/blockchain/client.ts#L174">src/blockchain/client.ts:174</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="action"><code class="tsd-tag">Readonly</code><span>Action</span><a href="#action" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">Action</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/ActionQuery.html" class="tsd-signature-type tsd-kind-interface">ActionQuery</a></div><div class="tsd-comment tsd-typography"><p>Action module query client</p>
+</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/BlockchainClient.html">BlockchainClient</a>.<a href="../interfaces/BlockchainClient.html#action">Action</a></p><ul><li>Defined in <a href="https://github.com/LumeraProtocol/sdk-js/blob/5af750cf0bb28561d99b5e911d3ea93d4356c2c2/src/blockchain/client.ts#L176">src/blockchain/client.ts:176</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="supernode"><code class="tsd-tag">Readonly</code><span>Supernode</span><a href="#supernode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">Supernode</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/SupernodeQuery.html" class="tsd-signature-type tsd-kind-interface">SupernodeQuery</a></div><div class="tsd-comment tsd-typography"><p>Supernode module query client</p>
+</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/BlockchainClient.html">BlockchainClient</a>.<a href="../interfaces/BlockchainClient.html#supernode">Supernode</a></p><ul><li>Defined in <a href="https://github.com/LumeraProtocol/sdk-js/blob/5af750cf0bb28561d99b5e911d3ea93d4356c2c2/src/blockchain/client.ts#L177">src/blockchain/client.ts:177</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="tx"><code class="tsd-tag">Readonly</code><span>Tx</span><a href="#tx" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">Tx</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/TxClient.html" class="tsd-signature-type tsd-kind-interface">TxClient</a></div><div class="tsd-comment tsd-typography"><p>Transaction client for signing and broadcasting</p>
+</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/BlockchainClient.html">BlockchainClient</a>.<a href="../interfaces/BlockchainClient.html#tx">Tx</a></p><ul><li>Defined in <a href="https://github.com/LumeraProtocol/sdk-js/blob/5af750cf0bb28561d99b5e911d3ea93d4356c2c2/src/blockchain/client.ts#L175">src/blockchain/client.ts:175</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getaddress"><span>get<wbr/>Address</span><a href="#getaddress" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getaddress-1"><span class="tsd-kind-call-signature">getAddress</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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#getaddress-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the signer's address.</p>
+</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>Bech32 address of the account associated with this client</p>
+<aside class="tsd-sources"><p>Implementation of <a href="../interfaces/BlockchainClient.html">BlockchainClient</a>.<a href="../interfaces/BlockchainClient.html#getaddress">getAddress</a></p><ul><li>Defined in <a href="https://github.com/LumeraProtocol/sdk-js/blob/5af750cf0bb28561d99b5e911d3ea93d4356c2c2/src/blockchain/client.ts#L196">src/blockchain/client.ts:196</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getchainid"><span>get<wbr/>Chain<wbr/>Id</span><a href="#getchainid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getchainid-1"><span class="tsd-kind-call-signature">getChainId</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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#getchainid-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the chain ID.</p>
+</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>Chain ID (e.g., &quot;lumera-testnet-2&quot;)</p>
+<aside class="tsd-sources"><p>Implementation of <a href="../interfaces/BlockchainClient.html">BlockchainClient</a>.<a href="../interfaces/BlockchainClient.html#getchainid">getChainId</a></p><ul><li>Defined in <a href="https://github.com/LumeraProtocol/sdk-js/blob/5af750cf0bb28561d99b5e911d3ea93d4356c2c2/src/blockchain/client.ts#L187">src/blockchain/client.ts:187</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#action"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Action</span></a><a href="#supernode"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Supernode</span></a><a href="#tx"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Tx</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#getaddress"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Address</span></a><a href="#getchainid"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Chain<wbr/>Id</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@lumera/sdk-js</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>