Class BaseEntityFetcher<RE>`Abstract`

The main class of the fetcher service.

Type Parameters

RE extends RawEntity

Hierarchy

BaseEntityFetcher

Constructors

constructor

new BaseEntityFetcher<RE>(type: IndexableEntityType, blockchainId: Blockchain, broker: ServiceBroker, pendingEntityDAL: PendingEntityStorage, pendingEntityCacheDAL: PendingEntityStorage, pendingEntityFetchDAL: PendingEntityStorage, entityCacheDAL: EntityStorage<RE>): BaseEntityFetcher<RE>
Initialize the fetcher service.
Type Parameters
- RE extends RawEntity
Parameters
- type: IndexableEntityType
- blockchainId: Blockchain
- broker: ServiceBroker
  
  The moleculer broker to assign to the service.
- pendingEntityDAL: PendingEntityStorage
  
  The pending entities' storage.
- pendingEntityCacheDAL: PendingEntityStorage
- pendingEntityFetchDAL: PendingEntityStorage
- entityCacheDAL: EntityStorage<RE>
  
  The raw entities' storage.
Returns BaseEntityFetcher<RE>
- Defined in packages/framework/src/services/fetcher/src/entityFetcher.ts:42

Properties

`Protected` blockchainId

blockchainId: Blockchain

`Protected` broker

broker: ServiceBroker

The moleculer broker to assign to the service.

`Protected` entityCacheDAL

entityCacheDAL: EntityStorage<RE>

The raw entities' storage.

`Protected` pendingEntities

pendingEntities: PendingWorkPool<string[]>

`Protected` pendingEntitiesCache

pendingEntitiesCache: PendingWorkPool<string[]>

`Protected` pendingEntitiesFetch

pendingEntitiesFetch: PendingWorkPool<string[]>

`Protected` pendingEntityCacheDAL

pendingEntityCacheDAL: PendingEntityStorage

`Protected` pendingEntityDAL

pendingEntityDAL: PendingEntityStorage

The pending entities' storage.

`Protected` pendingEntityFetchDAL

pendingEntityFetchDAL: PendingEntityStorage

`Protected` throughput

throughput: number = 0

`Protected` throughputInit

throughputInit: number = ...

`Protected` type

type: IndexableEntityType

Methods

`Protected` addThroughput

addThroughput(count: number): void
Used to improve performance.
Parameters
- count: number
  
  Entitys counter.
Returns void
- Defined in packages/framework/src/services/fetcher/src/entityFetcher.ts:268

delEntityCache

delEntityCache(args: DelEntityRequestArgs): Promise<void>
Delete the cached entity.
Parameters
- args: DelEntityRequestArgs
  
  The txn ids to delete the cache for.
Returns Promise<void>
- Defined in packages/framework/src/services/fetcher/src/entityFetcher.ts:345

`Protected` emitEntities

emitEntities(entities: RawEntityMsg<RE>[]): Promise<void>
Emit entities to the parser.
Parameters
- entities: RawEntityMsg<RE>[]
  
  Raw entities.
Returns Promise<void>
- Defined in packages/framework/src/services/fetcher/src/entityFetcher.ts:287

fetchEntitiesById

fetchEntitiesById(args: FetchEntitiesByIdRequestArgs): Promise<void>
Fetch entities from an account by ids.
Parameters
- args: FetchEntitiesByIdRequestArgs
  
  Entity ids.
Returns Promise<void>
- Defined in packages/framework/src/services/fetcher/src/entityFetcher.ts:110

`Protected` fetchIds

fetchIds(works: PendingWork<string[]>[], isRetry?: boolean): Promise<[RawEntityMsg<RE>[], PendingWork<string[]>[]]>
Parameters
- works: PendingWork<string[]>[]
- isRetry: boolean = false
Returns Promise<[RawEntityMsg<RE>[], PendingWork<string[]>[]]>
- Defined in packages/framework/src/services/fetcher/src/entityFetcher.ts:233

`Protected` `Abstract` filterEntityId

filterEntityId(id: string): boolean
Guard to validate an id.
Parameters
- id: string
  
  Id to validate.
Returns boolean
- Defined in packages/framework/src/services/fetcher/src/entityFetcher.ts:371

getEntityState

getEntityState(args: CheckEntityRequestArgs): Promise<EntityState[]>
Returns the fetch status of certain txn signatures.
Parameters
- args: CheckEntityRequestArgs
Returns Promise<EntityState[]>
- Defined in packages/framework/src/services/fetcher/src/entityFetcher.ts:307

