Events and history

Provider events, history queries, and transaction waits.

getTransactionHistory

Parameters: optional limit (1–100; default 50) and offset (default 0). Returns Promise<ArksatTransaction[]>. Requires transactions read permission.

await client.connect({ read: ['transactions'] })
const rows = await client.getTransactionHistory({ limit: 20, offset: 0 })

Records are newest first. Offset pagination is not a stable snapshot.

getTransaction

Accepts { txid: string } and returns Promise<ArksatTransaction | null>. Both Client and Provider require the explicit transactions read grant. Check method support before calling.

const capabilities = await client.getCapabilities()
if (!capabilities.methods.includes('getTransaction')) throw new Error('Update the extension')
await client.connect({ read: ['transactions'] })
const tx = await client.getTransaction({ txid })

Accepts a transaction ID or wallet record ID and searches all activity retained in the current wallet snapshot without the 100-record page limit. It does not query a global chain index. A null result is not proof that a transaction never occurred. Missing permission or unavailable history throws.

on / off

const listener = (network: 'mainnet' | 'mutinynet') => console.log(network)
provider.on('network:changed', listener)
provider.off('network:changed', listener)

Event	Payload
account:changed	string[]
network:changed	ArksatNetwork
balance:changed / assets:changed	ArksatDataEvent or null
transaction:updated / transfer:received / transfer:settled	ArksatTransactionEvent
connection:connected	Empty object
connection:disconnected	message field
wallet:locked / wallet:unlocked	null

subscribe

import { subscribe } from '@arksat/wallet-sdk'
const stop = subscribe(provider, 'balance:changed', () => {
  // Reload balance
})
stop()

Returns an idempotent unsubscribe function.

waitForTransaction

import { waitForTransaction } from '@arksat/wallet-sdk'
const tx = await waitForTransaction(provider, txid, {
  timeoutMs: 120000,
  pollIntervalMs: 3000,
})

Returns Promise<ArksatTransaction>. Optional AbortSignal is supported. Default timeout: 120 seconds; polling: 3 seconds, minimum 1 second.

Uses getTransaction to search all activity retained by the wallet and returns any non-pending status. Older providers without getTransaction fall back to only the latest 100 records. Check status for failed, cancelled, or recoverable results. Context changes and read errors reject.

Integration guide · Types