https://github.com/dojoengine/torii
Automatic indexer for Dojo.
https://github.com/dojoengine/torii
Last synced: 4 months ago
JSON representation
Automatic indexer for Dojo.
- Host: GitHub
- URL: https://github.com/dojoengine/torii
- Owner: dojoengine
- License: apache-2.0
- Created: 2025-04-16T05:33:16.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2026-01-21T01:18:47.000Z (5 months ago)
- Last Synced: 2026-01-21T12:42:03.716Z (5 months ago)
- Language: Rust
- Size: 47.8 MB
- Stars: 9
- Watchers: 2
- Forks: 5
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Agents: AGENTS.md
Awesome Lists containing this project
README
# Torii - Automatic Indexer for Dojo
Torii is a specialized indexer designed for Dojo games running on Starknet. It indexes and tracks onchain data changes, providing a comprehensive view of game state and history.
## Building
```bash
# Torii binary.
cargo build --bin torii
# Workspace.
cargo build --workspace
```
## Running Tests
Currently, the tests are based on pre-built Katana database to avoid
migrating the example each time (which takes a long time).
If you just pulled the repo, the pre-built databases are present, and you can uncompress them by running:
```bash
bash scripts/extract_test_db.sh
```
This will copy the databases in the `tmp` directory, ready to be used by the tests.
If you are working on Torii, then you will want to update the databases everytime you actually change the example cairo contracts. If you use `asdf`, the `.tool-versions` file will automatically install the correct version of Sozo and Katana. Soon the `dojoup` script will be updated to easily choose the toolchain version and the one to use too.
To rebuild the test artifacts, you can use the following script:
```bash
bash scripts/rebuild_test_artifacts.sh /path/to/sozo /path/to/katana
# If you have dojo with asdf, using `sozo` and `katana` will suffice, or if you have them already
# in the path with correect versions:
bash scripts/rebuild_test_artifacts.sh sozo katana
```
Finally, you can run the tests with:
```bash
# Use nextest to run the tests, adapt to your computer's resources.
KATANA_RUNNER_BIN=katana cargo nextest run --all-features --workspace --build-jobs 12
```
## Monitoring and Metrics
Torii includes comprehensive Prometheus metrics for monitoring indexer performance:
### Enable Metrics
```bash
torii --metrics --metrics.addr 0.0.0.0 --metrics.port 9200
```
### Grafana Integration
Torii includes pre-configured Grafana dashboards for visualizing metrics:
1. **Start Grafana and Prometheus**:
```bash
docker-compose -f docker-compose.grafana.yml up -d
```
2. **Access Grafana**:
- Open http://localhost:3000
- Login: admin/admin
- Navigate to "Torii Indexer Overview" dashboard
The dashboard provides insights into:
- Indexer fetch and process durations
- Event processing rates by contract type
- RPC call performance and error rates
- System backoff delays and error tracking
For detailed setup instructions, see [docs/grafana-setup.md](docs/grafana-setup.md).
## Linting
To check linting, several scripts are available. They also usually have a `--fix` option to automatically fix the linting errors.
```bash
bash scripts/rust_fmt.sh (--fix)
bash scripts/clippy.sh
```
## Documentation
For more detailed documentation, visit the [Dojo Book](https://book.dojoengine.org/toolchain/torii).
## License
This project is licensed under the Apache-2.0 License - see the [LICENSE](LICENSE) file for details.