getState

getState(): Promise<EntityFetcherState>
Returns Promise<EntityFetcherState>
- Defined in packages/framework/src/services/fetcher/src/entityFetcher.ts:95

`Protected` handlePendingEntities

handlePendingEntities(works: PendingWork<string[]>[]): Promise<void>
Fetch entities from ids.
Parameters
- works: PendingWork<string[]>[]
  
  Entity ids with extra properties as time and payload.
Returns Promise<void>
- Defined in packages/framework/src/services/fetcher/src/entityFetcher.ts:130

`Protected` handlePendingEntitiesCache

handlePendingEntitiesCache(works: PendingWork<string[]>[]): Promise<void>
Parameters
- works: PendingWork<string[]>[]
Returns Promise<void>
- Defined in packages/framework/src/services/fetcher/src/entityFetcher.ts:162

`Protected` handlePendingEntitiesFetch

handlePendingEntitiesFetch(works: PendingWork<string[]>[]): Promise<number | void>
Parameters
- works: PendingWork<string[]>[]
Returns Promise<number | void>
- Defined in packages/framework/src/services/fetcher/src/entityFetcher.ts:182

`Protected` log

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

`Protected` `Abstract` remoteFetchIds

remoteFetchIds(ids: string[], isRetry: boolean): Promise<(undefined | null | RE)[]>
Fetch entities from a RPC Node.
Parameters
- ids: string[]
- isRetry: boolean
Returns Promise<(undefined | null | RE)[]>
- Defined in packages/framework/src/services/fetcher/src/entityFetcher.ts:362

start

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

stop

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

Class BaseEntityFetcher<RE>Abstract

Type Parameters

RE extends RawEntity

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

RE extends RawEntity

Parameters

type: IndexableEntityType

blockchainId: Blockchain

broker: ServiceBroker

pendingEntityDAL: PendingEntityStorage

pendingEntityCacheDAL: PendingEntityStorage

pendingEntityFetchDAL: PendingEntityStorage

entityCacheDAL: EntityStorage<RE>

Returns BaseEntityFetcher<RE>

Properties

Protected blockchainId

Protected broker

Protected entityCacheDAL

Protected pendingEntities

Protected pendingEntitiesCache

Protected pendingEntitiesFetch

Protected pendingEntityCacheDAL

Protected pendingEntityDAL

Protected pendingEntityFetchDAL

Protected throughput

Protected throughputInit

Protected type

Methods

Protected addThroughput

Parameters

count: number

Returns void

delEntityCache

Parameters

args: DelEntityRequestArgs

Returns Promise<void>

Protected emitEntities

Parameters

entities: RawEntityMsg<RE>[]

Returns Promise<void>

fetchEntitiesById

Parameters

args: FetchEntitiesByIdRequestArgs

Returns Promise<void>

Protected fetchIds

Parameters

works: PendingWork<string[]>[]

isRetry: boolean = false

Returns Promise<[RawEntityMsg<RE>[], PendingWork<string[]>[]]>

Protected Abstract filterEntityId

Parameters

id: string

Returns boolean

getEntityState

Parameters

args: CheckEntityRequestArgs

Returns Promise<EntityState[]>

getState

Returns Promise<EntityFetcherState>

Protected handlePendingEntities

Parameters

works: PendingWork<string[]>[]

Returns Promise<void>

Protected handlePendingEntitiesCache

Parameters

works: PendingWork<string[]>[]

Returns Promise<void>

Protected handlePendingEntitiesFetch

Parameters

works: PendingWork<string[]>[]

Returns Promise<number | void>

Protected log

Parameters

Class BaseEntityFetcher<RE>`Abstract`

`Protected` blockchainId

`Protected` broker

`Protected` entityCacheDAL

`Protected` pendingEntities

`Protected` pendingEntitiesCache

`Protected` pendingEntitiesFetch

`Protected` pendingEntityCacheDAL

`Protected` pendingEntityDAL

`Protected` pendingEntityFetchDAL

`Protected` throughput

`Protected` throughputInit

`Protected` type

`Protected` addThroughput

`Protected` emitEntities

`Protected` fetchIds

`Protected` `Abstract` filterEntityId

`Protected` handlePendingEntities

`Protected` handlePendingEntitiesCache

`Protected` handlePendingEntitiesFetch

`Protected` log

`Rest` ...msgs: any[]

`Protected` `Abstract` remoteFetchIds