Use This When
- you need a backend to keep a SQL view of on-chain events or account state
- you want to expose indexed chain data through app APIs
- you need filtering, joins, and pagination over chain data that would be awkward to do directly from RPC
Core Packages
| Package | Role |
|---|---|
@thru/indexer | Defines streams, manages checkpoints, writes rows to Postgres, and can mount generated API routes. |
@thru/replay | Supplies the historical-plus-live replay layer and the ChainClient used by the indexer runtime. |
The Shape Of A Thru Indexer
Most projects follow this pattern:- define one or more event or account streams
- export the resulting stream tables in the Drizzle schema
- construct
new Indexer(...)with a DB client,ChainClientfactory, and stream arrays - optionally mount generated routes for those streams in a Hono app
Start Here
Quickstart
Build the smallest working token indexer with one event stream and one account stream.
Streams
Learn how event streams and account streams differ, and how to write each safely.
Running the Indexer
See the runtime architecture, tech-stack assumptions, and the indexer boot flow.
Querying Indexed Data
Query stream tables directly or expose them through generated routes.
Next Steps
- Read Quickstart for the first successful end-to-end setup.
- Move to Streams when you need to add or customize event or account parsing.
- Use Running the Indexer when you are wiring runtime config, checkpoints, migrations, or deployment shape.
- Use Querying Indexed Data once data is landing in Postgres.