Skip to main content

Class: OvercastIndexer

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

Drives the store off the chain through three modes. Each is a step that supervise runs in a loop:

backfill: scans history once, from the head down to genesis, as finalized. live: tails the live head as live (still reorgable). finalized: tails the finalized head as finalized (canonical).

All scanning runs backwards (the chain pages newest first), so a tail is a sweep bounded below by its stored cursor. Inserts are idempotent and each mode persists its own cursor, so a crash resumes without gaps or dupes.

Constructors​

Constructor​

new OvercastIndexer(
   client, 
   storage, 
   startCheckpoint?, 
   domain, 
   chunkSize?, 
   pollIntervalMs?): OvercastIndexer;

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

Parameters​

ParameterTypeDefault value
clientOvercastIndexerClientundefined
storageOvercastStoreundefined
startCheckpointCheckpoint | nullnull
domainnumberundefined
chunkSizenumber10
pollIntervalMsnumber500

Returns​

OvercastIndexer

Properties​

chunkSize​

chunkSize: number;

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

domain​

readonly domain: number;

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

indexer​

indexer: OvercastIndexerClient;

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

pollIntervalMs​

pollIntervalMs: number;

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

Pause between successive chain requests, in ms.

startCheckpoint​

startCheckpoint: Checkpoint | null;

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

Floor of the backwards search, normally genesis (null).

storage​

storage: OvercastStore;

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

Methods​

start()​

start(): Promise<void>;

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

Starts every mode and keeps indexing regardless of failures.

Returns​

Promise<void>