getRailsForPayeeAndToken

getRailsForPayeeAndToken(client, options): Promise<OutputType>

Defined in: packages/synapse-core/src/pay/get-rails-for-payee-and-token.ts:82

Get one bounded page of rails for a payee and token.

Pass the returned nextCursor back as cursor; treat it as opaque. Use paginate to traverse every page. total is the contract’s underlying rail-slot count, including slots skipped because their rails were finalized.

Parameters

Parameter	Type	Description
client	Client<Transport, Chain>	The client to use to get the rails.
options	OptionsType	getRailsForPayeeAndToken.OptionsType

Returns

Promise<OutputType>

Paginated rail results getRailsForPayeeAndToken.OutputType

Throws

Errors getRailsForPayeeAndToken.ErrorType

Examples

Read the first page

import { getRailsForPayeeAndToken } from '@filoz/synapse-core/pay'
import { createPublicClient, http } from 'viem'
import { calibration } from '@filoz/synapse-core/chains'

const client = createPublicClient({
  chain: calibration,
  transport: http(),
})

const payee = '0x1234567890123456789012345678901234567890'
const page = await getRailsForPayeeAndToken(client, { payee })
console.log(page.items, page.nextCursor, page.total)

Iterate over every page

import { paginate } from '@filoz/synapse-core'
import { getRailsForPayeeAndToken } from '@filoz/synapse-core/pay'

for await (const rail of paginate(({ cursor }) =>
  getRailsForPayeeAndToken(client, { payee, cursor })
)) {
  console.log(rail.railId)
}