Skip to content

📝 [DOCS] Add Torii indexer deployment guide for Sepolia and Mainnet #192

Description

@jimenezz22

📝 Description

We need to create comprehensive documentation for deploying Torii indexer on
both Sepolia testnet and Mainnet. Since both processes are nearly identical
(only RPC URL changes), we'll create a unified guide with network-specific
configurations.

📚 Context

The /deployments/torii.md page needs detailed content for deploying and
configuring Torii indexer for both Sepolia and Mainnet networks.

✅ Tasks

Torii Deployment Documentation (pages/deployments/torii.md)

  • Prerequisites

    • Document requirement for deployed contracts first using slot/sepolia/mainnet
    • Mention need for funded deployer account
  • Building & Testing

    sozo build
    sozo test
    
  • Environment Setup

    • Document required environment variables:
      export STARKNET_RPC_URL="<network_rpc_url>"
      export DEPLOYER_ACCOUNT_ADDRESS="<your_deployer_account_address>"
      export DEPLOYER_PRIVATE_KEY="<your_deployer_private_key>"
    • Include warning about funding deployer account
  • World Deployment Configuration

    • Explain seed configuration in dojo_sepolia.toml / dojo_mainnet.toml
      seed = "tamagotchi1" # Change to "tamagotchi2", etc. for new world
  • Torii Configuration File

    • Create torii-config.toml template:

The World address to index

world_address = "YOUR_WORLD_ADDRESS"

RPC URL - Network specific

rpc = "NETWORK_RPC_URL"

[indexing]
allowed_origins = ["*"]
transactions = true
pending = true
polling_interval = 1000
contracts = []

[events]
raw = true

[sql]
historical = ["tamagotchi-TrophyProgression"]

📋 Acceptance Criteria

  • Complete step-by-step guide for Torii deployment
  • Clear differentiation between Sepolia and Mainnet configurations
  • All commands are properly formatted with syntax highlighting
  • Configuration file template is complete and documented
  • Network-specific RPC URLs are clearly indicated
  • Instructions for both new deployments and updates

🎯 Expected Outcome

Developers should be able to:

  1. Configure environment for their target network
  2. Set up world deployment configuration
  3. Deploy Torii indexer using Slot

💡 Additional Notes

  • Emphasize that process is identical for both networks except RPC URL
  • Include links to check deployer account balance
  • Mention Torii version can be updated based on latest release
  • Consider adding common troubleshooting tips

📚 References

Contribution Guidelines

  • Please ensure you read and follow the contribution guidelines in the project's README file

Metadata

Metadata

Assignees

Labels

AUTO PAYMENTSCampaign: AUTO PAYMENTSGrantFox OSSIssue tracked in GrantFox OSSMaintainer: jimenezz22Maybe RewardedIssue may be eligible for a GrantFox rewarddocumentationImprovements or additions to documentationgood first issueGood for newcomersonlydust-waveContribute to awesome OSS repos during OnlyDust's open source week

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions