Class IndexerMsMain

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

Hierarchy

IndexerMsMain

Implements

IndexerMsI

Index

Constructors

constructor

new IndexerMsMain(indexerClient: IndexerMsClient, blockchains: Record<Blockchain, BlockchainIndexerI>, domain: IndexerWorkerDomainI): IndexerMsMain
Parameters
- indexerClient: IndexerMsClient
  
  Retrieve contextual information of sibling indexers.
- blockchains: Record<Blockchain, BlockchainIndexerI>
  
  A dictionary of instances that implements BlockchainIndexerI interface
- domain: IndexerWorkerDomainI
Returns IndexerMsMain
- Defined in packages/framework/src/services/indexer/main.ts:26

Properties

`Protected` blockchains

blockchains: Record<Blockchain, BlockchainIndexerI>

A dictionary of instances that implements BlockchainIndexerI interface

`Protected` domain

domain: IndexerWorkerDomainI

`Protected` indexerClient

indexerClient: IndexerMsClient

Retrieve contextual information of sibling indexers.

`Protected` inited

inited: boolean = false

Methods

deleteAccount

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

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 IndexerMsI.getAccountState
- Defined in packages/framework/src/services/indexer/main.ts:69

getAllIndexers

getAllIndexers(): string[]
Returns all indexer IDs.

Returns string[]
Implementation of IndexerMsI.getAllIndexers
- Defined in packages/framework/src/services/indexer/main.ts:55

`Protected` getBlockchainInstance

getBlockchainInstance(blockchainId: Blockchain): BlockchainIndexerI
Parameters
- blockchainId: Blockchain
Returns BlockchainIndexerI
- Defined in packages/framework/src/services/indexer/main.ts:113

getEntityPendingRequests

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

`Protected` getIndexerId

getIndexerId(): string
Returns string
- Defined in packages/framework/src/services/indexer/main.ts:125

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 IndexerMsI.indexAccount
- Defined in packages/framework/src/services/indexer/main.ts:59

invokeBlockchainMethod

invokeBlockchainMethod<R, A>(args: InvokeBlockchainMethodRequestArgs<A>): Promise<R>
Type Parameters
- R
- A
Parameters
- args: InvokeBlockchainMethodRequestArgs<A>
Returns Promise<R>
- Defined in packages/framework/src/services/indexer/main.ts:98

invokeDomainMethod

invokeDomainMethod(argss: InvokeMethodRequestArgs): Promise<unknown>
Invokes a domain method with the given account. This will be forwarded through the broker to the worker. @todo: Correct?
Parameters
- argss: InvokeMethodRequestArgs
  
  The account, the method and additional arguments to pass to the method.
Returns Promise<unknown>
Implementation of IndexerMsI.invokeDomainMethod
- Defined in packages/framework/src/services/indexer/main.ts:76

start

start(): Promise<void>
Initialize the indexer service. First fetches pending transactions and parses them, then loads existing requests to the service.

Returns Promise<void>
- Defined in packages/framework/src/services/indexer/main.ts:37

stop

stop(): Promise<void>
Returns Promise<void>
- Defined in packages/framework/src/services/indexer/main.ts:46

Class IndexerMsMain

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

indexerClient: IndexerMsClient

blockchains: Record<Blockchain, BlockchainIndexerI>

domain: IndexerWorkerDomainI

Returns IndexerMsMain

Properties

Protected blockchains

Protected domain

Protected indexerClient

Protected inited

Methods

deleteAccount

Parameters

args: AccountIndexerRequestArgs

Returns Promise<void>

getAccountState

Parameters

args: GetAccountIndexingEntityStateRequestArgs

Returns Promise<undefined | AccountIndexerState>

getAllIndexers

Returns string[]

Protected getBlockchainInstance

Parameters

blockchainId: Blockchain

Returns BlockchainIndexerI

getEntityPendingRequests

Parameters

args: GetEntityPendingRequestsRequestArgs

Returns Promise<EntityRequest[]>

Protected getIndexerId

Returns string

indexAccount

Parameters

args: AccountIndexerRequestArgs

Returns Promise<void>

invokeBlockchainMethod

Type Parameters

R

A

Parameters

args: InvokeBlockchainMethodRequestArgs<A>

Returns Promise<R>

invokeDomainMethod

Parameters

argss: InvokeMethodRequestArgs

Returns Promise<unknown>

start

Returns Promise<void>

stop

Returns Promise<void>

Settings

Member Visibility

Theme

`Protected` blockchains

`Protected` domain

`Protected` indexerClient

`Protected` inited

`Protected` getBlockchainInstance

`Protected` getIndexerId