Class EthereumBlockHistoryFetcher

Hierarchy

BaseHistoryFetcher<EthereumBlockHistoryPaginationCursor>
- EthereumBlockHistoryFetcher

Constructors

constructor

new EthereumBlockHistoryFetcher(config: EthereumBlockHistoryFetcherConfig, ethereumClient: EthereumClient, fetcherStateDAL: FetcherStateLevelStorage<EthereumBlockHistoryPaginationCursor>, blockDAL: EthereumRawBlockStorage, blockchainId?: Blockchain): EthereumBlockHistoryFetcher
Parameters
- config: EthereumBlockHistoryFetcherConfig
- ethereumClient: EthereumClient
- fetcherStateDAL: FetcherStateLevelStorage<EthereumBlockHistoryPaginationCursor>
- blockDAL: EthereumRawBlockStorage
- blockchainId: Blockchain = Blockchain.Ethereum
Returns EthereumBlockHistoryFetcher
Overrides BaseHistoryFetcher<EthereumBlockHistoryPaginationCursor>.constructor
- Defined in packages/ethereum/src/services/fetcher/src/block/blockHistoryFetcher.ts:33

Properties

`Protected` backwardJob

backwardJob: undefined | JobRunner

`Protected` blockDAL

blockDAL: EthereumRawBlockStorage

`Protected` blockchainId

blockchainId: Blockchain = Blockchain.Ethereum

`Protected` config

config: EthereumBlockHistoryFetcherConfig

`Protected` ethereumClient

ethereumClient: EthereumClient

`Protected` fetcherState

fetcherState: BaseFetcherState<EthereumBlockHistoryPaginationCursor>

`Protected` fetcherStateDAL

fetcherStateDAL: FetcherStateLevelStorage<EthereumBlockHistoryPaginationCursor>

`Protected` forwardJob

forwardJob: undefined | JobRunner

`Protected` iterationLimit

iterationLimit: number = 1000

`Protected` lastCheckCompleteBackward

lastCheckCompleteBackward: number = ...

`Protected` options

options: BaseFetcherOptions<EthereumBlockHistoryPaginationCursor>

`Protected` pageLimit

pageLimit: number = 50

Methods

`Protected` _checkComplete

_checkComplete(type: "forward" | "backward", ctx: {
    error?: Error;
    jobState: BaseFetcherJobState;
    newItems: boolean;
}): Promise<boolean>
Parameters
- type: "forward" | "backward"
- ctx: {
      error?: Error;
      jobState: BaseFetcherJobState;
      newItems: boolean;
  }
  - Optional error?: Error
  - jobState: BaseFetcherJobState
  - newItems: boolean
Returns Promise<boolean>
Inherited from BaseHistoryFetcher._checkComplete
- Defined in packages/framework/dist/src/services/fetcher/src/baseHistoryFetcher.d.ts:47

`Protected` _runJob

_runJob(fetcherType: "forward" | "backward", ctx: {
firstRun: boolean;
interval: number;
}): Promise<number>
Parameters
- fetcherType: "forward" | "backward"
- ctx: {
  firstRun: boolean;
  interval: number;
  }
  - firstRun: boolean
  - interval: number
Returns Promise<number>
Inherited from BaseHistoryFetcher._runJob
- Defined in packages/framework/dist/src/services/fetcher/src/baseHistoryFetcher.d.ts:39

`Protected` _updateCursors

_updateCursors(type: "forward" | "backward", ctx: {
lastCursors: BaseFetcherPaginationCursors<EthereumBlockHistoryPaginationCursor>;
prevCursors?: BaseFetcherPaginationCursors<EthereumBlockHistoryPaginationCursor>;
}): Promise<FetcherJobRunnerUpdateCursorResult<EthereumBlockHistoryPaginationCursor>>
Parameters
- type: "forward" | "backward"
- ctx: {
  lastCursors: BaseFetcherPaginationCursors<EthereumBlockHistoryPaginationCursor>;
  prevCursors?: BaseFetcherPaginationCursors<EthereumBlockHistoryPaginationCursor>;
  }
  - lastCursors: BaseFetcherPaginationCursors<EthereumBlockHistoryPaginationCursor>
  - Optional prevCursors?: BaseFetcherPaginationCursors<EthereumBlockHistoryPaginationCursor>
