@arkade-os/sdk Documentation - v0.4.54
    Preparing search index...

    Interface IReadonlyWallet

    Readonly wallet interface for Bitcoin transactions with Arkade protocol support.

    This interface defines the contract that all wallet implementations must follow. It provides methods for address management, balance checking, virtual output operations, and transaction management including sending, settling, and unrolling.

    IWallet

    interface IReadonlyWallet {
        activity: ActivityRegistry;
        assetManager: IReadonlyAssetManager;
        identity: ReadonlyIdentity;
        clear(): Promise<void>;
        getActivityHistory(): Promise<Activity[]>;
        getAddress(): Promise<string>;
        getBalance(): Promise<WalletBalance>;
        getBoardingAddress(): Promise<string>;
        getBoardingUtxos(): Promise<ExtendedCoin[]>;
        getContractManager(): Promise<IContractManager>;
        getTransactionHistory(): Promise<ArkTransaction[]>;
        getVtxos(filter?: GetVtxosFilter): Promise<NormalizedExtendedVirtualCoin[]>;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    activity assetManager identity

    Methods

    clear getActivityHistory getAddress getBalance getBoardingAddress getBoardingUtxos getContractManager getTransactionHistory getVtxos

    Properties

    activity: ActivityRegistry

    Resolvers that group/label getActivityHistory rows.

    assetManager: IReadonlyAssetManager

    Readonly asset manager bound to this wallet instance.

    identity: ReadonlyIdentity

    Readonly identity associated with the wallet.

    Methods

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

      Returns Promise<void>

    • Returns Promise<string>

      Arkade address used for offchain funds.

    • Returns Promise<string>

      Onchain boarding address used to move funds into Arkade.

    • 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

    • Get virtual outputs tracked by the wallet.

      Parameters

      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

      GetVtxosFilter

    Settings

    Member Visibility

    On This Page

    Properties
    Methods