Class ReadonlyWallet

ReadonlyarkServerPublicKey

ReadonlyboardingTapscript

ReadonlycontractRepository

Optional ReadonlydelegatorProvider

ReadonlydustAmount

Readonlyidentity

ReadonlyindexerProvider

Readonlynetwork

ReadonlyoffchainTapscript

ReadonlyonchainProvider

ReadonlywalletRepository

arkAddress

• get arkAddress(): ArkAddress

  Returns ArkAddress

assetManager

• get assetManager(): IReadonlyAssetManager

  Returns IReadonlyAssetManager

defaultContractScript

• get defaultContractScript(): string

  Get the contract script for the wallet's default address. This is the pkScript hex, used to identify the wallet in ContractManager.

  Returns string

fetchPendingTxs

• fetchPendingTxs(): Promise<string[]>

  Returns Promise<string[]>

getAddress

• getAddress(): Promise<string>

  Returns Promise<string>

getBalance

• getBalance(): Promise<WalletBalance>

  Returns Promise<WalletBalance>

getBoardingAddress

• getBoardingAddress(): Promise<string>

  Returns Promise<string>

getBoardingTxs

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

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

getBoardingUtxos

• getBoardingUtxos(): Promise<ExtendedCoin[]>

  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 VTXOs can be extended with the correct tapscript per contract.

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

getTransactionHistory

• getTransactionHistory(): Promise<ArkTransaction[]>

  Returns Promise<ArkTransaction[]>

getVtxos

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

  Parameters

  • Optionalfilter: GetVtxosFilter

  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). Falls back to only the current script if ContractManager is not yet initialized.

  Returns Promise<string[]>

notifyIncomingFunds

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

  Parameters

  • eventCallback: (coins: IncomingFunds) => void

  Returns Promise<() => void>

Staticcreate

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

  Parameters

  • config: ReadonlyWalletConfig

  Returns Promise<ReadonlyWallet>