@tezos-dappetizer/indexer

Index

Dappetizer Config

RPC Block Data

Client Indexer API

Applied

Applied<TOperation>: TOperation & { result: Exclude<TOperation["result"], { status: Exclude<OperationResultStatus, Applied> }> }

Limits operation results only to those with Applied status.

Type parameters

TOperation: OperationWithResult

IndexerModuleFactory

IndexerModuleFactory<TDbContext, TContextData>: (options: ModuleCreationOptions) => IndexerModule<TDbContext, TContextData>

Type parameters

TDbContext
TContextData = unknown

Type declaration

- (options: ModuleCreationOptions): IndexerModule<TDbContext, TContextData>
- Parameters
  - options: ModuleCreationOptions
  Returns IndexerModule<TDbContext, TContextData>

MainOperationWithBalanceUpdates

A main (top-level, directly in operation groups) operation with balance updates.

OperationWithBalanceUpdate

OperationWithBalanceUpdate: MainOperationWithBalanceUpdates | Applied<OriginationInternalOperation> | Applied<RegisterGlobalConstantInternalOperation> | Applied<TransactionInternalOperation>

A main or internal operation with balance updates.

OperationWithResult

OperationWithResult: MainOperationWithResults | InternalOperation

Either a main operation with a result or an internal operation. See unioned types.

Const INDEXER_DATABASE_HANDLER_DI_TOKEN

INDEXER_DATABASE_HANDLER_DI_TOKEN: InjectionToken<IndexerDatabaseHandler<unknown>> = ...

Const INDEXER_MODULES_DI_TOKEN

INDEXER_MODULES_DI_TOKEN: InjectionToken<IndexerModule<unknown, unknown>> = ...

Tsyringe token if you are using dependency injection manually.

Const INDEXER_MODULE_EXPORT_NAME

INDEXER_MODULE_EXPORT_NAME: "indexerModule" = 'indexerModule'

The property name in module.exports with an object implementing IndexerModule or related factory.

Other

ContractAbstraction

ContractAbstraction: taquito.ContractAbstraction<taquito.ContractProvider> & ReturnType<typeof taquitoTzip12.tzip12> & ReturnType<typeof taquitoTzip16.tzip16>

ContractEntrypointSchemas

ContractEntrypointSchemas: Readonly<Record<string, MichelsonSchema>>

GeneratedSchema

GeneratedSchema: DeepReadonly<taquitoMichelson.TokenSchema>

Michelson

Michelson: MichelsonPrim | MichelsonRawValue | readonly Michelson[]

Const BLOCK_LEVEL_INDEXING_LISTENERS_DI_TOKEN

BLOCK_LEVEL_INDEXING_LISTENERS_DI_TOKEN: InjectionToken<BlockLevelIndexingListener> = ...

Const CONTRACT_PROVIDER_DI_TOKEN

CONTRACT_PROVIDER_DI_TOKEN: InjectionToken<ContractProvider> = ...

Const INDEXER_PACKAGE_JSON_DI_TOKEN

INDEXER_PACKAGE_JSON_DI_TOKEN: InjectionToken<IndexerPackageJson> = ...

Const PARTIAL_INDEXER_MODULE_VERIFIERS_DI_TOKEN

PARTIAL_INDEXER_MODULE_VERIFIERS_DI_TOKEN: InjectionToken<PartialIndexerModuleVerifier> = ...

Const TAQUITO_TEZOS_TOOLKIT_DI_TOKEN

TAQUITO_TEZOS_TOOLKIT_DI_TOKEN: InjectionToken<TezosToolkit> = ...

Const michelsonDataPrims

michelsonDataPrims: Readonly<{ ELT: "Elt"; FALSE: "False"; LEFT: "Left"; NONE: "None"; PAIR: "Pair"; RIGHT: "Right"; SOME: "Some"; TRUE: "True"; UNIT: "Unit" }> = ...

Prims used in actual data.

