Skip to content

Documentation / @etherfold/browser / ProvidedIndexerConfig

Type Alias: ProvidedIndexerConfig<ABI> ​

ProvidedIndexerConfig<ABI> = object

Defined in: packages/core/dist/types.d.ts:667

Type Parameters ​

ABI ​

ABI extends Abi

Properties ​

feedBatchSize? ​

optional feedBatchSize?: number

Defined in: packages/core/dist/types.d.ts:670


fetch? ​

optional fetch?: FetchConfig

Defined in: packages/core/dist/types.d.ts:668


keepStream? ​

optional keepStream?: ExistingStream<ABI>

Defined in: packages/core/dist/types.d.ts:671


logLevel? ​

optional logLevel?: number

Defined in: packages/core/dist/types.d.ts:714


skipGenesisCheck? ​

optional skipGenesisCheck?: boolean

Defined in: packages/core/dist/types.d.ts:713

Skip the load-time GENESIS-HASH check, leaving eth_chainId as this deployment's whole identity guard.

The genesis check is the STRONGER of the two, because two chains can share a chain id and cannot share a genesis block, so turning it off is a real loss and not a tuning knob: a fork answering the right eth_chainId is then indexed as the chain it claims to be. It exists for the deployment that cannot pass it for reasons that are not about identity at all -- a node that does not serve block 0 (GenesisBlockNotServedError), or a private chain whose genesis hash nobody has written down.

Only has an effect where the source declares a genesisHash; with none declared there is no check to skip. It is a load-time safety gate belonging to the deployment rather than to the processor an author ships.


stream? ​

optional stream?: ProvidedStreamConfig

Defined in: packages/core/dist/types.d.ts:669


streamWriteRetry? ​

optional streamWriteRetry?: object

Defined in: packages/core/dist/types.d.ts:685

What the engine does about a cached-stream write that FAILS.

A failed write means the batch is NOT processed and the cursor does not move, so the next cycle re-derives the same delta and tries again: nothing is lost and the stream cannot fall behind the state. But a store can be PERMANENTLY unwritable (a quota, a private window, an evicted database), and retrying forever would leave an application showing stale data indefinitely because an OPTIONAL cache failed. So the retry is bounded and paced, and both numbers are here rather than in stream because stream is HASHED into the wire and cache identity -- a deployment that tuned its retry must not thereby invalidate its stream.

delaySeconds? ​

optional delaySeconds?: number

Seconds to wait after a failed write, so a driver looping to the tip cannot spin hot on a store that is refusing. Defaults to 1.

maxConsecutiveFailures? ​

optional maxConsecutiveFailures?: number

Consecutive failed writes before the cache is FROZEN and indexing carries on without it. Defaults to 3.