Official JavaScript/TypeScript SDK for Lumera Protocol
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.
pnpm install @lumera/sdk
For blockchain operations, you'll also need CosmJS packages:
pnpm install @cosmjs/proto-signing @cosmjs/stargate
import { createLumeraClient } from "@lumera/sdk";
import { DirectSecp256k1HdWallet } from "@cosmjs/proto-signing";
// Create a wallet
const wallet = await DirectSecp256k1HdWallet.fromMnemonic(
"your mnemonic phrase here",
{ prefix: "lumera" }
);
const [account] = await wallet.getAccounts();
// Create the client using testnet preset
const client = await createLumeraClient({
preset: "testnet",
signer: wallet,
address: account.address,
gasPrice: "0.025ulume"
});
// Get chain information
const chainId = await client.Blockchain.getChainId();
console.log("Chain ID:", chainId);
// Query action module parameters
const actionParams = await client.Blockchain.Action.getParams();
console.log("Action params:", actionParams);
// Query supernode module parameters
const supernodeParams = await client.Blockchain.Supernode.getParams();
console.log("Supernode params:", supernodeParams);
// Prepare your file
const fileContent = "Hello, Lumera!";
const fileBytes = new TextEncoder().encode(fileContent);
// Upload to Cascade
const uploadResult = await client.Cascade.uploader.uploadFile(fileBytes, {
actionId: `my-file-${Date.now()}`,
rq_ids_ic: 1000,
rq_ids_max: actionParams.rq_ids_max,
taskOptions: {
pollInterval: 2000,
timeout: 300000,
},
});
console.log("Upload completed:", uploadResult);
// Download using the action ID
const downloadStream = await client.Cascade.downloader.download(
uploadResult.actionId
);
// Read the stream
const reader = downloadStream.getReader();
const chunks: Uint8Array[] = [];
while (true) {
const { done, value } = await reader.read();
if (done) break;
chunks.push(value);
}
// Combine chunks
const totalLength = chunks.reduce((acc, chunk) => acc + chunk.length, 0);
const downloadedBytes = new Uint8Array(totalLength);
let offset = 0;
for (const chunk of chunks) {
downloadedBytes.set(chunk, offset);
offset += chunk.length;
}
const downloadedContent = new TextDecoder().decode(downloadedBytes);
console.log("Downloaded:", downloadedContent);
The SDK includes built-in presets for quick setup:
const client = await createLumeraClient({
preset: "testnet", // or "mainnet"
signer: wallet,
address: account.address,
});
Available presets:
testnet - Lumera testnet configurationmainnet - Lumera mainnet configurationFor custom chains or advanced setups:
const client = await createLumeraClient({
rpcUrl: "https://your-rpc-url.com",
lcdUrl: "https://your-lcd-url.com",
chainId: "your-chain-id",
signer: wallet,
address: account.address,
gasPrice: "0.025ulume",
cascade: {
snapiBaseUrl: "https://your-snapi-url.com"
}
});
Direct access to blockchain operations:
// Transaction operations
const msgs = [...]; // Your messages
const gas = await client.Blockchain.Tx.simulate(address, msgs);
const result = await client.Blockchain.Tx.broadcast(signedTx);
// Query operations
const actionList = await client.Blockchain.Action.listActions();
const supernodeList = await client.Blockchain.Supernode.listAll();
File storage operations:
// Upload with progress tracking
const uploader = client.Cascade.uploader;
const result = await uploader.uploadFile(fileBytes, {
actionId: "my-action",
rq_ids_ic: 1000,
rq_ids_max: 10000,
});
// Download as stream
const downloader = client.Cascade.downloader;
const stream = await downloader.download("action-id");
# Install dependencies
pnpm install
# Run tests
pnpm test
# Run tests with coverage
pnpm run coverage
# Build the SDK
pnpm build
# Generate API documentation
pnpm run docs
# Lint code
pnpm lint
Contributions are welcome! Please read our contributing guidelines before submitting PRs.
Apache-2.0 - see LICENSE file for details.
Built with ❤️ by the Lumera Protocol team