Class BaseEntityIndexer<PE>

Type Parameters

PE extends ParsedEntity<unknown> = ParsedEntity<unknown>

Hierarchy

BaseEntityIndexer

Index

Constructors

Properties

accountIndexers blockchainId domain entityFetcher entityHandler entityIndexerStateDAL fetcherClient indexerClient parserClient type

Methods

addAccount delAccount getAccountState getEntityPendingRequests mapWithIndexerId onEntities start stop

Constructors

constructor

new BaseEntityIndexer<PE>(type: IndexableEntityType, blockchainId: Blockchain, domain: IndexerWorkerDomainI, indexerClient: IndexerMsClient, fetcherClient: FetcherMsClient, parserClient: ParserMsClient, entityIndexerStateDAL: EntityIndexerStateStorage, entityFetcher: BaseIndexerEntityFetcher<PE>): BaseEntityIndexer<PE>
Type Parameters
- PE extends ParsedEntity<unknown> = ParsedEntity<unknown>
Parameters
- type: IndexableEntityType
- blockchainId: Blockchain
  
  The blockchain identifier.
- domain: IndexerWorkerDomainI
- indexerClient: IndexerMsClient
  
  Allows communication with the sibling indexer instances.
- fetcherClient: FetcherMsClient
  
  Allows communication with the fetcher service.
- parserClient: ParserMsClient
  
  Allows communication with the parser service.
- entityIndexerStateDAL: EntityIndexerStateStorage
  
  Stores the entity indexer state.
- entityFetcher: BaseIndexerEntityFetcher<PE>
  
  Fetches actual entity data by their signatures.
Returns BaseEntityIndexer<PE>
- Defined in packages/framework/src/services/indexer/src/entityIndexer.ts:35

Properties

`Protected` accountIndexers

accountIndexers: Record<string, BaseAccountEntityIndexer<PE>> = {}

`Protected` blockchainId

blockchainId: Blockchain

The blockchain identifier.

`Protected` domain

domain: IndexerWorkerDomainI

`Protected` entityFetcher

entityFetcher: BaseIndexerEntityFetcher<PE>

Fetches actual entity data by their signatures.

`Protected` entityHandler

entityHandler: ((chunk: PE[]) => Promise<void>)

Type declaration

- (chunk: PE[]): Promise<void>
- Parameters
  - chunk: PE[]
  Returns Promise<void>

`Protected` entityIndexerStateDAL

entityIndexerStateDAL: EntityIndexerStateStorage

Stores the entity indexer state.

`Protected` fetcherClient

fetcherClient: FetcherMsClient

Allows communication with the fetcher service.

`Protected` indexerClient

indexerClient: IndexerMsClient

Allows communication with the sibling indexer instances.

`Protected` parserClient

parserClient: ParserMsClient

Allows communication with the parser service.

`Protected` type

type: IndexableEntityType

Methods

addAccount

addAccount(args: AccountIndexerEntityRequestArgs): Promise<void>
Parameters
- args: AccountIndexerEntityRequestArgs
Returns Promise<void>
- Defined in packages/framework/src/services/indexer/src/entityIndexer.ts:74

delAccount

delAccount(account: string): Promise<void>
Parameters
- account: string
Returns Promise<void>
- Defined in packages/framework/src/services/indexer/src/entityIndexer.ts:93

getAccountState

getAccountState(args: GetAccountIndexingEntityStateRequestArgs): Promise<undefined | AccountEntityIndexerState>
Parameters
- args: GetAccountIndexingEntityStateRequestArgs
Returns Promise<undefined | AccountEntityIndexerState>
- Defined in packages/framework/src/services/indexer/src/entityIndexer.ts:102

getEntityPendingRequests

getEntityPendingRequests(filters: GetEntityPendingRequestsRequestArgs): Promise<EntityRequest[]>
Parameters
- filters: GetEntityPendingRequestsRequestArgs
Returns Promise<EntityRequest[]>
- Defined in packages/framework/src/services/indexer/src/entityIndexer.ts:117

`Protected` mapWithIndexerId

mapWithIndexerId<T>(items: T[]): T[]
Type Parameters
- T
Parameters
- items: T[]
Returns T[]
- Defined in packages/framework/src/services/indexer/src/entityIndexer.ts:131

`Protected` onEntities

onEntities(chunk: PE[]): Promise<void>
Parameters
- chunk: PE[]
Returns Promise<void>
- Defined in packages/framework/src/services/indexer/src/entityIndexer.ts:124

start

start(): Promise<void>
Waits for the fetchers and parsers to be ready. Registers the onEntities event on the parser, such that it can parse ixns from the txns.

Returns Promise<void>
- Defined in packages/framework/src/services/indexer/src/entityIndexer.ts:53

stop

stop(): Promise<void>
Returns Promise<void>
- Defined in packages/framework/src/services/indexer/src/entityIndexer.ts:65

Generated using TypeDoc