subsquid
Search…
Query Node Manifest

Overview

Field
Type
Description
version
String
A Semver version indicating which version of this API is being used.
description
String
An optional description of the substrate chain.
hydraVersion
String
SemVer range of Hydra Processor used by the mappings.
repository
String
An optional link to where the subgraph lives.
typegen
TypeGen Spec
Specification for Typegen tool

Typegen

Field
Type
Description
metadata
String
The type of data source. Possible values: substrate.
metadata.source
String
Chain name
metadata.blockHash
String
block hash to from where the metadata is fetched
events
List
A list of event names for which the typescript classes will be generated
calls
List
A list of extrinsics to be generated
outDir
String
The root directory of the generated classes
customTypes.lib
String
Name of a TypeScript library with custom type interface definitions
customTypes.typedefsLoc
String
Location of the type definitions json

Mapping

The mapping field may be one of the following supported mapping manifests:
Field
Type
Description
mappingsModule
String
A JS module to be loaded by the processor (should have all the handler functions exported)
range
String
A string representation of the block height range for the run (see Range rep for details)
eventHandlers
List of Handler Spec
Specification of event handlers
extrinsicHandlers
List of Handler Spec
Specification of extrinsic handlers
preBlockHooks
List of Handler Spec
Specification of hooks run before all the events in the block
postBlockHooks
List of Handler Spec
Specification of hooks run after all the events in the block

Handler

Field
Type
Description
handler
String
Handler name
event
String
(For eventHandlers only) An identifier for an event that will be handled in the mapping script.
extrinsic
String
(For extrinsicHandlers only) An identifier for an extrinsic that will be handled in the mapping script.
triggerEvents
String
(For extrinsicHandlers only) A list of event identifier that triggers the extrinsic handlers. Default: system.ExtrinsicSuccess
filter
Filter Spec
Additional filter specifying the condition for the handler to be triggered
filter.height
String
String representation of the block height range
filter.specVersion
String
Range of RuntimeVersion.specVersion. Useful when dealing with runtime upgrades
Range
Range is an open, semi-open, or closed interval. An interval can either be finite or infinite. It is represented by a string as below
From X to Y, inclusive: [X, Y]
From X to Y, exclusive: (X, Y)
From X (excl) to Y, incl: (X, Y]
From X (excl) to infinity: (X, )
Last modified 7d ago
Copy link