Main Navigation Home Getting Started Browser apps API

Appearance

Sidebar Navigation

Guide

Getting Started

Indexing in a browser app

API

@etherfold/browser

Classes

HostSettingsConflictError

IndexerHostDiedError

IndexerPortClosedError

NoTabProviderError

ProcessorBundleRefusedError

UnclonableValueError

Interfaces

IndexerGeneration

Type Aliases

AllContractData

ArgumentFilter

BrowserGenerationRegistryOptions

BrowserGenerationSpec

BrowserPublicationOptions

BrowserStateStoreConfig

BrowserStateStoreFactory

BrowserStreamSeedOptions

ConnectOutcome

ContractData

CrossTabStateStorage

DemotableWriter

Demotion

DemotionReason

EntityEventProcessorLike

ErrorCode

EventBlock

EventProcessor

ExistingStream

ExtendedLastSync

FilterRule

ForegroundTakeover

GenerationContext

GenerationProgress

HostAccess

HostDeath

HostDeathCause

HostedIndexerSpec

HostGeneration

HostHotUpdate

HostingShape

HostProgress

HostQueryContext

HostQueryHandler

HostQueryOptions

HostReconfigure

HostRestartOptions

HostSettingName

HostSettings

HostWatchOptions

HotUpdatableIndexer

HotUpdateGeneration

IndexerConnectOptions

IndexerHost

IndexerPort

IndexerPortOptions

IndexerProvider

IndexingSource

InstantiatedProcessorBundle

LastSync

LoadingState

LoadProcessorBundleOptions

LogEvent

LogParseConfig

MessageEndpoint

NotInstalledReason

PortCaseName

PortCases

PortError

PortPush

PortPushes

PortPushName

PortPushValue

PortRequest

PortRequestPayload

PortResponse

PortResponseValue

PortRow

PortStateReads

PortWithProgress

PortWithReads

ProcessorBundleLocation

ProcessorBundleOutcome

ProcessorBundlePolicyViolation

ProcessorBundleRefusalReason

ProcessorBundleSource

ProgressReadable

ProvidedIndexerConfig

ProvidedStreamConfig

PublicationIndex

PublicationRefusalReason

PublicationSnapshot

PublicationState

PublishedStateSnapshot

PublishedStreamSeed

ReaderState

ReadPublication

ReconfigureReport

RefusedProcessorBundle

SnapshotSwitchReason

StateMovedAcrossTabs

StatusState

StoredEventBlock

StoredLastSync

StoredLogEvent

StreamFetcher

StreamSeedDirection

StreamSeedLocation

StreamSeedState

SyncingState

SyncPhase

TabElection

TabElectionRole

TabElectionState

TabVisibility

TakeoverReason

TxInclusionBasis

TxInclusionQuery

TxInclusionStatus

TxInclusionVerdict

UsedIndexerConfig

UsedPortOptions

UsedStreamConfig

Variables

BROWSER_GENERATION_CAPS

DEFAULT_CATCH_UP_WITHIN_SECONDS

DEFAULT_FOREGROUND_SETTLE_MS

DEFAULT_PRUNE_BUDGET

HOST_SETTING_NAMES

INDEXER_PORT_PROTOCOL

KEYVAL_DATABASE

KEYVAL_OBJECT_STORE

PORT_PUSH_SUBSCRIPTIONS

STATE_MOVED_CHANNEL_PROTOCOL

TAB_ELECTION_PROTOCOL

Functions

assertClonable

backoffFor

connectToIndexerHost

createBrowserStateStore

createIndexerState

createPortReadSurface

createProgressReadable

dedicatedWorkerHost

demoteToReader

errorFromPort

executionScopeName

generationAddress

generationRegistryPortOnIndexedDB

hostIndexerInThisSharedWorker

hostIndexerInThisWorker

isPortPush

isPortRequest

isPortResponse

keepStreamOnIndexedDB

keyvalStore

listen

loadProcessorBundle

openGenerationRegistryOnIndexedDB

openStateMovedAcrossTabs

portErrorOf

publishedSeedLocationsFor

publishedSnapshotFor

pushSubscribedBy

pushUnsubscribedBy

readPublicationIndex

reconfigureFromHotUpdate

resolvePortOptions

sameProgress

serveIndexerHost

sharedWorkerHost

simple_hash

stateMovedChannelName

streamAddress

streamSubtree

streamsUnder

tabElectionName

@etherfold/core

Classes

ArchiveRefusedError

CannotPauseFollowerError

CanonicalGenerationNotHeldError

FetchRangeBelowFinalityError

GenerationCapReachedError

GenerationInstantiationError

GenerationIsCanonicalError

GenerationRebuild

GenesisBlockNotServedError

GenesisCheckUnavailableError

