Interface IReadonlyWallet

Readonlyactivity

assetManager

identity

clear

• clear(): Promise<void>

  Wipe all locally persisted wallet data (VTXOs, UTXOs, history, sync cursor, contracts).

  Returns Promise<void>

getActivityHistory

• getActivityHistory(): Promise<Activity[]>

  Returns Promise<Activity[]>

  Wallet history grouped into logical activities with signed net amounts.

getAddress

• getAddress(): Promise<string>

  Returns Promise<string>

  Arkade address used for offchain funds.

getArkadeInfo

• getArkadeInfo(opts?: GetArkadeInfoOptions): Promise<ArkadeInfo>

  Server info for the Arkade server this wallet is connected to — network, signer key, delays, dust, fees and limits.

  The wallet is the single place that knows which server it speaks to, so a plugin needs only the wallet, never a server URL of its own. Live info wins; when the server is unreachable this falls back to the snapshot persisted at construction, so an offline wallet still answers.

  With requireLive, that fallback is off: the read throws when the operator is unreachable instead of answering from cache. For callers about to bind signerPubkey or a delay into a covenant — a stale snapshot there derives an address the operator may no longer co-sign for, so failing closed is the correct shape.

  Parameters

  • Optionalopts: GetArkadeInfoOptions

  Returns Promise<ArkadeInfo>

  The Arkade server's info

  See

  ArkadeInfo

getArkadeReader

• getArkadeReader(): Promise<ArkadeReader>

  Chain reads against this wallet's Arkade server, for scripts the wallet does not own — a plugin's covenant, say. getVtxos answers for the wallet's own outputs and reads from repositories; this one goes to the server.

  Returns Promise<ArkadeReader>

  A normalized reader bound to this wallet's server

  See

  ArkadeReader

getBalance

• getBalance(): Promise<WalletBalance>

  Returns Promise<WalletBalance>

  The wallet's combined onchain and offchain balance.

getBoardingAddress

• getBoardingAddress(): Promise<string>

  Returns Promise<string>

  Onchain boarding address used to move funds into Arkade.

getBoardingUtxos

• getBoardingUtxos(): Promise<ExtendedCoin[]>

  Returns Promise<ExtendedCoin[]>

  Onchain boarding inputs tracked by the wallet.

getContractManager

• getContractManager(): Promise<IContractManager>

  Get the contract manager associated with this wallet. This is useful for querying contract state and watching for contract events.

  Returns Promise<IContractManager>

  Contract manager instance

getSpendableVtxos

• getSpendableVtxos(
      filter?: GetVtxosFilter,
  ): Promise<NormalizedExtendedVirtualCoin[]>

  The subset of getVtxos that generic spending may select: the same filter, minus contracts the generic-spending gate closes, minus funds awaiting recovery under a past-cutoff signer, minus outpoints locked by an in-flight intent. Every implicit coin selection in the SDK reads this; getVtxos stays the raw reporting/recovery read.

  Both exclusion sets are derived from one contract snapshot, so they cannot disagree about which VTXOs exist.

  Parameters

  • Optionalfilter: GetVtxosFilter

    Same flags, same defaults, as getVtxos

  Returns Promise<NormalizedExtendedVirtualCoin[]>

  See

  GetVtxosFilter

getTransactionHistory

• getTransactionHistory(): Promise<ArkTransaction[]>

  Returns Promise<ArkTransaction[]>

  Wallet transaction history derived from boarding and Arkade activity.

getVtxos

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

  Get virtual outputs tracked by the wallet.

  Parameters

  • Optionalfilter: GetVtxosFilter

    Optional filtering flags

  Returns Promise<NormalizedExtendedVirtualCoin[]>

  virtual outputs with tapscript and witness data, normalized: every canonical fact the capability predicates read is populated, whatever the underlying repository stored

  See

  GetVtxosFilter