Multichain Indexer Template (Template 1/6) #822

nikbhintade · 2025-11-11T11:18:32Z

Summary by CodeRabbit

New Features
- Added a Multichain Indexer template for indexing across multiple blockchains, plus a new CLI template option.
- Added event handlers and GraphQL types to capture Uniswap V3 factory events.
- Included TypeScript build config, example env entries, and repository ignore patterns for the template.
Documentation
- Added a comprehensive README with usage, configuration examples, and run/codegen instructions.

coderabbitai · 2025-11-11T11:18:49Z

Walkthrough

Adds a new "Multichain Indexer" template: a Template enum variant with Strum serialization, mapping to a new directory name, and static TypeScript template files (schema, config, event handlers, docs, and supporting files) for indexing Uniswap V3 across multiple chains.

Changes

Cohort / File(s)	Summary
CLI enum & mapping `codegenerator/cli/src/cli_args/init_config.rs`, `codegenerator/cli/src/template_dirs.rs`	Added `MultichainIndexer` variant to public `Template` enum with `#[strum(serialize = "Feature: Multichain Indexer")]`; annotated `Greeter` and `Erc20` with explicit `#[strum(serialize = "...")]`. Added mapping to `"multichain_indexer"` in `template_dirs.rs`.
Template static shared files `codegenerator/cli/templates/static/multichain_indexer_template/shared/*`	Added `.gitignore`, `README.md` (usage, config examples, run/codegen steps), `.env.example` (ENVIO_API_TOKEN placeholder), and `schema.graphql` defining three entity types: `UniswapV3Factory_FeeAmountEnabled`, `UniswapV3Factory_OwnerChanged`, `UniswapV3Factory_PoolCreated` (each with `chainId` indexed).
TypeScript template & build config `codegenerator/cli/templates/static/multichain_indexer_template/typescript/...`	Added `config.yaml` (UniswapV3Factory contract + event signatures, networks for chain IDs 1, 130, 42161, unordered_multichain_mode, preload handlers), `src/EventHandlers.ts` (three async handlers creating/persisting entities), and `tsconfig.json` (strict TS settings).
Docs / CLI help `codegenerator/cli/CommandLineHelp.md`	Added `multichain-indexer` as a new possible value for the template option in CLI help.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant CLI as dev CLI
  participant Init as init_config
  participant FS as template files
  note over CLI,Init: User selects "multichain-indexer"
  CLI->>Init: parse option -> Template::MultichainIndexer
  Init->>FS: resolve "multichain_indexer" dir -> copy template files
  note over FS: files created (schema, config.yaml, src/EventHandlers.ts, README)

sequenceDiagram
  autonumber
  participant Chain as Blockchain (any network)
  participant Env as Envio runtime
  participant Handler as EventHandlers.ts
  participant Store as Indexer context (context.set)
  note over Chain,Handler: UniswapV3Factory events emitted
  Chain->>Env: log/event
  Env->>Handler: invoke handler with event + context
  Handler->>Store: build entity (id from chainId:block:logIndex) -> context.set(entity)
  alt success
    Store-->>Handler: ack
  else error
    Store-->>Handler: error
  end

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Review focuses: new public enum variant serialization, template directory mapping, GraphQL schema consistency, event handler field mappings and ID construction, and config.yaml network/addresses.
Files requiring extra attention:
- codegenerator/cli/src/cli_args/init_config.rs — ensure Strum annotations match CLI help strings.
- codegenerator/cli/src/template_dirs.rs — mapping correctness.
- .../shared/schema.graphql and .../typescript/src/EventHandlers.ts — alignment between schema, generated types, and handler persistence.
- .../typescript/config.yaml — network chain IDs and addresses.

Suggested reviewers

JonoPrest
DZakh

Poem

🐰 I hopped through code and built a bridge of light,
Multichain whispers turned to indexed sight.
Events arrive, I stitch them tight—
Chains converge, entities alight.
Hop on, the index hums tonight! ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run `@coderabbitai generate docstrings` to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The PR title 'Multichain Indexer Template (Template 1/6)' accurately describes the main change: adding a new multichain indexer template to the codebase.

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch nb/multichain-template

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

codegenerator/cli/templates/static/multichain_indexer_template/shared/.gitignore (1)
1-35: Remove duplicate entries.

The .gitignore has duplicate patterns: *.obj (lines 2 and 16) and *.annot (lines 8 and 18).

Apply this diff to remove duplicates:
 *.exe
 *.obj
 *.out
 *.compile
 *.native
 *.byte
 *.cmo
 *.annot
 *.cmi
 *.cmx
 *.cmt
 *.cmti
 *.cma
 *.a
 *.cmxa
-*.obj
 *~
-*.annot
 *.cmj
 *.bak

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1fc77a8 and 71bc5b7.

📒 Files selected for processing (8)

codegenerator/cli/src/cli_args/init_config.rs (1 hunks)
codegenerator/cli/src/template_dirs.rs (1 hunks)
codegenerator/cli/templates/static/multichain_indexer_template/shared/.gitignore (1 hunks)
codegenerator/cli/templates/static/multichain_indexer_template/shared/README.md (1 hunks)
codegenerator/cli/templates/static/multichain_indexer_template/shared/schema.graphql (1 hunks)
codegenerator/cli/templates/static/multichain_indexer_template/typescript/config.yaml (1 hunks)
codegenerator/cli/templates/static/multichain_indexer_template/typescript/src/EventHandlers.ts (1 hunks)
codegenerator/cli/templates/static/multichain_indexer_template/typescript/tsconfig.json (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

codegenerator/cli/**

📄 CodeRabbit inference engine (.cursor/rules/navigation.mdc)

The Rust CLI lives in codegenerator/cli

Files:

codegenerator/cli/templates/static/multichain_indexer_template/typescript/tsconfig.json
codegenerator/cli/src/template_dirs.rs
codegenerator/cli/templates/static/multichain_indexer_template/shared/schema.graphql
codegenerator/cli/templates/static/multichain_indexer_template/typescript/src/EventHandlers.ts
codegenerator/cli/templates/static/multichain_indexer_template/shared/README.md
codegenerator/cli/templates/static/multichain_indexer_template/typescript/config.yaml
codegenerator/cli/src/cli_args/init_config.rs

🧠 Learnings (6)

📓 Common learnings

Learnt from: CR
Repo: enviodev/hyperindex PR: 0
File: .cursor/rules/navigation.mdc:0-0
Timestamp: 2025-10-21T16:31:22.127Z
Learning: Applies to codegenerator/cli/src/hbs_templating/codegen_templates.rs : hbs_templating/codegen_templates.rs feeds templates