Skip to main content
Version: FireSquid

Quickstart: Substrate chains

The substrate squid template indexes transfers on the Kusama network. It is intended to be a stepping stone for building a custom squid for any Substrate-based chain.

Pre-requisites​

Before getting to work on your very first squid, verify that you have installed the following software:

  • Node v16.x or newer
  • Squid CLI v2.1.0 or newer

Please note:

  • The squid template is not compatible with yarn. Use npm instead.

Step 1: Scaffold from a template​

Come up with a new memorable name for your squid. Choose the template matching your network and scaffold using sqd init.

  • For indexing native events emitted by Substrate-based chains, use substrate
  • For indexing Frontier EVM contracts on Astar and Shiden use frontier-evm
  • For indexing ink! smart contracts, use ink
  • For indexing EVM+ contracts on Karura or Acala, use acala

For example:

sqd init my-awesome-squid --template substrate
cd my-awesome-squid

Step 2: Install dependencies​

npm ci

Step 3: Launch Postgres in a detached Docker container​

sqd up

Step 4: Create the database schema and run the processor​

The squid we have just built ingests pre-indexed data from a Kusama Archive. This data is then transformed, as defined by the data handler supplied to the processor.run() call in src/processor.ts.

This command will keep the console busy until manually terminated:

sqd process

Step 5: Start the GraphQL server​

Run in a separate terminal window:

sqd serve

The GraphQL playground is available at http://localhost:4350/graphql. Open it in a browser and run sample queries by applying filters and data selections in the panel to the left.

query MyQuery {
  accountsConnection(orderBy: id_ASC) {
    totalCount
  }
}

Step 6: Customize​

Hack the schema file schema.graphql and the processor src/processor.ts to index the data your way. Choose any supported network using the lookupArchive() method of @subsquid/archive-registry or run one locally.

What's next?​