createPublic

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

Method Signature

static createPublic(config?: ConfigOptions): SparkReadonlyClient

Parameters

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

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");

Bitcoin balance and wallet-history queries return empty results (zero balances, empty arrays) when a private wallet denies read access. This deliberately avoids revealing whether the wallet is private or empty; unrelated authentication or network errors can still occur. Use createWithViewerKey() as the owner or an authorized viewer to query a private wallet. An unrelated authenticated identity does not gain access.

Introduction

Wallets

Wallet Viewer

Utilities

Issuance

createPublic

Method Signature

Parameters

Returns

Example

​Method Signature

​Parameters

​Returns

​Example

Method Signature

Parameters

Returns

Example