A starter Squid project to demonstrate its structure and conventions. It accumulates kusama account transfers and serves them via GraphQL API.
yarn package manager is not supportedExample commands below use sqd. Please install it before proceeding.
# 1. Install dependencies
npm i
# 2. Start target Postgres database and detach
sqd up
# 3. Build the project
sqd build
# 4. Start both the squid processor and the GraphQL server
sqd run .A GraphiQL playground will be available at localhost:4350/graphql.
Subsquid provides archive data sources for most parachains. Use lookupArchive(<network name>, <lookup filters>) from @subsquid/archive-registry to look up the archive endpoint by the network name, e.g.
processor.setDataSource({
archive: lookupArchive("kusama", { release: "ArrowSquid" })
//...
});To make sure you're indexing the right chain one can additionally filter by the genesis block hash:
processor.setDataSource({
archive: lookupArchive("kusama", {
release: "ArrowSquid",
genesis: "0xb0a8d493285c2df73290dfb7e61f870f17b41801197a149ca93654499ea3dafe"
}),
//...
});If the chain is not yet supported, you can still index it using RPC ingestion. If you take this route, use metadata exporer with Substrate typegen for help with decoding.
You can also fill out this form to submit a request for an Archive/Subsquid Network dataset.
Self-hosted Archives are deprecated by the ArrowSquid release. Keep an eye on updates on Subsquid Network and use it instead once it is released.
Start development by defining the schema of the target database via schema.graphql.
Schema definition consists of regular graphql type declarations annotated with custom directives.
Full description of schema.graphql dialect is available here.
Mapping developers use TypeORM entities
to interact with the target database during data processing. All necessary entity classes are
generated by the squid framework from schema.graphql. This is done by running npx squid-typeorm-codegen
or (equivalently) sqd codegen command.
All database changes are applied through migration files located at db/migrations.
squid-typeorm-migration(1) tool provides several commands to drive the process.
It is all TypeORM under the hood.
# Connect to database, analyze its state and generate migration to match the target schema.
# The target schema is derived from entity classes generated earlier.
# Don't forget to compile your entity classes beforehand!
npx squid-typeorm-migration generate
# Create template file for custom database changes
npx squid-typeorm-migration create
# Apply database migrations from `db/migrations`
npx squid-typeorm-migration apply
# Revert the last performed migration
npx squid-typeorm-migration revert Available sqd shortcuts:
# Build the project, remove any old migrations, then run `npx squid-typeorm-migration generate`
sqd migration:generate
# Run npx squid-typeorm-migration apply
sqd migration:applyThis is an optional part, but it is very advisable.
Event, call and runtime storage data come to mapping handlers as raw untyped json. While it is possible to work with raw untyped json data, it's extremely error-prone and the json structure may change over time due to runtime upgrades.
Squid framework provides a tool for generating type-safe wrappers around events, calls and runtime storage items for each historical change in the spec version. See the Substrate typegen documentation page.
After a local run, obtain a deployment key by signing into Subsquid Cloud and run
npx sqd auth -k YOUR_DEPLOYMENT_KEYNext, inspect the Squid CLI help to deploy and manage your squid:
npx sqd squid --helpFor more information, consult the Deployment Guide.
Squid tools assume a certain project layout.
lib and all TypeScript sources in src.
The layout of lib must reflect src.src/model/index.ts (lib/model module).schema.graphql.db/migrations and must be plain js files.squid-*(1) executables consult .env file for a number of environment variables.See the full desription in the documentation.
Substrate chains that have blocks with metadata versions below 14 don't provide enough information to decode their data. For those chains, external type definitions are required.
Subsquid tools include definitions for many chains, however sometimes external definitions are still required.
You can pass them as a special json file (types bundle) of the following structure:
{
"types": {
"AccountId": "[u8; 32]"
},
"typesAlias": {
"assets": {
"Balance": "u64"
}
},
"versions": [
{
"minmax": [0, 1000], // spec version range with inclusive boundaries
"types": {
"AccountId": "[u8; 16]"
},
"typesAlias": {
"assets": {
"Balance": "u32"
}
}
}
]
}.types - scale type definitions similar to polkadot.js types.typesAlias - similar to polkadot.js type aliases.versions - per-block range overrides/patches for above fields.All fields in the type bundle are optional and applied on top of a fixed set of well-known frame types.
Note, that although the structure of subsquid types bundle is very similar to the one from polkadot.js, those two are not fully compatible.
Polkadot.js provides lots of specialized classes for various types of data.
Even primitives like u32 are exposed through special classes.
In contrast, the squid framework works only with plain js primitives and objects.
For instance, account data is passed to the handler context as a plain byte array. To convert it into a standard human-readable format one should explicitly use a utility lib @subsquid/ss58:
// ...
from: ss58.codec('kusama').encode(rec.from),
to: ss58.codec('kusama').encode(rec.to),It is possible to extend squid-graphql-server(1) with custom
type-graphql resolvers and to add request validation.
For more details, consult docs.