Class BaseIndexerEntityFetcher<T>`Abstract`

Type Parameters

T extends ParsedEntity<unknown>

Hierarchy

BaseIndexerEntityFetcher

Constructors

constructor

new BaseIndexerEntityFetcher<T>(type: IndexableEntityType, blockchainId: Blockchain, fetcherMsClient: FetcherMsClient, entityRequestDAL: EntityRequestStorage, entityRequestIncomingEntityDAL: EntityRequestIncomingEntityStorage<T>, entityRequestPendingEntityDAL: EntityRequestPendingEntityStorage, entityRequestResponseDAL: EntityRequestResponseStorage<T>, nonce?: NonceTimestamp): BaseIndexerEntityFetcher<T>
Type Parameters
- T extends ParsedEntity<unknown>
Parameters
- type: IndexableEntityType
- blockchainId: Blockchain
- fetcherMsClient: FetcherMsClient
- entityRequestDAL: EntityRequestStorage
- entityRequestIncomingEntityDAL: EntityRequestIncomingEntityStorage<T>
- entityRequestPendingEntityDAL: EntityRequestPendingEntityStorage
- entityRequestResponseDAL: EntityRequestResponseStorage<T>
- nonce: NonceTimestamp = ...
Returns BaseIndexerEntityFetcher<T>
- Defined in packages/framework/src/services/indexer/src/entityFetcher.ts:66

Properties

`Protected` blockchainId

blockchainId: Blockchain

`Protected` checkCompletionJob

checkCompletionJob: DebouncedJob<void, unknown>

`Protected` checkPendingRetriesJob

checkPendingRetriesJob: JobRunner

`Protected` entityRequestDAL

entityRequestDAL: EntityRequestStorage

`Protected` entityRequestIncomingEntityDAL

entityRequestIncomingEntityDAL: EntityRequestIncomingEntityStorage<T>

`Protected` entityRequestPendingEntityDAL

entityRequestPendingEntityDAL: EntityRequestPendingEntityStorage

`Protected` entityRequestResponseDAL

entityRequestResponseDAL: EntityRequestResponseStorage<T>

`Protected` events

events: EventEmitter = ...

`Protected` fetcherMsClient

fetcherMsClient: FetcherMsClient

`Protected` incomingEntities

incomingEntities: PendingWorkPool<T>

`Protected` nonce

nonce: NonceTimestamp = ...

`Protected` requestFutures

requestFutures: Record<number, Future<number>> = {}

`Protected` requestMutex

requestMutex: Mutex = ...

`Protected` toRemoveBuffer

toRemoveBuffer: BufferExec<EntityRequestPendingEntity>

`Protected` toRetryBuffer

toRetryBuffer: BufferExec<EntityRequestPendingEntity>

`Protected` type

type: IndexableEntityType

Methods

awaitRequestComplete

awaitRequestComplete(nonce: number): Promise<void>
Parameters
- nonce: number
Returns Promise<void>
- Defined in packages/framework/src/services/indexer/src/entityFetcher.ts:197

`Protected` checkAllPendingSignatures

checkAllPendingSignatures(): Promise<void>
Returns Promise<void>
- Defined in packages/framework/src/services/indexer/src/entityFetcher.ts:487

`Protected` checkAllRequestCompletion

checkAllRequestCompletion(): Promise<void>
Returns Promise<void>
- Defined in packages/framework/src/services/indexer/src/entityFetcher.ts:438

`Protected` checkPendingSignatures

checkPendingSignatures(request: EntityRequest, drain?: boolean): Promise<void>
Parameters
- request: EntityRequest
- drain: boolean = true
Returns Promise<void>
- Defined in packages/framework/src/services/indexer/src/entityFetcher.ts:497

`Protected` checkRequestCompletion

checkRequestCompletion(request: EntityRequest): Promise<void>
Parameters
- request: EntityRequest
Returns Promise<void>
- Defined in packages/framework/src/services/indexer/src/entityFetcher.ts:446

`Protected` drainPendingSignaturesBuffer

drainPendingSignaturesBuffer(): Promise<void>
Returns Promise<void>
- Defined in packages/framework/src/services/indexer/src/entityFetcher.ts:532

fetchAccountEntitiesByDate

