Interface: OvercastIndexerClient

Defined in: packages/overcast-core/src/indexer/client.ts:30

Methods

getEvents()

getEvents(
   range, 
   cursor, 
   limit, 
commitment): Promise<EventPage>;

Defined in: packages/overcast-core/src/indexer/client.ts:46

One bounded page of events in the range (floor, ceil]. Pass cursor as null to start, then thread back EventPage until it is null (range drained). Returns at most limit events, oldest first. The adapter owns the scan direction and drops anything above ceil. commitment is the tier being indexed; an adapter may skip work only the finalized tier needs (e.g. an exact txIdx).

Parameters

Parameter	Type
range	{ ceil: Checkpoint; floor: Checkpoint | null; }
range.ceil	Checkpoint
range.floor	Checkpoint | null
cursor	Checkpoint | null
limit	number
commitment	Commitment

Returns

Promise<EventPage>

---

getHead()

getHead(commitment): Promise<Checkpoint>;

Defined in: packages/overcast-core/src/indexer/client.ts:36

The current chain head at a Commitment level: live (fast, still reorgable) or finalized (settled, canonical). A sweep runs toward the head at its level as a ceiling.

Parameters

Parameter	Type
commitment	Commitment

Returns

Promise<Checkpoint>

---

watch()?

optional watch(onActivity): void;

Defined in: packages/overcast-core/src/indexer/client.ts:58

Optional push hint: calls onActivity whenever the deployment likely has new live events. Only wakes the live tail early, it never carries data, so a missed call just waits for the next fallback tick.

Parameters

Parameter	Type
onActivity	() => void

Returns

void