Interface: OvercastIndexerClient
Defined in: packages/overcast-core/src/indexer/client.ts:84
Methods
getEvents()
getEvents(
start,
end,
chunk): Promise<EventPage>;
Defined in: packages/overcast-core/src/indexer/client.ts:125
Searches backwards — from end (the newest point) down towards start
(the oldest, normally genesis) — the direction chains like Solana page
natively.
Parameters
| Parameter | Type | Description |
|---|---|---|
start | Checkpoint | null | the lower bound to stop at — the oldest point, normally genesis. null searches all the way down to genesis. |
end | Checkpoint | the (exclusive) upper bound to page down from — the newest point. Its inner checkpoint hash being null means "start at the chain head" (the newest event is included); a concrete signature/block hash means "strictly older than this". |
chunk | number | the maximum number of transactions to scan |
Returns
Promise<EventPage>
an EventPage: the events found (newest-first) plus a
cursor — the oldest checkpoint scanned — to pass back as end on the
next call. Page until cursor is null to reach start.
getFinalizedCheckpoint()
getFinalizedCheckpoint(): Promise<Checkpoint>;
Defined in: packages/overcast-core/src/indexer/client.ts:107
The head at the chain's finality commitment — the newest checkpoint that is settled and can no longer be reorged away. Always at or behind getLatestCheckpoint. Drives the finalization loop, which re-sweeps the range up to this point so the store converges on the canonical chain even if the live tail folded a confirmed-but-later-dropped transaction (or missed one on a failed tick).
Returns
Promise<Checkpoint>
getLatestCheckpoint()
getLatestCheckpoint(): Promise<Checkpoint>;
Defined in: packages/overcast-core/src/indexer/client.ts:97
The current chain head at the live commitment (confirmed, latest slot, etc.) — a blockheight, slot or state_version, anything that identifies the current ledger state as a checkpoint. Drives the low-latency live tail.
Returns
Promise<Checkpoint>
getTransactionInfo()
getTransactionInfo(hash): Promise<unknown>;
Defined in: packages/overcast-core/src/indexer/client.ts:90
Parameters
| Parameter | Type | Description |
|---|---|---|
hash | string | the transaction hash |
Returns
Promise<unknown>
the chain's parsed detail for the transaction, or null if not found