fetchAccountEntitiesByDate(params: AccountDateRange): Promise<number>
Parameters
- params: AccountDateRange
Returns Promise<number>
- Defined in packages/framework/src/services/indexer/src/entityFetcher.ts:124

fetchEntitiesById

fetchEntitiesById(params: IdRange): Promise<number>
Parameters
- params: IdRange
Returns Promise<number>
- Defined in packages/framework/src/services/indexer/src/entityFetcher.ts:117

`Protected` fetchEntityIds

fetchEntityIds(requestParams: EntityRequestParams): Promise<void | AsyncIterable<string[]> | string[][]>
Parameters
- requestParams: EntityRequestParams
Returns Promise<void | AsyncIterable<string[]> | string[][]>
- Defined in packages/framework/src/services/indexer/src/entityFetcher.ts:415

`Protected` filterIncomingEntitiesByRequest

filterIncomingEntitiesByRequest(entities: T[], request: EntityRequest): {
filteredEntities: T[];
remainingEntities: T[];
}
Parameters
- entities: T[]
- request: EntityRequest
Returns {
filteredEntities: T[];
remainingEntities: T[];
}
- filteredEntities: T[]
- remainingEntities: T[]
- Defined in packages/framework/src/services/indexer/src/entityFetcher.ts:306

`Protected` getFuture

getFuture(nonce: number): Future<number>
Parameters
- nonce: number
Returns Future<number>
- Defined in packages/framework/src/services/indexer/src/entityFetcher.ts:542

getRequests

getRequests(filters?: GetEntityPendingRequestsRequestArgs): Promise<EntityRequest[]>
Parameters
- Optional filters: GetEntityPendingRequestsRequestArgs
Returns Promise<EntityRequest[]>
- Defined in packages/framework/src/services/indexer/src/entityFetcher.ts:139

getResponse

getResponse(nonce: number): Promise<TransactionResponse<T>>
Parameters
- nonce: number
Returns Promise<TransactionResponse<T>>
- Defined in packages/framework/src/services/indexer/src/entityFetcher.ts:206

`Protected` handleEntityRequest

handleEntityRequest(requestParams: EntityRequestParams, waitForResponse?: boolean): Promise<number>
Parameters
- requestParams: EntityRequestParams
- waitForResponse: boolean = false
Returns Promise<number>
- Defined in packages/framework/src/services/indexer/src/entityFetcher.ts:342

`Protected` handleIncomingEntities

handleIncomingEntities(works: PendingWork<T>[]): Promise<number | void>
Parameters
- works: PendingWork<T>[]
Returns Promise<number | void>
- Defined in packages/framework/src/services/indexer/src/entityFetcher.ts:241

`Protected` handlePendingRetries

handlePendingRetries(): Promise<void>
Returns Promise<void>
- Defined in packages/framework/src/services/indexer/src/entityFetcher.ts:537

`Protected` handleRemovePendingTransactions

handleRemovePendingTransactions(pendings: EntityRequestPendingEntity[]): Promise<void>
Parameters
- pendings: EntityRequestPendingEntity[]
Returns Promise<void>
- Defined in packages/framework/src/services/indexer/src/entityFetcher.ts:574

`Protected` handleRetryPendingEntities

handleRetryPendingEntities(pendings: EntityRequestPendingEntity[]): Promise<void>
Parameters
- pendings: EntityRequestPendingEntity[]
Returns Promise<void>
- Defined in packages/framework/src/services/indexer/src/entityFetcher.ts:562

isRequestComplete

isRequestComplete(nonce: number): Promise<boolean>
Parameters
- nonce: number
Returns Promise<boolean>
- Defined in packages/framework/src/services/indexer/src/entityFetcher.ts:190

`Protected` log

log(...msgs: any[]): void
Parameters
- Rest ...msgs: any[]
Returns void
- Defined in packages/framework/src/services/indexer/src/entityFetcher.ts:581

offResponse

offResponse(handler: ((nonce: number) => void)): void
Parameters
- handler: ((nonce: number) => void)
  - - (nonce: number): void
    - Parameters
      
      nonce: number
      
      Returns void
Returns void
- Defined in packages/framework/src/services/indexer/src/entityFetcher.ts:135

onEntities

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

onResponse

onResponse(handler: ((nonce: number) => void)): void
Parameters
- handler: ((nonce: number) => void)
  - - (nonce: number): void
    - Parameters
      
      nonce: number
      
      Returns void
