https://github.com/rebase-agency/evm-blocks-squid
Blocks indexer for EVM based chains with GraphQL API available out of the box
https://github.com/rebase-agency/evm-blocks-squid
blockchain blocks docker docker-image evm squid subsquid typescript web3
Last synced: 5 months ago
JSON representation
Blocks indexer for EVM based chains with GraphQL API available out of the box
- Host: GitHub
- URL: https://github.com/rebase-agency/evm-blocks-squid
- Owner: rebase-agency
- License: mit
- Created: 2024-01-23T11:17:24.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-11-28T09:28:22.000Z (7 months ago)
- Last Synced: 2025-11-30T17:56:43.042Z (7 months ago)
- Topics: blockchain, blocks, docker, docker-image, evm, squid, subsquid, typescript, web3
- Language: TypeScript
- Homepage:
- Size: 835 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# EVM Blocks Squid
🚀 Blazing fast* and simple real-time blocks indexer for EVM based chains with GraphQL API available out of the box which
can be quickly configured with environment variables and deployed anywhere with Docker. Details about deployment and
configuration will be described soon.
* – the maximum indexing speed can be reached with Subsquid Gateways. The list of supported EVM chains can be found
[here](https://docs.subsquid.io/subsquid-network/reference/evm-networks).
More information about Squids and Subsquid protocol can be found in the [offical documentation](https://docs.subsquid.io).
## Local running
```bash
# 1. Install dependencies
npm ci
# 2. Start a Postgres database container and detach
sqd up
# 3. Build the squid
sqd build
# 4. Start both the squid processor and the GraphQL server
sqd run .
```
A GraphiQL playground will be available at [localhost:4350/graphql](http://localhost:4350/graphql).
You can also start squid services one by one:
```bash
sqd process
sqd serve
```
## Project conventions
Squid tools assume a certain [project layout](https://docs.subsquid.io/basics/squid-structure):
* All compiled js files must reside in `lib` and all TypeScript sources in `src`.
The layout of `lib` must reflect `src`.
* All TypeORM classes must be exported by `src/model/index.ts` (`lib/model` module).
* Database schema must be defined in `schema.graphql`.
* Database migrations must reside in `db/migrations` and must be plain js files.
* `sqd(1)` and `squid-*(1)` executables consult `.env` file for environment variables.