https://github.com/subsquid/squid-sdk

The main repo of the squid SDK
https://github.com/subsquid/squid-sdk

Last synced: 5 days ago
JSON representation

The main repo of the squid SDK

• Host: GitHub
• URL: https://github.com/subsquid/squid-sdk
• Owner: subsquid
• License: apache-2.0
• Created: 2021-12-10T11:39:00.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2025-01-03T11:44:42.000Z (9 days ago)
• Last Synced: 2025-01-04T05:07:00.915Z (8 days ago)
• Language: TypeScript
• Homepage:
• Size: 15.1 MB
• Stars: 1,235
• Watchers: 22
• Forks: 155
• Open Issues: 36
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-evm-data-tools - Squid SDK - is a set of open source Typescript libraries that retrieve, decode, transform and persist the data. (Indexers)
• awesome-evm-data-tools - Squid SDK - is a set of open source Typescript libraries that retrieve, decode, transform and persist the data. (Indexers)
• best-of-crypto - GitHub - 39% open · ⏱️ 03.06.2024): (Others)

README

        
# Squid SDK - an ETL framework for Web3 data

Subsquid SDK is a TypeScript ETL toolkit for blockchain data, that currently supports

* Ethereum and everything Ethereum-like

* [Substrate](https://substrate.io)-based chains

* Solana.

Subsquid SDK stands apart from the competition by

* Being a toolkit (rather than an indexing app like TheGraph or Ponder)

* Fast binary data codecs and type-safe access to decoded data

* Native support for sourcing the data from Subsquid Network.

The latter is a key point, as [Subsquid Network](https://docs.subsquid.io/subsquid-network/overview/) 

is a decentralized data lake and query engine,

that allows to granularly select and stream subset of block data to lightweight clients

while providing game changing performance over traditional RPC API.

## Getting started

The best way to get started is to install [squid CLI](https://github.com/subsquid/squid-cli) and scaffold a squid project with [`sqd init`](https://docs.subsquid.io/squid-cli/init/). 

For step-by-step instructions, follow one of the [Quickstart guides](https://docs.subsquid.io/quickstart/).

## Developer community

Our developers are active on [Telegram](https://t.me/HydraDevs) and [Discord](https://discord.gg/subsquid). Feel free to join and ask any question!

## Contributing

Subsquid is an OpenSource project, contributions are welcomed, encouraged and will be rewarded!

Please consult [CONTRIBUTING.md](CONTRIBUTING.md) for hacking instructions

and make sure to read our [code of conduct](CODE_OF_CONDUCT.md).