Returns Promise<FetcherJobRunnerUpdateCursorResult<EthereumBlockHistoryPaginationCursor>>
Inherited from BaseHistoryFetcher._updateCursors
- Defined in packages/framework/dist/src/services/fetcher/src/baseHistoryFetcher.d.ts:43

`Protected` checkCompleteBackward

checkCompleteBackward(ctx: {
    error?: Error;
    fetcherState: BaseFetcherState<EthereumBlockHistoryPaginationCursor>;
    jobState: BaseFetcherJobState;
    newItems: boolean;
}): Promise<boolean>
Parameters
- ctx: {
      error?: Error;
      fetcherState: BaseFetcherState<EthereumBlockHistoryPaginationCursor>;
      jobState: BaseFetcherJobState;
      newItems: boolean;
  }
  - Optional error?: Error
  - fetcherState: BaseFetcherState<EthereumBlockHistoryPaginationCursor>
  - jobState: BaseFetcherJobState
  - newItems: boolean
Returns Promise<boolean>
- Defined in packages/ethereum/src/services/fetcher/src/block/blockHistoryFetcher.ts:144

complete

complete(fetcherType: "forward" | "backward"): Promise<void>
Parameters
- fetcherType: "forward" | "backward"
Returns Promise<void>
Inherited from BaseHistoryFetcher.complete
- Defined in packages/framework/dist/src/services/fetcher/src/baseHistoryFetcher.d.ts:24

`Protected` fetchBlocks

fetchBlocks(options: EthereumFetchBlocksOptions, goingForward: boolean): Promise<{
error?: Error;
lastCursors: EthereumBlockHistoryPaginationCursors;
}>
Parameters
- options: EthereumFetchBlocksOptions
- goingForward: boolean
Returns Promise<{
error?: Error;
lastCursors: EthereumBlockHistoryPaginationCursors;
}>
- Defined in packages/ethereum/src/services/fetcher/src/block/blockHistoryFetcher.ts:108

`Protected` getFetcherState

getFetcherState(): Promise<BaseFetcherState<EthereumBlockHistoryPaginationCursor>>
Initialises the fetcherState class property of the Fetcher instance, could get the data from the data access layer when the fetching progress is restarted.

Returns Promise<BaseFetcherState<EthereumBlockHistoryPaginationCursor>>
Inherited from BaseHistoryFetcher.getFetcherState
- Defined in packages/framework/dist/src/services/fetcher/src/baseHistoryFetcher.d.ts:33

getId

getId(): string
Returns string
Inherited from BaseHistoryFetcher.getId
- Defined in packages/framework/dist/src/services/fetcher/src/baseHistoryFetcher.d.ts:19

getLastRun

getLastRun(fetcherType?: "forward" | "backward"): Promise<number>
Parameters
- Optional fetcherType: "forward" | "backward"
Returns Promise<number>
Inherited from BaseHistoryFetcher.getLastRun
- Defined in packages/framework/dist/src/services/fetcher/src/baseHistoryFetcher.d.ts:26

getNextRun

getNextRun(fetcherType?: "forward" | "backward"): Promise<number>
Parameters
- Optional fetcherType: "forward" | "backward"
Returns Promise<number>
Inherited from BaseHistoryFetcher.getNextRun
- Defined in packages/framework/dist/src/services/fetcher/src/baseHistoryFetcher.d.ts:27

getPendingRuns