Const michelsonTypePrims

michelsonTypePrims: Readonly<{ ADDRESS: "address"; BIG_MAP: "big_map"; BLS12_381_FR: "bls12_381_fr"; BLS12_381_G1: "bls12_381_g1"; BLS12_381_G2: "bls12_381_g2"; BOOL: "bool"; BYTES: "bytes"; CHAIN_ID: "chain_id"; CHEST: "chest"; CHEST_KEY: "chest_key"; CONSTANT: "constant"; CONTRACT: "contract"; INT: "int"; KEY: "key"; KEY_HASH: "key_hash"; LAMBDA: "lambda"; LIST: "list"; MAP: "map"; MUTEZ: "mutez"; NAT: "nat"; NEVER: "never"; OPERATION: "operation"; OPTION: "option"; OR: "or"; PAIR: "pair"; SAPLING_STATE: "sapling_state"; SAPLING_TRANSACTION: "sapling_transaction"; SET: "set"; SIGNATURE: "signature"; STRING: "string"; TICKET: "ticket"; TIMESTAMP: "timestamp"; UNIT: "unit" }> = ...

Prims used in type definitions, schemas.

Const versionInfo

versionInfo: Readonly<{ COMMIT_HASH: ""; VERSION: string }> = ...

createPrim

createPrim(prim: string, args: undefined | readonly Michelson[], annots: undefined | readonly string[]): MichelsonPrim

Avoids undefined and empty properties.

Parameters
- prim: string
- args: undefined | readonly Michelson[]
- annots: undefined | readonly string[]
Returns MichelsonPrim

flatRightCombPairs

flatRightCombPairs(michelson: Michelson): Michelson

Parameters
- michelson: Michelson
Returns Michelson

getSingleAnnot

getSingleAnnot(michelsonPrim: MichelsonPrim): string | null

Parameters
- michelsonPrim: MichelsonPrim
Returns string | null

getSingleAnnotCleaned

getSingleAnnotCleaned(michelsonPrim: MichelsonPrim): string | null

Parameters
- michelsonPrim: MichelsonPrim
Returns string | null

getUnderlyingMichelson

getUnderlyingMichelson(schema: Schema | ParameterSchema): Michelson

Parameters
- schema: Schema | ParameterSchema
Returns Michelson

isPrim

isPrim(michelson: Michelson): michelson is MichelsonPrim

Parameters
- michelson: Michelson
Returns michelson is MichelsonPrim

isRawValue

isRawValue(michelson: Michelson): michelson is MichelsonRawValue

Parameters
- michelson: Michelson
Returns michelson is MichelsonRawValue

registerDappetizerIndexer

registerDappetizerIndexer(diContainer: default): void

Parameters
- diContainer: default
Returns void

RPC Block Data

BalanceUpdate

BalanceUpdate: BalanceUpdateCommitment | BalanceUpdateContract | BalanceUpdateFreezer | BalanceUpdateLostEndorsingRewards | BalanceUpdateSimple

The update of the balance. It is the discriminated union which can be narrowed by kind or category.

BalanceUpdateFreezerCategory

BalanceUpdateSimpleCategory

BalanceUpdateSimpleKind

BalanceUpdateSimpleKind: Accumulator | Burned | Minted

BigMapDiff

BigMapDiff: BigMapAlloc | BigMapCopy | BigMapRemove | BigMapUpdate

DelegationResult

DelegationResult: AppliedDelegationResult | BacktrackedDelegationResult | FailedOperationResult | SkippedOperationResult

InternalOperation

InternalOperationKind

InternalOperationKind: Delegation | Origination | RegisterGlobalConstant | Reveal | Transaction

deprecated

MainOperationWithResults

The main (top-level, directly in operation groups) operation which has a result and also internal operations with their results. It is the discriminated union which can be narrowed by kind.

Operation

The main (top-level, directly in operation groups) operation. It is the discriminated union which can be narrowed by kind.

