Class BaseFetcher`Abstract`

The main class of the fetcher service.

Hierarchy

BaseFetcher

Implements

BlockchainFetcherI

Index

Constructors

constructor

new BaseFetcher(blockchainId: Blockchain, fetcherClient: FetcherMsClient, entityFetchers: Partial<Record<IndexableEntityType, BaseEntityFetcherMain<unknown, AccountEntityHistoryStorageEntity, RawEntity>>>): BaseFetcher
Initialize the fetcher service.
Parameters
- blockchainId: Blockchain
  
  The blockchain identifier.
- fetcherClient: FetcherMsClient
  
  Allows communication with the sibling fetcher instances.
- entityFetchers: Partial<Record<IndexableEntityType, BaseEntityFetcherMain<unknown, AccountEntityHistoryStorageEntity, RawEntity>>>
Returns BaseFetcher
- Defined in packages/framework/src/services/fetcher/src/fetcher.ts:34

Properties

`Protected` blockchainFetcherClient

blockchainFetcherClient: FetcherClientI

`Protected` blockchainId

blockchainId: Blockchain

The blockchain identifier.

`Protected` entityFetchers

entityFetchers: Partial<Record<IndexableEntityType, BaseEntityFetcherMain<unknown, AccountEntityHistoryStorageEntity, RawEntity>>>

`Protected` fetcherClient

fetcherClient: FetcherMsClient

Allows communication with the sibling fetcher instances.

Methods

addAccountEntityFetcher

addAccountEntityFetcher(args: AddAccountEntityRequestArgs): Promise<void>
Requests a new signature fetcher, which will fetch all txn ids including a given account.
Parameters
- args: AddAccountEntityRequestArgs
  
  Arguments for the fetcher.
Returns Promise<void>
Implementation of BlockchainFetcherI.addAccountEntityFetcher
- Defined in packages/framework/src/services/fetcher/src/fetcher.ts:62

delAccountEntityFetcher

delAccountEntityFetcher(args: DelAccountEntityRequestArgs): Promise<void>
Requests to remove a signature fetcher.
Parameters
- args: DelAccountEntityRequestArgs
  
  The account to remove the fetcher from.
Returns Promise<void>
Implementation of BlockchainFetcherI.delAccountEntityFetcher
- Defined in packages/framework/src/services/fetcher/src/fetcher.ts:70

delEntityCache

delEntityCache(args: DelEntityRequestArgs): Promise<void>
Parameters
- args: DelEntityRequestArgs
Returns Promise<void>
Implementation of BlockchainFetcherI.delEntityCache
- Defined in packages/framework/src/services/fetcher/src/fetcher.ts:126

fetchAccountEntitiesByDate

fetchAccountEntitiesByDate(args: FetchAccountEntitiesByDateRequestArgs): Promise<void | AsyncIterable<string[]>>
Returns all txn ids fetched for a given account by timestamp range as a stream.
Parameters
- args: FetchAccountEntitiesByDateRequestArgs
  
  Account and timestamp range to get the ids for.
Returns Promise<void | AsyncIterable<string[]>>
Implementation of BlockchainFetcherI.fetchAccountEntitiesByDate
- Defined in packages/framework/src/services/fetcher/src/fetcher.ts:106

fetchEntitiesById

fetchEntitiesById(args: FetchEntitiesByIdRequestArgs): Promise<void>
Adds new ids to the fetcher loop to fetch their related transactions.
Parameters
- args: FetchEntitiesByIdRequestArgs
  
  The ids of the transactions to fetch.
Returns Promise<void>
Implementation of BlockchainFetcherI.fetchEntitiesById
- Defined in packages/framework/src/services/fetcher/src/fetcher.ts:114

getAccountEntityFetcherState

getAccountEntityFetcherState(args: GetAccountEntityStateRequestArgs): Promise<undefined | AccountEntityHistoryState<any>>
Returns a signature fetcher's state.
Parameters
- args: GetAccountEntityStateRequestArgs
  
  The account to get the fetcher's state from.
Returns Promise<undefined | AccountEntityHistoryState<any>>
Implementation of BlockchainFetcherI.getAccountEntityFetcherState
- Defined in packages/framework/src/services/fetcher/src/fetcher.ts:78

`Protected` getEntityFetcherInstance