Returns void
- Defined in packages/framework/src/services/indexer/src/entityFetcher.ts:131

`Protected` resolveFuture

resolveFuture(nonce: number): void
Parameters
- nonce: number
Returns void
- Defined in packages/framework/src/services/indexer/src/entityFetcher.ts:553

start

start(): Promise<void>
Returns Promise<void>
- Defined in packages/framework/src/services/indexer/src/entityFetcher.ts:107

stop

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

`Protected` storeIncomingEntities

storeIncomingEntities(chunk: T[]): Promise<void>
Parameters
- chunk: T[]
Returns Promise<void>
- Defined in packages/framework/src/services/indexer/src/entityFetcher.ts:231

Class BaseIndexerEntityFetcher<T>Abstract

Type Parameters

T extends ParsedEntity<unknown>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T extends ParsedEntity<unknown>

Parameters

type: IndexableEntityType

blockchainId: Blockchain

fetcherMsClient: FetcherMsClient

entityRequestDAL: EntityRequestStorage

entityRequestIncomingEntityDAL: EntityRequestIncomingEntityStorage<T>

entityRequestPendingEntityDAL: EntityRequestPendingEntityStorage

entityRequestResponseDAL: EntityRequestResponseStorage<T>

nonce: NonceTimestamp = ...

Returns BaseIndexerEntityFetcher<T>

Properties

Protected blockchainId

Protected checkCompletionJob

Protected checkPendingRetriesJob

Protected entityRequestDAL

Protected entityRequestIncomingEntityDAL

Protected entityRequestPendingEntityDAL

Protected entityRequestResponseDAL

Protected events

Protected fetcherMsClient

Protected incomingEntities

Protected nonce

Protected requestFutures

Protected requestMutex

Protected toRemoveBuffer

Protected toRetryBuffer

Protected type

Methods

awaitRequestComplete

Parameters

nonce: number

Returns Promise<void>

Protected checkAllPendingSignatures

Returns Promise<void>

Protected checkAllRequestCompletion

Returns Promise<void>

Protected checkPendingSignatures

Parameters

request: EntityRequest

drain: boolean = true

Returns Promise<void>

Protected checkRequestCompletion

Parameters

request: EntityRequest

Returns Promise<void>

Protected drainPendingSignaturesBuffer

Returns Promise<void>

fetchAccountEntitiesByDate

Parameters

params: AccountDateRange

Returns Promise<number>

fetchEntitiesById

Parameters

params: IdRange

Returns Promise<number>

Protected fetchEntityIds

Parameters

requestParams: EntityRequestParams

Returns Promise<void | AsyncIterable<string[]> | string[][]>

Protected filterIncomingEntitiesByRequest

Parameters

entities: T[]

request: EntityRequest

Returns { filteredEntities: T[]; remainingEntities: T[]; }

filteredEntities: T[]

remainingEntities: T[]

Protected getFuture

Parameters

Class BaseIndexerEntityFetcher<T>`Abstract`

`Protected` blockchainId

`Protected` checkCompletionJob

`Protected` checkPendingRetriesJob

`Protected` entityRequestDAL

`Protected` entityRequestIncomingEntityDAL

`Protected` entityRequestPendingEntityDAL

`Protected` entityRequestResponseDAL

`Protected` events

`Protected` fetcherMsClient

`Protected` incomingEntities

`Protected` nonce

`Protected` requestFutures

`Protected` requestMutex

`Protected` toRemoveBuffer

`Protected` toRetryBuffer

`Protected` type

`Protected` checkAllPendingSignatures

`Protected` checkAllRequestCompletion

`Protected` checkPendingSignatures

`Protected` checkRequestCompletion

`Protected` drainPendingSignaturesBuffer

`Protected` fetchEntityIds

`Protected` filterIncomingEntitiesByRequest

Returns {
filteredEntities: T[];
remainingEntities: T[];
}

`Protected` getFuture

`Optional` filters: GetEntityPendingRequestsRequestArgs

`Protected` handleEntityRequest

`Protected` handleIncomingEntities

`Protected` handlePendingRetries

`Protected` handleRemovePendingTransactions

`Protected` handleRetryPendingEntities

`Protected` log

`Rest` ...msgs: any[]

`Protected` resolveFuture

`Protected` storeIncomingEntities