EventEmitter

SparkWallet extends EventEmitter, so it inherits the following methods for handling events.

Available Events

Event	Callback Signature	Description
`"transfer:claimed"`	`(transferId: string, updatedBalance: bigint) => void`	Emitted when an incoming transfer is claimed. Does NOT fire for outgoing Lightning payments.
`"deposit:confirmed"`	`(depositId: string, updatedBalance: bigint) => void`	Emitted when a claimed L1 deposit is marked available (after the required confirmations, 3 by default).
`"stream:connected"`	`() => void`	Emitted when the event stream connects
`"stream:disconnected"`	`(reason: string) => void`	Emitted when the stream disconnects after max retries
`"stream:reconnecting"`	`(attempt: number, maxAttempts: number, delayMs: number, error: string) => void`	Emitted when attempting to reconnect

The updatedBalance parameter is a bigint representing the wallet’s new total balance in satoshis after the event.

Events are only emitted for incoming funds (transfers received, deposits confirmed). For outgoing operations (Lightning sends, withdrawals), poll the status using getLightningSendRequest() or getCoopExitRequest().

on(event: string, listener: Function)

Adds a listener for the specified event.

on(event: keyof SparkWalletEvents, listener: Function): this

Parameters

string

required

The event name to listen for

Function

required

The callback function to execute when the event is emitted

Returns

this

required

The SparkWallet instance for chaining

Example

wallet.on("transfer:claimed", (transferId, updatedBalance) => {
  console.log(`Transfer ${transferId} claimed. New balance: ${updatedBalance}`);
});

once(event: string, listener: Function)

Adds a one-time listener for the specified event.

once(event: keyof SparkWalletEvents, listener: Function): this

Parameters

string

required

The event name to listen for

Function

required

The callback function to execute when the event is emitted

Returns

this

required

The SparkWallet instance for chaining

Example

wallet.once("deposit:confirmed", (depositId, updatedBalance) => {
  console.log(`Deposit ${depositId} confirmed! New balance: ${updatedBalance}`);
});

off(event: string, listener: Function)

Removes the specified listener from the specified event.

off(event: keyof SparkWalletEvents, listener: Function): this

Parameters

string

required

The event name

Function

required

The callback function to remove

Returns

this

required

The SparkWallet instance for chaining

Example

const listener = (transferId) => console.log(`Transfer: ${transferId}`);
wallet.on("transfer:claimed", listener);

// Later, remove the listener
wallet.off("transfer:claimed", listener);

Introduction

Wallets

Wallet Viewer

Utilities

Issuance

EventEmitter

Available Events

on(event: string, listener: Function)

Parameters

Returns

Example

once(event: string, listener: Function)

Parameters

Returns

Example

off(event: string, listener: Function)

Parameters

Returns

Example

​Available Events

​on(event: string, listener: Function)

​Parameters

​Returns

​Example

​once(event: string, listener: Function)

​Parameters

​Returns

​Example

​off(event: string, listener: Function)

​Parameters

​Returns

​Example

Available Events

on(event: string, listener: Function)

Parameters

Returns

Example

once(event: string, listener: Function)

Parameters

Returns

Example

off(event: string, listener: Function)

Parameters

Returns

Example