GenesisHashMismatchError

Indexer

IndexerGeneration

IngestionRefusedError

IngestionUnavailableError

InvalidBatchError

LogFetcher

NoFetchProgressError

NoLiveReceiverError

OpenedSpecsDisplaceOneAnotherError

ReceivingIndexer

StateMovedPublisher

StreamBuilder

StreamHoleError

StreamWriter

SuspectedTruncationError

TimestamplessLogError

UnexpectedChainError

UnexpectedFromBlockError

UnexpectedProviderMethodError

UnheldGenerationError

UnknownGenerationError

UnknownStreamError

WireContextMismatchError

Interfaces

BaseError

Register

Type Aliases

Abi

AbiConstructor

AbiError

AbiEvent

AbiFallback

AbiFunction

AbiInternalType

AbiItemType

AbiParameter

AbiParameterKind

AbiParametersToPrimitiveTypes

AbiParameterToPrimitiveType

AbiReceive

AbiStateMutability

AbiType

AbiTypeToPrimitiveType

Address

AllContractData

AnyGenerationSpec

AppliedBlock

ArgumentFilter

BaseLogEvent

CaptureStreamOptions

ChainIdentityCheckPoint

ContextIdentifier

ContractData

CursorCorrection

DeclinedReclaim

DefaultRegister

DisplacementRuntime

EmissionAppender

EmissionWrite

EmittedLog

EngineProviderMethod

EventBlock

EventProcessor

ExistingStream

ExtractAbiError

ExtractAbiErrorNames

ExtractAbiErrors

ExtractAbiEvent

ExtractAbiEventNames

ExtractAbiEvents

ExtractAbiFunction

ExtractAbiFunctionNames

ExtractAbiFunctions

FetchConfig

FetchCycleOutcome

FetchedStream

FetcherLimits

FetchLike

FilterRule

FixtureBlock

FoldReport

FoldReporter

FrozenReason

GenerationCaps

GenerationContainer

GenerationContext

GenerationDeletion

GenerationFolding

GenerationId

GenerationRebuildOptions

GenerationRecord

GenerationRegistry

GenerationRegistryPort

GenerationRegistryState

GenerationRegistryWrite

GenerationSlots

GenerationSpec

HeldFold

HeldGeneration

HttpIngestionOptions

IncludedEIP1193Log

IndexerGenerationOptions

IndexerOptions

IndexingSource

IngestionAcknowledgement

IngestionOutcome

IngestionResponse

IngestionResult

IngestionTarget

InstantiateProcessorOptions

InvalidationReason

InvalidationVerdict

IsAbi

IsTypedData

LastSync

LearnedRange

LiveIngestions

LoadingState

LogEvent

LogEventWithParsingFailure

LogIngestion

LogParseConfig

LogParsedData

MethodDeclaringProvider

Narrow

NotInstalledReason

OutOfSpaceError

ParseAbi

ParseAbiItem

ParseAbiParameter

ParseAbiParameters

ParsedLogEvent

PauseState

ProcessorModule

PromotionConfig

PromotionOnAdd

PromotionPolicy

PromotionView

ProvidedIndexerConfig

ProvidedLearnedRange

ProvidedLogFetcherConfig

ProvidedStreamConfig

PublicationIndex

PublishedStateSnapshot

PublishedStreamSeed

RangedAbi

RangedAbiEvent

RebuildReport

RebuildStop

ReceivedGenerationSpec

ReceivingIndexerOptions

ReclaimedGeneration

ReclaimReport

ReconfigureArrival

ReconfigureOutcome

ReconfigureReport

RecordedReorg

ReorgCause

ReorgCounters

ReorgDetection

ReorgRecorder

ReplayChunk

ReplayChunkQuery

ReplayOptions

ReplayRead

ReplaySource

ResolvedRegister

ResolvedSuspectResultCount

Retraction

RetryableError

RetryPolicy

SegmentCommit

SlotAssignment

SlotName

SlottedGenerations

SolidityAddress

SolidityArray

SolidityArrayWithoutTuple

SolidityArrayWithTuple

SolidityBool

SolidityBytes

SolidityFixedArrayRange

SolidityFixedArraySizeLookup

SolidityFunction

SolidityInt

SolidityString

SolidityTuple

SourceHashEntry

SourceInvalidation

StateApplied

StateMoved

StateMovedDetach

StateMovedHandler

StateRepointed

StateRetracted

StoredEventBlock

StoredLastSync

StoredLogEvent

StoredSegment

StreamBuilderOptions

StreamClearer

StreamCoverage

StreamCursorRead

StreamCursorRecord

StreamCursorSource

StreamDeletion

StreamDelta

StreamFetcher

StreamFixture

StreamFixtureProvenance

