Transactions

addTransaction(options)

Get some or all transactions on the network. options has the following structure:

{
  // data requests
  type?: TransactionType[]

  // related data retrieval
  receipts?: boolean
  inputs?: boolean
  outputs?: boolean

  range?: {
    from: number
    to?: number
  }
}

Data requests:

• type sets the type of the transaction. Transaction type has the following options: 'Script' | 'Create' | 'Mint' | 'Upgrade' | 'Upload'. Leave it undefined to subscribe to all transactions.

Enabling the receipts and/or inputs and outputs flags will cause the processor to retrieve receipts, inputs and outputs that occured as a result of each selected transaction. The data will be added to the appropriate iterables within the block data. You can also call augmentBlock() from @subsquid/fuel-objects on the block data to populate the convenience reference fields like transaction.receipts.

Note that transactions can also be requested by the other FuelDataSource methods as related data.

Selection of the exact fields to be retrieved for each transaction and the optional related data items is done with the setFields() method documented on the Field selection page.

Examples

Request all transactions with Create and Mint types and include receipts, inputs and outputs:

processor
  .addTransaction({
    type: ["Create", "Mint"],
    receipts: true,
    inputs: true,
    outputs: true,
  })
  .build();