Class ReadonlyWallet

ReadonlyarkServerPublicKey

ReadonlyboardingTapscript

ReadonlycontractRepository

Optional ReadonlydelegatorProvider

ReadonlydustAmount

Readonlyidentity

ReadonlyindexerProvider

Readonlynetwork

ReadonlyoffchainTapscript

ReadonlyonchainProvider

ReadonlywalletContractTimelocks

ReadonlywalletRepository

arkAddress

• get arkAddress(): ArkAddress

  Returns ArkAddress

assetManager

• get assetManager(): IReadonlyAssetManager

  Readonly asset manager bound to this wallet instance.

  Returns IReadonlyAssetManager

defaultContractScript

• get defaultContractScript(): string

  Get the pkScript hex for the wallet's primary offchain address. For the full wallet-owned script set registered in ContractManager, use getWalletScripts().

  Returns string

[asyncDispose]

• "[asyncDispose]"(): Promise<void>

  Async-dispose hook that forwards to dispose().

  Returns Promise<void>

clearSyncCursor

• clearSyncCursor(): Promise<void>

  Clear the global VTXO sync cursor, forcing a full re-bootstrap on next sync. Useful for recovery after indexer reprocessing or debugging.

  Returns Promise<void>

dispose

• dispose(): Promise<void>

  Dispose wallet-owned managers and release background resources.

  Returns Promise<void>

fetchPendingTxs

• fetchPendingTxs(): Promise<string[]>

  Fetch Arkade transaction ids that are still pending final settlement.

  Returns Promise<string[]>

getAddress

• getAddress(): Promise<string>

  Returns the wallet's Arkade address.

  Returns Promise<string>

getBalance

• getBalance(): Promise<WalletBalance>

  Return the wallet's combined onchain and offchain balances.

  Returns Promise<WalletBalance>

getBoardingAddress

• getBoardingAddress(): Promise<string>

  Returns the onchain boarding address used to move funds into Arkade.

  Returns Promise<string>

getBoardingTxs

• getBoardingTxs(): Promise<
      { boardingTxs: ArkTransaction[]; commitmentsToIgnore: Set<string> },
  >

  Build a transaction history view for the wallet's boarding address.

  Returns Promise<{ boardingTxs: ArkTransaction[]; commitmentsToIgnore: Set<string> }>

getBoardingUtxos

• getBoardingUtxos(): Promise<ExtendedCoin[]>

  Fetch and cache onchain inputs (UTXOs) received at the boarding address.

  Returns Promise<ExtendedCoin[]>

getContractManager

• getContractManager(): Promise<ContractManager>

  Get the ContractManager for managing contracts including the wallet's default address.

  The ContractManager handles:

  • The wallet's default receiving address (as a "default" contract)
  • External contracts (Boltz swaps, HTLCs, etc.)
  • Multi-contract watching with resilient connections

  Returns Promise<ContractManager>

  Example

  const manager = await wallet.getContractManager();
  
  // Create a contract for a Boltz swap
  const contract = await manager.createContract({
    label: "Boltz Swap",
    type: "vhtlc",
    params: { ... },
    script: swapScript,
    address: swapAddress,
  });
  
  // Start watching for events (includes wallet's default address)
  const stop = await manager.onContractEvent((event) => {
    console.log(`${event.type} on ${event.contractScript}`);
  });
  Copy

getScriptMap

• getScriptMap(): Promise<Map<string, DefaultVtxo.Script | DelegateVtxo.Script>>

  Build a map of scriptHex → VtxoScript for all wallet contracts, so virtual outputs can be extended with the correct tapscript per contract.

  Returns Promise<Map<string, DefaultVtxo.Script | DelegateVtxo.Script>>

getTransactionHistory

• getTransactionHistory(): Promise<ArkTransaction[]>

  Return wallet transaction history derived from Arkade state and boarding transactions.

  Returns Promise<ArkTransaction[]>

getVtxos

• getVtxos(filter?: GetVtxosFilter): Promise<ExtendedVirtualCoin[]>

  Return virtual outputs tracked by the wallet.

  Parameters

  • Optionalfilter: GetVtxosFilter

    Optional flags controlling whether recoverable or unrolled VTXOs are included

  Returns Promise<ExtendedVirtualCoin[]>

getWalletScripts

• getWalletScripts(): Promise<string[]>

  Get all pkScript hex strings for the wallet's own addresses (both delegate and non-delegate, current and historical).

  Returns Promise<string[]>

notifyIncomingFunds

• notifyIncomingFunds(
      eventCallback: (coins: IncomingFunds) => void,
  ): Promise<() => void>

  Subscribe to onchain and offchain notifications for newly received funds.

  Parameters

  • eventCallback: (coins: IncomingFunds) => void

    Callback invoked when matching funds are detected

  Returns Promise<() => void>

  A function that stops the subscriptions

Staticcreate

• create(config: ReadonlyWalletConfig): Promise<ReadonlyWallet>

  Create a readonly wallet for querying balances, addresses, and history.

  Parameters

  • config: ReadonlyWalletConfig

    Readonly wallet configuration

  Returns Promise<ReadonlyWallet>

  A readonly wallet instance