Repository navigation
📝 [DOCS] Add Torii indexer overview #193
Description
📝 Description
Create a simplified overview documentation explaining Torii indexer and its
role in the Dojo ecosystem. Keep it concise and practical.
📚 Context
New developers need a quick understanding of what Torii is and why they need
it, without overwhelming technical details.
✅ Tasks
Torii Overview Documentation (pages/deployments/torii/overview.md)
-
What is Torii?
- Official indexing engine for Dojo worlds
- Automatically syncs blockchain state to a database
- Provides APIs to query game data efficiently
- Built in Rust for performance
- Comes pre-installed with Dojo toolchain
-
Why use Torii?
- Direct blockchain queries are slow and expensive
- Torii indexes your game state for instant access
- Real-time updates via subscriptions
- Multiple query options (GraphQL, gRPC, SQL)
-
How it works (simplified)
- Monitors your deployed World contract
- Captures all game state changes
- Stores data in local database
- Provides APIs for your client to query
-
API Interfaces
- GraphQL: Flexible queries with subscriptions
- Endpoint:
http://localhost:8080/graphql
- Endpoint:
- gRPC: High-performance binary protocol
- Endpoint:
http://localhost:8080
- Endpoint:
- GraphQL: Flexible queries with subscriptions
-
When to use Torii
- Fetching player statistics
- Building leaderboards
- Real-time game state updates
- Historical game data analysis
-
Installation Note
- Torii is included by default when you install Dojo
- No separate installation needed
📋 Acceptance Criteria
- Clear, concise explanation (no overwhelming details)
- Practical examples of use cases
- Mention that Torii comes with Dojo
- Links to deployment and integration guides
🎯 Expected Outcome
A developer should understand in 2-3 minutes:
- What Torii does
- Why they need it
- That it's already installed with Dojo
- What APIs it provides
💡 Additional Notes
- Keep technical jargon to minimum
- Focus on practical benefits
- Avoid deep architecture details
- Use simple analogies if helpful
📚 References
Contribution Guidelines
- Please ensure you read and follow the contribution guidelines in the project's README file
Activity
respp commentedon Aug 25, 2025
Hello @jimenezz22 Can I take this issue?
I'm a developer with a solid background in Web3, working across both front-end and back-end. I've contributed to projects in ecosystems like StarkNet, Stellar, Optimism, and Worldcoin, with a focus on building scalable, secure, and efficient blockchain applications.
Currently, I'm a Fellow at OnlyDust and a maintainer at PayStell and StellarRent, where I lead the development of smart contracts and decentralized infrastructure.
docs: add Torii indexer overview documentation
Villarley commentedon Aug 3, 2026
Starktesting
grantfox-oss-development commentedon Aug 3, 2026
🦊 GrantFox — @Villarley has been assigned to this issue!
Next steps:
Closes #193)Good luck! Track your progress on GrantFox.
grantfox-oss-qa commentedon Aug 3, 2026
🦊 GrantFox — @Villarley has been assigned to this issue as part of the Test Fund ALL RELEASE campaign!
Next steps:
Closes #193)Good luck! Track your progress on GrantFox.
grantfox-oss-development commentedon Aug 3, 2026
🎉 This issue has been marked as completed on GrantFox!
@Villarley's PR #203 was approved and merged by @coxmars.
🏆 @Villarley: You earned 35 FoxPoints for this contribution! Your current tier: Explorer (70 total points). Track your full progress on GrantFox.
👏 Great work, @Villarley! Keep contributing to AkatsukiLabs.
grantfox-oss-qa commentedon Aug 3, 2026
🎉 This issue has been marked as completed on GrantFox as part of the Test Fund ALL RELEASE campaign!
@Villarley's PR #203 was approved and merged by @coxmars.
🏆 @Villarley: You earned 35 FoxPoints for this contribution! Your current tier: Explorer (83 total points). Track your full progress on GrantFox.
👏 Great work, @Villarley! Keep contributing to AkatsukiLabs.