Skip to main content
Creates and initializes a new IssuerSparkWallet instance.

Method Signature

interface IssuerSparkWalletProps {
  mnemonicOrSeed?: Uint8Array | string;
  accountNumber?: number;
  signer?: SparkSigner;
  options?: ConfigOptions;
}

static async initialize(props: IssuerSparkWalletProps): Promise<{
  wallet: IssuerSparkWallet;
  mnemonic?: string;
}>

Parameters

mnemonicOrSeed
Uint8Array | string
BIP-39 mnemonic phrase or raw seed
accountNumber
number
Number used to generate multiple identity keys from the same mnemonic
signer
SparkSigner
Custom signer implementation for advanced use cases
options
ConfigOptions
Wallet configuration options including network selection

Returns

wallet
IssuerSparkWallet
required
The initialized IssuerSparkWallet instance
mnemonic
string
The mnemonic if one was generated (undefined for raw seed)

Example

import { IssuerSparkWallet } from "@buildonspark/issuer-sdk";

// Create a new issuer wallet
const { wallet, mnemonic } = await IssuerSparkWallet.initialize({
  options: { network: "REGTEST" } // or "MAINNET"
});

console.log("Issuer wallet initialized:", wallet);
console.log("Generated mnemonic:", mnemonic);