Options
All
  • Public
  • Public/Protected
  • All
Menu

Module @tezos-dappetizer/indexer

Index

Client Indexer API

Dappetizer Config

Other

RPC Block Data

Client Indexer API

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

Limits operation results only to those with Applied status.

Type parameters

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

Type parameters

  • TDbContext

  • TContextData = unknown

Type declaration

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

A main or internal operation with balance updates.

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

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

Tsyringe token if you are using dependency injection manually.

INDEXER_MODULE_EXPORT_NAME: "indexerModule" = 'indexerModule'

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

Other

ContractAbstraction: taquito.ContractAbstraction<taquito.ContractProvider> & ReturnType<typeof taquitoTzip12.tzip12> & ReturnType<typeof taquitoTzip16.tzip16>
ContractEntrypointSchemas: Readonly<Record<string, MichelsonSchema>>
GeneratedSchema: DeepReadonly<taquitoMichelson.TokenSchema>
Michelson: MichelsonPrim | MichelsonRawValue | readonly Michelson[]
BLOCK_LEVEL_INDEXING_LISTENERS_DI_TOKEN: InjectionToken<BlockLevelIndexingListener> = ...
CONTRACT_PROVIDER_DI_TOKEN: InjectionToken<ContractProvider> = ...
INDEXER_PACKAGE_JSON_DI_TOKEN: InjectionToken<IndexerPackageJson> = ...
PARTIAL_INDEXER_MODULE_VERIFIERS_DI_TOKEN: InjectionToken<PartialIndexerModuleVerifier> = ...
TAQUITO_TEZOS_TOOLKIT_DI_TOKEN: InjectionToken<TezosToolkit> = ...
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.

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.

versionInfo: Readonly<{ COMMIT_HASH: ""; VERSION: string }> = ...
  • 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

  • getSingleAnnotCleaned(michelsonPrim: MichelsonPrim): string | null
  • getUnderlyingMichelson(schema: Schema | ParameterSchema): Michelson
  • Parameters

    • schema: Schema | ParameterSchema

    Returns Michelson

  • registerDappetizerIndexer(diContainer: default): void
  • Parameters

    • diContainer: default

    Returns void

RPC Block Data

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

BalanceUpdateFreezerCategory: Deposits | Fees | LegacyDeposits | LegacyFees | LegacyRewards | Rewards
BalanceUpdateSimpleKind: Accumulator | Burned | Minted
deprecated

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.

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

TaquitoRpcActivateAccountOperation: DeepReadonly<taquitoRpc.OperationContentsAndResultActivateAccount>
TaquitoRpcBalanceUpdate: DeepReadonly<taquitoRpc.OperationBalanceUpdatesItem>
TaquitoRpcBallotOperation: DeepReadonly<taquitoRpc.OperationContentsAndResultBallot>
TaquitoRpcBigMapDiff: DeepReadonly<taquitoRpc.ContractBigMapDiffItem>
TaquitoRpcBlock: DeepReadonly<taquitoRpc.BlockResponse>
TaquitoRpcBlockHeader: DeepReadonly<taquitoRpc.BlockFullHeader>
TaquitoRpcContractScript: DeepReadonly<taquitoRpc.ScriptedContracts>
TaquitoRpcDelegationOperation: DeepReadonly<taquitoRpc.OperationContentsAndResultDelegation>
TaquitoRpcDelegationResult: DeepReadonly<taquitoRpc.OperationResultDelegation>
TaquitoRpcDoubleBakingEvidenceOperation: DeepReadonly<taquitoRpc.OperationContentsAndResultDoubleBaking>
TaquitoRpcDoubleEndorsementEvidenceOperation: DeepReadonly<taquitoRpc.OperationContentsAndResultDoubleEndorsement>
TaquitoRpcDoublePreendorsementEvidenceOperation: DeepReadonly<taquitoRpc.OperationContentsAndResultDoublePreEndorsement>
TaquitoRpcEndorsementOperation: DeepReadonly<taquitoRpc.OperationContentsAndResultEndorsement>
TaquitoRpcEndorsementWithSlotOperation: DeepReadonly<taquitoRpc.OperationContentsAndResultEndorsementWithSlot>
TaquitoRpcInternalOperation: DeepReadonly<taquitoRpc.InternalOperationResult>
TaquitoRpcInternalOperationResult: TaquitoRpcInternalOperation["result"]
TaquitoRpcOperation: DeepReadonly<taquitoRpc.OperationContentsAndResult>
TaquitoRpcOperationError: DeepReadonly<taquitoRpc.TezosGenericOperationError>
TaquitoRpcOperationGroup: DeepReadonly<taquitoRpc.OperationEntry>
TaquitoRpcOriginationOperation: DeepReadonly<taquitoRpc.OperationContentsAndResultOrigination>
TaquitoRpcOriginationResult: DeepReadonly<taquitoRpc.OperationResultOrigination>
TaquitoRpcPreendorsementOperation: DeepReadonly<taquitoRpc.OperationContentsAndResultPreEndorsement>
TaquitoRpcProposalsOperation: DeepReadonly<taquitoRpc.OperationContentsAndResultProposals>
TaquitoRpcRegisterGlobalConstantOperation: DeepReadonly<taquitoRpc.OperationContentsAndResultRegisterGlobalConstant>
TaquitoRpcRegisterGlobalConstantResult: DeepReadonly<taquitoRpc.OperationResultRegisterGlobalConstant>
TaquitoRpcRevealOperation: DeepReadonly<taquitoRpc.OperationContentsAndResultReveal>
TaquitoRpcRevealResult: DeepReadonly<taquitoRpc.OperationResultReveal>
TaquitoRpcSeedNonceRevelationOperation: DeepReadonly<taquitoRpc.OperationContentsAndResultRevelation>
TaquitoRpcSetDepositsLimitOperation: DeepReadonly<taquitoRpc.OperationContentsAndResultSetDepositsLimit>
TaquitoRpcSetDepositsLimitResult: DeepReadonly<taquitoRpc.OperationResultSetDepositsLimit>
TaquitoRpcTransactionOperation: DeepReadonly<taquitoRpc.OperationContentsAndResultTransaction>
TaquitoRpcTransactionParameter: DeepReadonly<taquitoRpc.TransactionOperationParameter>
TaquitoRpcTransactionResult: DeepReadonly<taquitoRpc.OperationResultTransaction>

Generated using TypeDoc