Avalanche Manifest File

... 2022-9-24 About 4 min

# Avalanche Manifest File

The Manifest project.yaml file can be seen as an entry point of your project and it defines most of the details on how SubQuery will index and transform the chain data. It clearly indicates where we are indexing data from, and to what on chain events we are subscribing to.

The Manifest can be in either YAML or JSON format. In this document, we will use YAML in all the examples.

Below is a standard example of a basic Avalanche project.yaml.

specVersion: 1.0.0
name: avalanche-subql-starter
version: 0.0.1
runner:
  node:
    name: "@subql/node-avalanche"
    version: latest
  query:
    name: "@subql/query"
    version: latest
description: "This project can be use as a starting point for developing your Avalanche based SubQuery project"
repository: https://github.com/subquery/avalanche-subql-starter
schema:
  file: ./schema.graphql
network:
  chainId: "mainnet"
  subnet: "C"
  # This endpoint must be a public non-pruned archive node
  # Public nodes may be rate limited, which can affect indexing speed
  # When developing your project we suggest getting a private API key
  # You can get them from OnFinality for free https://app.onfinality.io
  # https://documentation.onfinality.io/support/the-enhanced-api-service
  endpoint: "https://avalanche.api.onfinality.io/public"
  # Optionally provide the HTTP endpoint of a full chain dictionary to speed up processing
  dictionary: https://api.subquery.network/sq/subquery/avalanche-dictionary
dataSources:
  - kind: avalanche/Runtime
    startBlock: 1 # Block to start indexing from
    options:
      # Must be a key of assets
      abi: erc20
      ## Pangolin token https://snowtrace.io/token/0x60781c2586d68229fde47564546784ab3faca982
      address: "0x60781C2586D68229fde47564546784ab3fACA982"
    assets:
      erc20:
        file: "IPangolinERC20.json"
    mapping:
      file: ./dist/index.js
      handlers:
        - handler: handleBlock
          kind: avalanche/BlockHandler
        - handler: handleTransaction
          kind: avalanche/TransactionHandler
          filter:
            ## The function can either be the function fragment or signature
            # function: '0x095ea7b3'
            # function: '0x7ff36ab500000000000000000000000000000000000000000000000000000000'
            function: approve(address spender, uint256 rawAmount)
            ## from: "0x60781C2586D68229fde47564546784ab3fACA982"
        - handler: handleLog
          kind: avalanche/LogHandler
          filter:
            topics:
              ## Follows standard log filters https://docs.ethers.io/v5/concepts/events/
              - Transfer(address indexed from, address indexed to, uint256 amount)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

# Overview

# Top Level Spec

Field Type Description
specVersion String The spec version of the manifest file
name String Name of your project
version String Version of your project
description String Discription of your project
repository String Git repository address of your project
schema Schema Spec The location of your GraphQL schema file
network Network Spec Detail of the network to be indexed
dataSources DataSource Spec The datasource to your project
templates Templates Spec Allows creating new datasources from this templates
runner Runner Spec Runner specs info

# Schema Spec

Field Type Description
file String The location of your GraphQL schema file

# Network Spec

If you start your project by using the subql init command, you'll generally receive a starter project with the correct network settings. If you are changing the target chain of an existing project, you'll need to edit the Network Spec section of this manifest.

The chainId is the network identifier of the blockchain. Examples in Avalanche might be mainnet.

Additionally you will need to update the endpoint. This defines the wss endpoint of the blockchain to be indexed - this must be a full archive node. You can retrieve endpoints for all parachains for free from OnFinality (opens new window)

Field Type Description
chainId String A network identifier for the blockchain
endpoint String Defines the wss or ws endpoint of the blockchain to be indexed - This must be a full archive node. You can retrieve endpoints for all parachains for free from OnFinality (opens new window)
port Number Optional port number on the endpoint to connect to
dictionary String It is suggested to provide the HTTP endpoint of a full chain dictionary to speed up processing - read how a SubQuery Dictionary works.

# Runner Spec

Field Type Description
node Runner node spec Describe the node service use for indexing
query Runner query spec Describe the query service

# Runner Node Spec

Field Type Description
name String @subql/node-avalanche
version String Version of the indexer Node service, it must follow the SEMVER (opens new window) rules or latest, you can also find available versions in subquery SDK releases (opens new window)

# Runner Query Spec

Field Type Description
name String @subql/query
version String Version of the Query service, available versions can be found here (opens new window), it also must follow the SEMVER rules or latest.

# Datasource Spec

Defines the data that will be filtered and extracted and the location of the mapping function handler for the data transformation to be applied.

Field Type Description
kind string avalanche/Runtime
startBlock Integer This changes your indexing start block, set this higher to skip initial blocks with less data
mapping Mapping Spec

# Mapping Spec

Field Type Description
handlers & filters Default handlers and filters List all the mapping functions and their corresponding handler types, with additional mapping filters.

# Data Sources and Mapping

In this section, we will talk about the default Avalanche runtime and its mapping. Here is an example:

dataSources:
  - kind: avalanche/Runtime # Indicates that this is default runtime
    startBlock: 1 # This changes your indexing start block, set this higher to skip initial blocks with less data
    mapping:
      file: dist/index.js # Entry path for this mapping
      ...
1
2
3
4
5
6

# Mapping handlers and Filters

The following table explains filters supported by different handlers.

Your SubQuery project will be much more efficient when you only use TransactionHandler or LogHandler handlers with appropriate mapping filters (e.g. NOT a BlockHandler).

Handler Supported filter
BlockHandler No filters
TransactionHandler function filters (either be the function fragment or signature), from (address), to (address)
LogHandler topics filters, and address

Default runtime mapping filters are an extremely useful feature to decide what block, event, or extrinsic will trigger a mapping handler.

Only incoming data that satisfy the filter conditions will be processed by the mapping functions. Mapping filters are optional but are highly recommended as they significantly reduce the amount of data processed by your SubQuery project and will improve indexing performance.

The modulo filter allows handling every N blocks, which is useful if you want to group or calculate data at a set interval. The following example shows how to use this filter.

filter:
  modulo: 50 # Index every 50 blocks: 0, 50, 100, 150....
1
2

# Validating

You can validate your project manifest by running subql validate. This will check that it has the correct structure, valid values where possible and provide useful feedback as to where any fixes should be made.

Last update: September 24, 2022 05:55