What you’ll get
Your Solana indexer (squid) will:- Fetch all historical USDC-SOL swaps made on Whirlpool
- Save the data to a local PostgreSQL database
- Start a GraphQL server with a rich API to query the indexed swaps
This tutorial focuses on Solana. For other chains, see the EVM Quickstart or Substrate Quickstart.
Prerequisites
Before you begin, ensure you have:- Node.js v20+ - Download here
- Git - Download here
- Docker - Download here (for running PostgreSQL)
- WSL (Windows only) - Install WSL
1
(Optional) Install Squid CLI
Install the Squid CLI globally:
Verify installation by running
sqd --version2
Scaffold the indexer project
Create a new squid project from the Whirlpool USDC-SOL swaps example:or, if you skipped the installation of Squid CLI
3
Inspect the project structure
Explore the project structure:Next,
hello-squid
db
src
abi
abi.support.ts
idl.support.ts
token-program.ts
whirlpool
main.ts
model
exchange.model.ts
index.ts
.env
docker-compose.yml
package.json
squid.yaml
tsconfig.json
src/main.ts: the main executable, with the data retrieval configuration and the processing logic.src/abi/whirlpool/: modules generated from the Whirlpool program IDL, used to filter and decode its instructions.src/abi/token-program.ts: a handwritten module for the SPL Token program.src/model/: TypeORM model classes used in database operations.
main.ts file first defines the data source object and configures its data retrieval options:main.ts
main.ts defines the data processing and storage logic. Data processing is defined in the batch handler, the callback that the run() function receives as its final argument:main.ts
4
Install dependencies and build
Install dependencies and build the project:
Verify the build completed successfully by checking for the
lib/ directory.5
Start the database and processor
The processor continuously fetches data, decodes it, and stores it in PostgreSQL. All logic is defined in Apply database migrations:Then start the processor:
main.ts and is fully customizable.First, start a local PostgreSQL database (the template includes a Docker Compose file):The indexer is now running and will begin processing blocks.
6
Start the GraphQL API
Start the GraphQL API to serve the transfer data:
7
Query the data
You can now query your indexed data! Check it out at the GraphiQL playground at localhost:4350/graphql.