Squid SDK Quickstart

This quickstart scaffolds the current EVM template, indexes ETH burn transactions, stores them in PostgreSQL, and exposes them through GraphQL.

Prerequisites

Node.js 20 or newer
Git
Docker with Compose
An SQD Network API key

Install the Squid CLI

npm i -g @subsquid/cli@latest
sqd --version

The version output has the form @subsquid/cli/<version>.

Scaffold the current EVM template

sqd init hello-squid -t evm
cd hello-squid
npm i

The evm alias is maintained by the CLI. It currently retrieves subsquid-labs/squid-evm-template.

Configure access to the v2 gateway

Add your data API key to the existing .env file:

.env

SQD_API_KEY=<YOUR_SQD_NETWORK_API_KEY>

EvmBatchProcessor reads this variable automatically when .setGateway() receives a URL. You can instead pass .setGateway({url, apiKey}), but do not commit a real key.

The key is for SQD Network v2 gateway access. It is separate from the optional SQD Cloud deployment key used by sqd auth.

Build the project

sqd build

The template defines build in commands.json. The command generates JavaScript in lib/ and stops on TypeScript errors.

Start PostgreSQL

sqd up

This runs the template’s Docker Compose service with the connection settings from .env.

Run the processor and GraphQL server

sqd run .

The CLI starts the processor and GraphQL services declared in squid.yaml. The processor command applies pending database migrations before it starts.The processor in src/processor.ts uses EvmBatchProcessor to request transactions sent to the zero address. The handler in src/main.ts turns each transaction into a Burn entity and inserts the batch through ctx.store.

Query indexed data

Open http://localhost:4350/graphql and run:

query RecentBurns {
  burns(limit: 10, orderBy: block_DESC) {
    id
    block
    address
    value
    txHash
  }
}

Stop the CLI with Ctrl+C. Remove the local database container with:

sqd down

What to change next

Edit src/processor.ts to select the transactions, logs, traces, or state diffs your application needs.
Edit schema.graphql, then run sqd codegen and sqd migration:generate after model changes.
For Portal-native ingestion, use @subsquid/evm-stream or migrate an existing processor with the Portal migration guide.

Overview

Pipes SDK

Squid SDK

Alternative clients

Prerequisites

What to change next

​Prerequisites

​What to change next

Prerequisites

What to change next