Packages overview

Squid SDK is modular: a squid combines a chain-specific data source, a store, and optional code-generation and serving tools. This page lists the packages relevant to EVM squids.

One package: `@subsquid/squid-sdk`

For Portal-native EVM squids, the @subsquid/squid-sdk package bundles the whole toolkit behind one dependency with subpath imports:

import {run} from '@subsquid/squid-sdk/processor'
import {DataSourceBuilder} from '@subsquid/squid-sdk/evm'
import {TypeormDatabase} from '@subsquid/squid-sdk/store/typeorm'

Subpath	Contents
`evm`	EVM Portal stream — `DataSourceBuilder`
`evm/objects`	Block augmentation (`augmentBlock`)
`evm/rpc`	RPC data source — needs the optional peers below
`evm/fallback`	Fallback data source
`fallback`	Chain-agnostic fallback machinery (policy types, metrics sink)
`processor`	`run()` and `Processor`
`store/typeorm`	TypeORM store
`logger`	Logger
`client/portal`, `client/http`, `client/rpc`	Portal, HTTP, and RPC clients
`util`, `util/*`	Range, hex, JSON, and data-source utilities

Two optional peer packages, @subsquid/evm-rpc and @subsquid/evm-normalization, are required only when the evm/rpc subpath (or an rpc fallback source) is used. The subpaths also work under the classic TypeScript resolution used by standard squid tsconfigs (module: commonjs) — the package ships per-subpath type redirects, so autocomplete works without moduleResolution changes.

Individual packages

The same functionality remains available as standalone packages — existing squids need not migrate:

@subsquid/evm-stream + @subsquid/batch-processor — Portal-native data source and runner
@subsquid/evm-objects — block augmentation
@subsquid/evm-typegen — ABI-based utility module generator; its output imports @subsquid/evm-abi and @subsquid/evm-codec (install both)

Stores

Any store works with any data source:

@subsquid/typeorm-store — PostgreSQL, with @subsquid/typeorm-codegen (dev dependency) and @subsquid/typeorm-migration
@subsquid/file-store — filesystem datasets (CSV, JSON, Parquet, local or S3)
@subsquid/bigquery-store — Google BigQuery

The store contract itself is documented in Store interface.

Serving and tooling

@subsquid/graphql-server — the OpenReader GraphQL server, derived from the schema file
Hasura configuration tool — for Hasura-based APIs
@subsquid/logger — structured logging
Squid CLI — scaffolding (sqd init), command runner, and SQD Cloud deployment

Overview

Pipes SDK

Squid SDK

Alternative clients

One package: `@subsquid/squid-sdk`

Individual packages

Stores

Serving and tooling

​One package: @subsquid/squid-sdk

​Individual packages

​Stores

​Serving and tooling

One package: `@subsquid/squid-sdk`

Individual packages

Stores

Serving and tooling