-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathindex.html
More file actions
103 lines (92 loc) · 35.7 KB
/
index.html
File metadata and controls
103 lines (92 loc) · 35.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
<!DOCTYPE html><html class="default" lang="en" data-base="./"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@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"><h1>@lumera/sdk-js</h1></div><div class="tsd-panel tsd-typography"><h1 id="lumerasdk-js" class="tsd-anchor-link">@lumera/sdk-js<a href="#lumerasdk-js" 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></h1><p><strong>Official JavaScript/TypeScript SDK for Lumera Protocol</strong></p>
<p>A unified SDK providing seamless access to the Lumera blockchain and Cascade distributed storage network. Built with modern TypeScript, featuring comprehensive type safety, and designed for both Node.js and browser environments.</p>
<h2 id="✨-features" class="tsd-anchor-link">✨ Features<a href="#✨-features" 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></h2><ul>
<li><strong>🔗 Unified Client Interface</strong> - Single entry point for all Lumera operations</li>
<li><strong>⛓️ Blockchain Operations</strong> - Complete CosmJS integration with LCD/REST queries
<ul>
<li>Transaction simulation, signing, and broadcasting</li>
<li>Action module queries and operations</li>
<li>Supernode module queries</li>
<li>Chain parameter queries</li>
</ul>
</li>
<li><strong>📦 Cascade Storage</strong> - Full-featured distributed file storage client
<ul>
<li>Upload/download with progress tracking</li>
<li>Automatic file chunking and Reed-Solomon encoding</li>
<li>Task management with polling and status updates</li>
<li>Stream-based downloads for memory efficiency</li>
</ul>
</li>
<li><strong>🔐 Wallet Integration</strong> - Support for multiple wallet types
<ul>
<li>Keplr wallet integration</li>
<li>Leap wallet integration</li>
<li>Programmatic signing with DirectSecp256k1HdWallet</li>
</ul>
</li>
<li><strong>🎯 Type Safety</strong> - Full TypeScript support with comprehensive types</li>
<li><strong>🌐 Cross-Platform</strong> - Works in Node.js (v18+) and modern browsers</li>
<li><strong>📝 Extensive Documentation</strong> - Complete API reference and examples</li>
</ul>
<h2 id="📦-installation" class="tsd-anchor-link">📦 Installation<a href="#📦-installation" 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></h2><pre><code class="bash"><span class="hl-0">pnpm</span><span class="hl-1"> </span><span class="hl-2">install</span><span class="hl-1"> </span><span class="hl-2">@lumera/sdk</span>
</code><button type="button">Copy</button></pre>
<h3 id="peer-dependencies" class="tsd-anchor-link">Peer Dependencies<a href="#peer-dependencies" 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><p>For blockchain operations, you'll also need CosmJS packages:</p>
<pre><code class="bash"><span class="hl-0">pnpm</span><span class="hl-1"> </span><span class="hl-2">install</span><span class="hl-1"> </span><span class="hl-2">@cosmjs/proto-signing</span><span class="hl-1"> </span><span class="hl-2">@cosmjs/stargate</span>
</code><button type="button">Copy</button></pre>
<h2 id="🚀-quick-start" class="tsd-anchor-link">🚀 Quick Start<a href="#🚀-quick-start" 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></h2><h3 id="1-initialize-the-client" class="tsd-anchor-link">1. Initialize the Client<a href="#1-initialize-the-client" 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><pre><code class="typescript"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">createLumeraClient</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">"@lumera/sdk"</span><span class="hl-1">;</span><br/><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">DirectSecp256k1HdWallet</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">"@cosmjs/proto-signing"</span><span class="hl-1">;</span><br/><br/><span class="hl-5">// Create a wallet</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">wallet</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">DirectSecp256k1HdWallet</span><span class="hl-1">.</span><span class="hl-0">fromMnemonic</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-2">"your mnemonic phrase here"</span><span class="hl-1">,</span><br/><span class="hl-1"> { </span><span class="hl-4">prefix:</span><span class="hl-1"> </span><span class="hl-2">"lumera"</span><span class="hl-1"> }</span><br/><span class="hl-1">);</span><br/><br/><span class="hl-6">const</span><span class="hl-1"> [</span><span class="hl-7">account</span><span class="hl-1">] = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">wallet</span><span class="hl-1">.</span><span class="hl-0">getAccounts</span><span class="hl-1">();</span><br/><br/><span class="hl-5">// Create the client using testnet preset</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">client</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">createLumeraClient</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">preset:</span><span class="hl-1"> </span><span class="hl-2">"testnet"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">signer:</span><span class="hl-1"> </span><span class="hl-4">wallet</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">address:</span><span class="hl-1"> </span><span class="hl-4">account</span><span class="hl-1">.</span><span class="hl-4">address</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">gasPrice:</span><span class="hl-1"> </span><span class="hl-2">"0.025ulume"</span><br/><span class="hl-1">});</span>
</code><button type="button">Copy</button></pre>
<h3 id="2-query-the-blockchain" class="tsd-anchor-link">2. Query the Blockchain<a href="#2-query-the-blockchain" 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><pre><code class="typescript"><span class="hl-5">// Get chain information</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">chainId</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-4">Blockchain</span><span class="hl-1">.</span><span class="hl-0">getChainId</span><span class="hl-1">();</span><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">"Chain ID:"</span><span class="hl-1">, </span><span class="hl-4">chainId</span><span class="hl-1">);</span><br/><br/><span class="hl-5">// Query action module parameters</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">actionParams</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-4">Blockchain</span><span class="hl-1">.</span><span class="hl-4">Action</span><span class="hl-1">.</span><span class="hl-0">getParams</span><span class="hl-1">();</span><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">"Action params:"</span><span class="hl-1">, </span><span class="hl-4">actionParams</span><span class="hl-1">);</span><br/><br/><span class="hl-5">// Query supernode module parameters </span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">supernodeParams</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-4">Blockchain</span><span class="hl-1">.</span><span class="hl-4">Supernode</span><span class="hl-1">.</span><span class="hl-0">getParams</span><span class="hl-1">();</span><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">"Supernode params:"</span><span class="hl-1">, </span><span class="hl-4">supernodeParams</span><span class="hl-1">);</span>
</code><button type="button">Copy</button></pre>
<h3 id="3-upload-a-file-to-cascade" class="tsd-anchor-link">3. Upload a File to Cascade<a href="#3-upload-a-file-to-cascade" 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><pre><code class="typescript"><span class="hl-5">// Prepare your file</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">fileContent</span><span class="hl-1"> = </span><span class="hl-2">"Hello, Lumera!"</span><span class="hl-1">;</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">fileBytes</span><span class="hl-1"> = </span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-0">TextEncoder</span><span class="hl-1">().</span><span class="hl-0">encode</span><span class="hl-1">(</span><span class="hl-4">fileContent</span><span class="hl-1">);</span><br/><br/><span class="hl-5">// Upload to Cascade</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">uploadResult</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-4">Cascade</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">fileBytes</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">`my-file-</span><span class="hl-6">${</span><span class="hl-4">Date</span><span class="hl-8">.</span><span class="hl-0">now</span><span class="hl-8">()</span><span class="hl-6">}</span><span class="hl-2">`</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">1000</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">rq_ids_max:</span><span class="hl-1"> </span><span class="hl-4">actionParams</span><span class="hl-1">.</span><span class="hl-4">rq_ids_max</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><span class="hl-1">,</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">"Upload completed:"</span><span class="hl-1">, </span><span class="hl-4">uploadResult</span><span class="hl-1">);</span>
</code><button type="button">Copy</button></pre>
<h3 id="4-download-a-file-from-cascade" class="tsd-anchor-link">4. Download a File from Cascade<a href="#4-download-a-file-from-cascade" 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><pre><code class="typescript"><span class="hl-5">// Download using the action ID</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">downloadStream</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-4">Cascade</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><br/><span class="hl-1"> </span><span class="hl-4">uploadResult</span><span class="hl-1">.</span><span class="hl-4">actionId</span><br/><span class="hl-1">);</span><br/><br/><span class="hl-5">// Read 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">downloadStream</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</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">=></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">downloadedBytes</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">downloadedBytes</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><br/><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">downloadedContent</span><span class="hl-1"> = </span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-0">TextDecoder</span><span class="hl-1">().</span><span class="hl-0">decode</span><span class="hl-1">(</span><span class="hl-4">downloadedBytes</span><span class="hl-1">);</span><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">"Downloaded:"</span><span class="hl-1">, </span><span class="hl-4">downloadedContent</span><span class="hl-1">);</span>
</code><button type="button">Copy</button></pre>
<h2 id="📚-documentation" class="tsd-anchor-link">📚 Documentation<a href="#📚-documentation" 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></h2><ul>
<li><strong><a href="./docs/api/README.md">API Reference</a></strong> - Complete TypeScript API documentation</li>
<li><strong><a href="./MIGRATION.md">Migration Guide</a></strong> - Migrate from direct fetch/LCD calls to the SDK</li>
<li><strong><a href="media/examples">Examples</a></strong> - Working code examples
<ul>
<li><a href="media/node">Node.js Examples</a> - Full workflow and standalone examples</li>
<li><a href="media/browser">Browser Example</a> - Browser-based upload/download demo</li>
</ul>
</li>
</ul>
<h2 id="🎯-core-concepts" class="tsd-anchor-link">🎯 Core Concepts<a href="#🎯-core-concepts" 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></h2><h3 id="chain-presets" class="tsd-anchor-link">Chain Presets<a href="#chain-presets" 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><p>The SDK includes built-in presets for quick setup:</p>
<pre><code class="typescript"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">client</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">createLumeraClient</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">preset:</span><span class="hl-1"> </span><span class="hl-2">"testnet"</span><span class="hl-1">, </span><span class="hl-5">// or "mainnet"</span><br/><span class="hl-1"> </span><span class="hl-4">signer:</span><span class="hl-1"> </span><span class="hl-4">wallet</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">address:</span><span class="hl-1"> </span><span class="hl-4">account</span><span class="hl-1">.</span><span class="hl-4">address</span><span class="hl-1">,</span><br/><span class="hl-1">});</span>
</code><button type="button">Copy</button></pre>
<p>Available presets:</p>
<ul>
<li><code>testnet</code> - Lumera testnet configuration</li>
<li><code>mainnet</code> - Lumera mainnet configuration</li>
</ul>
<h3 id="manual-configuration" class="tsd-anchor-link">Manual Configuration<a href="#manual-configuration" 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><p>For custom chains or advanced setups:</p>
<pre><code class="typescript"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">client</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">createLumeraClient</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">rpcUrl:</span><span class="hl-1"> </span><span class="hl-2">"https://your-rpc-url.com"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">lcdUrl:</span><span class="hl-1"> </span><span class="hl-2">"https://your-lcd-url.com"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">chainId:</span><span class="hl-1"> </span><span class="hl-2">"your-chain-id"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">signer:</span><span class="hl-1"> </span><span class="hl-4">wallet</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">address:</span><span class="hl-1"> </span><span class="hl-4">account</span><span class="hl-1">.</span><span class="hl-4">address</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">gasPrice:</span><span class="hl-1"> </span><span class="hl-2">"0.025ulume"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">cascade:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">snapiBaseUrl:</span><span class="hl-1"> </span><span class="hl-2">"https://your-snapi-url.com"</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">});</span>
</code><button type="button">Copy</button></pre>
<h3 id="blockchain-client" class="tsd-anchor-link">Blockchain Client<a href="#blockchain-client" 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><p>Direct access to blockchain operations:</p>
<pre><code class="typescript"><span class="hl-5">// Transaction operations</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">msgs</span><span class="hl-1"> = [...]; </span><span class="hl-5">// Your messages</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">gas</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-4">Blockchain</span><span class="hl-1">.</span><span class="hl-4">Tx</span><span class="hl-1">.</span><span class="hl-0">simulate</span><span class="hl-1">(</span><span class="hl-4">address</span><span class="hl-1">, </span><span class="hl-4">msgs</span><span class="hl-1">);</span><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">client</span><span class="hl-1">.</span><span class="hl-4">Blockchain</span><span class="hl-1">.</span><span class="hl-4">Tx</span><span class="hl-1">.</span><span class="hl-0">broadcast</span><span class="hl-1">(</span><span class="hl-4">signedTx</span><span class="hl-1">);</span><br/><br/><span class="hl-5">// Query operations</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">actionList</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-4">Blockchain</span><span class="hl-1">.</span><span class="hl-4">Action</span><span class="hl-1">.</span><span class="hl-0">listActions</span><span class="hl-1">();</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">supernodeList</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-4">Blockchain</span><span class="hl-1">.</span><span class="hl-4">Supernode</span><span class="hl-1">.</span><span class="hl-0">listAll</span><span class="hl-1">();</span>
</code><button type="button">Copy</button></pre>
<h3 id="cascade-client" class="tsd-anchor-link">Cascade Client<a href="#cascade-client" 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><p>File storage operations:</p>
<pre><code class="typescript"><span class="hl-5">// Upload with progress tracking</span><br/><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-4">client</span><span class="hl-1">.</span><span class="hl-4">Cascade</span><span class="hl-1">.</span><span class="hl-4">uploader</span><span class="hl-1">;</span><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">fileBytes</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">"my-action"</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">1000</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">rq_ids_max:</span><span class="hl-1"> </span><span class="hl-9">10000</span><span class="hl-1">,</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-5">// Download as stream</span><br/><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-4">client</span><span class="hl-1">.</span><span class="hl-4">Cascade</span><span class="hl-1">.</span><span class="hl-4">downloader</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">"action-id"</span><span class="hl-1">);</span>
</code><button type="button">Copy</button></pre>
<h2 id="🧪-development" class="tsd-anchor-link">🧪 Development<a href="#🧪-development" 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></h2><pre><code class="bash"><span class="hl-5"># Install dependencies</span><br/><span class="hl-0">pnpm</span><span class="hl-1"> </span><span class="hl-2">install</span><br/><br/><span class="hl-5"># Run tests</span><br/><span class="hl-0">pnpm</span><span class="hl-1"> </span><span class="hl-2">test</span><br/><br/><span class="hl-5"># Run tests with coverage</span><br/><span class="hl-0">pnpm</span><span class="hl-1"> </span><span class="hl-2">run</span><span class="hl-1"> </span><span class="hl-2">coverage</span><br/><br/><span class="hl-5"># Build the SDK</span><br/><span class="hl-0">pnpm</span><span class="hl-1"> </span><span class="hl-2">build</span><br/><br/><span class="hl-5"># Generate API documentation</span><br/><span class="hl-0">pnpm</span><span class="hl-1"> </span><span class="hl-2">run</span><span class="hl-1"> </span><span class="hl-2">docs</span><br/><br/><span class="hl-5"># Lint code</span><br/><span class="hl-0">pnpm</span><span class="hl-1"> </span><span class="hl-2">lint</span>
</code><button type="button">Copy</button></pre>
<h2 id="📋-requirements" class="tsd-anchor-link">📋 Requirements<a href="#📋-requirements" 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></h2><ul>
<li>Node.js v18 or higher</li>
<li>TypeScript 5.x (for development)</li>
<li>Modern browser with ES2020+ support (for browser usage)</li>
</ul>
<h2 id="🤝-contributing" class="tsd-anchor-link">🤝 Contributing<a href="#🤝-contributing" 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></h2><p>Contributions are welcome! Please read our contributing guidelines before submitting PRs.</p>
<h2 id="📄-license" class="tsd-anchor-link">📄 License<a href="#📄-license" 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></h2><p>Apache-2.0 - see LICENSE file for details.</p>
<h2 id="🔗-links" class="tsd-anchor-link">🔗 Links<a href="#🔗-links" 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></h2><ul>
<li><a href="https://github.com/LumeraProtocol/sdk-js">GitHub Repository</a></li>
<li><a href="https://lumera.io">Lumera Protocol</a></li>
<li><a href="./docs/api/README.md">Documentation</a></li>
</ul>
<h2 id="💡-support" class="tsd-anchor-link">💡 Support<a href="#💡-support" 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></h2><ul>
<li>For bug reports and feature requests, please open an issue on GitHub</li>
<li>For questions and discussions, join our community channels</li>
</ul>
<hr>
<p><strong>Built with ❤️ by the Lumera Protocol team</strong></p>
</div></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"><a href="#lumerasdk-js"><span>@lumera/sdk-<wbr/>js</span></a><ul><li><a href="#✨-features"><span>✨ <wbr/>Features</span></a></li><li><a href="#📦-installation"><span>📦 <wbr/>Installation</span></a></li><li><ul><li><a href="#peer-dependencies"><span>Peer <wbr/>Dependencies</span></a></li></ul></li><li><a href="#🚀-quick-start"><span>🚀 <wbr/>Quick <wbr/>Start</span></a></li><li><ul><li><a href="#1-initialize-the-client"><span>1. <wbr/>Initialize the <wbr/>Client</span></a></li><li><a href="#2-query-the-blockchain"><span>2. <wbr/>Query the <wbr/>Blockchain</span></a></li><li><a href="#3-upload-a-file-to-cascade"><span>3. <wbr/>Upload a <wbr/>File to <wbr/>Cascade</span></a></li><li><a href="#4-download-a-file-from-cascade"><span>4. <wbr/>Download a <wbr/>File from <wbr/>Cascade</span></a></li></ul></li><li><a href="#📚-documentation"><span>📚 <wbr/>Documentation</span></a></li><li><a href="#🎯-core-concepts"><span>🎯 <wbr/>Core <wbr/>Concepts</span></a></li><li><ul><li><a href="#chain-presets"><span>Chain <wbr/>Presets</span></a></li><li><a href="#manual-configuration"><span>Manual <wbr/>Configuration</span></a></li><li><a href="#blockchain-client"><span>Blockchain <wbr/>Client</span></a></li><li><a href="#cascade-client"><span>Cascade <wbr/>Client</span></a></li></ul></li><li><a href="#🧪-development"><span>🧪 <wbr/>Development</span></a></li><li><a href="#📋-requirements"><span>📋 <wbr/>Requirements</span></a></li><li><a href="#🤝-contributing"><span>🤝 <wbr/>Contributing</span></a></li><li><a href="#📄-license"><span>📄 <wbr/>License</span></a></li><li><a href="#🔗-links"><span>🔗 <wbr/>Links</span></a></li><li><a href="#💡-support"><span>💡 <wbr/>Support</span></a></li></ul></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>