Skip to main content
The Spark TypeScript SDK provides TypeScript support for building Bitcoin wallet applications on Node.js and web browsers. This guide covers installation and basic setup. Before getting started, ensure you have Node.js (v16 or later) installed and a TypeScript development environment set up.

​
Getting Started

To get started, follow the steps below.
1

Install SDK

Install the Spark SDK packages using your package manager of choice.
npm install @buildonspark/spark-sdk
2

Setup Wallet

Create a wallet instance that will be used to interact with the Spark network.
wallet.ts
import { SparkWallet } from "@buildonspark/spark-sdk";

export const initializeWallet = async () => {
  const { wallet, mnemonic } = await SparkWallet.initialize({
    mnemonicOrSeed: "optional-mnemonic-or-seed",
    accountNumber: "optional-number",
    options: {
      network: "REGTEST" // or "MAINNET"
    }
  });

  console.log("Wallet initialized successfully:", mnemonic);
  return wallet;
};
3

Start Building

That’s it—you can now start using the Spark TypeScript SDK.
app.ts
import { SparkWallet } from "@buildonspark/spark-sdk";

async function main() {
  try {
    // Initialize wallet
    const { wallet, mnemonic } = await SparkWallet.initialize({
      options: { network: "REGTEST" }
    });

    console.log("Wallet created successfully!");
    console.log("Mnemonic:", mnemonic);
    console.log("Address:", wallet.getAddress());
    console.log("Balance:", await wallet.getBalance());

    // Example: Send Bitcoin
    const result = await wallet.send({
      to: "recipient-address",
      amount: 1000, // sats
    });

    console.log("Transaction sent:", result.txid);
  } catch (error) {
    console.error("Error:", error);
  }
}

main();

​
TypeScript Configuration

​
tsconfig.json

Create a tsconfig.json file in your project root:
tsconfig.json
{
  "compilerOptions": {
    "target": "ES2020",
    "module": "commonjs",
    "lib": ["ES2020"],
    "outDir": "./dist",
    "rootDir": "./src",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true,
    "resolveJsonModule": true,
    "declaration": true,
    "declarationMap": true,
    "sourceMap": true
  },
  "include": ["src/**/*"],
  "exclude": ["node_modules", "dist"]
}

​
Package.json Scripts

Add TypeScript build scripts to your package.json:
package.json
{
  "scripts": {
    "build": "tsc",
    "start": "node dist/app.js",
    "dev": "ts-node src/app.ts",
    "watch": "tsc --watch"
  }
}

​
Core Wallet Operations

​
Initialize a Wallet

A wallet requires either a mnemonic or raw seed for initialization. The initialize() function accepts both. If no input is given, it will auto-generate a mnemonic and return it. 
// Initialize a new wallet instance
const { wallet, mnemonic } = await SparkWallet.initialize({
  mnemonicOrSeed: "optional-mnemonic-or-seed",
  accountNumber: "optional-number",
  options: {
    network: "REGTEST" // or "MAINNET"
  }
});

console.log("Wallet initialized successfully:", mnemonic);

​
Mnemonic Phrases

A mnemonic is a human-readable encoding of your wallet’s seed. It’s a 12- or 24-word phrase from the BIP-39 wordlist, used to derive the cryptographic keys that control your wallet.

​
TypeScript Features

​
Type Safety

The Spark TypeScript SDK provides full type safety for all wallet operations: 
import { SparkWallet } from "@buildonspark/spark-sdk";

// TypeScript will provide autocomplete and type checking
const wallet = await SparkWallet.initialize({
  options: { network: "REGTEST" }
});

// All methods are fully typed
const address: string = wallet.getAddress();
const balance: number = await wallet.getBalance();

​
Interface Definitions

All wallet methods return properly typed interfaces: 
interface WalletResult {
  wallet: SparkWallet;
  mnemonic: string;
}

interface SendResult {
  txid: string;
  // ... other transaction properties
}