Class BaseEntityHistoryFetcher<CU, HE>`Abstract`

The main class of the fetcher service.

Type Parameters

CU
HE extends AccountEntityHistoryStorageEntity

Hierarchy

BaseEntityHistoryFetcher

Index

Constructors

constructor

new BaseEntityHistoryFetcher<CU, HE>(type: IndexableEntityType, blockchainId: Blockchain, fetcherClient: FetcherMsClient, accountDAL: PendingAccountStorage, accountEntityHistoryDAL: AccountEntityHistoryStorage<HE>, id?: string): BaseEntityHistoryFetcher<CU, HE>
Initialize the fetcher service.
Type Parameters
- CU
- HE extends AccountEntityHistoryStorageEntity
Parameters
- type: IndexableEntityType
- blockchainId: Blockchain
  
  The blockchain identifier.
- fetcherClient: FetcherMsClient
  
  The Fetcher ms client.
- accountDAL: PendingAccountStorage
  
  The account job storage.
- accountEntityHistoryDAL: AccountEntityHistoryStorage<HE>
- id: string = ...
Returns BaseEntityHistoryFetcher<CU, HE>
- Defined in packages/framework/src/services/fetcher/src/entityHistoryFetcher.ts:39

Properties

`Protected` accountDAL

accountDAL: PendingAccountStorage

The account job storage.

`Protected` accountEntityHistoryDAL

accountEntityHistoryDAL: AccountEntityHistoryStorage<HE>

`Protected` blockchainId

blockchainId: Blockchain

The blockchain identifier.

`Protected` fetcherClient

fetcherClient: FetcherMsClient

The Fetcher ms client.

`Protected` id

id: string = ...

`Protected` pendingAccounts

pendingAccounts: FetcherPool<string[]>

`Protected` type

type: IndexableEntityType

Methods

addAccount

addAccount(args: AddAccountEntityRequestArgs): Promise<void>
Assigns to a fetcher instance an account owned by the specific program and initializes it.
Parameters
- args: AddAccountEntityRequestArgs
  
  Account address to asign to the fetcher instance,
Returns Promise<void>
- Defined in packages/framework/src/services/fetcher/src/entityHistoryFetcher.ts:70

delAccount

delAccount(args: DelAccountEntityRequestArgs): Promise<void>
Stops the fetching process of that instance of the fetcher for that account.
Parameters
- args: DelAccountEntityRequestArgs
Returns Promise<void>
- Defined in packages/framework/src/services/fetcher/src/entityHistoryFetcher.ts:86

fetchAccountEntitiesByDate

fetchAccountEntitiesByDate(args: FetchAccountEntitiesByDateRequestArgs): Promise<void | AsyncIterable<string[]>>
Parameters
- args: FetchAccountEntitiesByDateRequestArgs
Returns Promise<void | AsyncIterable<string[]>>
- Defined in packages/framework/src/services/fetcher/src/entityHistoryFetcher.ts:108

`Protected` fetchAccountEntitiesByIdFromDateRange

fetchAccountEntitiesByIdFromDateRange(ids: string[], byDateArgs: FetchAccountEntitiesByDateRequestArgs): Promise<void>
Parameters
- ids: string[]
- byDateArgs: FetchAccountEntitiesByDateRequestArgs
Returns Promise<void>
- Defined in packages/framework/src/services/fetcher/src/entityHistoryFetcher.ts:142

`Protected` `Abstract` getAccountFetcher

getAccountFetcher(account: string): BaseHistoryFetcher<CU>
Parameters
- account: string
Returns BaseHistoryFetcher<CU>
- Defined in packages/framework/src/services/fetcher/src/entityHistoryFetcher.ts:191

`Abstract` getAccountState

getAccountState(args: GetAccountEntityStateRequestArgs): Promise<undefined | AccountEntityHistoryState<CU>>
Parameters
- args: GetAccountEntityStateRequestArgs
Returns Promise<undefined | AccountEntityHistoryState<CU>>
- Defined in packages/framework/src/services/fetcher/src/entityHistoryFetcher.ts:187

`Protected` getPartialAccountState

getPartialAccountState(args: GetAccountEntityStateRequestArgs): Promise<undefined | AccountEntityHistoryState<CU>>
Parameters
- args: GetAccountEntityStateRequestArgs
Returns Promise<undefined | AccountEntityHistoryState<CU>>
- Defined in packages/framework/src/services/fetcher/src/entityHistoryFetcher.ts:154

getState

getState(): Promise<AccountEntityHistoryFetcherState>
Returns Promise<AccountEntityHistoryFetcherState>
- Defined in packages/framework/src/services/fetcher/src/entityHistoryFetcher.ts:103

`Protected` queryEntitiesByDate

queryEntitiesByDate(args: FetchAccountEntitiesByDateRequestArgs): Promise<StorageStream<string, HE>>
Parameters
- args: FetchAccountEntitiesByDateRequestArgs
Returns Promise<StorageStream<string, HE>>
- Defined in packages/framework/src/services/fetcher/src/entityHistoryFetcher.ts:175

start

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

stop

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

Class BaseEntityHistoryFetcher<CU, HE>Abstract

Type Parameters

CU

HE extends AccountEntityHistoryStorageEntity

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

CU

HE extends AccountEntityHistoryStorageEntity

Parameters

type: IndexableEntityType

blockchainId: Blockchain

fetcherClient: FetcherMsClient

accountDAL: PendingAccountStorage

accountEntityHistoryDAL: AccountEntityHistoryStorage<HE>

id: string = ...

Returns BaseEntityHistoryFetcher<CU, HE>

Properties

Protected accountDAL

Protected accountEntityHistoryDAL

Protected blockchainId

Protected fetcherClient

Protected id

Protected pendingAccounts

Protected type

Methods

addAccount

Parameters

args: AddAccountEntityRequestArgs

Returns Promise<void>

delAccount

Parameters

args: DelAccountEntityRequestArgs

Returns Promise<void>

fetchAccountEntitiesByDate

Parameters

args: FetchAccountEntitiesByDateRequestArgs

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

Protected fetchAccountEntitiesByIdFromDateRange

Parameters

ids: string[]

byDateArgs: FetchAccountEntitiesByDateRequestArgs

Returns Promise<void>

Protected Abstract getAccountFetcher

Parameters

account: string

Returns BaseHistoryFetcher<CU>

Abstract getAccountState

Parameters

args: GetAccountEntityStateRequestArgs

Returns Promise<undefined | AccountEntityHistoryState<CU>>

Protected getPartialAccountState

Parameters

args: GetAccountEntityStateRequestArgs

Returns Promise<undefined | AccountEntityHistoryState<CU>>

getState

Returns Promise<AccountEntityHistoryFetcherState>

Protected queryEntitiesByDate

Parameters

args: FetchAccountEntitiesByDateRequestArgs

Returns Promise<StorageStream<string, HE>>

start

Returns Promise<void>

stop

Returns Promise<void>

Settings

Member Visibility

Theme

Class BaseEntityHistoryFetcher<CU, HE>`Abstract`

`Protected` accountDAL

`Protected` accountEntityHistoryDAL

`Protected` blockchainId

`Protected` fetcherClient

`Protected` id

`Protected` pendingAccounts

`Protected` type

`Protected` fetchAccountEntitiesByIdFromDateRange

`Protected` `Abstract` getAccountFetcher

`Abstract` getAccountState

`Protected` getPartialAccountState

`Protected` queryEntitiesByDate