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 Substrate squids.

​

Data source

• @subsquid/substrate-processor — SubstrateBatchProcessor, the Substrate data source and runner

​

Typegen and Substrate utilities

• @subsquid/substrate-typegen — runtime-aware pallet data decoding and storage queries
• @subsquid/ink-typegen — decoders for ink! contracts
• @subsquid/ss58 — SS58 address encoding/decoding
• @subsquid/frontier — Frontier EVM pallet data extraction

​

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