getPendingRuns(fetcherType?: "forward" | "backward"): Promise<number>
Parameters
- Optional fetcherType: "forward" | "backward"
Returns Promise<number>
Inherited from BaseHistoryFetcher.getPendingRuns
- Defined in packages/framework/dist/src/services/fetcher/src/baseHistoryFetcher.d.ts:28

getState

getState(): Promise<BaseFetcherState<EthereumBlockHistoryPaginationCursor>>
Returns Promise<BaseFetcherState<EthereumBlockHistoryPaginationCursor>>
Inherited from BaseHistoryFetcher.getState
- Defined in packages/framework/dist/src/services/fetcher/src/baseHistoryFetcher.d.ts:23

`Protected` indexBlocks

indexBlocks(blocks: EthereumRawBlock[], goingForward: boolean): Promise<void>
Parameters
- blocks: EthereumRawBlock[]
- goingForward: boolean
Returns Promise<void>
- Defined in packages/ethereum/src/services/fetcher/src/block/blockHistoryFetcher.ts:179

init

init(): Promise<void>
Returns Promise<void>
Inherited from BaseHistoryFetcher.init
- Defined in packages/framework/dist/src/services/fetcher/src/baseHistoryFetcher.d.ts:20

`Protected` initJobsFrequencyState

initJobsFrequencyState(jobType: "forward" | "backward"): void
Parameters
- jobType: "forward" | "backward"
Returns void
Inherited from BaseHistoryFetcher.initJobsFrequencyState
- Defined in packages/framework/dist/src/services/fetcher/src/baseHistoryFetcher.d.ts:34

isComplete

isComplete(fetcherType?: "forward" | "backward"): Promise<boolean>
Parameters
- Optional fetcherType: "forward" | "backward"
Returns Promise<boolean>
Inherited from BaseHistoryFetcher.isComplete
- Defined in packages/framework/dist/src/services/fetcher/src/baseHistoryFetcher.d.ts:25

run

run(): Promise<unknown>
Returns Promise<unknown>
Inherited from BaseHistoryFetcher.run
- Defined in packages/framework/dist/src/services/fetcher/src/baseHistoryFetcher.d.ts:21

`Protected` runBackward

runBackward(): Promise<FetcherJobRunnerHandleFetchResult<EthereumBlockHistoryPaginationCursor>>
Returns Promise<FetcherJobRunnerHandleFetchResult<EthereumBlockHistoryPaginationCursor>>
- Defined in packages/ethereum/src/services/fetcher/src/block/blockHistoryFetcher.ts:85

`Protected` runForward

runForward(): Promise<FetcherJobRunnerHandleFetchResult<EthereumBlockHistoryPaginationCursor>>
Returns Promise<FetcherJobRunnerHandleFetchResult<EthereumBlockHistoryPaginationCursor>>
- Defined in packages/ethereum/src/services/fetcher/src/block/blockHistoryFetcher.ts:63

`Protected` saveFetcherState

saveFetcherState(): Promise<void>
Saves the fetcher state in the data access layer.

Returns Promise<void>
Inherited from BaseHistoryFetcher.saveFetcherState
- Defined in packages/framework/dist/src/services/fetcher/src/baseHistoryFetcher.d.ts:38

stop

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

Class EthereumBlockHistoryFetcher

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

config: EthereumBlockHistoryFetcherConfig

ethereumClient: EthereumClient

fetcherStateDAL: FetcherStateLevelStorage<EthereumBlockHistoryPaginationCursor>

blockDAL: EthereumRawBlockStorage

blockchainId: Blockchain = Blockchain.Ethereum

Returns EthereumBlockHistoryFetcher

Properties

Protected backwardJob

Protected blockDAL

Protected blockchainId

Protected config

Protected ethereumClient

Protected fetcherState

Protected fetcherStateDAL

Protected forwardJob

Protected iterationLimit

Protected lastCheckCompleteBackward

Protected options

Protected pageLimit

Methods

Protected _checkComplete

Parameters

type: "forward" | "backward"

ctx: { error?: Error; jobState: BaseFetcherJobState; newItems: boolean; }

Optional error?: Error

jobState: BaseFetcherJobState

newItems: boolean

Returns Promise<boolean>

Protected _runJob

Parameters

fetcherType: "forward" | "backward"

ctx: { firstRun: boolean; interval: number; }

firstRun: boolean

interval: number

Returns Promise<number>

Protected _updateCursors

Parameters

type: "forward" | "backward"

ctx: { lastCursors: BaseFetcherPaginationCursors<EthereumBlockHistoryPaginationCursor>; prevCursors?: BaseFetcherPaginationCursors<EthereumBlockHistoryPaginationCursor>; }

lastCursors: BaseFetcherPaginationCursors<EthereumBlockHistoryPaginationCursor>

Optional prevCursors?: BaseFetcherPaginationCursors<EthereumBlockHistoryPaginationCursor>

Returns Promise<FetcherJobRunnerUpdateCursorResult<EthereumBlockHistoryPaginationCursor>>

Protected checkCompleteBackward

Parameters

ctx: { error?: Error; fetcherState: BaseFetcherState<EthereumBlockHistoryPaginationCursor>; jobState: BaseFetcherJobState; newItems: boolean; }

Optional error?: Error

fetcherState: BaseFetcherState<EthereumBlockHistoryPaginationCursor>

jobState: BaseFetcherJobState

newItems: boolean

Returns Promise<boolean>

complete

Parameters

fetcherType: "forward" | "backward"

Returns Promise<void>

Protected fetchBlocks

Parameters

options: EthereumFetchBlocksOptions

goingForward: boolean

Returns Promise<{ error?: Error; lastCursors: EthereumBlockHistoryPaginationCursors; }>

Protected getFetcherState

Returns Promise<BaseFetcherState<EthereumBlockHistoryPaginationCursor>>

getId

Returns string

getLastRun

Parameters

Optional fetcherType: "forward" | "backward"

Returns Promise<number>

getNextRun

Parameters

Optional fetcherType: "forward" | "backward"

Returns Promise<number>

`Protected` backwardJob

`Protected` blockDAL

`Protected` blockchainId

`Protected` config

`Protected` ethereumClient

`Protected` fetcherState

`Protected` fetcherStateDAL

`Protected` forwardJob

`Protected` iterationLimit

`Protected` lastCheckCompleteBackward

`Protected` options

`Protected` pageLimit

`Protected` _checkComplete

ctx: {
error?: Error;
jobState: BaseFetcherJobState;
newItems: boolean;
}

`Optional` error?: Error

`Protected` _runJob

ctx: {
firstRun: boolean;
interval: number;
}

`Protected` _updateCursors

ctx: {
lastCursors: BaseFetcherPaginationCursors<EthereumBlockHistoryPaginationCursor>;
prevCursors?: BaseFetcherPaginationCursors<EthereumBlockHistoryPaginationCursor>;
}

`Optional` prevCursors?: BaseFetcherPaginationCursors<EthereumBlockHistoryPaginationCursor>

`Protected` checkCompleteBackward

ctx: {
error?: Error;
fetcherState: BaseFetcherState<EthereumBlockHistoryPaginationCursor>;
jobState: BaseFetcherJobState;
newItems: boolean;
}

`Optional` error?: Error

`Protected` fetchBlocks

Returns Promise<{
error?: Error;
lastCursors: EthereumBlockHistoryPaginationCursors;
}>

`Protected` getFetcherState

`Optional` fetcherType: "forward" | "backward"

`Optional` fetcherType: "forward" | "backward"

`Optional` fetcherType: "forward" | "backward"

`Protected` indexBlocks

`Protected` initJobsFrequencyState

`Optional` fetcherType: "forward" | "backward"

`Protected` runBackward

`Protected` runForward

`Protected` saveFetcherState