Class WalletAbstract

Abstract class for Wallet.

Implemented by

Constructors

constructor

Methods

getBalance getChangeAddress getCollateral getNetworkId getRewardAddresses getUnspentOutputs getUnusedAddresses getUsedAddresses postTransaction signData signTransaction

Constructors

constructor

Methods

AbstractgetBalance

  • getBalance(): Promise<Value>

  • Retrieves the total available balance of the wallet, encoded in CBOR.

    Returns Promise<Value>

    • The balance of the wallet.

AbstractgetChangeAddress

  • getChangeAddress(): Promise<Address>

  • Retrieves an address owned by the wallet which should be used to return transaction change.

    Returns Promise<Address>

    • The change address.

AbstractgetCollateral

  • getCollateral(): Promise<TransactionUnspentOutput[]>

  • Retrieves the collateral UnspentOutputs for the wallet.

    Returns Promise<TransactionUnspentOutput[]>

    • The collateral for the wallet.

AbstractgetNetworkId

  • getNetworkId(): Promise<NetworkId>

  • Retrieves the network ID of the currently connected account.

    Returns Promise<NetworkId>

    • The network ID of the currently connected account.

AbstractgetRewardAddresses

  • getRewardAddresses(): Promise<RewardAddress[]>

  • Retrieves the reward addresses controlled by the wallet.

    Returns Promise<RewardAddress[]>

    • The reward addresses controlled by the wallet.

AbstractgetUnspentOutputs

  • getUnspentOutputs(): Promise<TransactionUnspentOutput[]>

  • Retrieves the UnspentOutputs controlled by the wallet.

    Returns Promise<TransactionUnspentOutput[]>

    • The UnspentOutputs controlled by the wallet.

AbstractgetUnusedAddresses

  • getUnusedAddresses(): Promise<Address[]>

  • Retrieves all unused addresses controlled by the wallet.

    Returns Promise<Address[]>

    • The unused addresses controlled by the wallet.

AbstractgetUsedAddresses

  • getUsedAddresses(): Promise<Address[]>

  • Retrieves all used addresses controlled by the wallet.

    Returns Promise<Address[]>

    • The used addresses controlled by the wallet.

AbstractpostTransaction

  • postTransaction(tx): Promise<TransactionId>

  • Posts a transaction through the wallet.

    Parameters

    • tx: Transaction

      The transaction to submit.

    Returns Promise<TransactionId>

    • The ID of the submitted transaction.

AbstractsignData

  • signData(address, payload): Promise<CIP30DataSignature>

  • Requests signed data from the wallet.

    Parameters

    • address: Address

      The address to sign the data with.

    • payload: string

      The data to sign.

    Returns Promise<CIP30DataSignature>

    • The signed data.

AbstractsignTransaction

  • signTransaction(tx, partialSign): Promise<TransactionWitnessSet>

  • Requests a transaction signature from the wallet.

    Parameters

    • tx: Transaction

      The transaction to sign.

    • partialSign: boolean

      Whether to partially sign the transaction.

    Returns Promise<TransactionWitnessSet>

    • The signed transaction.

Settings

Member Visibility

On This Page

Constructors
Methods