Skip to main content

Getting Started

@joltz/sdk-js is the JavaScript wrapper for the Joltz SDK. Currently only Node.js is supported, but support for the browser will soon be added as well.

Install​

The Joltz SDK public beta is on npm, this beta is limited to the signet network. Contact Joltz to access our private mainnet beta (request access here). Run the following command to install:

npm install @joltz/sdk-js

Example​

import { SDK, newSeed } from "@joltz/sdk-js";

// First, you need to generate a seed phrase. This seed phrase is in the azseed format (like LND).
const seed = await newSeed();

// Then you need to initialize the SDK.
const sdk = new SDK({ seed });

// Now you are all set, you can start calling SDK functions (i.e. create a bitcoin address!).
console.log("address", await sdk.bitcoin.newAddress());