Skip to main content

ReadonlyWallet

An interface type for a readonly wallet that manages a user's UTxOs and addresses.

export interface ReadonlyWallet {
  collateral: Promise<TxInput[]>
  isMainnet(): Promise<boolean>
  stakingAddresses: Promise<StakingAddress[]>
  unusedAddresses: Promise<Address[]>
  usedAddresses: Promise<Address[]>
  utxos: Promise<TxInput[]>
}

Properties​

collateral​

Returns a list of utxos suitable for use as collateral

readonlyWallet.collateral satisfies Promise<TxInput[]>

isMainnet​

Returns true if the wallet is connected to the mainnet.

readonlyWallet.isMainnet satisfies () => Promise<boolean>

stakingAddresses​

Returns a list of the reward addresses.

readonlyWallet.stakingAddresses satisfies Promise<StakingAddress[]>

unusedAddresses​

Returns a list of unique unused addresses which can be used to send UTxOs to with increased anonimity.

readonlyWallet.unusedAddresses satisfies Promise<Address[]>

usedAddresses​

Returns a list of addresses which already contain UTxOs.

readonlyWallet.usedAddresses satisfies Promise<Address[]>

utxos​

Returns a list of all the utxos controlled by the wallet.

readonlyWallet.utxos satisfies Promise<TxInput[]>