Class IndexerMainDomain`Abstract`

The main indexer domain class. Primary entry point for all data being indexed. This is a core piece in developing a custom indexer. Add and overwrite methods to customize the indexer. This class communicates through the broker with the services, which can be powered by multiple workers. All of this is abstracted away through this class.

Hierarchy

IndexerMainDomain

Index

Constructors

constructor

new IndexerMainDomain(context: IndexerCommonDomainContext, baseConfig?: IndexerMainDomainConfig): IndexerMainDomain
Parameters
- context: IndexerCommonDomainContext
- Optional baseConfig: IndexerMainDomainConfig
Returns IndexerMainDomain
- Defined in packages/framework/src/utils/domain/indexer/main.ts:81

Properties

`Protected` accounts

accounts: Record<Blockchain, Set<string>>

`Protected` `Optional` baseConfig

baseConfig?: IndexerMainDomainConfig

`Protected` context

context: IndexerCommonDomainContext

`Protected` discoverJob

discoverJob: undefined | JobRunner

`Protected` statsJob

statsJob: undefined | JobRunner

Methods

`Protected` _discover

_discover(): Promise<void>
Returns Promise<void>
- Defined in packages/framework/src/utils/domain/indexer/main.ts:242

`Protected` _updateStats

_updateStats(): Promise<void>
Returns Promise<void>
- Defined in packages/framework/src/utils/domain/indexer/main.ts:286

`Protected` checkDiscovery

checkDiscovery(): this is IndexerMainDomainWithDiscovery<unknown>
Protected
Throws an error if the indexer does not have discovery capabilities.

Returns this is IndexerMainDomainWithDiscovery<unknown>
- Defined in packages/framework/src/utils/domain/indexer/main.ts:317

`Protected` checkStats

checkStats(): this is IndexerMainDomainWithStats
Protected
Throws an error if the indexer does not have stats capabilities.

Returns this is IndexerMainDomainWithStats
- Defined in packages/framework/src/utils/domain/indexer/main.ts:331

getAccountState

getAccountState(blockchainId: Blockchain, type: IndexableEntityType, accounts?: string[]): Promise<AccountIndexerState[]>
Gets the indexing state of the given accounts.
Parameters
- blockchainId: Blockchain
- type: IndexableEntityType
- accounts: string[] = []
  
  The accounts to get the state from.
Returns Promise<AccountIndexerState[]>
- Defined in packages/framework/src/utils/domain/indexer/main.ts:154

getAccountStats

getAccountStats<V>(blockchainId: Blockchain, accounts?: string[]): Promise<AccountStats<V>[]>
Returns the global stats for the given accounts.
Type Parameters
- V
Parameters
- blockchainId: Blockchain
- accounts: string[] = []
  
  The accounts to get the summary from.
Returns Promise<AccountStats<V>[]>
- Defined in packages/framework/src/utils/domain/indexer/main.ts:205

getAccountTimeSeriesStats

getAccountTimeSeriesStats<V>(blockchainId: Blockchain, accounts?: string[], type: string, filters: AccountStatsFilters): Promise<AccountTimeSeriesStats<V>[]>
Returns the time-series stats for the given account.
Type Parameters
- V
Parameters
- blockchainId: Blockchain
- accounts: string[] = []
  
  The accounts to get the time-series stats from.
- type: string
  
  The type of time-series to get.
- filters: AccountStatsFilters
  
  The transformations and clipping to apply to the time-series.
Returns Promise<AccountTimeSeriesStats<V>[]>
- Defined in packages/framework/src/utils/domain/indexer/main.ts:176

`Protected` getBlockchainAccounts

getBlockchainAccounts(blockchainId: Blockchain, accounts?: string[]): string[]
Parameters
- blockchainId: Blockchain
- accounts: string[] = []
Returns string[]
- Defined in packages/framework/src/utils/domain/indexer/main.ts:228

getEntityPendingRequests

getEntityPendingRequests(args: GetEntityPendingRequestsRequestArgs): Promise<EntityRequest[]>
Parameters
- args: GetEntityPendingRequestsRequestArgs
Returns Promise<EntityRequest[]>
- Defined in packages/framework/src/utils/domain/indexer/main.ts:341

`Protected` indexAccounts

indexAccounts(options: (AccountIndexerRequestArgs | AccountIndexerConfigWithMeta<unknown>)[]): Promise<void>
Protected
Called when a new account is discovered.
Parameters
- options: (AccountIndexerRequestArgs | AccountIndexerConfigWithMeta<unknown>)[]
  
  The indexer options to use for the new account.
Returns Promise<void>
- Defined in packages/framework/src/utils/domain/indexer/main.ts:268

init

init(...args: unknown[]): Promise<void>
Initializes the stats and discovery jobs.
Parameters
- Rest ...args: unknown[]
  
  Not used.
Returns Promise<void>
- Defined in packages/framework/src/utils/domain/indexer/main.ts:111

withDiscovery

withDiscovery(): this is IndexerMainDomainWithDiscovery<unknown>
Checks whether the indexer has discovery capabilities.

Returns this is IndexerMainDomainWithDiscovery<unknown>
- Defined in packages/framework/src/utils/domain/indexer/main.ts:135

withStats

withStats(): this is IndexerMainDomainWithStats
Checks whether the indexer has stats capabilities.

Returns this is IndexerMainDomainWithStats
- Defined in packages/framework/src/utils/domain/indexer/main.ts:142

Class IndexerMainDomainAbstract

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

context: IndexerCommonDomainContext

Optional baseConfig: IndexerMainDomainConfig

Returns IndexerMainDomain

Properties

Protected accounts

Protected Optional baseConfig

Protected context

Protected discoverJob

Protected statsJob

Methods

Protected _discover

Returns Promise<void>

Protected _updateStats

Returns Promise<void>

Protected checkDiscovery

Returns this is IndexerMainDomainWithDiscovery<unknown>

Protected checkStats

Returns this is IndexerMainDomainWithStats

getAccountState

Parameters

blockchainId: Blockchain

type: IndexableEntityType

accounts: string[] = []

Returns Promise<AccountIndexerState[]>

getAccountStats

Type Parameters

V

Parameters

blockchainId: Blockchain

accounts: string[] = []

Returns Promise<AccountStats<V>[]>

getAccountTimeSeriesStats

Type Parameters

V

Parameters

blockchainId: Blockchain

accounts: string[] = []

type: string

filters: AccountStatsFilters

Returns Promise<AccountTimeSeriesStats<V>[]>

Protected getBlockchainAccounts

Parameters

blockchainId: Blockchain

accounts: string[] = []

Returns string[]

getEntityPendingRequests

Parameters

args: GetEntityPendingRequestsRequestArgs

Returns Promise<EntityRequest[]>

Protected indexAccounts

Parameters

options: (AccountIndexerRequestArgs | AccountIndexerConfigWithMeta<unknown>)[]

Returns Promise<void>

init

Parameters

Rest ...args: unknown[]

Returns Promise<void>

withDiscovery

Returns this is IndexerMainDomainWithDiscovery<unknown>

withStats

Returns this is IndexerMainDomainWithStats

Settings

Member Visibility

Theme

Class IndexerMainDomain`Abstract`

`Optional` baseConfig: IndexerMainDomainConfig

`Protected` accounts

`Protected` `Optional` baseConfig

`Protected` context

`Protected` discoverJob

`Protected` statsJob

`Protected` _discover

`Protected` _updateStats

`Protected` checkDiscovery

`Protected` checkStats

`Protected` getBlockchainAccounts

`Protected` indexAccounts

`Rest` ...args: unknown[]