TaquitoRpcActivateAccountOperation

TaquitoRpcActivateAccountOperation: DeepReadonly<taquitoRpc.OperationContentsAndResultActivateAccount>

TaquitoRpcBalanceUpdate

TaquitoRpcBalanceUpdate: DeepReadonly<taquitoRpc.OperationBalanceUpdatesItem>

TaquitoRpcBallotOperation

TaquitoRpcBallotOperation: DeepReadonly<taquitoRpc.OperationContentsAndResultBallot>

TaquitoRpcBigMapDiff

TaquitoRpcBigMapDiff: DeepReadonly<taquitoRpc.ContractBigMapDiffItem>

TaquitoRpcBlock

TaquitoRpcBlock: DeepReadonly<taquitoRpc.BlockResponse>

TaquitoRpcBlockHeader

TaquitoRpcBlockHeader: DeepReadonly<taquitoRpc.BlockFullHeader>

TaquitoRpcContractScript

TaquitoRpcContractScript: DeepReadonly<taquitoRpc.ScriptedContracts>

TaquitoRpcDelegationOperation

TaquitoRpcDelegationOperation: DeepReadonly<taquitoRpc.OperationContentsAndResultDelegation>

TaquitoRpcDelegationResult

TaquitoRpcDelegationResult: DeepReadonly<taquitoRpc.OperationResultDelegation>

TaquitoRpcDoubleBakingEvidenceOperation

TaquitoRpcDoubleBakingEvidenceOperation: DeepReadonly<taquitoRpc.OperationContentsAndResultDoubleBaking>

TaquitoRpcDoubleEndorsementEvidenceOperation

TaquitoRpcDoubleEndorsementEvidenceOperation: DeepReadonly<taquitoRpc.OperationContentsAndResultDoubleEndorsement>

TaquitoRpcDoublePreendorsementEvidenceOperation

TaquitoRpcDoublePreendorsementEvidenceOperation: DeepReadonly<taquitoRpc.OperationContentsAndResultDoublePreEndorsement>

TaquitoRpcEndorsementOperation

TaquitoRpcEndorsementOperation: DeepReadonly<taquitoRpc.OperationContentsAndResultEndorsement>

TaquitoRpcEndorsementWithSlotOperation

TaquitoRpcEndorsementWithSlotOperation: DeepReadonly<taquitoRpc.OperationContentsAndResultEndorsementWithSlot>

TaquitoRpcInternalOperation

TaquitoRpcInternalOperation: DeepReadonly<taquitoRpc.InternalOperationResult>

TaquitoRpcInternalOperationResult

TaquitoRpcInternalOperationResult: TaquitoRpcInternalOperation["result"]

TaquitoRpcOperation

TaquitoRpcOperation: DeepReadonly<taquitoRpc.OperationContentsAndResult>

TaquitoRpcOperationError

TaquitoRpcOperationError: DeepReadonly<taquitoRpc.TezosGenericOperationError>

TaquitoRpcOperationGroup

TaquitoRpcOperationGroup: DeepReadonly<taquitoRpc.OperationEntry>

TaquitoRpcOriginationOperation

TaquitoRpcOriginationOperation: DeepReadonly<taquitoRpc.OperationContentsAndResultOrigination>

TaquitoRpcOriginationResult

TaquitoRpcOriginationResult: DeepReadonly<taquitoRpc.OperationResultOrigination>

TaquitoRpcPreendorsementOperation

TaquitoRpcPreendorsementOperation: DeepReadonly<taquitoRpc.OperationContentsAndResultPreEndorsement>

TaquitoRpcProposalsOperation

TaquitoRpcProposalsOperation: DeepReadonly<taquitoRpc.OperationContentsAndResultProposals>

TaquitoRpcRegisterGlobalConstantOperation

TaquitoRpcRegisterGlobalConstantOperation: DeepReadonly<taquitoRpc.OperationContentsAndResultRegisterGlobalConstant>

