New Templates & Changes in CLI #790
Conversation
WalkthroughThis PR extends the CLI template system by adding six new indexer templates (topic-filtering, wildcard-indexing, on-block-handler, effects-api, factory-indexer, multichain-indexer) to the Template enum and implementing language-aware template filtering. Each template includes configuration, event handlers, schema definitions, and documentation. Changes
Sequence DiagramsequenceDiagram
participant User
participant CLI
participant Template Selection
participant Template Filtering
participant Event Handler
User->>CLI: envio init
CLI->>Template Selection: prompt_ecosystem(selected_language)
Template Selection->>Template Filtering: filter by supported_languages()
Template Filtering-->>Template Selection: [filtered templates]
Template Selection-->>CLI: available templates
CLI-->>User: display language-filtered options
User->>CLI: select template (e.g., effects-api)
rect rgb(220, 240, 255)
Note over Event Handler: Template Runtime
User->>Event Handler: event emitted
Event Handler->>Event Handler: construct entity
Event Handler->>Event Handler: call context.set()
Event Handler-->>User: data indexed
end
Estimated code review effort🎯 4 (Complex) | ⏱️ ~50 minutes This PR introduces heterogeneous changes across six new template implementations with diverse handler logic (effects API, factory patterns, multichain support, snapshot mechanics) alongside core CLI infrastructure changes (new enum variants, trait addition, template filtering). While individual template files follow repetitive patterns, each template's event handlers require separate reasoning due to domain-specific logic variations. The addition of public enum variants and new trait methods adds moderate API surface complexity. Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 16
♻️ Duplicate comments (5)
codegenerator/cli/templates/static/multichain_indexer_template/shared/.env.example (1)
2-2: Remove quotes around the placeholder value.Same issue as in
codegenerator/cli/templates/static/effects_api_template/shared/.env.example.- ENVIO_API_TOKEN="<YOUR-API-TOKEN>" + ENVIO_API_TOKEN=<YOUR-API-TOKEN>codegenerator/cli/templates/static/factory_indexer_template/shared/.env.example (1)
2-2: Remove quotes around the placeholder value.Same issue as in
codegenerator/cli/templates/static/effects_api_template/shared/.env.example.- ENVIO_API_TOKEN="<YOUR-API-TOKEN>" + ENVIO_API_TOKEN=<YOUR-API-TOKEN>codegenerator/cli/templates/static/wildcard_indexing_template/shared/.env.example (1)
2-2: Remove quotes around the placeholder value.Same issue as in
codegenerator/cli/templates/static/effects_api_template/shared/.env.example.- ENVIO_API_TOKEN="<YOUR-API-TOKEN>" + ENVIO_API_TOKEN=<YOUR-API-TOKEN>codegenerator/cli/templates/static/onblock_handler_template/shared/.env.example (1)
2-2: Remove quotes around the placeholder value.Same issue as in
codegenerator/cli/templates/static/effects_api_template/shared/.env.example.- ENVIO_API_TOKEN="<YOUR-API-TOKEN>" + ENVIO_API_TOKEN=<YOUR-API-TOKEN>codegenerator/cli/templates/static/topic_filtering_template/shared/.env.example (1)
2-2: Remove quotes around the placeholder value.Same issue as in
codegenerator/cli/templates/static/effects_api_template/shared/.env.example.- ENVIO_API_TOKEN="<YOUR-API-TOKEN>" + ENVIO_API_TOKEN=<YOUR-API-TOKEN>
🧹 Nitpick comments (22)
codegenerator/cli/templates/static/onblock_handler_template/shared/.gitignore (1)
1-35: Remove duplicated ignore patterns.The .gitignore file contains unnecessary duplicate entries that can be consolidated:
- Line 2 and 16 both specify
*.obj- Line 8 and 18 both specify
*.annotWhile duplicates don't affect functionality, removing them improves clarity and maintainability.
Apply this diff to deduplicate the patterns:
*.exe *.obj *.out *.compile *.native *.byte *.cmo *.annot *.cmi *.cmx *.cmt *.cmti *.cma *.a *.cmxa -*.obj *~ -*.annot *.cmj *.bakcodegenerator/cli/templates/static/factory_indexer_template/shared/.gitignore (1)
1-35: Remove duplicated ignore patterns.Like the onblock_handler_template .gitignore, this file contains unnecessary duplicate entries (*.obj on lines 2 and 16; *.annot on lines 8 and 18). Consolidate to improve maintainability.
Apply this diff to deduplicate the patterns:
*.exe *.obj *.out *.compile *.native *.byte *.cmo *.annot *.cmi *.cmx *.cmt *.cmti *.cma *.a *.cmxa -*.obj *~ -*.annot *.cmj *.bakcodegenerator/cli/templates/static/wildcard_indexing_template/shared/.gitignore (1)
1-35: Remove duplicated ignore patterns (consistent issue across templates).This .gitignore file shares the same duplication issue as the other templates' .gitignore files in this PR (*.obj appears at lines 2 and 16; *.annot appears at lines 8 and 18). Consolidating these across all template .gitignore files will improve consistency and maintainability.
Apply this diff to deduplicate:
*.exe *.obj *.out *.compile *.native *.byte *.cmo *.annot *.cmi *.cmx *.cmt *.cmti *.cma *.a *.cmxa -*.obj *~ -*.annot *.cmj *.bakcodegenerator/cli/src/cli_args/interactive_init/mod.rs (1)
79-84: Consider a more professional comment style.The emoji-prefixed comment is informal for production code.
- // ✅ Filter templates based on selected language + // Filter templates based on selected language let options: Vec<_> = evm::Template::iter() .filter(|t| t.supported_languages().contains(&selected_language)) .collect();codegenerator/cli/templates/static/effects_api_template/typescript/tsconfig.json (1)
21-21: Add newline at end of file.The file is missing a trailing newline, which is a POSIX standard and expected by most editors and linters.
codegenerator/cli/templates/static/multichain_indexer_template/shared/README.md (1)
44-44: Minor grammar improvement.Consider changing "While indexer is running" to "While the indexer is running" for better readability.
codegenerator/cli/templates/static/topic_filtering_template/typescript/src/EventHandler.ts (1)
23-23: Add newline at end of file.The file is missing a trailing newline, which is a POSIX standard and expected by most editors and linters.
codegenerator/cli/templates/static/multichain_indexer_template/shared/.gitignore (2)
1-35: Remove duplicate patterns.The .gitignore contains duplicate entries:
*.objappears on both lines 2 and 16*.annotappears on both lines 8 and 18Apply this diff to remove duplicates:
*.exe *.obj *.out *.compile *.native *.byte *.cmo *.annot *.cmi *.cmx *.cmt *.cmti *.cma *.a *.cmxa -*.obj *~ -*.annot *.cmj *.bak lib/* *.mlast *.mliast .vscode .merlin .bsb.lock node_modules/ build/ benchmarks/ artifacts cache *.res.js *.res.mjs generated .env
35-35: Add newline at end of file.The file is missing a trailing newline, which is a POSIX standard and expected by most editors and linters.
codegenerator/cli/templates/static/multichain_indexer_template/typescript/config.yaml (2)
12-12: Consider using realistic start_block values.Setting
start_block: 0will index from the genesis block, which can be extremely slow and resource-intensive for mainnet chains. For a template, consider using more recent block numbers or documenting that users should update these values.
30-30: Add newline at end of file.The file is missing a trailing newline, which is a POSIX standard and expected by most editors and linters.
codegenerator/cli/templates/static/topic_filtering_template/shared/README.md (2)
7-7: Consider simplifying the phrase.As flagged by static analysis, "add an additional feature" is somewhat redundant. Consider simplifying to "add a feature" or "we add filtering" for clearer prose.
50-50: Minor grammar improvement.Consider changing "While indexer is running" to "While the indexer is running" for better readability.
codegenerator/cli/templates/static/topic_filtering_template/shared/.gitignore (2)
1-35: Remove duplicate patterns.The .gitignore contains duplicate entries:
*.objappears on both lines 2 and 16*.annotappears on both lines 8 and 18Apply this diff to remove duplicates:
*.exe *.obj *.out *.compile *.native *.byte *.cmo *.annot *.cmi *.cmx *.cmt *.cmti *.cma *.a *.cmxa -*.obj *~ -*.annot *.cmj *.bak lib/* *.mlast *.mliast .vscode .merlin .bsb.lock node_modules/ build/ benchmarks/ artifacts cache *.res.js *.res.mjs generated .env
35-35: Add newline at end of file.The file is missing a trailing newline, which is a POSIX standard and expected by most editors and linters.
codegenerator/cli/templates/static/onblock_handler_template/typescript/config.yaml (2)
10-10: Consider using realistic start_block value.Setting
start_block: 0will index from the genesis block, which can be extremely slow and resource-intensive for mainnet. For a template, consider using a more recent block number or documenting that users should update this value.
16-16: Add newline at end of file.The file is missing a trailing newline, which is a POSIX standard and expected by most editors and linters.
codegenerator/cli/templates/static/multichain_indexer_template/typescript/src/EventHandlers.ts (1)
11-19: LGTM; multichain-safe IDs are correct. Minor nits.Good use of
${event.chainId}_...in entity IDs. Optionally, consider:
- Using
${event.chainId}_${event.transaction.hash}_${event.logIndex}for stronger uniqueness across reorgs.- Normalizing addresses (e.g., toLowerCase) for consistent querying.
Also applies to: 21-29, 31-42
codegenerator/cli/templates/static/onblock_handler_template/typescript/src/EventHandlers.ts (1)
13-18: Avoid hardcoding chain: 1 for onBlock.Parameterize or derive from config so the template works on non-mainnet networks and testnets. Example: pass chain(s) via config.yaml or expose a CHAIN_ID env. Based on learnings.
codegenerator/cli/templates/static/effects_api_template/typescript/src/EventHandlers.ts (1)
35-43: Parallelize token metadata lookups for performance.Fetch token0/token1 decimals concurrently.
-UniswapV3Factory.PoolCreated.handler(async ({ event, context }) => { - const token0Details = await context.effect(fetchTokenDetails, { - token: event.params.token0, - }); - - const token1Details = await context.effect(fetchTokenDetails, { - token: event.params.token1, - }); +UniswapV3Factory.PoolCreated.handler(async ({ event, context }) => { + const [token0Details, token1Details] = await Promise.all([ + context.effect(fetchTokenDetails, { token: event.params.token0 }), + context.effect(fetchTokenDetails, { token: event.params.token1 }), + ]);Also consider removing console.log or switching to a template-friendly logger.
codegenerator/cli/templates/static/factory_indexer_template/typescript/src/EventHandlers.ts (2)
19-21: Register dynamic contracts before handling the creating event.Place contractRegister above the PoolCreated handler to ensure deterministic registration. Based on learnings.
+UniswapV3Factory.PoolCreated.contractRegister(({ event, context }) => { + context.addUniswapV3Pool(event.params.pool); +}); + UniswapV3Factory.PoolCreated.handler(async ({ event, context }) => { @@ context.UniswapV3Factory_PoolCreated.set(entity); }); - -UniswapV3Factory.PoolCreated.contractRegister(({ event, context }) => { - context.addUniswapV3Pool(event.params.pool); -});Also applies to: 6-17
23-36: LGTM; event-to-entity mapping looks correct.IDs include chainId, and Swap fields align with typical Uniswap v3 event params.
Normalize sender/recipient to lowercase for consistent querying.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (46)
codegenerator/cli/CommandLineHelp.md(1 hunks)codegenerator/cli/src/cli_args/init_config.rs(1 hunks)codegenerator/cli/src/cli_args/interactive_init/mod.rs(4 hunks)codegenerator/cli/src/template_dirs.rs(3 hunks)codegenerator/cli/templates/static/effects_api_template/shared/.env.example(1 hunks)codegenerator/cli/templates/static/effects_api_template/shared/.gitignore(1 hunks)codegenerator/cli/templates/static/effects_api_template/shared/README.md(1 hunks)codegenerator/cli/templates/static/effects_api_template/shared/schema.graphql(1 hunks)codegenerator/cli/templates/static/effects_api_template/typescript/config.yaml(1 hunks)codegenerator/cli/templates/static/effects_api_template/typescript/src/EventHandlers.ts(1 hunks)codegenerator/cli/templates/static/effects_api_template/typescript/tsconfig.json(1 hunks)codegenerator/cli/templates/static/factory_indexer_template/shared/.env.example(1 hunks)codegenerator/cli/templates/static/factory_indexer_template/shared/.gitignore(1 hunks)codegenerator/cli/templates/static/factory_indexer_template/shared/README.md(1 hunks)codegenerator/cli/templates/static/factory_indexer_template/shared/schema.graphql(1 hunks)codegenerator/cli/templates/static/factory_indexer_template/typescript/config.yaml(1 hunks)codegenerator/cli/templates/static/factory_indexer_template/typescript/src/EventHandlers.ts(1 hunks)codegenerator/cli/templates/static/factory_indexer_template/typescript/tsconfig.json(1 hunks)codegenerator/cli/templates/static/multichain_indexer_template/shared/.env.example(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)codegenerator/cli/templates/static/onblock_handler_template/shared/.env.example(1 hunks)codegenerator/cli/templates/static/onblock_handler_template/shared/.gitignore(1 hunks)codegenerator/cli/templates/static/onblock_handler_template/shared/README.md(1 hunks)codegenerator/cli/templates/static/onblock_handler_template/shared/schema.graphql(1 hunks)codegenerator/cli/templates/static/onblock_handler_template/typescript/config.yaml(1 hunks)codegenerator/cli/templates/static/onblock_handler_template/typescript/src/EventHandlers.ts(1 hunks)codegenerator/cli/templates/static/onblock_handler_template/typescript/tsconfig.json(1 hunks)codegenerator/cli/templates/static/topic_filtering_template/shared/.env.example(1 hunks)codegenerator/cli/templates/static/topic_filtering_template/shared/.gitignore(1 hunks)codegenerator/cli/templates/static/topic_filtering_template/shared/README.md(1 hunks)codegenerator/cli/templates/static/topic_filtering_template/shared/schema.graphql(1 hunks)codegenerator/cli/templates/static/topic_filtering_template/typescript/config.yaml(1 hunks)codegenerator/cli/templates/static/topic_filtering_template/typescript/src/EventHandler.ts(1 hunks)codegenerator/cli/templates/static/topic_filtering_template/typescript/tsconfig.json(1 hunks)codegenerator/cli/templates/static/wildcard_indexing_template/shared/.env.example(1 hunks)codegenerator/cli/templates/static/wildcard_indexing_template/shared/.gitignore(1 hunks)codegenerator/cli/templates/static/wildcard_indexing_template/shared/README.md(1 hunks)codegenerator/cli/templates/static/wildcard_indexing_template/shared/schema.graphql(1 hunks)codegenerator/cli/templates/static/wildcard_indexing_template/typescript/config.yaml(1 hunks)codegenerator/cli/templates/static/wildcard_indexing_template/typescript/src/EventHandler.ts(1 hunks)codegenerator/cli/templates/static/wildcard_indexing_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/factory_indexer_template/shared/schema.graphqlcodegenerator/cli/templates/static/onblock_handler_template/shared/README.mdcodegenerator/cli/src/cli_args/interactive_init/mod.rscodegenerator/cli/templates/static/onblock_handler_template/shared/schema.graphqlcodegenerator/cli/templates/static/factory_indexer_template/shared/README.mdcodegenerator/cli/templates/static/topic_filtering_template/typescript/config.yamlcodegenerator/cli/templates/static/multichain_indexer_template/typescript/config.yamlcodegenerator/cli/templates/static/multichain_indexer_template/typescript/tsconfig.jsoncodegenerator/cli/templates/static/effects_api_template/typescript/config.yamlcodegenerator/cli/src/template_dirs.rscodegenerator/cli/templates/static/effects_api_template/shared/schema.graphqlcodegenerator/cli/templates/static/wildcard_indexing_template/shared/schema.graphqlcodegenerator/cli/templates/static/effects_api_template/shared/README.mdcodegenerator/cli/templates/static/effects_api_template/typescript/tsconfig.jsoncodegenerator/cli/CommandLineHelp.mdcodegenerator/cli/templates/static/effects_api_template/typescript/src/EventHandlers.tscodegenerator/cli/templates/static/wildcard_indexing_template/shared/README.mdcodegenerator/cli/templates/static/topic_filtering_template/shared/README.mdcodegenerator/cli/templates/static/onblock_handler_template/typescript/config.yamlcodegenerator/cli/templates/static/wildcard_indexing_template/typescript/src/EventHandler.tscodegenerator/cli/templates/static/topic_filtering_template/typescript/tsconfig.jsoncodegenerator/cli/templates/static/topic_filtering_template/typescript/src/EventHandler.tscodegenerator/cli/templates/static/wildcard_indexing_template/typescript/tsconfig.jsoncodegenerator/cli/templates/static/onblock_handler_template/typescript/tsconfig.jsoncodegenerator/cli/templates/static/factory_indexer_template/typescript/src/EventHandlers.tscodegenerator/cli/templates/static/multichain_indexer_template/typescript/src/EventHandlers.tscodegenerator/cli/templates/static/factory_indexer_template/typescript/config.yamlcodegenerator/cli/templates/static/multichain_indexer_template/shared/schema.graphqlcodegenerator/cli/templates/static/topic_filtering_template/shared/schema.graphqlcodegenerator/cli/templates/static/wildcard_indexing_template/typescript/config.yamlcodegenerator/cli/templates/static/multichain_indexer_template/shared/README.mdcodegenerator/cli/templates/static/factory_indexer_template/typescript/tsconfig.jsoncodegenerator/cli/src/cli_args/init_config.rscodegenerator/cli/templates/static/onblock_handler_template/typescript/src/EventHandlers.ts
🧠 Learnings (19)
📚 Learning: 2025-08-11T08:47:04.346Z
Learnt from: CR
PR: enviodev/hyperindex#0
File: scenarios/fuel_test/.cursor/rules/hyperindex.mdc:0-0
Timestamp: 2025-08-11T08:47:04.346Z
Learning: Always load and reference HyperIndex docs and example indexers during development (docs.envio.dev HyperIndex, Uniswap v4 indexer, Safe indexer)
Applied to files:
codegenerator/cli/templates/static/factory_indexer_template/shared/README.mdcodegenerator/cli/templates/static/wildcard_indexing_template/shared/README.mdcodegenerator/cli/templates/static/multichain_indexer_template/shared/README.md
📚 Learning: 2025-08-11T08:49:57.399Z
Learnt from: CR
PR: enviodev/hyperindex#0
File: scenarios/test_codegen/.cursor/rules/hyperindex.mdc:0-0
Timestamp: 2025-08-11T08:49:57.399Z
Learning: Include HyperIndex documentation and example indexers (Uniswap v4 and Safe) in the context during development
Applied to files:
codegenerator/cli/templates/static/factory_indexer_template/shared/README.mdcodegenerator/cli/templates/static/multichain_indexer_template/shared/README.md
📚 Learning: 2025-10-21T16:31:22.099Z
Learnt from: CR
PR: enviodev/hyperindex#0
File: .cursor/rules/navigation.mdc:0-0
Timestamp: 2025-10-21T16:31:22.099Z
Learning: Compiled .js artifacts can be ignored
Applied to files:
codegenerator/cli/templates/static/topic_filtering_template/shared/.gitignorecodegenerator/cli/templates/static/factory_indexer_template/shared/.gitignorecodegenerator/cli/templates/static/onblock_handler_template/shared/.gitignorecodegenerator/cli/templates/static/wildcard_indexing_template/shared/.gitignorecodegenerator/cli/templates/static/multichain_indexer_template/shared/.gitignorecodegenerator/cli/templates/static/effects_api_template/shared/.gitignore
📚 Learning: 2025-10-13T12:27:30.803Z
Learnt from: CR
PR: enviodev/hyperindex#0
File: codegenerator/cli/templates/static/shared/.cursor/rules/subgraph-migration.mdc:0-0
Timestamp: 2025-10-13T12:27:30.803Z
Learning: Applies to codegenerator/cli/templates/static/shared/**/config.yaml : Refactor to contract-specific handler files in config.yaml and remove the single EventHandlers.ts reference
Applied to files:
codegenerator/cli/templates/static/topic_filtering_template/typescript/config.yamlcodegenerator/cli/templates/static/multichain_indexer_template/typescript/config.yamlcodegenerator/cli/templates/static/effects_api_template/typescript/config.yamlcodegenerator/cli/templates/static/effects_api_template/typescript/src/EventHandlers.tscodegenerator/cli/templates/static/onblock_handler_template/typescript/config.yamlcodegenerator/cli/templates/static/wildcard_indexing_template/typescript/src/EventHandler.tscodegenerator/cli/templates/static/topic_filtering_template/typescript/src/EventHandler.tscodegenerator/cli/templates/static/factory_indexer_template/typescript/src/EventHandlers.tscodegenerator/cli/templates/static/multichain_indexer_template/typescript/src/EventHandlers.tscodegenerator/cli/templates/static/factory_indexer_template/typescript/config.yamlcodegenerator/cli/templates/static/wildcard_indexing_template/typescript/config.yaml
📚 Learning: 2025-10-13T12:27:30.803Z
Learnt from: CR
PR: enviodev/hyperindex#0
File: codegenerator/cli/templates/static/shared/.cursor/rules/subgraph-migration.mdc:0-0
Timestamp: 2025-10-13T12:27:30.803Z
Learning: Applies to codegenerator/cli/templates/static/shared/**/config.yaml : Avoid duplicate contract definitions in network sections; define handlers/events globally and only provide addresses per network; enable unordered_multichain_mode: true
Applied to files:
codegenerator/cli/templates/static/multichain_indexer_template/typescript/config.yamlcodegenerator/cli/templates/static/effects_api_template/typescript/config.yamlcodegenerator/cli/templates/static/onblock_handler_template/typescript/config.yamlcodegenerator/cli/templates/static/wildcard_indexing_template/typescript/config.yaml
📚 Learning: 2025-10-13T12:27:30.803Z
Learnt from: CR
PR: enviodev/hyperindex#0
File: codegenerator/cli/templates/static/shared/.cursor/rules/subgraph-migration.mdc:0-0
Timestamp: 2025-10-13T12:27:30.803Z
Learning: Applies to codegenerator/cli/templates/static/shared/**/config.yaml : For multichain deployments, keep handlers and events defined in the global contracts section and only list addresses under networks per chain
Applied to files:
codegenerator/cli/templates/static/multichain_indexer_template/typescript/config.yamlcodegenerator/cli/templates/static/onblock_handler_template/typescript/config.yaml
📚 Learning: 2025-08-11T08:42:57.311Z
Learnt from: CR
PR: enviodev/hyperindex#0
File: codegenerator/cli/templates/static/shared/.cursor/rules/hyperindex.mdc:0-0
Timestamp: 2025-08-11T08:42:57.311Z
Learning: Applies to codegenerator/cli/templates/static/shared/**/*.ts : After any change to TypeScript files, run `pnpm tsc --noEmit` to ensure successful compilation
Applied to files:
codegenerator/cli/templates/static/multichain_indexer_template/typescript/tsconfig.jsoncodegenerator/cli/templates/static/effects_api_template/typescript/tsconfig.jsoncodegenerator/cli/templates/static/topic_filtering_template/typescript/tsconfig.jsoncodegenerator/cli/templates/static/wildcard_indexing_template/typescript/tsconfig.jsoncodegenerator/cli/templates/static/onblock_handler_template/typescript/tsconfig.jsoncodegenerator/cli/templates/static/factory_indexer_template/typescript/tsconfig.json
📚 Learning: 2025-10-13T12:27:30.803Z
Learnt from: CR
PR: enviodev/hyperindex#0
File: codegenerator/cli/templates/static/shared/.cursor/rules/subgraph-migration.mdc:0-0
Timestamp: 2025-10-13T12:27:30.803Z
Learning: Applies to codegenerator/cli/templates/static/shared/**/.env.example : Document all environment variables used in code by listing them in .env.example with descriptions and example values
Applied to files:
codegenerator/cli/templates/static/multichain_indexer_template/shared/.env.examplecodegenerator/cli/templates/static/factory_indexer_template/shared/.env.examplecodegenerator/cli/templates/static/wildcard_indexing_template/shared/.env.examplecodegenerator/cli/templates/static/effects_api_template/shared/.env.examplecodegenerator/cli/templates/static/onblock_handler_template/shared/.env.examplecodegenerator/cli/templates/static/topic_filtering_template/shared/.env.example
📚 Learning: 2025-10-13T12:27:30.803Z
Learnt from: CR
PR: enviodev/hyperindex#0
File: codegenerator/cli/templates/static/shared/.cursor/rules/subgraph-migration.mdc:0-0
Timestamp: 2025-10-13T12:27:30.803Z
Learning: Applies to codegenerator/cli/templates/static/shared/src/**/*.{ts,js} : Search for all usages of process.env.* to ensure they are documented and handled; update .env.example accordingly
Applied to files:
codegenerator/cli/templates/static/wildcard_indexing_template/shared/.env.examplecodegenerator/cli/templates/static/onblock_handler_template/shared/.env.example
📚 Learning: 2025-10-13T12:26:45.351Z
Learnt from: CR
PR: enviodev/hyperindex#0
File: .cursor/rules/subgraph-migration.mdc:0-0
Timestamp: 2025-10-13T12:26:45.351Z
Learning: Applies to .env.example : Document all environment variables discovered in code under .env.example with sample values and comments
Applied to files:
codegenerator/cli/templates/static/wildcard_indexing_template/shared/.env.examplecodegenerator/cli/templates/static/topic_filtering_template/shared/.env.example
📚 Learning: 2025-10-13T12:27:30.803Z
Learnt from: CR
PR: enviodev/hyperindex#0
File: codegenerator/cli/templates/static/shared/.cursor/rules/subgraph-migration.mdc:0-0
Timestamp: 2025-10-13T12:27:30.803Z
Learning: Applies to codegenerator/cli/templates/static/shared/src/effects/**/*.ts : External calls (RPC/API) must be implemented via the Effect API in src/effects/ using experimental_createEffect with proper input/output schemas and error handling
Applied to files:
codegenerator/cli/templates/static/effects_api_template/shared/README.md
📚 Learning: 2025-10-13T12:26:45.351Z
Learnt from: CR
PR: enviodev/hyperindex#0
File: .cursor/rules/subgraph-migration.mdc:0-0
Timestamp: 2025-10-13T12:26:45.351Z
Learning: Applies to src/effects/**/*.ts : Create external calls (RPC/API) as Effect API functions under src/effects and define schemas via `experimental_createEffect`
Applied to files:
codegenerator/cli/templates/static/effects_api_template/shared/README.md
📚 Learning: 2025-10-13T12:26:45.351Z
Learnt from: CR
PR: enviodev/hyperindex#0
File: .cursor/rules/subgraph-migration.mdc:0-0
Timestamp: 2025-10-13T12:26:45.351Z
Learning: Applies to src/EventHandlers.ts : Remove the monolithic EventHandlers.ts file after moving handlers to contract-specific files
Applied to files:
codegenerator/cli/templates/static/effects_api_template/typescript/src/EventHandlers.tscodegenerator/cli/templates/static/wildcard_indexing_template/typescript/src/EventHandler.tscodegenerator/cli/templates/static/topic_filtering_template/typescript/src/EventHandler.tscodegenerator/cli/templates/static/factory_indexer_template/typescript/src/EventHandlers.tscodegenerator/cli/templates/static/multichain_indexer_template/typescript/src/EventHandlers.tscodegenerator/cli/templates/static/onblock_handler_template/typescript/src/EventHandlers.ts
📚 Learning: 2025-10-13T12:27:30.803Z
Learnt from: CR
PR: enviodev/hyperindex#0
File: codegenerator/cli/templates/static/shared/.cursor/rules/subgraph-migration.mdc:0-0
Timestamp: 2025-10-13T12:27:30.803Z
Learning: Applies to codegenerator/cli/templates/static/shared/src/EventHandlers.ts : Remove the original src/EventHandlers.ts after moving handlers into contract-specific files
Applied to files:
codegenerator/cli/templates/static/effects_api_template/typescript/src/EventHandlers.tscodegenerator/cli/templates/static/wildcard_indexing_template/typescript/src/EventHandler.tscodegenerator/cli/templates/static/topic_filtering_template/typescript/src/EventHandler.tscodegenerator/cli/templates/static/factory_indexer_template/typescript/src/EventHandlers.tscodegenerator/cli/templates/static/multichain_indexer_template/typescript/src/EventHandlers.tscodegenerator/cli/templates/static/onblock_handler_template/typescript/src/EventHandlers.ts
📚 Learning: 2025-10-13T12:27:30.803Z
Learnt from: CR
PR: enviodev/hyperindex#0
File: codegenerator/cli/templates/static/shared/.cursor/rules/subgraph-migration.mdc:0-0
Timestamp: 2025-10-13T12:27:30.803Z
Learning: Applies to codegenerator/cli/templates/static/shared/src/EventHandlers.ts : Clear all boilerplate logic from src/EventHandlers.ts and replace handlers with empty skeletons before implementing business logic
Applied to files:
codegenerator/cli/templates/static/effects_api_template/typescript/src/EventHandlers.tscodegenerator/cli/templates/static/wildcard_indexing_template/typescript/src/EventHandler.tscodegenerator/cli/templates/static/topic_filtering_template/typescript/src/EventHandler.tscodegenerator/cli/templates/static/factory_indexer_template/typescript/src/EventHandlers.tscodegenerator/cli/templates/static/multichain_indexer_template/typescript/src/EventHandlers.tscodegenerator/cli/templates/static/onblock_handler_template/typescript/src/EventHandlers.ts
📚 Learning: 2025-10-13T12:27:30.803Z
Learnt from: CR
PR: enviodev/hyperindex#0
File: codegenerator/cli/templates/static/shared/.cursor/rules/subgraph-migration.mdc:0-0
Timestamp: 2025-10-13T12:27:30.803Z
Learning: Applies to codegenerator/cli/templates/static/shared/src/**/*.ts : Register dynamic contracts using contractRegister above the creating event’s handler (e.g., context.addPair(event.params.pair))
Applied to files:
codegenerator/cli/templates/static/wildcard_indexing_template/typescript/src/EventHandler.tscodegenerator/cli/templates/static/topic_filtering_template/typescript/src/EventHandler.tscodegenerator/cli/templates/static/factory_indexer_template/typescript/src/EventHandlers.ts
📚 Learning: 2025-10-13T12:27:30.803Z
Learnt from: CR
PR: enviodev/hyperindex#0
File: codegenerator/cli/templates/static/shared/.cursor/rules/subgraph-migration.mdc:0-0
Timestamp: 2025-10-13T12:27:30.803Z
Learning: Applies to codegenerator/cli/templates/static/shared/src/**/*.ts : Prefix all entity IDs with event.chainId and never hardcode chainId=1; accept chainId in helper functions; use chain-specific Bundle IDs like `${chainId}-1`
Applied to files:
codegenerator/cli/templates/static/topic_filtering_template/typescript/src/EventHandler.tscodegenerator/cli/templates/static/multichain_indexer_template/typescript/src/EventHandlers.ts
📚 Learning: 2025-10-13T12:26:45.351Z
Learnt from: CR
PR: enviodev/hyperindex#0
File: .cursor/rules/subgraph-migration.mdc:0-0
Timestamp: 2025-10-13T12:26:45.351Z
Learning: Applies to src/**/*.ts : For multichain support, prefix all entity IDs with `${event.chainId}-...` and never hardcode `chainId = 1`
Applied to files:
codegenerator/cli/templates/static/multichain_indexer_template/typescript/src/EventHandlers.ts
📚 Learning: 2025-10-13T12:26:45.351Z
Learnt from: CR
PR: enviodev/hyperindex#0
File: .cursor/rules/subgraph-migration.mdc:0-0
Timestamp: 2025-10-13T12:26:45.351Z
Learning: Applies to src/EventHandlers.ts : Clear boilerplate logic in EventHandlers.ts and replace with empty handlers before implementing business logic
Applied to files:
codegenerator/cli/templates/static/onblock_handler_template/typescript/src/EventHandlers.ts
🧬 Code graph analysis (3)
codegenerator/cli/src/template_dirs.rs (3)
codegenerator/cli/src/cli_args/interactive_init/mod.rs (1)
Language(152-154)codegenerator/integration_tests/src/main.rs (1)
new(43-55)codegenerator/cli/src/hbs_templating/init_templates.rs (1)
new(23-58)
codegenerator/cli/src/cli_args/init_config.rs (2)
codegenerator/cli/src/config_parsing/entity_parsing.rs (2)
serialize(1177-1182)serialize(1328-1333)codegenerator/cli/src/rescript_types.rs (1)
serialize(703-709)
codegenerator/cli/templates/static/onblock_handler_template/typescript/src/EventHandlers.ts (1)
codegenerator/cli/npm/envio/index.d.ts (1)
bigint(109-109)
🪛 dotenv-linter (4.0.0)
codegenerator/cli/templates/static/multichain_indexer_template/shared/.env.example
[warning] 2-2: [QuoteCharacter] The value has quote characters (', ")
(QuoteCharacter)
codegenerator/cli/templates/static/factory_indexer_template/shared/.env.example
[warning] 2-2: [QuoteCharacter] The value has quote characters (', ")
(QuoteCharacter)
codegenerator/cli/templates/static/wildcard_indexing_template/shared/.env.example
[warning] 2-2: [QuoteCharacter] The value has quote characters (', ")
(QuoteCharacter)
codegenerator/cli/templates/static/effects_api_template/shared/.env.example
[warning] 2-2: [QuoteCharacter] The value has quote characters (', ")
(QuoteCharacter)
codegenerator/cli/templates/static/onblock_handler_template/shared/.env.example
[warning] 2-2: [QuoteCharacter] The value has quote characters (', ")
(QuoteCharacter)
codegenerator/cli/templates/static/topic_filtering_template/shared/.env.example
[warning] 2-2: [QuoteCharacter] The value has quote characters (', ")
(QuoteCharacter)
🪛 LanguageTool
codegenerator/cli/templates/static/topic_filtering_template/shared/README.md
[style] ~7-~7: This phrase might be redundant. Consider either removing or replacing the adjective ‘additional’.
Context: ...n event signature. In this version, we add an additional feature that filters those events further based...
(ADD_AN_ADDITIONAL)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: build_and_test
🔇 Additional comments (26)
codegenerator/cli/templates/static/topic_filtering_template/typescript/tsconfig.json (1)
1-21: TypeScript configuration structure is sound.The tsconfig.json follows best practices with es2020 target (supporting BigInt), strict mode enabled, and proper CommonJS module setup. This aligns with the standard template configuration pattern across other templates in the PR.
Per the learning guidelines, ensure TypeScript compilation verification is completed: after any changes to TypeScript files, run
pnpm tsc --noEmitto validate the configuration. Given the PR mentions path issues during CLI testing, confirm this template's generated files reference correct module paths.codegenerator/cli/templates/static/wildcard_indexing_template/shared/README.md (1)
1-45: Documentation is clear and well-structured.The README provides excellent guidance on wildcard indexing with proper code examples, prerequisites, and running instructions. References to official documentation are included, and the example correctly demonstrates the
wildcard: trueconfiguration.Verify that hyperlinks on lines 8 and 45 are active and point to correct endpoints:
- Line 8:
https://docs.envio.dev/docs/HyperIndex/wildcard-indexing- Line 45:
https://envio.dev/consolecodegenerator/cli/templates/static/factory_indexer_template/typescript/tsconfig.json (1)
1-21: TypeScript configuration is consistent with template standards.The tsconfig.json follows the same valid pattern used across other templates in this PR, ensuring consistent build configuration across the template suite.
codegenerator/cli/templates/static/multichain_indexer_template/typescript/tsconfig.json (1)
1-21: LGTM.Consistent with other template TypeScript configurations in the PR.
codegenerator/cli/templates/static/onblock_handler_template/shared/schema.graphql (1)
1-13: LGTM!The GraphQL schema is well-defined with clear field naming and appropriate types. The distinction between
currentSupply(TotalSupply) andsupply(TotalSupplySnapshot) appropriately differentiates the current state from historical snapshots.codegenerator/cli/src/cli_args/interactive_init/mod.rs (3)
11-11: LGTM!The import of
Templatefromcrate::template_dirsis appropriate for enabling language-aware template filtering.
34-37: LGTM!Adding the
selected_languageparameter enables language-specific template filtering as intended by this PR.
166-166: LGTM!Passing
language.clone()toprompt_ecosystemcorrectly provides the language context needed for template filtering.codegenerator/cli/templates/static/topic_filtering_template/shared/schema.graphql (1)
1-12: LGTM!The GraphQL schema is well-defined with clear, helpful comments explaining each field. The field types are appropriate for representing transfer events.
codegenerator/cli/templates/static/wildcard_indexing_template/typescript/config.yaml (1)
1-15: LGTM!The configuration is appropriate for wildcard indexing. The contract is defined without a specific address (line 8), which is correct for wildcard matching. The recent
start_block(23480542) helps keep template data minimal for demonstration purposes.codegenerator/cli/templates/static/wildcard_indexing_template/typescript/src/EventHandler.ts (1)
1-14: LGTM!The event handler is well-structured and correctly implements wildcard Transfer event indexing. The ID construction (line 6) follows best practices by combining
chainId,block.number, andlogIndexto ensure uniqueness across chains and transactions.codegenerator/cli/templates/static/effects_api_template/typescript/config.yaml (1)
21-21: No changes required—UniswapV3Pool configuration is correct.The verification confirms this is the proper factory pattern implementation. Both the effects_api_template and factory_indexer_template use the identical pattern: UniswapV3Factory has a hardcoded address (the factory contract), while UniswapV3Pool lacks an address because pool instances are dynamically registered via the
PoolCreatedevent. This is the correct design for factory-deployed contracts.codegenerator/cli/templates/static/multichain_indexer_template/typescript/config.yaml (1)
17-22: The address is correct — no changes needed.The UniswapV3Factory on Unichain Mainnet (chain ID 130) is deployed at 0x1f98400000000000000000000000000000000003. The address beginning 0x1F98431c... is UniswapV3Factory on Ethereum mainnet and Unichain Sepolia. Uniswap V3 deployments use different contract addresses across different networks; the address in the template is the legitimate mainnet deployment, not a placeholder.
Likely an incorrect or invalid review comment.
codegenerator/cli/templates/static/effects_api_template/shared/README.md (1)
1-93: Documentation is clear and comprehensive.The README provides excellent guidance on the Effects API template with concrete examples, prerequisites, and running instructions. The code samples are accurate and demonstrate the pattern well.
codegenerator/cli/templates/static/topic_filtering_template/typescript/config.yaml (1)
1-15: Configuration is well-structured and complete.The template config properly defines the topic filtering indexer with complete contract specification and appropriate network configuration. The ERC20 Transfer event setup is correct.
codegenerator/cli/templates/static/factory_indexer_template/shared/schema.graphql (1)
1-20: GraphQL schema is well-structured.The factory indexer schema properly models the Uniswap V3 relationship between pool creation and swaps. The
@derivedFromrelationship is correctly established on the pool reference field.codegenerator/cli/templates/static/factory_indexer_template/shared/README.md (1)
1-55: Documentation clearly explains the factory pattern.The README provides a clear explanation of dynamic contract registration with proper examples and running instructions. The Uniswap V3 concrete example effectively demonstrates the contractRegister pattern.
codegenerator/cli/templates/static/wildcard_indexing_template/shared/schema.graphql (1)
1-12: Schema is well-documented and properly structured.The Transfer type is clearly defined with helpful inline comments explaining each field's purpose. The field types are appropriate for the wildcard indexing pattern.
codegenerator/cli/templates/static/multichain_indexer_template/shared/schema.graphql (1)
1-20: Schema types are well-defined.All three GraphQL types are properly structured with appropriate field types for capturing Uniswap V3 Factory events across multiple chains.
codegenerator/cli/src/cli_args/init_config.rs (2)
72-84: Sanity check: handler path is plumbed from Language into HumanConfig as-is.Given the unified path above, this flow looks correct. Please re-run a local init (TS and JS/ReScript) to confirm configs reference the right EventHandlers file relative to the project root.
Also applies to: 147-156, 167-184
356-361: TypeScript path should include "./", not remove it from others.The actual template config.yaml files consistently use
./src/EventHandlers.*across all languages. The Rust code should mirror this by adding./to TypeScript, not removing it from ReScript and JavaScript as suggested.- Language::ReScript => "./src/EventHandlers.res.js".to_string(), + Language::ReScript => "./src/EventHandlers.res.js".to_string(), Language::TypeScript => "./src/EventHandlers.ts".to_string(), - Language::JavaScript => "./src/EventHandlers.js".to_string(), + Language::JavaScript => "./src/EventHandlers.js".to_string(),Likely an incorrect or invalid review comment.
codegenerator/cli/src/template_dirs.rs (5)
13-14: LGTM! Clean trait extension.The new
supported_languages()method provides a clear API for querying language support per template, enabling dynamic filtering in the CLI.
57-65: LGTM!The Fuel template language support is properly implemented and consistent with the EVM Greeter template.
469-508: LGTM! Well-improved test coverage.The test updates properly validate that each template has directories for only its supported languages, and the error messages are now more specific and helpful. The addition of the dynamic shared init template check is also good.
514-552: LGTM! Tests properly validate template extraction.The extraction tests now correctly iterate over only the supported languages for each template. The use of separate TempDirs for template types improves test isolation.
22-24: Based on the script output you provided, I can now verify the situation:Key Finding: All 6 new template directories exist and are properly configured:
- ✅ effects_api_template
- ✅ factory_indexer_template
- ✅ multichain_indexer_template
- ✅ onblock_handler_template
- ✅ topic_filtering_template
- ✅ wildcard_indexing_template
The code snippet shown only displays lines 22-24 with 3 enum variants, but this is just a partial view. The 3 visible variants (TopicFiltering, WildcardIndexing, OnBlockHandler) match 3 of the 6 template directories. Since all 6 directories exist on disk with proper TypeScript subdirectories, the template directory structure is complete and correct.
The original review comment was based on incomplete information—the code snippet doesn't show the full enum, so it appeared that only 3 templates were added when in fact all 6 are present. The discrepancy mentioned in the PR description and code is resolved by the fact that all template directories are present on the filesystem.
No issues found - template directories verified as complete.
| * `-t`, `--template <TEMPLATE>` — Name of the template to be used in initialization | ||
|
|
||
| Possible values: `greeter`, `erc20` | ||
| Possible values: `greeter`, `erc20`, `topic-filtering`, `wildcard-indexing`, `on-block-handler` |
There was a problem hiding this comment.
🧩 Analysis chain
Verify all new templates are documented.
The PR description mentions adding 6 new templates, but only 5 are listed here. The AI summary references templates like effects-api, factory-indexer, and multichain-indexer that don't appear in this help text. Please confirm:
- Are all new templates included in the documentation?
- Are
greeteranderc20pre-existing templates or new additions?
🏁 Script executed:
#!/bin/bash
# Find all template directories to verify what templates exist
fd -t d . codegenerator/cli/templates/static/ -d 1 --exec basename
Length of output: 235
I need to view the complete CommandLineHelp.md file to understand the full context and what should be documented.
---
🏁 Script executed:
```shell
#!/bin/bash
# View the CommandLineHelp.md file to see complete context
cat codegenerator/cli/CommandLineHelp.md
Length of output: 10277
Update the EVM template documentation to include all available templates.
The filesystem contains more templates than currently documented:
EVM templates in codebase:
- Documented:
greeter,erc20,topic-filtering,wildcard-indexing,on-block-handler - Not documented:
factory-indexer,multichain-indexer,effects-api,blank
Fuel templates in codebase:
- Documented:
greeter - Not documented:
greeteronfuel
Update line 145 (envio init template section) and the Fuel template section to include all available templates, or confirm that undocumented templates are intentionally excluded.
🤖 Prompt for AI Agents
In codegenerator/cli/CommandLineHelp.md around line 145, the list of possible
templates is incomplete: add the missing EVM templates (factory-indexer,
multichain-indexer, effects-api, blank) to the `envio init template` section and
update the Fuel templates section to include `greeteronfuel` (or explicitly note
any intentionally excluded templates); edit the documented lists so they match
the filesystem names exactly and keep ordering/format consistent with existing
entries.
| #[strum(serialize = "Greeter")] | ||
| Greeter, | ||
| #[strum(serialize = "ERC20")] | ||
| Erc20, | ||
| #[strum(serialize = "Feature: Topic Filtering")] | ||
| TopicFiltering, | ||
| #[strum(serialize = "Feature: Wildcard Indexing")] | ||
| WildcardIndexing, | ||
| #[strum(serialize = "Feature: On-Block Handler")] | ||
| OnBlockHandler, |
There was a problem hiding this comment.
🧩 Analysis chain
Template naming/serialization may drift across clap/strum/serde. Verify UX strings and parsing.
- strum(serialize = "...") sets Display/EnumString, but clap::ValueEnum uses its own naming rules unless given explicit clap attributes; serde derives won’t use strum Display either.
- Result: interactive/help text and config (de)serialization may show different strings than the ones you intend (“Feature: ...”).
Please confirm:
- CLI shows the intended labels for these variants.
- Non-interactive flags parse both human labels and machine labels as expected.
- The new templates (effects-api, factory-indexer, multichain-indexer) are exposed to users (either here or via template_dirs). If they’re intentionally not in this enum, ensure template_dirs.rs maps them correctly.
You can run:
🏁 Script executed:
#!/bin/bash
# Inspect enum variants and any template mappings
rg -nP 'enum\s+Template\b' -C2 codegenerator/cli
rg -nP 'supported_languages\s*\(' codegenerator/cli
rg -nP '(effects_api_template|factory_indexer_template|multichain_indexer_template)' -n codegenerator/cli
Length of output: 1647
I need to gather more information about the Template enums and how they're used.<!-- [scratchpad_update]
[observations_additional]
- Web search confirms: clap::ValueEnum has its own naming logic separate from strum serialize
- clap uses kebab-case by default; can be overridden with #[clap(rename_all = "...")] attribute
- strum(serialize = "...") controls Display/EnumString/serde serialization, NOT clap's ValueEnum parsing
- When clap::ValueEnum and strum both present, clap won't automatically respect strum(serialize) unless #[clap(...)] attributes are explicitly added
- This is exactly what the review comment warns about
- ValueEnum.to_possible_value() is the method that controls CLI value parsing
[pending_critical]
- Need to inspect the actual Template enum definition to see if clap attributes are present
- Need to find where the new templates are defined/used
- Need to check template_dirs.rs for template registration
[scratchpad_end] -->
Need to inspect the actual Template enum and template registration in more detail.
🏁 Script executed:
#!/bin/bash
# Get full context of the Template enum at line 30
sed -n '28,80p' codegenerator/cli/src/cli_args/init_config.rs
Length of output: 2220
🏁 Script executed:
#!/bin/bash
# Get full context of the second Template enum at line 231
sed -n '229,240p' codegenerator/cli/src/cli_args/init_config.rs
Length of output: 285
🏁 Script executed:
#!/bin/bash
# Look for clap attributes on Template enum
rg -nP '#\[clap' codegenerator/cli/src/cli_args/init_config.rs -A2 -B2
Length of output: 243
🏁 Script executed:
#!/bin/bash
# Search for new template names in template_dirs.rs
rg -nP '(effects|factory|multichain)' codegenerator/cli/src/template_dirs.rs -i -C2
Length of output: 0
🏁 Script executed:
#!/bin/bash
# Check if there's a match on Template enum and ValueEnum derive to understand how it's used
ast-grep --pattern $'#[derive($$$ValueEnum$$$)]
pub enum Template {
$$$
}'
Length of output: 0
🏁 Script executed:
#!/bin/bash
# Look for clap rename_all on the enum itself
rg -nP 'enum Template' codegenerator/cli -B5 | head -40
Length of output: 1303
🏁 Script executed:
#!/bin/bash
# Search in template_dirs for TemplateProvider or template registration logic
rg -nP 'fn.*template' codegenerator/cli/src/template_dirs.rs -i -n
Length of output: 1251
🏁 Script executed:
#!/bin/bash
# Look for where Template enum variants are used in value parsing
rg -nP 'to_possible_value|value_variants|Template::' codegenerator/cli/src/cli_args/init_config.rs -n
Length of output: 0
🏁 Script executed:
#!/bin/bash
# Check if there's any test or mock for template selection
fd -e rs codegenerator/cli -path '*/test*' -o -name '*test*' | xargs rg -l Template 2>/dev/null | head -5
Length of output: 360
🏁 Script executed:
#!/bin/bash
# Look for explicit use of strum in imports or dependencies
rg -n '^use.*strum' codegenerator/cli/src/
Length of output: 991
🏁 Script executed:
#!/bin/bash
# Look for where Template is actually parsed/matched in the interactive flow
rg -nP 'Template::|template.*select|select.*template' codegenerator/cli/src/cli_args/interactive_init/ -i
Length of output: 932
🏁 Script executed:
#!/bin/bash
# Check Cargo.toml for versions of clap, strum, serde
rg -n '(clap|strum|serde)' codegenerator/cli/Cargo.toml -A1
Length of output: 379
🏁 Script executed:
#!/bin/bash
# Look at the full enum definition including derive macros
sed -n '25,100p' codegenerator/cli/src/cli_args/init_config.rs
Length of output: 3034
I need to verify a few more critical details about how Template enum is used in argument parsing and whether clap attributes exist at the module level.
🏁 Script executed:
#!/bin/bash
# Check if Template is used in clap argument definitions
rg -nP 'template|Template' codegenerator/cli/src/cli_args/clap_definitions.rs -i -C3
Length of output: 1763
🏁 Script executed:
#!/bin/bash
# Look at the evm module declaration to see if there are clap attributes
sed -n '1,50p' codegenerator/cli/src/cli_args/init_config.rs
Length of output: 1537
🏁 Script executed:
#!/bin/bash
# Check how the Template is rendered in the interactive prompt (Display impl check)
rg -nP 'shared_prompts|SelectItem' codegenerator/cli/src/cli_args/interactive_init/shared_prompts.rs -C5
Length of output: 887
🏁 Script executed:
#!/bin/bash
# Look for where template names are actually output to user (help text, prompts)
rg -nP 'which.*template|select.*template' codegenerator/cli/src/cli_args/interactive_init/ -i -C3
Length of output: 1539
🏁 Script executed:
#!/bin/bash
# Check TemplateType enum to understand template registration
sed -n '179,220p' codegenerator/cli/src/template_dirs.rs
Length of output: 1422
🏁 Script executed:
#!/bin/bash
# Look for any rename_all or clap rename directives on evm module
grep -n 'mod evm' codegenerator/cli/src/cli_args/init_config.rs -B5 -A10
Length of output: 411
🏁 Script executed:
#!/bin/bash
# Search for ValueEnum implementation to see if to_possible_value is customized
rg -nP 'impl.*ValueEnum|to_possible_value' codegenerator/cli/src/cli_args/init_config.rs -n
Length of output: 0
🏁 Script executed:
#!/bin/bash
# Check template_dirs.rs TemplateType for variant names
sed -n '179,200p' codegenerator/cli/src/template_dirs.rs
Length of output: 679
Add #[clap(...)] attributes to Template enum variants to align clap parsing with strum Display strings.
The review concern is valid. Template enum (line 29-40) derives ValueEnum without explicit clap attributes, causing a mismatch:
- Interactive UI displays strum serialized strings: "ERC20", "Feature: Topic Filtering"
- clap parses using variant names as kebab-case: "erc-20", "topic-filtering"
This breaks non-interactive flag parsing (e.g., --template erc-20 would fail).
Fix: Add #[clap(name = "...")] attributes on each Template variant, mirroring the strum serialized values. Reference: Language enum (lines 346-352) demonstrates the correct pattern with explicit clap name attributes.
Regarding new templates: effects_api_template, factory_indexer_template, multichain_indexer_template are not found in the Template enum or template_dirs.rs. Verify whether these should be added to the enum or are intentionally excluded.
🤖 Prompt for AI Agents
In codegenerator/cli/src/cli_args/init_config.rs around lines 31 to 40, the
Template enum variants derive ValueEnum but lack clap name attributes so clap
parsing uses kebab-case variant names (e.g., "erc-20") while the interactive UI
uses strum serialized strings (e.g., "ERC20"); add #[clap(name = "...")] to each
variant with the exact string used in #[strum(serialize = "...")] (e.g.,
#[clap(name = "ERC20")]) so non-interactive flags parse the same values, and
also verify whether effects_api_template, factory_indexer_template, and
multichain_indexer_template should be added to this enum or intentionally
omitted and update template_dirs.rs accordingly.
|
|
||
| fn supported_languages(&self) -> Vec<Language> { | ||
| match self { | ||
| // Example mappings — adjust based on what your actual templates support |
There was a problem hiding this comment.
🛠️ Refactor suggestion | 🟠 Major
Remove the placeholder comment.
The comment suggests this is example code needing adjustment. Please remove it as the mappings appear to be the actual implementation.
- // Example mappings — adjust based on what your actual templates support
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| // Example mappings — adjust based on what your actual templates support |
🤖 Prompt for AI Agents
In codegenerator/cli/src/template_dirs.rs around line 31, remove the placeholder
comment line "// Example mappings — adjust based on what your actual templates
support" from the file since the mappings below are the real implementation;
simply delete that comment so the file contains only relevant code/comments and
re-run formatting if needed.
| @@ -0,0 +1,2 @@ | |||
| # To create or update a token visit https://envio.dev/app/api-tokens | |||
| ENVIO_API_TOKEN="<YOUR-API-TOKEN>" | |||
There was a problem hiding this comment.
Remove quotes around the placeholder value in .env.example.
The double-quoted placeholder value violates dotenv conventions. If users copy this line without modification, the token value will include the literal quotes, causing authentication failures. Placeholder values in .env.example should be unquoted.
- ENVIO_API_TOKEN="<YOUR-API-TOKEN>"
+ ENVIO_API_TOKEN=<YOUR-API-TOKEN>
🧰 Tools
🪛 dotenv-linter (4.0.0)
[warning] 2-2: [QuoteCharacter] The value has quote characters (', ")
(QuoteCharacter)
🤖 Prompt for AI Agents
In codegenerator/cli/templates/static/effects_api_template/shared/.env.example
around line 2, the placeholder ENVIO_API_TOKEN is wrapped in double quotes which
can cause users to copy the quotes into their actual .env and break
authentication; remove the surrounding quotes so the placeholder is unquoted
(ENVIO_API_TOKEN=<YOUR-API-TOKEN>) and ensure any accompanying documentation
notes the token should be pasted without quotes.
| *.exe | ||
| *.obj | ||
| *.out | ||
| *.compile | ||
| *.native | ||
| *.byte | ||
| *.cmo | ||
| *.annot | ||
| *.cmi | ||
| *.cmx | ||
| *.cmt | ||
| *.cmti | ||
| *.cma | ||
| *.a | ||
| *.cmxa | ||
| *.obj | ||
| *~ | ||
| *.annot | ||
| *.cmj | ||
| *.bak | ||
| lib/* | ||
| *.mlast | ||
| *.mliast | ||
| .vscode | ||
| .merlin | ||
| .bsb.lock | ||
| node_modules/ | ||
| build/ | ||
| benchmarks/ | ||
| artifacts | ||
| cache | ||
| *.res.js | ||
| *.res.mjs | ||
| generated | ||
| .env |
There was a problem hiding this comment.
Remove duplicate ignore patterns.
The file contains duplicate patterns that should be consolidated:
*.objappears on lines 2 and 16*.annotappears on 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
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| *.exe | |
| *.obj | |
| *.out | |
| *.compile | |
| *.native | |
| *.byte | |
| *.cmo | |
| *.annot | |
| *.cmi | |
| *.cmx | |
| *.cmt | |
| *.cmti | |
| *.cma | |
| *.a | |
| *.cmxa | |
| *.obj | |
| *~ | |
| *.annot | |
| *.cmj | |
| *.bak | |
| lib/* | |
| *.mlast | |
| *.mliast | |
| .vscode | |
| .merlin | |
| .bsb.lock | |
| node_modules/ | |
| build/ | |
| benchmarks/ | |
| artifacts | |
| cache | |
| *.res.js | |
| *.res.mjs | |
| generated | |
| .env | |
| *.exe | |
| *.obj | |
| *.out | |
| *.compile | |
| *.native | |
| *.byte | |
| *.cmo | |
| *.annot | |
| *.cmi | |
| *.cmx | |
| *.cmt | |
| *.cmti | |
| *.cma | |
| *.a | |
| *.cmxa | |
| *~ | |
| *.cmj | |
| *.bak | |
| lib/* | |
| *.mlast | |
| *.mliast | |
| .vscode | |
| .merlin | |
| .bsb.lock | |
| node_modules/ | |
| build/ | |
| benchmarks/ | |
| artifacts | |
| cache | |
| *.res.js | |
| *.res.mjs | |
| generated | |
| .env |
🤖 Prompt for AI Agents
In codegenerator/cli/templates/static/effects_api_template/shared/.gitignore
around lines 1 to 35, there are duplicate ignore patterns (*.obj on lines 2 and
16, and *.annot on lines 8 and 18); remove the duplicated entries so each
pattern appears only once (keep a single instance of *.obj and a single instance
of *.annot), preserving the rest of the ordering and content.
| } | ||
| , | ||
| async ({ block, context }) => { | ||
| const latestSupply = await context.TotalSupply.get("latest"); |
There was a problem hiding this comment.
🛠️ Refactor suggestion | 🟠 Major
Chain-scope the “latest” entity ID to prevent collisions across networks.
If run against multiple chains now or later, "latest" will collide. Include chainId in the key.
- const latestSupply = await context.TotalSupply.get("latest");
+ const latestSupply = await context.TotalSupply.get(`${block.chainId}-latest`);
@@
- const latestSupply = await context.TotalSupply.getOrCreate({
- id: "latest",
+ const latestSupply = await context.TotalSupply.getOrCreate({
+ id: `${event.chainId}-latest`,
@@
- const latestEntity: TotalSupply = {
- id: "latest",
+ const latestEntity: TotalSupply = {
+ id: `${event.chainId}-latest`,
Additionally, consider guarding burns so supply doesn’t go negative on malformed events.
Also applies to: 48-53, 67-72
🤖 Prompt for AI Agents
In
codegenerator/cli/templates/static/onblock_handler_template/typescript/src/EventHandlers.ts
around line 21 (and also update the similar occurrences at lines 48-53 and
67-72), the entity key "latest" must be chain-scoped to avoid cross-chain
collisions and burns must be guarded so supply cannot go negative; change all
uses of the "latest" key to include the chain identifier from the handler
context (e.g., prepend or append context.chainId/context.network.chainId to the
key) and update any get/set calls accordingly, and when applying burn/transfer
decrements clamp the resulting supply at zero (or skip the decrement if it would
go negative) so malformed events cannot produce a negative totalSupply.
| const supply = latestSupply.currentSupply; | ||
| const blockNumber = latestSupply.blockNumber; | ||
| const timestamp = latestSupply.timestamp; | ||
|
|
||
| const totalSupplySnapshot: TotalSupplySnapshot = { | ||
| id: `${block.chainId}_${block.number}`, | ||
| supply: supply, | ||
| blockNumber: blockNumber, | ||
| timestamp: timestamp, | ||
| }; |
There was a problem hiding this comment.
Bug: snapshot stores stale blockNumber/timestamp from latestSupply.
Use the current block’s values, not the last mint/burn’s. Fix below.
- const supply = latestSupply.currentSupply;
- const blockNumber = latestSupply.blockNumber;
- const timestamp = latestSupply.timestamp;
+ const supply = latestSupply.currentSupply;
+ const blockNumber = BigInt(block.number);
+ const timestamp = BigInt(block.timestamp);
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| const supply = latestSupply.currentSupply; | |
| const blockNumber = latestSupply.blockNumber; | |
| const timestamp = latestSupply.timestamp; | |
| const totalSupplySnapshot: TotalSupplySnapshot = { | |
| id: `${block.chainId}_${block.number}`, | |
| supply: supply, | |
| blockNumber: blockNumber, | |
| timestamp: timestamp, | |
| }; | |
| const supply = latestSupply.currentSupply; | |
| const blockNumber = BigInt(block.number); | |
| const timestamp = BigInt(block.timestamp); | |
| const totalSupplySnapshot: TotalSupplySnapshot = { | |
| id: `${block.chainId}_${block.number}`, | |
| supply: supply, | |
| blockNumber: blockNumber, | |
| timestamp: timestamp, | |
| }; |
🤖 Prompt for AI Agents
In
codegenerator/cli/templates/static/onblock_handler_template/typescript/src/EventHandlers.ts
around lines 26 to 35, the TotalSupplySnapshot is being populated with
blockNumber and timestamp from latestSupply (stale values); change those
assignments to use the current block's values (block.number and block.timestamp)
so the snapshot reflects the current block, and update the id if it relies on
those fields to use the current block values as well.
| { | ||
| "compilerOptions": { | ||
| "target": "es2020", //required for use with BigInt types | ||
| "lib": [ | ||
| "es2020" | ||
| ], | ||
| "allowJs": true, | ||
| "checkJs": false, | ||
| "outDir": "build", | ||
| "strict": true, | ||
| "noImplicitAny": true, | ||
| "esModuleInterop": true, | ||
| "resolveJsonModule": true, | ||
| "skipLibCheck": true, | ||
| "module": "CommonJS" | ||
| }, | ||
| "include": [ | ||
| "src", | ||
| "test" | ||
| ] | ||
| } |
There was a problem hiding this comment.
🧩 Analysis chain
TypeScript configuration looks correct.
The configuration appropriately targets es2020 for BigInt support with strict type checking enabled. Ensure that TypeScript compilation succeeds with this configuration before merging.
🏁 Script executed:
#!/bin/bash
# Description: Verify TypeScript compilation for onblock_handler_template
cd codegenerator/cli/templates/static/onblock_handler_template/typescript
pnpm tsc --noEmit
Length of output: 195
🏁 Script executed:
#!/bin/bash
# Check what files exist in the onblock_handler_template directory
fd . codegenerator/cli/templates/static/onblock_handler_template/typescript/ -type f
Length of output: 170
🏁 Script executed:
#!/bin/bash
# Check the parent directory structure to understand template organization
ls -la codegenerator/cli/templates/static/onblock_handler_template/
Length of output: 226
🏁 Script executed:
#!/bin/bash
# Search for references to onblock_handler_template in the codebase
rg -n "onblock_handler_template" codegenerator/cli/ --type rust --type ts --type toml
Length of output: 0
🏁 Script executed:
#!/bin/bash
# Check if there's a package.json at a higher level (workspace root)
fd package.json codegenerator/cli/templates/ -type f
Length of output: 170
🏁 Script executed:
#!/bin/bash
# Look for TypeScript files in the template structure
fd '\.ts$' codegenerator/cli/templates/static/onblock_handler_template/ -type f
Length of output: 170
🏁 Script executed:
#!/bin/bash
# Check if there's a root package.json we can use for type checking
fd package.json codegenerator/cli/ -type f | head -5
Length of output: 170
🏁 Script executed:
#!/bin/bash
# Check the README or documentation about these templates
fd README codegenerator/cli/templates/ -type f
Length of output: 170
🏁 Script executed:
#!/bin/bash
# Look at the structure of the templates directory
ls -la codegenerator/cli/templates/static/
Length of output: 934
🏁 Script executed:
#!/bin/bash
# Check if tsconfig.json is referenced in any Rust source code (generator code)
rg -n "tsconfig" codegenerator/cli/ --type rust -A2 -B2
Length of output: 0
🏁 Script executed:
#!/bin/bash
# Search for any test or validation of these templates
fd "template" codegenerator/cli/src/ --type f -name "*.rs" | head -10
Length of output: 230
🏁 Script executed:
#!/bin/bash
# Look at the actual Rust code that generates or manages these templates
ls -la codegenerator/cli/src/
Length of output: 1176
🏁 Script executed:
#!/bin/bash
# Check the structure more broadly
find codegenerator/cli/templates -type d | head -20
Length of output: 1265
🏁 Script executed:
#!/bin/bash
# Look for configuration or references to how templates are validated
rg -n "onblock" codegenerator/cli/src/ --type rust -C2 | head -30
Length of output: 436
🏁 Script executed:
#!/bin/bash
# Check if there's a build.rs or similar that processes templates
fd "build.rs\|lib.rs\|main.rs" codegenerator/cli/src/ --type f
Length of output: 0
🏁 Script executed:
#!/bin/bash
# Examine the content structure of the template directory
find codegenerator/cli/templates/static/onblock_handler_template -type f -exec file {} \;
Length of output: 319
🏁 Script executed:
#!/bin/bash
# Check if there's documentation about template usage
rg -n "template" codegenerator/cli/README.md --type markdown -C3 2>/dev/null || echo "No README found"
Length of output: 15
🏁 Script executed:
#!/bin/bash
# Look for CargoToml or similar configuration that might reference these templates
cat codegenerator/cli/Cargo.toml | grep -A10 -B10 "onblock\|template" || echo "No matches in Cargo.toml"
Length of output: 24
🏁 Script executed:
#!/bin/bash
# Check what Rust modules exist in the CLI
ls -la codegenerator/cli/src/*.rs
Length of output: 596
🏁 Script executed:
#!/bin/bash
# List all files recursively in the onblock_handler_template directory
find codegenerator/cli/templates/static/onblock_handler_template -type f
Length of output: 660
🏁 Script executed:
#!/bin/bash
# Compare with another template to understand the pattern
find codegenerator/cli/templates/static/greeter_template -type f | head -20
Length of output: 1366
🏁 Script executed:
#!/bin/bash
# Check if there's any TypeScript validation in the build process
cat codegenerator/cli/Cargo.toml
Length of output: 1879
🏁 Script executed:
#!/bin/bash
# Validate tsconfig.json syntax using a simple JSON validator
python3 << 'EOF'
import json
try:
with open('codegenerator/cli/templates/static/onblock_handler_template/typescript/tsconfig.json', 'r') as f:
data = json.load(f)
print("✓ tsconfig.json is valid JSON")
print("✓ Compiler options found:", len(data.get('compilerOptions', {})))
print("✓ Include paths:", data.get('include', []))
except json.JSONDecodeError as e:
print("✗ JSON syntax error:", str(e))
except Exception as e:
print("✗ Error:", str(e))
EOF
Length of output: 98
🏁 Script executed:
#!/bin/bash
# Check the template_dirs.rs to understand how templates are used
cat codegenerator/cli/src/template_dirs.rs | head -100
Length of output: 3160
🏁 Script executed:
#!/bin/bash
# Look for any documentation about these templates
find codegenerator/cli/templates -name "*.md" -o -name "README*" 2>/dev/null
Length of output: 1102
🏁 Script executed:
#!/bin/bash
# Check if there are similar onblock or handler templates elsewhere
find codegenerator/cli/templates -type d -name "*onblock*" -o -type d -name "*handler*"
Length of output: 59
🏁 Script executed:
#!/bin/bash
# List files in related templates' typescript directories
ls -la codegenerator/cli/templates/static/greeter_template/typescript/
Length of output: 401
🏁 Script executed:
#!/bin/bash
# Check if there's any validation or testing of template files
rg -n "tsconfig\|typescript" codegenerator/cli/src/commands.rs -C2
Length of output: 0
🏁 Script executed:
#!/bin/bash
# Compare tsconfig.json between templates
cat codegenerator/cli/templates/static/greeter_template/typescript/tsconfig.json
Length of output: 392
🏁 Script executed:
#!/bin/bash
# Check another template's tsconfig.json
cat codegenerator/cli/templates/static/wildcard_indexing_template/typescript/tsconfig.json
Length of output: 392
🏁 Script executed:
#!/bin/bash
# Verify the exact content of the file under review
cat codegenerator/cli/templates/static/onblock_handler_template/typescript/tsconfig.json
Length of output: 392
🏁 Script executed:
#!/bin/bash
# Check if topic_filtering also has tsconfig
cat codegenerator/cli/templates/static/topic_filtering_template/typescript/tsconfig.json
Length of output: 392
Remove JSON comment from tsconfig.json — the file contains invalid JSON syntax.
Line 3 has //required for use with BigInt types which violates the JSON specification. JSON does not support // comments. This will cause TypeScript compilation to fail when users initialize projects from this template.
Remove the comment entirely or move the explanation to documentation.
{
"compilerOptions": {
"target": "es2020",
"lib": [
"es2020"
],
Note: This issue exists identically in other TypeScript templates (greeter_template, wildcard_indexing_template, topic_filtering_template).
🤖 Prompt for AI Agents
In
codegenerator/cli/templates/static/onblock_handler_template/typescript/tsconfig.json
lines 1-21, remove the inline comment on line 3 ("//required for use with BigInt
types") because tsconfig.json must be valid JSON; delete the comment or move the
note to accompanying docs/README and ensure the file only contains valid JSON
(no // or /* */ comments) so TypeScript compilation from the template won't
fail.
| { | ||
| wildcard: true, | ||
| eventFilters: { | ||
| from: ZERO_ADDRESS, | ||
| to: ZERO_ADDRESS, | ||
| } | ||
| }, |
There was a problem hiding this comment.
🧩 Analysis chain
Verify eventFilters logic - may not match any transfers.
The current configuration filters for transfers where BOTH from AND to are ZERO_ADDRESS, which is impossible for standard ERC20 transfers. Typically, you'd want to match:
- Mints:
from= ZERO_ADDRESS (anyto) - Burns:
to= ZERO_ADDRESS (anyfrom)
If this is an example template, consider documenting the expected behavior or adjusting to demonstrate a realistic use case.
Run the following script to check if there are other topic filtering examples or documentation that clarify the intended behavior:
🏁 Script executed:
#!/bin/bash
# Search for topic filtering examples and documentation
rg -n -C3 "eventFilters" --type=ts --type=md --type=yaml
Length of output: 12852
🏁 Script executed:
#!/bin/bash
# Get the full context of the EventHandler.ts template file
cat codegenerator/cli/templates/static/topic_filtering_template/typescript/src/EventHandler.ts
Length of output: 506
🏁 Script executed:
#!/bin/bash
# Check for README or documentation in the template directory
find codegenerator/cli/templates/static/topic_filtering_template -type f \( -name "*.md" -o -name "*.txt" -o -name "README*" \) -exec cat {} +
Length of output: 1654
Fix template to demonstrate realistic topic filtering patterns.
The template's eventFilters configuration requires both from and to to equal ZERO_ADDRESS simultaneously, which is impossible for valid ERC20 transfers and demonstrates ineffective filtering. The README provides no explanation for this configuration.
Based on test examples in the codebase, realistic Transfer filtering shows:
- Mints:
from: ZERO_ADDRESS(anyto) - Burns:
to: ZERO_ADDRESS(anyfrom)
Update the template to demonstrate one of these realistic patterns or show both mints and burns using separate filter objects in an array (for OR logic), matching patterns used in scenarios/test_codegen/src/EventHandlers.ts.
🤖 Prompt for AI Agents
In
codegenerator/cli/templates/static/topic_filtering_template/typescript/src/EventHandler.ts
around lines 16 to 22, the eventFilters currently require both from and to to
equal ZERO_ADDRESS which can never match real ERC20 Transfer events; replace
that single impossible filter with realistic pattern(s) — either a single filter
for mints (from: ZERO_ADDRESS, no to constraint) or burns (to: ZERO_ADDRESS, no
from constraint), or preferably an array of two filter objects (one for mints
and one for burns) to implement OR logic as used in
scenarios/test_codegen/src/EventHandlers.ts so the template demonstrates real
Transfer filtering.
| { | ||
| "compilerOptions": { | ||
| "target": "es2020", //required for use with BigInt types | ||
| "lib": [ | ||
| "es2020" | ||
| ], | ||
| "allowJs": true, | ||
| "checkJs": false, | ||
| "outDir": "build", | ||
| "strict": true, | ||
| "noImplicitAny": true, | ||
| "esModuleInterop": true, | ||
| "resolveJsonModule": true, | ||
| "skipLibCheck": true, | ||
| "module": "CommonJS" | ||
| }, | ||
| "include": [ | ||
| "src", | ||
| "test" | ||
| ] | ||
| } |
There was a problem hiding this comment.
🧩 Analysis chain
TypeScript configuration looks correct.
The configuration appropriately targets es2020 for BigInt support with strict type checking enabled. Ensure that TypeScript compilation succeeds with this configuration before merging.
🏁 Script executed:
#!/bin/bash
# Description: Verify TypeScript compilation for wildcard_indexing_template
cd codegenerator/cli/templates/static/wildcard_indexing_template/typescript
pnpm tsc --noEmit
Length of output: 197
🏁 Script executed:
#!/bin/bash
# Find package.json files in the codegenerator/cli/templates directory hierarchy
echo "=== Searching for package.json in templates directory ==="
find codegenerator/cli/templates -name "package.json" -type f | head -20
echo -e "\n=== Checking root package.json in codegenerator/cli ==="
if [ -f "codegenerator/cli/package.json" ]; then
echo "Found: codegenerator/cli/package.json"
else
echo "Not found at codegenerator/cli/package.json"
fi
echo -e "\n=== Checking if tsconfig.json is valid JSON ==="
cat codegenerator/cli/templates/static/wildcard_indexing_template/typescript/tsconfig.json | python3 -m json.tool > /dev/null && echo "Valid JSON" || echo "Invalid JSON"
echo -e "\n=== List contents of template directory ==="
ls -la codegenerator/cli/templates/static/wildcard_indexing_template/typescript/
Length of output: 679
🏁 Script executed:
#!/bin/bash
# Explore repository structure to understand how templates are used
echo "=== Searching for package.json in templates hierarchy ==="
find codegenerator/cli/templates -name "package.json" -type f 2>/dev/null
echo -e "\n=== Checking codegenerator/cli directory ==="
ls -la codegenerator/cli/ | grep -E "package|tsconfig"
echo -e "\n=== Validating tsconfig.json is valid JSON ==="
if python3 -m json.tool codegenerator/cli/templates/static/wildcard_indexing_template/typescript/tsconfig.json > /dev/null 2>&1; then
echo "✓ tsconfig.json is valid JSON"
else
echo "✗ tsconfig.json is invalid JSON"
fi
echo -e "\n=== Contents of wildcard_indexing_template directory ==="
find codegenerator/cli/templates/static/wildcard_indexing_template -type f
echo -e "\n=== Check if there's a root package.json ==="
[ -f "package.json" ] && echo "Found package.json at repository root" || echo "No package.json at root"
Length of output: 987
🏁 Script executed:
#!/bin/bash
# Check other template tsconfig.json files for the same issue
echo "=== Checking all tsconfig.json files in templates ==="
find codegenerator/cli/templates -name "tsconfig.json" -type f -print0 | xargs -0 -I {} sh -c 'echo "File: {}"; python3 -m json.tool "{}" > /dev/null 2>&1 && echo " ✓ Valid JSON" || echo " ✗ Invalid JSON"'
echo -e "\n=== Display onblock_handler_template tsconfig.json for comparison ==="
cat codegenerator/cli/templates/static/onblock_handler_template/typescript/tsconfig.json
Length of output: 1568
🏁 Script executed:
#!/bin/bash
# Check all tsconfig.json files in templates for validity
echo "=== Checking all tsconfig.json files in templates ==="
find codegenerator/cli/templates -name "tsconfig.json" -type f | while read file; do
echo "File: $file"
if python3 -m json.tool "$file" > /dev/null 2>&1; then
echo " ✓ Valid JSON"
else
echo " ✗ Invalid JSON - Error details:"
python3 -m json.tool "$file" 2>&1 | head -5
fi
done
echo -e "\n=== Compare with onblock_handler_template tsconfig.json ==="
if [ -f "codegenerator/cli/templates/static/onblock_handler_template/typescript/tsconfig.json" ]; then
echo "Content:"
cat codegenerator/cli/templates/static/onblock_handler_template/typescript/tsconfig.json
fi
Length of output: 2517
Remove inline comments from tsconfig.json—they are invalid JSON syntax.
All template tsconfig.json files contain inline comments (e.g., //required for use with BigInt types) which violate JSON specification. While TypeScript can parse JSONC, the generated files will fail validation and cause issues with standard JSON tools. Move the comment to a line above the property or remove it entirely:
{
"compilerOptions": {
// Required for use with BigInt types
"target": "es2020",
...
}
}
This affects all 10 templates: blank_template, erc20_template, greeter_template, greeteronfuel_template, effects_api_template, factory_indexer_template, multichain_indexer_template, onblock_handler_template, topic_filtering_template, and wildcard_indexing_template.
🤖 Prompt for AI Agents
In
codegenerator/cli/templates/static/wildcard_indexing_template/typescript/tsconfig.json
lines 1-21, the file contains inline C++/JS-style comments (e.g., "//required
for use with BigInt types") which makes it invalid JSON; remove those inline
comments or relocate them to their own lines as JSON comments are not allowed in
standard JSON, so update the file to eliminate any // comments inside the JSON
object (and apply the same change across the other nine templates:
blank_template, erc20_template, greeter_template, greeteronfuel_template,
effects_api_template, factory_indexer_template, multichain_indexer_template,
onblock_handler_template, and topic_filtering_template) ensuring each
tsconfig.json is pure valid JSON with any explanatory notes moved outside the
JSON or into build docs.
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (3)
codegenerator/cli/templates/static/topic_filtering_template/typescript/src/EventHandlers.ts (1)
16-22: Critical issue with eventFilters already flagged in previous review.The configuration requiring both
fromandtoto equal ZERO_ADDRESS simultaneously cannot match any valid ERC20 Transfer events. This issue has already been comprehensively documented in the previous review comment, which provides detailed explanations and suggests realistic filtering patterns (mints or burns).codegenerator/cli/src/template_dirs.rs (1)
34-34: Remove the placeholder comment.The comment suggests this is example code needing adjustment. Please remove it as the mappings appear to be the actual implementation.
- // Example mappings — adjust based on what your actual templates supportcodegenerator/cli/src/cli_args/init_config.rs (1)
29-47: Add#[clap(name = "...")]attributes to align CLI parsing with display strings.The Template enum derives
ValueEnumbut lacks explicit#[clap(name = "...")]attributes, causing a critical mismatch:
- Interactive UI (using
Displayvia strum): Shows "ERC20", "Feature: Topic Filtering", etc.- CLI parsing (using
ValueEnum): Accepts kebab-case variant names like "erc20", "topic-filtering", etc.This breaks non-interactive usage where users see one set of strings but must type different ones.
Fix: Add
#[clap(name = "...")]to each variant, mirroring the strum serialization. Reference the Language enum (lines 352-357) which demonstrates the correct pattern:#[derive(Clone, Debug, ValueEnum, Serialize, Deserialize, EnumIter, EnumString, Display)] pub enum Template { + #[clap(name = "Greeter")] #[strum(serialize = "Greeter")] Greeter, + #[clap(name = "ERC20")] #[strum(serialize = "ERC20")] Erc20, + #[clap(name = "Feature: Topic Filtering")] #[strum(serialize = "Feature: Topic Filtering")] TopicFiltering, + #[clap(name = "Feature: Wildcard Indexing")] #[strum(serialize = "Feature: Wildcard Indexing")] WildcardIndexing, + #[clap(name = "Feature: onBlock Handler")] #[strum(serialize = "Feature: onBlock Handler")] OnBlockHandler, + #[clap(name = "Feature: Effects API")] #[strum(serialize = "Feature: Effects API")] EffectsAPI, + #[clap(name = "Feature: Factory Indexer")] #[strum(serialize = "Feature: Factory Indexer")] FactoryIndexer, + #[clap(name = "Feature: Multichain Indexer")] #[strum(serialize = "Feature: Multichain Indexer")] MultichainIndexer, }
🧹 Nitpick comments (1)
codegenerator/cli/templates/static/wildcard_indexing_template/typescript/src/EventHandlers.ts (1)
3-14: LGTM! Wildcard handler implementation is correct.The handler correctly implements wildcard ERC20 Transfer indexing. The ID composition (
chainId_blockNumber_logIndex) ensures uniqueness across chains and within blocks, and all required fields are properly mapped from the event parameters.Consider adding a
timestampfield to improve queryability:ERC20.Transfer.handler( async ({ event, context }) => { context.Transfer.set({ id: `${event.chainId}_${event.block.number}_${event.logIndex}`, amount: event.params.value, from: event.params.from, to: event.params.to, contract: event.srcAddress, + timestamp: event.block.timestamp, }); }, { wildcard: true }, );Note: This would also require updating the schema to include the
timestampfield.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
codegenerator/cli/src/cli_args/init_config.rs(1 hunks)codegenerator/cli/src/template_dirs.rs(3 hunks)codegenerator/cli/templates/static/topic_filtering_template/typescript/src/EventHandlers.ts(1 hunks)codegenerator/cli/templates/static/wildcard_indexing_template/typescript/src/EventHandlers.ts(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/src/template_dirs.rscodegenerator/cli/templates/static/wildcard_indexing_template/typescript/src/EventHandlers.tscodegenerator/cli/src/cli_args/init_config.rscodegenerator/cli/templates/static/topic_filtering_template/typescript/src/EventHandlers.ts
🧠 Learnings (7)
📚 Learning: 2025-10-21T16:31:22.099Z
Learnt from: CR
PR: enviodev/hyperindex#0
File: .cursor/rules/navigation.mdc:0-0
Timestamp: 2025-10-21T16:31:22.099Z
Learning: Applies to codegenerator/cli/src/hbs_templating/codegen_templates.rs : hbs_templating/codegen_templates.rs feeds templates
Applied to files:
codegenerator/cli/src/template_dirs.rs
📚 Learning: 2025-10-13T12:27:30.803Z
Learnt from: CR
PR: enviodev/hyperindex#0
File: codegenerator/cli/templates/static/shared/.cursor/rules/subgraph-migration.mdc:0-0
Timestamp: 2025-10-13T12:27:30.803Z
Learning: Applies to codegenerator/cli/templates/static/shared/src/EventHandlers.ts : Remove the original src/EventHandlers.ts after moving handlers into contract-specific files
Applied to files:
codegenerator/cli/templates/static/wildcard_indexing_template/typescript/src/EventHandlers.tscodegenerator/cli/templates/static/topic_filtering_template/typescript/src/EventHandlers.ts
📚 Learning: 2025-10-13T12:26:45.351Z
Learnt from: CR
PR: enviodev/hyperindex#0
File: .cursor/rules/subgraph-migration.mdc:0-0
Timestamp: 2025-10-13T12:26:45.351Z
Learning: Applies to src/EventHandlers.ts : Remove the monolithic EventHandlers.ts file after moving handlers to contract-specific files
Applied to files:
codegenerator/cli/templates/static/wildcard_indexing_template/typescript/src/EventHandlers.tscodegenerator/cli/templates/static/topic_filtering_template/typescript/src/EventHandlers.ts
📚 Learning: 2025-10-13T12:27:30.803Z
Learnt from: CR
PR: enviodev/hyperindex#0
File: codegenerator/cli/templates/static/shared/.cursor/rules/subgraph-migration.mdc:0-0
Timestamp: 2025-10-13T12:27:30.803Z
Learning: Applies to codegenerator/cli/templates/static/shared/src/EventHandlers.ts : Clear all boilerplate logic from src/EventHandlers.ts and replace handlers with empty skeletons before implementing business logic
Applied to files:
codegenerator/cli/templates/static/wildcard_indexing_template/typescript/src/EventHandlers.tscodegenerator/cli/templates/static/topic_filtering_template/typescript/src/EventHandlers.ts
📚 Learning: 2025-10-13T12:27:30.803Z
Learnt from: CR
PR: enviodev/hyperindex#0
File: codegenerator/cli/templates/static/shared/.cursor/rules/subgraph-migration.mdc:0-0
Timestamp: 2025-10-13T12:27:30.803Z
Learning: Applies to codegenerator/cli/templates/static/shared/**/config.yaml : Refactor to contract-specific handler files in config.yaml and remove the single EventHandlers.ts reference
Applied to files:
codegenerator/cli/templates/static/wildcard_indexing_template/typescript/src/EventHandlers.tscodegenerator/cli/templates/static/topic_filtering_template/typescript/src/EventHandlers.ts
📚 Learning: 2025-10-13T12:27:30.803Z
Learnt from: CR
PR: enviodev/hyperindex#0
File: codegenerator/cli/templates/static/shared/.cursor/rules/subgraph-migration.mdc:0-0
Timestamp: 2025-10-13T12:27:30.803Z
Learning: Applies to codegenerator/cli/templates/static/shared/src/**/*.ts : Register dynamic contracts using contractRegister above the creating event’s handler (e.g., context.addPair(event.params.pair))
Applied to files:
codegenerator/cli/templates/static/wildcard_indexing_template/typescript/src/EventHandlers.ts
📚 Learning: 2025-10-13T12:26:45.351Z
Learnt from: CR
PR: enviodev/hyperindex#0
File: .cursor/rules/subgraph-migration.mdc:0-0
Timestamp: 2025-10-13T12:26:45.351Z
Learning: Applies to src/EventHandlers.ts : Clear boilerplate logic in EventHandlers.ts and replace with empty handlers before implementing business logic
Applied to files:
codegenerator/cli/templates/static/topic_filtering_template/typescript/src/EventHandlers.ts
🧬 Code graph analysis (2)
codegenerator/cli/src/template_dirs.rs (2)
codegenerator/cli/src/cli_args/interactive_init/mod.rs (1)
Language(152-154)codegenerator/cli/src/hbs_templating/init_templates.rs (1)
new(23-58)
codegenerator/cli/src/cli_args/init_config.rs (2)
codegenerator/cli/src/config_parsing/entity_parsing.rs (2)
serialize(1177-1182)serialize(1328-1333)codegenerator/cli/src/rescript_types.rs (1)
serialize(703-709)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: build_and_test
🔇 Additional comments (7)
codegenerator/cli/templates/static/wildcard_indexing_template/typescript/src/EventHandlers.ts (1)
1-1: LGTM!The import statement correctly references the generated ERC20 contract bindings.
codegenerator/cli/templates/static/topic_filtering_template/typescript/src/EventHandlers.ts (2)
1-3: LGTM!Import and constant definitions are correct. The ZERO_ADDRESS constant is properly formatted for Ethereum addresses.
6-15: LGTM!The handler implementation is correct. The composite ID format ensures uniqueness across chains and blocks, and the field mappings properly extract Transfer event data into the entity.
codegenerator/cli/src/template_dirs.rs (4)
13-14: LGTM! Clean trait extension for language-aware filtering.The new
supported_languages()method enables the language-based template filtering described in the PR objectives.
63-71: LGTM! Fuel template language support correctly configured.The implementation correctly specifies that the Greeter template supports all three languages, consistent with the EVM Greeter template.
475-559: LGTM! Tests correctly updated to use language-aware filtering.The tests now properly iterate only over each template's supported languages rather than all languages globally. This prevents false failures when templates don't support all languages and aligns with the language-based template filtering introduced in this PR.
22-28: All new template directories exist and are correctly mapped.Verification confirms that all six template directories are present in the filesystem and correctly referenced by the code mappings in
to_dir_name(). The code changes are sound.
| #[strum(serialize = "Feature: Topic Filtering")] | ||
| TopicFiltering, | ||
| #[strum(serialize = "Feature: Wildcard Indexing")] | ||
| WildcardIndexing, | ||
| #[strum(serialize = "Feature: onBlock Handler")] | ||
| OnBlockHandler, | ||
| #[strum(serialize = "Feature: Effects API")] | ||
| EffectsAPI, | ||
| #[strum(serialize = "Feature: Factory Indexer")] | ||
| FactoryIndexer, | ||
| #[strum(serialize = "Feature: Multichain Indexer")] | ||
| MultichainIndexer, |
There was a problem hiding this comment.
| #[strum(serialize = "Feature: Topic Filtering")] | |
| TopicFiltering, | |
| #[strum(serialize = "Feature: Wildcard Indexing")] | |
| WildcardIndexing, | |
| #[strum(serialize = "Feature: onBlock Handler")] | |
| OnBlockHandler, | |
| #[strum(serialize = "Feature: Effects API")] | |
| EffectsAPI, | |
| #[strum(serialize = "Feature: Factory Indexer")] | |
| FactoryIndexer, | |
| #[strum(serialize = "Feature: Multichain Indexer")] | |
| MultichainIndexer, | |
| #[strum(serialize = "Feature: Topic Filtering")] | |
| TopicFiltering, | |
| #[strum(serialize = "Feature: Wildcard Indexing")] | |
| WildcardIndexing, | |
| #[strum(serialize = "Feature: Block Handler")] | |
| OnBlockHandler, | |
| #[strum(serialize = "Feature: External Calls")] | |
| EffectsAPI, | |
| #[strum(serialize = "Feature: Factory Contract")] | |
| FactoryIndexer, | |
| #[strum(serialize = "Feature: Multichain Indexer")] | |
| MultichainIndexer, |
2 participants
Added 6 new templates that users can now select directly from the CLI. Currently, all of these templates are available only in TypeScript.
CLI Updates:
Summary by CodeRabbit