Interface IReadonlyWallet

Readonly 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 IReadonlyWallet {
    identity: ReadonlyIdentity;
    getAddress(): Promise<string>;
    getBalance(): Promise<WalletBalance>;
    getBoardingAddress(): Promise<string>;
    getBoardingUtxos(): Promise<ExtendedCoin[]>;
    getTransactionHistory(): Promise<ArkTransaction[]>;
    getVtxos(filter?: GetVtxosFilter): Promise<ExtendedVirtualCoin[]>;
}

Hierarchy (View Summary)

IReadonlyWallet
- IWallet

Implemented by

Index

Properties

Methods

getAddress getBalance getBoardingAddress getBoardingUtxos getTransactionHistory getVtxos

Properties

identity

identity: ReadonlyIdentity

Methods

getAddress

getAddress(): Promise<string>
Returns Promise<string>
- Defined in wallet/index.ts:272

getBalance

getBalance(): Promise<WalletBalance>
Returns Promise<WalletBalance>
- Defined in wallet/index.ts:275

getBoardingAddress

getBoardingAddress(): Promise<string>
Returns Promise<string>
- Defined in wallet/index.ts:274

getBoardingUtxos

getBoardingUtxos(): Promise<ExtendedCoin[]>
Returns Promise<ExtendedCoin[]>
- Defined in wallet/index.ts:277

getTransactionHistory

getTransactionHistory(): Promise<ArkTransaction[]>
Returns Promise<ArkTransaction[]>
- Defined in wallet/index.ts:278

getVtxos

getVtxos(filter?: GetVtxosFilter): Promise<ExtendedVirtualCoin[]>
Parameters
- Optionalfilter: GetVtxosFilter
Returns Promise<ExtendedVirtualCoin[]>
- Defined in wallet/index.ts:276