createPublic

Create an unauthenticated wallet viewer for public wallet queries.

Creates a SparkReadonlyClient with no authentication. Can query any wallet that hasn’t enabled privacy mode.

Method Signature

static createPublic(config?: ConfigOptions): SparkReadonlyClient

Parameters

config · ConfigOptions

Configuration options including network selection.

Show ConfigOptions Details

interface ConfigOptions {
  network?: "MAINNET" | "TESTNET" | "SIGNET" | "REGTEST" | "LOCAL";
  // Additional advanced options rarely needed for readonly use
}

Returns

client · SparkReadonlyClient · required

A wallet viewer instance with no authentication. Requests are made without an identity key.

Example

import { SparkReadonlyClient } from "@buildonspark/spark-sdk";

const client = SparkReadonlyClient.createPublic({
  network: "MAINNET",
});

// Query any public wallet
const balance = await client.getAvailableBalance("sp1...");
console.log("Balance:", balance, "sats");

Private wallets return empty results (zero balances, empty arrays) to unauthenticated clients, not errors. Use createWithMasterKey() to query private wallets you own.