StreamFixtureReader

StreamRead

StreamReader

StreamSaveDeclined

StreamSaver

StreamSeed

StreamSeedChain

StreamSeedCoverage

StreamSeedInstallOptions

StreamSeedInstallOutcome

StreamSeedLocation

StreamSeedProducer

StreamSeedProducerKind

StreamSegment

StreamSegmentPort

StreamWriteOutcome

StreamWriterOptions

SuccessorReplacementAtStart

SuspectResultCountSource

TxInclusionBasis

TxInclusionQuery

TxInclusionStatus

TxInclusionVerdict

TypedData

TypedDataDomain

TypedDataParameter

TypedDataToPrimitiveTypes

TypedDataType

UntypedWireBatch

UsedIndexerConfig

UsedPromotionConfig

UsedStreamConfig

WireBatch

WireContext

Variables

DEFAULT_FEED_BATCH_SIZE

DEFAULT_MAX_EMISSIONS_PER_CHUNK

DEFAULT_PROMOTION_POLICY

ENGINE_PROVIDER_METHODS

GENERATION_DIGEST_LENGTH

PROMOTION_POLICIES

PUBLICATION_INDEX_FORMAT

PUBLICATION_INDEX_NAME

REORG_COUNTER_KEY

REORG_LAST_KEY

SERVER_GENERATION_CAPS

SLOT_NAMES

STREAM_DIGEST_LENGTH

STREAM_FIXTURE_FORMAT

STREAM_SEED_FORMAT

Functions

assertWellFormed

blocksOf

canonical_form

captureStream

checkTxInclusion

coherenceToken

createDirectIngestion

createHttpIngestion

createMemoryGenerationRegistryPort

createSegmentedStream

cursorSyncedThrough

declaredMethodsOnly

displacedBySuccessor

fetcherOf

generationDigestOf

hasReachedCursor

installStreamSeed

instantiateProcessor

isEngineProviderMethod

isGenesisProbe

isOutOfSpace

isPublicationIndex

isRetryable

moduleReferencesOf

openGenerationRegistry

openIndexer

openMemoryGenerationRegistry

openReceivingIndexer

parseStreamFixture

parseStreamSeed

parseWireBatch

pinnedStreamSeedContentHash

processorArtifactIdentity

processorCodeFingerprint

promotionOnAdd

publishedBodyLocation

readOnlyStream

readyForPromotion

replayFixtureInto

replayStream

resolvePromotionConfig

resolveStreamConfig

retryCanAdvance

sameGeneration

sameWireContext

serializeStreamFixture

serializeStreamSeed

serializeWireBatch

simple_hash

slotHolding

storedEventOf

storedStreamOf

streamConfigHashOf

streamDigestOf

streamDigestOfSourceHashes

streamSeedContentHash

streamSeedPayloadOf

taggedBnReplacer

taggedBnReviver

unslottedGenerations

@etherfold/processor-entities

Classes

EntityEventProcessor

EntityStateView

RevertBeyondSnapshotError

SnapshotFormatError

SnapshotProcessorMismatchError

Interfaces

SnapshotAwareStateStore

StateStore

StateStoreBackend

WritableStateStore

Type Aliases

ArrivedProcessorBundle

AsOfAddress

BlockOfEvents

BlockPointer

BootstrapOptions

BootstrapOutcome

CursorWrite

EntityDeclaration

EntityEventProcessorOptions

EntityId

EntityIdOf

EntityPrefixOf

EntityProcessor

EntityReaderState

EntityReads

EntityRow

EnumField

EventHandlers

FieldDeclaration

FieldType

FieldValue

InputNames

InputValues

Mutation

MutationContext

NotBootstrappedReason

PruneOptions

PruneReport

PublishedSnapshotForState

ReadSurface

Retention

RetentionSetting

SemanticField

SemanticTypeName

SnapshotDocument

SnapshotHead

SnapshotLocation

StateClaimPatience

StateFactories

StateFactoriesOptions

StateSnapshot

StateStoreCapabilities

Variables

ENTITY_SNAPSHOT_FORMAT

SYNC_CURSOR_KEY

syncedThrough

Functions

applyEventStream

blockPointer

bootstrapFromSnapshot

createReadSurface

createSnapshot

declareEntities

deserializeLastSync

forkPoint

fromEntityProcessor

groupByBlock

localPosition

openAndBootstrap

openForReading

openForWriting

openSnapshotAware

parseStoredCursor

readSnapshot

runBlockHandlers

serializeLastSync

stateFactoriesFrom

On this page

Documentation

Packages

@etherfold/browser
@etherfold/core
@etherfold/processor-entities

Pager

Next pageGetting Started

Documentation ​

Packages ​

Documentation

Packages