Skip to main content

IrisClient

export interface IrisClient {
  getAddressesWithAssetClass(assetClass: AssetClass): Promise<{
    address: Address
    quantity: bigint
  }[]>
  getTx(id: TxId): Promise<Tx>
  getUtxo(id: TxOutputId): Promise<TxInput>
  getUtxos(addr: Address): Promise<TxInput[]>
  getUtxosWithAssetClass(
    address: Address,
    assetClass: AssetClass
  ): Promise<TxInput[]>
  hasTx(id: TxId): Promise<boolean>
  hasUtxo(id: TxOutputId): Promise<boolean>
  isMainnet(): boolean
  now: number
  parameters: Promise<NetworkParams>
  selectUtxos(
    address: Address,
    value: Value,
    algorithm?: "smallest-first" | "largest-first"
  ): Promise<TxInput[]>
  submitTx(tx: Tx): Promise<TxId>
}
Experimental IrisClient (REST API gateway created by Helios)

Properties​

getAddressesWithAssetClass​

getAddressesWithAssetClass(assetClass: AssetClass): Promise<{
  address: Address
  quantity: bigint
}[]>
Returns a list of addresses containing the given asset class.

getTx​

getTx(id: TxId): Promise<Tx>

getUtxo​

getUtxo(id: TxOutputId): Promise<TxInput>

getUtxos​

getUtxos(addr: Address): Promise<TxInput[]>

getUtxosWithAssetClass​

getUtxosWithAssetClass(
  address: Address,
  assetClass: AssetClass
): Promise<TxInput[]>

hasTx​

hasTx(id: TxId): Promise<boolean>

hasUtxo​

hasUtxo(id: TxOutputId): Promise<boolean>

isMainnet​

isMainnet(): boolean

now​

now: number

parameters​

parameters: Promise<NetworkParams>

selectUtxos​

selectUtxos(
  address: Address,
  value: Value,
  algorithm?: "smallest-first" | "largest-first"
): Promise<TxInput[]>
algorithm defaults to "smallest-first"

submitTx​

submitTx(tx: Tx): Promise<TxId>