Class BaseIndexerClient`Abstract`

Client to access the main indexer service through the broker.

Hierarchy

BaseIndexerClient

Implements

IndexerClientI

Index

Constructors

constructor

new BaseIndexerClient(blockchainId: Blockchain, broker: ServiceBroker, msId?: MsIds): BaseIndexerClient
Parameters
- blockchainId: Blockchain
  
  The id of the blockchain the client handles
- broker: ServiceBroker
  
  The broker instance to retrieve the actual service from.
- msId: MsIds = MsIds.Indexer
  
  The moleculer service id of the indexer service.
Returns BaseIndexerClient
- Defined in packages/framework/src/services/indexer/src/client.ts:24

Properties

`Protected` blockchainId

blockchainId: Blockchain

The id of the blockchain the client handles

`Protected` broker

broker: ServiceBroker

The broker instance to retrieve the actual service from.

`Protected` msId

msId: MsIds = MsIds.Indexer

The moleculer service id of the indexer service.

Methods

deleteAccount

deleteAccount(args: Omit<AccountIndexerRequestArgs, "blockchainId">, broadcast?: boolean): Promise<void>
Parameters
- args: Omit<AccountIndexerRequestArgs, "blockchainId">
- broadcast: boolean = false
Returns Promise<void>
Implementation of IndexerClientI.deleteAccount
- Defined in packages/framework/src/services/indexer/src/client.ts:69

getAccountState

getAccountState(args: Omit<GetAccountIndexingEntityStateRequestArgs, "blockchainId">): Promise<undefined | AccountIndexerState>
Parameters
- args: Omit<GetAccountIndexingEntityStateRequestArgs, "blockchainId">
Returns Promise<undefined | AccountIndexerState>
Implementation of IndexerClientI.getAccountState
- Defined in packages/framework/src/services/indexer/src/client.ts:104

getEntityPendingRequests

getEntityPendingRequests(args: Omit<GetEntityPendingRequestsRequestArgs, "blockchainId">): Promise<EntityRequest[]>
Parameters
- args: Omit<GetEntityPendingRequestsRequestArgs, "blockchainId">
Returns Promise<EntityRequest[]>
Implementation of IndexerClientI.getEntityPendingRequests
- Defined in packages/framework/src/services/indexer/src/client.ts:139

indexAccount

indexAccount(args: Omit<AccountIndexerRequestArgs, "blockchainId">, broadcast?: boolean): Promise<void>
Parameters
- args: Omit<AccountIndexerRequestArgs, "blockchainId">
- broadcast: boolean = false
Returns Promise<void>
Implementation of IndexerClientI.indexAccount
- Defined in packages/framework/src/services/indexer/src/client.ts:34

invokeDomainMethod

invokeDomainMethod(args: Omit<InvokeMethodRequestArgs, "blockchainId">): Promise<unknown>
Parameters
- args: Omit<InvokeMethodRequestArgs, "blockchainId">
Returns Promise<unknown>
Implementation of IndexerClientI.invokeDomainMethod
- Defined in packages/framework/src/services/indexer/src/client.ts:120

`Abstract` normalizeAccount

normalizeAccount(account: string): string
Parameters
- account: string
Returns string
Implementation of IndexerClientI.normalizeAccount
- Defined in packages/framework/src/services/indexer/src/client.ts:30

`Abstract` normalizeEntityId

normalizeEntityId(entity: IndexableEntityType, id: string): string
Parameters
- entity: IndexableEntityType
- id: string
Returns string
Implementation of IndexerClientI.normalizeEntityId
- Defined in packages/framework/src/services/indexer/src/client.ts:32

Class BaseIndexerClientAbstract

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

blockchainId: Blockchain

broker: ServiceBroker

msId: MsIds = MsIds.Indexer

Returns BaseIndexerClient

Properties

Protected blockchainId

Protected broker

Protected msId

Methods

deleteAccount

Parameters

args: Omit<AccountIndexerRequestArgs, "blockchainId">

broadcast: boolean = false

Returns Promise<void>

getAccountState

Parameters

args: Omit<GetAccountIndexingEntityStateRequestArgs, "blockchainId">

Returns Promise<undefined | AccountIndexerState>

getEntityPendingRequests

Parameters

args: Omit<GetEntityPendingRequestsRequestArgs, "blockchainId">

Returns Promise<EntityRequest[]>

indexAccount

Parameters

args: Omit<AccountIndexerRequestArgs, "blockchainId">

broadcast: boolean = false

Returns Promise<void>

invokeDomainMethod

Parameters

args: Omit<InvokeMethodRequestArgs, "blockchainId">

Returns Promise<unknown>

Abstract normalizeAccount

Parameters

account: string

Returns string

Abstract normalizeEntityId

Parameters

entity: IndexableEntityType

id: string

Returns string

Settings

Member Visibility

Theme

Class BaseIndexerClient`Abstract`

`Protected` blockchainId

`Protected` broker

`Protected` msId

`Abstract` normalizeAccount

`Abstract` normalizeEntityId