createWithViewerKey

Creates a SparkReadonlyClient authenticated with an identity key derived from a mnemonic or seed. Can query a private wallet as its owner or as the viewer identity authorized by that owner. Use a separate viewer mnemonic for services. Derive the public key with deriveViewerIdentityPublicKey(config, mnemonicOrSeed, accountNumber) and have the owner authorize it with setViewerIdentityPublicKey(). Use the same network and account number for derivation and authentication. See the complete setup.

Method Signature

static async createWithViewerKey(
  config: ConfigOptions | undefined,
  mnemonicOrSeed: Uint8Array | string,
  accountNumber?: number,
): Promise<SparkReadonlyClient>

Parameters

ConfigOptions | undefined

required

Configuration options including network selection. Pass undefined for defaults.

Uint8Array | string

required

BIP-39 mnemonic phrase, hex-encoded seed string, or raw seed bytes.

number

Account index for key derivation. Defaults to 0 for REGTEST, 1 otherwise.

Returns

Promise<SparkReadonlyClient>

required

An authenticated wallet viewer. Requests include an identity key signature for access to private wallet data.

Example

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

const client = await SparkReadonlyClient.createWithViewerKey(
  { network: "MAINNET" },
  viewerMnemonic, // The service’s own mnemonic, not the owner’s wallet mnemonic
);

// Query a wallet that granted this identity read access.
const balance = await client.getAvailableBalance("sp1...");

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

const client = await SparkReadonlyClient.createWithViewerKey(
  { network: "MAINNET" },
  seedBytes, // Uint8Array
  1,         // account number
);

Introduction

Wallets

Wallet Viewer

Utilities

Issuance

createWithViewerKey

Method Signature

Parameters

Returns

Example