Class HotWallet

Readonlyaddress

ReadonlynetworkId

ReadonlyrewardAddress

getBalance

• getBalance(): Promise<Value>

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

  Returns Promise<Value>

  • The balance of the wallet.

getChangeAddress

• getChangeAddress(): Promise<Address>

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

  Returns Promise<Address>

  • The change address.

getCollateral

• getCollateral(): Promise<TransactionUnspentOutput[]>

• Retrieves the collateral UTxO(s) for the wallet.

  Returns Promise<TransactionUnspentOutput[]>

  • The collateral for the wallet.

getNetworkId

• getNetworkId(): Promise<NetworkId>

• Retrieves the network ID of the currently connected account.

  Returns Promise<NetworkId>

  • The network ID of the currently connected account.

getRewardAddresses

• getRewardAddresses(): Promise<RewardAddress[]>

• Retrieves the reward addresses controlled by the wallet.

  Returns Promise<RewardAddress[]>

  • The reward addresses controlled by the wallet.

getUnspentOutputs

• getUnspentOutputs(): Promise<TransactionUnspentOutput[]>

• Retrieves the UTxO(s) controlled by the wallet.

  Returns Promise<TransactionUnspentOutput[]>

  • The UTXO(s) controlled by the wallet.

getUnusedAddresses

• getUnusedAddresses(): Promise<Address[]>

• Retrieves all unused addresses controlled by the wallet.

  Returns Promise<Address[]>

  • The unused addresses controlled by the wallet.

getUsedAddresses

• getUsedAddresses(): Promise<Address[]>

• Retrieves all used addresses controlled by the wallet.

  Returns Promise<Address[]>

  • The used addresses controlled by the wallet.

postTransaction

• postTransaction(tx): Promise<TransactionId>

• Submits a transaction through the wallet.

  Parameters

  • tx: Transaction

    The transaction to submit.

  Returns Promise<TransactionId>

  • The ID of the submitted transaction.

signData

• 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.

signTransaction

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

• Requests a transaction signature from the wallet.

  Parameters

  • tx: Transaction

    The transaction to sign.
  • partialSign: boolean = true

    Whether to partially sign the transaction.
  • signWithStakeKey: boolean = false

    Whether to also sign the transaction with the stake key.

  Returns Promise<TransactionWitnessSet>

  • The signed transaction.

StaticfromMasterkey

• fromMasterkey(masterkey, provider, networkId?, addressType?): Promise<HotWallet>

• Parameters

  • masterkey: Core.Bip32PrivateKeyHex
  • provider: Provider
  • networkId: NetworkId = NetworkId.Testnet
  • addressType: AddressType = AddressType.BasePaymentKeyStakeKey

  Returns Promise<HotWallet>

StaticgenerateAccountAddressFromMasterkey

• generateAccountAddressFromMasterkey(masterkey, networkId?, addressType?): Promise<{
      address: Address;
      paymentKey: Bip32PrivateKey;
      publicKey: Bip32PublicKey;
      stakePaymentKey: Bip32PrivateKey;
  }>

• Parameters

  • masterkey: Bip32PrivateKey
  • networkId: NetworkId = NetworkId.Testnet
  • addressType: AddressType = AddressType.BasePaymentKeyStakeKey

  Returns Promise<{
      address: Address;
      paymentKey: Bip32PrivateKey;
      publicKey: Bip32PublicKey;
      stakePaymentKey: Bip32PrivateKey;
  }>