getEntityFetcherInstance(type: IndexableEntityType): BaseEntityFetcherMain<unknown, AccountEntityHistoryStorageEntity, RawEntity>
Parameters
- type: IndexableEntityType
Returns BaseEntityFetcherMain<unknown, AccountEntityHistoryStorageEntity, RawEntity>
- Defined in packages/framework/src/services/fetcher/src/fetcher.ts:132

getEntityState

getEntityState(args: CheckEntityRequestArgs): Promise<EntityState[]>
Parameters
- args: CheckEntityRequestArgs
Returns Promise<EntityState[]>
Implementation of BlockchainFetcherI.getEntityState
- Defined in packages/framework/src/services/fetcher/src/fetcher.ts:120

`Protected` getFetcherId

getFetcherId(): string
Returns string
- Defined in packages/framework/src/services/fetcher/src/fetcher.ts:141

getFetcherState

getFetcherState(__namedParameters: FetcherStateRequestArgs): Promise<FetcherState<any>>
Parameters
- __namedParameters: FetcherStateRequestArgs
Returns Promise<FetcherState<any>>
Implementation of BlockchainFetcherI.getFetcherState
- Defined in packages/framework/src/services/fetcher/src/fetcher.ts:86

`Protected` mapAccount

mapAccount(args: {
account: string;
}): string
Parameters
- args: {
  account: string;
  }
  - account: string
Returns string
- Defined in packages/framework/src/services/fetcher/src/fetcher.ts:145

`Protected` mapEntityIds

mapEntityIds(args: {
ids: string[];
type: IndexableEntityType;
}): string[]
Parameters
- args: {
  ids: string[];
  type: IndexableEntityType;
  }
  - ids: string[]
  - type: IndexableEntityType
Returns string[]
- Defined in packages/framework/src/services/fetcher/src/fetcher.ts:149

start

start(): Promise<void>
Returns Promise<void>
Implementation of BlockchainFetcherI.start
- Defined in packages/framework/src/services/fetcher/src/fetcher.ts:46

stop

stop(): Promise<void>
Returns Promise<void>
Implementation of BlockchainFetcherI.stop
- Defined in packages/framework/src/services/fetcher/src/fetcher.ts:54

Class BaseFetcherAbstract

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

blockchainId: Blockchain

fetcherClient: FetcherMsClient

entityFetchers: Partial<Record<IndexableEntityType, BaseEntityFetcherMain<unknown, AccountEntityHistoryStorageEntity, RawEntity>>>

Returns BaseFetcher

Properties

Protected blockchainFetcherClient

Protected blockchainId

Protected entityFetchers

Protected fetcherClient

Methods

addAccountEntityFetcher

Parameters

args: AddAccountEntityRequestArgs

Returns Promise<void>

delAccountEntityFetcher

Parameters

args: DelAccountEntityRequestArgs

Returns Promise<void>

delEntityCache

Parameters

args: DelEntityRequestArgs

Returns Promise<void>

fetchAccountEntitiesByDate

Parameters

args: FetchAccountEntitiesByDateRequestArgs

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

fetchEntitiesById

Parameters

args: FetchEntitiesByIdRequestArgs

Returns Promise<void>

getAccountEntityFetcherState

Parameters

args: GetAccountEntityStateRequestArgs

Returns Promise<undefined | AccountEntityHistoryState<any>>

Protected getEntityFetcherInstance

Parameters

type: IndexableEntityType

Returns BaseEntityFetcherMain<unknown, AccountEntityHistoryStorageEntity, RawEntity>

getEntityState

Parameters

args: CheckEntityRequestArgs

Returns Promise<EntityState[]>

Protected getFetcherId

Returns string

getFetcherState

Parameters

__namedParameters: FetcherStateRequestArgs

Returns Promise<FetcherState<any>>

Protected mapAccount

Parameters

args: { account: string; }

account: string

Returns string

Protected mapEntityIds

Parameters

args: { ids: string[]; type: IndexableEntityType; }

ids: string[]

type: IndexableEntityType

Returns string[]

start

Returns Promise<void>

stop

Returns Promise<void>

Settings

Member Visibility

Theme

Class BaseFetcher`Abstract`

`Protected` blockchainFetcherClient

`Protected` blockchainId

`Protected` entityFetchers

`Protected` fetcherClient

`Protected` getEntityFetcherInstance

`Protected` getFetcherId

`Protected` mapAccount

args: {
account: string;
}

`Protected` mapEntityIds

args: {
ids: string[];
type: IndexableEntityType;
}