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

    Interface IWallet

    Core wallet interface for Bitcoin transactions with Ark protocol support.

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

    interface IWallet {
        identity: Identity;
        getAddress(): Promise<string>;
        getBalance(): Promise<WalletBalance>;
        getBoardingAddress(): Promise<string>;
        getBoardingUtxos(): Promise<ExtendedCoin[]>;
        getTransactionHistory(): Promise<ArkTransaction[]>;
        getVtxos(filter?: GetVtxosFilter): Promise<ExtendedVirtualCoin[]>;
        sendBitcoin(params: SendBitcoinParams): Promise<string>;
        settle(
            params?: SettleParams,
            eventCallback?: (event: SettlementEvent) => void,
        ): Promise<string>;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    identity

    Methods

    getAddress getBalance getBoardingAddress getBoardingUtxos getTransactionHistory getVtxos sendBitcoin settle

    Properties

    identity: Identity

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods