Class AccountTimeSeriesStatsManager<V>

This class handles the stats for a given account. It is responsible for aggregating the stats from the time series and compacting the time series database when needed.

The stats are stored in two different places:

The time series, which is a list of stats for a given time frame
The state, which is the current state of the processed account stats

Type Parameters

V

The type of the value of the account stats

Hierarchy

AccountTimeSeriesStatsManager

Index

Constructors

constructor

new AccountTimeSeriesStatsManager<V>(config: AccountTimeSeriesStatsConfig<V>, indexerClient: IndexerMsClient, stateDAL: StatsStateStorage, timeSeriesDAL: StatsTimeSeriesStorage): AccountTimeSeriesStatsManager<V>
Type Parameters
- V
Parameters
- config: AccountTimeSeriesStatsConfig<V>
- indexerClient: IndexerMsClient
- stateDAL: StatsStateStorage
- timeSeriesDAL: StatsTimeSeriesStorage
Returns AccountTimeSeriesStatsManager<V>
- Defined in packages/framework/src/utils/stats/accountTimeSeries.ts:39

Properties

`Protected` compactionJob

compactionJob: JobRunner

config

config: AccountTimeSeriesStatsConfig<V>

`Protected` indexerClient

indexerClient: IndexerMsClient

`Protected` stateDAL

stateDAL: StatsStateStorage

`Protected` stats

stats: AccountStats<V>

`Protected` timeSeriesDAL

timeSeriesDAL: StatsTimeSeriesStorage

Methods

`Protected` aggregateAccountStats

aggregateAccountStats(now: number): Promise<void>
Parameters
- now: number
Returns Promise<void>
- Defined in packages/framework/src/utils/stats/accountTimeSeries.ts:150

`Protected` aggregateTimeSeries

aggregateTimeSeries(now: number): Promise<void>
Parameters
- now: number
Returns Promise<void>
- Defined in packages/framework/src/utils/stats/accountTimeSeries.ts:111

`Protected` compactStates

compactStates(): Promise<void>
Returns Promise<void>
- Defined in packages/framework/src/utils/stats/accountTimeSeries.ts:162

getStats

getStats(): Promise<AccountStats<V>>
Returns the currently aggregated account stats.

Returns Promise<AccountStats<V>>
- Defined in packages/framework/src/utils/stats/accountTimeSeries.ts:93

getTimeSeriesStats

getTimeSeriesStats(type: string, filters: AccountStatsFilters): Promise<AccountTimeSeriesStats<any>>
Returns time series values for a given time frame.
Parameters
- type: string
  
  The type of the time series, as defined by the user
- filters: AccountStatsFilters
  
  The filters to apply to the time series fetched
Returns Promise<AccountTimeSeriesStats<any>>
- Defined in packages/framework/src/utils/stats/accountTimeSeries.ts:66

init

init(): Promise<void>
Initializes the account stats manager. It will start the compaction job.

Returns Promise<void>
- Defined in packages/framework/src/utils/stats/accountTimeSeries.ts:57

process

process(now: number): Promise<void>
Processes the account stats. It will trigger the processing of time stats based on fetched events and aggregate the account stats.
Parameters
- now: number
  
  The timestamp to which to process past stats
Returns Promise<void>
- Defined in packages/framework/src/utils/stats/accountTimeSeries.ts:105

Class AccountTimeSeriesStatsManager<V>

Type Parameters

V

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

V

Parameters

config: AccountTimeSeriesStatsConfig<V>

indexerClient: IndexerMsClient

stateDAL: StatsStateStorage

timeSeriesDAL: StatsTimeSeriesStorage

Returns AccountTimeSeriesStatsManager<V>

Properties

Protected compactionJob

config

Protected indexerClient

Protected stateDAL

Protected stats

Protected timeSeriesDAL

Methods

Protected aggregateAccountStats

Parameters

now: number

Returns Promise<void>

Protected aggregateTimeSeries

Parameters

now: number

Returns Promise<void>

Protected compactStates

Returns Promise<void>

getStats

Returns Promise<AccountStats<V>>

getTimeSeriesStats

Parameters

type: string

filters: AccountStatsFilters

Returns Promise<AccountTimeSeriesStats<any>>

init

Returns Promise<void>

process

Parameters

now: number

Returns Promise<void>

Settings

Member Visibility

Theme

`Protected` compactionJob

`Protected` indexerClient

`Protected` stateDAL

`Protected` stats

`Protected` timeSeriesDAL

`Protected` aggregateAccountStats

`Protected` aggregateTimeSeries

`Protected` compactStates