Class EthereumLogFetcher

The main class of the fetcher service.

Hierarchy

BaseEntityFetcher<EthereumRawLog>
- EthereumLogFetcher

Constructors

constructor

new EthereumLogFetcher(ethereumClient: EthereumClient, broker: ServiceBroker, pendingLogDAL: PendingEntityStorage, pendingLogCacheDAL: PendingEntityStorage, pendingLogFetchDAL: PendingEntityStorage, rawLogDAL: EthereumRawLogStorage, blockchainId?: Blockchain): EthereumLogFetcher
Parameters
- ethereumClient: EthereumClient
- broker: ServiceBroker
- pendingLogDAL: PendingEntityStorage
- pendingLogCacheDAL: PendingEntityStorage
- pendingLogFetchDAL: PendingEntityStorage
- rawLogDAL: EthereumRawLogStorage
- blockchainId: Blockchain = Blockchain.Ethereum
Returns EthereumLogFetcher
Overrides BaseEntityFetcher<EthereumRawLog>.constructor
- Defined in packages/ethereum/src/services/fetcher/src/log/logFetcher.ts:16

Properties

`Protected` blockchainId

blockchainId: Blockchain = Blockchain.Ethereum

`Protected` broker

broker: ServiceBroker

`Protected` entityCacheDAL

entityCacheDAL: EntityStorage<EthereumRawLog>

`Protected` ethereumClient

ethereumClient: EthereumClient

`Protected` pendingEntities

pendingEntities: PendingWorkPool<string[]>

`Protected` pendingEntitiesCache

pendingEntitiesCache: PendingWorkPool<string[]>

`Protected` pendingEntitiesFetch

pendingEntitiesFetch: PendingWorkPool<string[]>

`Protected` pendingEntityCacheDAL

pendingEntityCacheDAL: PendingEntityStorage

`Protected` pendingEntityDAL

pendingEntityDAL: PendingEntityStorage

`Protected` pendingEntityFetchDAL

pendingEntityFetchDAL: PendingEntityStorage

`Protected` pendingLogCacheDAL

pendingLogCacheDAL: PendingEntityStorage

`Protected` pendingLogDAL

pendingLogDAL: PendingEntityStorage

`Protected` pendingLogFetchDAL

pendingLogFetchDAL: PendingEntityStorage

`Protected` rawLogDAL

rawLogDAL: EthereumRawLogStorage

`Protected` throughput

throughput: number

`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
Inherited from BaseEntityFetcher.addThroughput
- Defined in packages/framework/dist/src/services/fetcher/src/entityFetcher.d.ts:52

delEntityCache

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

`Protected` emitEntities

emitEntities(entities: RawEntityMsg<EthereumRawLog>[]): Promise<void>
Emit entities to the parser.
Parameters
- entities: RawEntityMsg<EthereumRawLog>[]
  
  Raw entities.
Returns Promise<void>
Inherited from BaseEntityFetcher.emitEntities
- Defined in packages/framework/dist/src/services/fetcher/src/entityFetcher.d.ts:57

fetchEntitiesById

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

`Protected` fetchIds

fetchIds(works: PendingWork<string[]>[], isRetry?: boolean): Promise<[RawEntityMsg<EthereumRawLog>[], PendingWork<string[]>[]]>
Parameters
- works: PendingWork<string[]>[]
- Optional isRetry: boolean
Returns Promise<[RawEntityMsg<EthereumRawLog>[], PendingWork<string[]>[]]>
Inherited from BaseEntityFetcher.fetchIds
- Defined in packages/framework/dist/src/services/fetcher/src/entityFetcher.d.ts:47

`Protected` filterEntityId

filterEntityId(id: string): boolean
Parameters
- id: string
Returns boolean
Overrides BaseEntityFetcher.filterEntityId
- Defined in packages/ethereum/src/services/fetcher/src/log/logFetcher.ts:36

getEntityState

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

getState

getState(): Promise<EntityFetcherState>
Returns Promise<EntityFetcherState>
Inherited from BaseEntityFetcher.getState
- Defined in packages/framework/dist/src/services/fetcher/src/entityFetcher.d.ts:34

`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>
Inherited from BaseEntityFetcher.handlePendingEntities
- Defined in packages/framework/dist/src/services/fetcher/src/entityFetcher.d.ts:44

