Class BaseIndexer`Abstract`

Main class of the indexer service. Creates and manages all indexers.

Hierarchy

BaseIndexer

Implements

BlockchainIndexerI

Index

Constructors

`Protected` constructor

new BaseIndexer(blockchainId: Blockchain, indexerClient: IndexerMsClient, entityIndexers: Partial<Record<IndexableEntityType, BaseEntityIndexer<ParsedEntity<unknown>>>>, domain: IndexerWorkerDomainI): BaseIndexer
Returns the main indexer instance.
Parameters
- blockchainId: Blockchain
  
  The blockchain identifier.
- indexerClient: IndexerMsClient
  
  The indexer client.
- entityIndexers: Partial<Record<IndexableEntityType, BaseEntityIndexer<ParsedEntity<unknown>>>>
  
  Handles all indexing process related with an specific entity
- domain: IndexerWorkerDomainI
  
  The customized domain user class.
Returns BaseIndexer
- Defined in packages/framework/src/services/indexer/src/indexer.ts:29

Properties

`Protected` blockchainId

blockchainId: Blockchain

The blockchain identifier.

`Protected` blockchainIndexerClient

blockchainIndexerClient: IndexerClientI

`Protected` domain

domain: IndexerWorkerDomainI

The customized domain user class.

`Protected` entityIndexers

entityIndexers: Partial<Record<IndexableEntityType, BaseEntityIndexer<ParsedEntity<unknown>>>>

Handles all indexing process related with an specific entity

`Protected` indexerClient

indexerClient: IndexerMsClient

The indexer client.

Methods

deleteAccount

deleteAccount(args: DelAccountIndexerRequestArgs): Promise<void>
Remove the indexer for the given account, either for transactions or content or both.
Parameters
- args: DelAccountIndexerRequestArgs
  
  The indexer configuration.
Returns Promise<void>
Implementation of BlockchainIndexerI.deleteAccount
- Defined in packages/framework/src/services/indexer/src/indexer.ts:100

getAccountState

getAccountState(args: GetAccountIndexingEntityStateRequestArgs): Promise<undefined | AccountIndexerState>
Returns the indexing state of the given account.
Parameters
- args: GetAccountIndexingEntityStateRequestArgs
  
  The account to get the state of.
Returns Promise<undefined | AccountIndexerState>
Implementation of BlockchainIndexerI.getAccountState
- Defined in packages/framework/src/services/indexer/src/indexer.ts:119

`Protected` getEntityIndexerInstance

getEntityIndexerInstance(type: IndexableEntityType): BaseEntityIndexer<ParsedEntity<unknown>>
Parameters
- type: IndexableEntityType
Returns BaseEntityIndexer<ParsedEntity<unknown>>
- Defined in packages/framework/src/services/indexer/src/indexer.ts:142

getEntityPendingRequests

getEntityPendingRequests(args: GetEntityPendingRequestsRequestArgs): Promise<EntityRequest[]>
Returns all pending and processed transaction requests.
Parameters
- args: GetEntityPendingRequestsRequestArgs
Returns Promise<EntityRequest[]>
Implementation of BlockchainIndexerI.getEntityPendingRequests
- Defined in packages/framework/src/services/indexer/src/indexer.ts:127

indexAccount

indexAccount(args: AccountIndexerRequestArgs): Promise<void>
Registers a new indexer for the given account, either for transactions or content or both.
Parameters
- args: AccountIndexerRequestArgs
  
  The indexer configuration.
Returns Promise<void>
Implementation of BlockchainIndexerI.indexAccount
- Defined in packages/framework/src/services/indexer/src/indexer.ts:58

`Protected` mapAccount

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

`Protected` mapEntityId

mapEntityId(args: {
id: string;
type: IndexableEntityType;
}): string
Parameters
- args: {
  id: string;
  type: IndexableEntityType;
  }
  - id: string
  - type: IndexableEntityType
Returns string
- Defined in packages/framework/src/services/indexer/src/indexer.ts:155

start

start(): Promise<void>
Returns Promise<void>
Implementation of BlockchainIndexerI.start
- Defined in packages/framework/src/services/indexer/src/indexer.ts:42

stop

stop(): Promise<void>
Returns Promise<void>
Implementation of BlockchainIndexerI.stop
- Defined in packages/framework/src/services/indexer/src/indexer.ts:50

Class BaseIndexerAbstract

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

Protected constructor

Parameters

blockchainId: Blockchain

indexerClient: IndexerMsClient

entityIndexers: Partial<Record<IndexableEntityType, BaseEntityIndexer<ParsedEntity<unknown>>>>

domain: IndexerWorkerDomainI

Returns BaseIndexer

Properties

Protected blockchainId

Protected blockchainIndexerClient

Protected domain

Protected entityIndexers

Protected indexerClient

Methods

deleteAccount

Parameters

args: DelAccountIndexerRequestArgs

Returns Promise<void>

getAccountState

Parameters

args: GetAccountIndexingEntityStateRequestArgs

Returns Promise<undefined | AccountIndexerState>

Protected getEntityIndexerInstance

Parameters

type: IndexableEntityType

Returns BaseEntityIndexer<ParsedEntity<unknown>>

getEntityPendingRequests

Parameters

args: GetEntityPendingRequestsRequestArgs

Returns Promise<EntityRequest[]>

indexAccount

Parameters

args: AccountIndexerRequestArgs

Returns Promise<void>

Protected mapAccount

Parameters

args: { account: string; }

account: string

Returns string

Protected mapEntityId

Parameters

args: { id: string; type: IndexableEntityType; }

id: string

type: IndexableEntityType

Returns string

start

Returns Promise<void>

stop

Returns Promise<void>

Settings

Member Visibility

Theme

Class BaseIndexer`Abstract`

`Protected` constructor

`Protected` blockchainId

`Protected` blockchainIndexerClient

`Protected` domain

`Protected` entityIndexers

`Protected` indexerClient

`Protected` getEntityIndexerInstance

`Protected` mapAccount

args: {
account: string;
}

`Protected` mapEntityId

args: {
id: string;
type: IndexableEntityType;
}