Class ColdWallet

constructor

• new ColdWallet(address, networkId, provider): ColdWallet

• Constructs a new instance of the ColdWallet class.

  Parameters

  • address: Address

    The address of the wallet.
  • networkId: NetworkId

    The network ID of the wallet.
  • provider: Provider

    The provider of the wallet.

  Returns ColdWallet

Readonlyaddress

ReadonlynetworkId

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
  • _payload: string

  Returns Promise<CIP30DataSignature>

  • The signed data.

signTransaction

• signTransaction(_tx, _partialSign?): Promise<TransactionWitnessSet>

• Requests a transaction signature from the wallet.

  Parameters

  • _tx: Transaction
  • Optional_partialSign: boolean

  Returns Promise<TransactionWitnessSet>

  • The signed transaction.