getBatchPosters

Type Aliases

GetBatchPostersParams

type GetBatchPostersParams: object;

Type declaration

Member	Type	Description
rollup	Address	Address of the rollup we're getting list of batch posters from
sequencerInbox	Address	Address of the sequencerInbox we're getting logs from

Source

src/getBatchPosters.ts:57

---

GetBatchPostersReturnType

type GetBatchPostersReturnType: object;

Type declaration

Member	Type	Description
batchPosters	Address[]	List of batch posters for the given rollup
isAccurate	boolean	If logs contain unknown signature, batch posters list might: - contain false positives (batch posters that were removed, but returned as batch poster) - contain false negatives (batch posters that were added, but not present in the list)

Source

src/getBatchPosters.ts:63

Functions

getBatchPosters()

function getBatchPosters<TChain>(publicClient: object, GetBatchPostersParams: GetBatchPostersParams): Promise<GetBatchPostersReturnType>

Type parameters

Type parameter
TChain extends undefined | Chain<undefined | ChainFormatters>

Parameters

Parameter	Type	Description
publicClient	object	The chain Viem Public Client
GetBatchPostersParams	GetBatchPostersParams	GetBatchPostersParams

Returns

Promise<GetBatchPostersReturnType>

Promise<GetBatchPostersReturnType>

Remarks

Batch posters list is not guaranteed to be exhaustive if the isAccurate flag is false. It might contain false positive (batch posters that were removed, but returned as batch poster) or false negative (batch posters that were added, but not present in the list)

Example

const { isAccurate, batchPosters } = getBatchPosters(client, {
  rollup: '0xc47dacfbaa80bd9d8112f4e8069482c2a3221336',
  sequencerInbox: '0x995a9d3ca121D48d21087eDE20bc8acb2398c8B1'
});

if (isAccurate) {
  // batch posters were all fetched properly
} else {
  // batch posters list is not guaranteed to be accurate
}

Source

src/getBatchPosters.ts:97