TaquitoRpcRegisterGlobalConstantResult

TaquitoRpcRegisterGlobalConstantResult: DeepReadonly<taquitoRpc.OperationResultRegisterGlobalConstant>

TaquitoRpcRevealOperation

TaquitoRpcRevealOperation: DeepReadonly<taquitoRpc.OperationContentsAndResultReveal>

TaquitoRpcRevealResult

TaquitoRpcRevealResult: DeepReadonly<taquitoRpc.OperationResultReveal>

TaquitoRpcSeedNonceRevelationOperation

TaquitoRpcSeedNonceRevelationOperation: DeepReadonly<taquitoRpc.OperationContentsAndResultRevelation>

TaquitoRpcSetDepositsLimitOperation

TaquitoRpcSetDepositsLimitOperation: DeepReadonly<taquitoRpc.OperationContentsAndResultSetDepositsLimit>

TaquitoRpcSetDepositsLimitResult

TaquitoRpcSetDepositsLimitResult: DeepReadonly<taquitoRpc.OperationResultSetDepositsLimit>

TaquitoRpcTransactionOperation

TaquitoRpcTransactionOperation: DeepReadonly<taquitoRpc.OperationContentsAndResultTransaction>

TaquitoRpcTransactionParameter

TaquitoRpcTransactionParameter: DeepReadonly<taquitoRpc.TransactionOperationParameter>

TaquitoRpcTransactionResult

TaquitoRpcTransactionResult: DeepReadonly<taquitoRpc.OperationResultTransaction>

TransactionResult

TransactionResult: AppliedTransactionResult | BacktrackedTransactionResult | FailedOperationResult | SkippedOperationResult

Index

Client Indexer API

Dappetizer Config

Other

RPC Block Data

Client Indexer API

Applied

Type parameters

TOperation: OperationWithResult

IndexerModuleFactory

Type parameters

TDbContext

TContextData = unknown

Type declaration

Parameters

options: ModuleCreationOptions

Returns IndexerModule<TDbContext, TContextData>

MainOperationWithBalanceUpdates

OperationWithBalanceUpdate

OperationWithResult

Const INDEXER_DATABASE_HANDLER_DI_TOKEN

Const INDEXER_MODULES_DI_TOKEN

Const INDEXER_MODULE_EXPORT_NAME

Other

ContractAbstraction

ContractEntrypointSchemas

GeneratedSchema

Michelson

Const BLOCK_LEVEL_INDEXING_LISTENERS_DI_TOKEN

Const CONTRACT_PROVIDER_DI_TOKEN

Const INDEXER_PACKAGE_JSON_DI_TOKEN

Const PARTIAL_INDEXER_MODULE_VERIFIERS_DI_TOKEN

Const TAQUITO_TEZOS_TOOLKIT_DI_TOKEN

Const michelsonDataPrims

Const michelsonTypePrims

Const versionInfo

createPrim

Parameters

prim: string

args: undefined | readonly Michelson[]

annots: undefined | readonly string[]

Returns MichelsonPrim

flatRightCombPairs

Parameters

michelson: Michelson

Returns Michelson

getSingleAnnot

Parameters

michelsonPrim: MichelsonPrim

Returns string | null

getSingleAnnotCleaned

Parameters

michelsonPrim: MichelsonPrim

Returns string | null

getUnderlyingMichelson

Parameters

schema: Schema | ParameterSchema

Returns Michelson

isPrim

Parameters

michelson: Michelson

Returns michelson is MichelsonPrim

isRawValue

Parameters

michelson: Michelson

Returns michelson is MichelsonRawValue

registerDappetizerIndexer

Parameters

diContainer: default

Returns void

RPC Block Data

BalanceUpdate

BalanceUpdateFreezerCategory

BalanceUpdateSimpleCategory

BalanceUpdateSimpleKind

BigMapDiff

DelegationResult

InternalOperation

InternalOperationKind

MainOperationWithResults