`Protected` handlePendingEntitiesCache

handlePendingEntitiesCache(works: PendingWork<string[]>[]): Promise<void>
Parameters
- works: PendingWork<string[]>[]
Returns Promise<void>
Inherited from BaseEntityFetcher.handlePendingEntitiesCache
- Defined in packages/framework/dist/src/services/fetcher/src/entityFetcher.d.ts:45

`Protected` handlePendingEntitiesFetch

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

`Protected` log

log(...msgs: any[]): void
Parameters
- Rest ...msgs: any[]
Returns void
Inherited from BaseEntityFetcher.log
- Defined in packages/framework/dist/src/services/fetcher/src/entityFetcher.d.ts:68

`Protected` remoteFetchIds

remoteFetchIds(ids: string[], isRetry: boolean): Promise<(undefined | null | EthereumRawLog)[]>
Parameters
- ids: string[]
- isRetry: boolean
Returns Promise<(undefined | null | EthereumRawLog)[]>
Overrides BaseEntityFetcher.remoteFetchIds
- Defined in packages/ethereum/src/services/fetcher/src/log/logFetcher.ts:41

start

start(): Promise<void>
Returns Promise<void>
Inherited from BaseEntityFetcher.start
- Defined in packages/framework/dist/src/services/fetcher/src/entityFetcher.d.ts:32

stop

stop(): Promise<void>
Returns Promise<void>
Inherited from BaseEntityFetcher.stop
- Defined in packages/framework/dist/src/services/fetcher/src/entityFetcher.d.ts:33

Class EthereumLogFetcher

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

ethereumClient: EthereumClient

broker: ServiceBroker

pendingLogDAL: PendingEntityStorage

pendingLogCacheDAL: PendingEntityStorage

pendingLogFetchDAL: PendingEntityStorage

rawLogDAL: EthereumRawLogStorage

blockchainId: Blockchain = Blockchain.Ethereum

Returns EthereumLogFetcher

Properties

Protected blockchainId

Protected broker

Protected entityCacheDAL

Protected ethereumClient

Protected pendingEntities

Protected pendingEntitiesCache

Protected pendingEntitiesFetch

Protected pendingEntityCacheDAL

Protected pendingEntityDAL

Protected pendingEntityFetchDAL

Protected pendingLogCacheDAL

Protected pendingLogDAL

Protected pendingLogFetchDAL

Protected rawLogDAL

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<EthereumRawLog>[]

Returns Promise<void>

fetchEntitiesById

Parameters

args: FetchEntitiesByIdRequestArgs

Returns Promise<void>

Protected fetchIds

Parameters

works: PendingWork<string[]>[]

Optional isRetry: boolean

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

Protected 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

`Protected` blockchainId

`Protected` broker

`Protected` entityCacheDAL

`Protected` ethereumClient

`Protected` pendingEntities

`Protected` pendingEntitiesCache

`Protected` pendingEntitiesFetch

`Protected` pendingEntityCacheDAL

`Protected` pendingEntityDAL

`Protected` pendingEntityFetchDAL

`Protected` pendingLogCacheDAL

`Protected` pendingLogDAL

`Protected` pendingLogFetchDAL

`Protected` rawLogDAL

`Protected` throughput

`Protected` throughputInit

`Protected` type

`Protected` addThroughput

`Protected` emitEntities

`Protected` fetchIds

`Optional` isRetry: boolean

`Protected` filterEntityId

`Protected` handlePendingEntities

`Protected` handlePendingEntitiesCache

`Protected` handlePendingEntitiesFetch

`Protected` log

`Rest` ...msgs: any[]

`Protected` remoteFetchIds