QubicTypeScript

subscribeTransfers

Emits decoded QU transfer events as structured objects, without needing to decode raw log payloads.

Signature

bob.subscribeTransfers(
  filter?: BobTransferFilter,
  options?: SubscribeOptions,
): AsyncIterable<SubscriptionEvent<BobTransferEvent>>

Purpose

Emits QU transfer events as structured objects, without needing to decode raw log payloads. Use this for a simple transfer stream; use subscribeQuTransfers from @qubic.org/events for full type safety with decoded payloads.

for await (const event of bob.subscription.subscribeTransfers({ identity })) {
  if (event.isCatchUp) continue

  const { source, destination, amount, tick } = event.data
  const dir = source === identity ? "OUT" : "IN"
  console.log(`[${dir}] ${amount}n QU at tick ${tick}`)
}

Parameters

Filter (BobTransferFilter)

NameTypeDescription
identityIdentityFilter by sender or recipient
fromTicknumberStart tick (inclusive)
toTicknumberEnd tick (inclusive)

Options

NameTypeDescription
startLogIdbigintResume from this log ID
signalAbortSignalStops the iteration when aborted

Returns

AsyncIterable<SubscriptionEvent<BobTransferEvent>>

BobTransferEvent fields

FieldTypeDescription
data.ticknumberTick the transfer occurred in
data.logIdbigintUnique log ID
data.sourceIdentitySender
data.destinationIdentityRecipient
data.amountbigintQU amount

On this page