@arkade-os/sdk Documentation - v0.4.21
    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 {
        assetManager: IReadonlyAssetManager;
        identity: ReadonlyIdentity;
        getAddress(): Promise<string>;
        getBalance(): Promise<WalletBalance>;
        getBoardingAddress(): Promise<string>;
        getBoardingUtxos(): Promise<ExtendedCoin[]>;
        getContractManager(): Promise<IContractManager>;
        getTransactionHistory(): Promise<ArkTransaction[]>;
        getVtxos(filter?: GetVtxosFilter): Promise<ExtendedVirtualCoin[]>;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    assetManager identity

    Methods

    getAddress getBalance getBoardingAddress getBoardingUtxos getContractManager getTransactionHistory getVtxos

    Properties

    assetManager: IReadonlyAssetManager

    Readonly asset manager bound to this wallet instance.

    identity: ReadonlyIdentity

    Readonly identity associated with the wallet.

    Methods

    • 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

    Settings

    Member Visibility

    On This Page

    Properties
    Methods