Skip to content

📝 [DOCS] Add Torii indexer overview #193

@jimenezz22

Description

@jimenezz22

📝 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)

    1. Monitors your deployed World contract
    2. Captures all game state changes
    3. Stores data in local database
    4. Provides APIs for your client to query
  • API Interfaces

    • GraphQL: Flexible queries with subscriptions
      • Endpoint: http://localhost:8080/graphql
    • gRPC: High-performance binary protocol
      • Endpoint: http://localhost:8080
  • 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:

  1. What Torii does
  2. Why they need it
  3. That it's already installed with Dojo
  4. 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

Metadata

Metadata

Assignees

Labels

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions