Add block handler support for fuel by DZakh · Pull Request #820 · enviodev/hyperindex

DZakh · 2025-11-10T16:03:18Z

Nobody asked, but still 🫡

(only because Solana and block.events feature)

Summary by CodeRabbit

Release Notes

New Features
- Added support for Fuel blockchain block events, enabling event handling on Fuel chains
- Implemented ecosystem-aware block handler parameters that adapt to EVM and Fuel blockchains
Bug Fixes
- Removed platform-specific validation restrictions that prevented non-EVM blockchain support in block handlers

coderabbitai · 2025-11-10T16:03:30Z

Walkthrough

This pull request introduces multi-ecosystem block event support by making block event types generic and platform-specific. It replaces fixed block event definitions with parameterized types (blockEvent for EVM, fuelBlockEvent for Fuel), adds a Platform abstraction for dynamic block event construction, and threads platform configuration through event processing layers. The platform guard preventing non-EVM platforms is also removed.

Changes

Cohort / File(s)	Summary
Type exports and re-exports `codegenerator/cli/npm/envio/index.d.ts`	Exports new `fuelBlockEvent` type alias from generated source
Core type definitions `codegenerator/cli/npm/envio/src/Envio.gen.ts`, `codegenerator/cli/npm/envio/src/Envio.res`	Adds `blockEvent` (EVM) and `fuelBlockEvent` (Fuel) types; transforms `onBlockArgs` from single-generic `onBlockArgs<context>` to two-generic `onBlockArgs<block, context>` for ecosystem flexibility
Internal type abstractions `codegenerator/cli/npm/envio/src/Internal.gen.ts`, `codegenerator/cli/npm/envio/src/Internal.res`	Removes public `blockEvent` export from Internal.gen.ts; replaces concrete `blockEvent` with opaque type in Internal.res; removes context field from `onBlockArgs`
Platform abstraction `codegenerator/cli/npm/envio/src/Platform.res`	Adds `makeBlockEvent` function to construct platform-specific block events dynamically using platform configuration
Handler registration `codegenerator/cli/npm/envio/src/EventRegister.res`	Removes platform guard check, allowing non-EVM platforms to proceed through block event registration
Event processing logic `codegenerator/cli/templates/static/codegen/src/EventProcessing.res`	Adds `~platform` parameter to `preloadBatchOrThrow`; threads platform through call sites; replaces literal block object creation with `Platform.makeBlockEvent` invocations
Handler templates `codegenerator/cli/templates/dynamic/codegen/src/Handlers.res.hbs`	Adds conditional block type to `onBlock` signature: `Envio.blockEvent` for EVM, `Envio.fuelBlockEvent` for Fuel
Test helper templates `codegenerator/cli/templates/dynamic/codegen/src/TestHelpers_MockDb.res.hbs`	Passes `~platform=indexer.config.platform` to `preloadBatchOrThrow` call

Sequence Diagram

sequenceDiagram
    participant EventProcessing
    participant Platform
    participant Handlers

    Note over EventProcessing,Handlers: Old Flow (Fixed Block Type)
    EventProcessing->>Handlers: onBlockArgs<blockEvent, context>

    Note over EventProcessing,Handlers: New Flow (Platform-Specific Block Type)
    EventProcessing->>Platform: makeBlockEvent(blockNumber, chainId, platform)
    Platform-->>EventProcessing: blockEvent or fuelBlockEvent
    EventProcessing->>Handlers: onBlockArgs<BlockType, context>
    Note right of Handlers: BlockType resolved from platform

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Areas requiring attention:
- Generic parameter addition to onBlockArgs and its cascading effects across type definitions and handler templates
- Platform abstraction threading through EventProcessing and call sites to ensure consistent platform configuration passing
- Internal vs. public type boundary: opaque Internal.blockEvent vs. concrete Envio.blockEvent and Envio.fuelBlockEvent
- Conditional template logic in Handlers.res.hbs for EVM vs. Fuel ecosystem routing

Possibly related PRs

Platform & Storage abstractions #819: Introduces Platform.t abstraction and multi-chain block event shapes that this PR builds upon
On block interval #734: Modifies the on-block API surface and onBlockArgs signature that this PR extends with generics
Add mockDb.processEvents for testing batches #611: Updates TestHelpers_MockDb template with similar platform parameter threading patterns

Suggested reviewers

JonoPrest
JasoonS

Poem

🐰 A rabbit hops 'cross chains so bright,
EVM blocks by day, Fuel blocks by night,
Platform-aware, the events now dance,
Generic types grant ecosystems a chance!
From Solidity to Sway, all blocks align,
Multi-chain magic—a developer's design! ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'Add block handler support for fuel' directly and accurately summarizes the main objective of the PR, which introduces block handler support for the Fuel blockchain platform.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch feat-fuel-block-handler-BHcot

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/npm/envio/src/Platform.res (1)

135-141: Consider safer alternatives to Utils.magic for type coercion.

While the dynamic field naming based on platform.blockNumberName is clever and the implementation is straightforward, the three uses of Utils.magic for type coercion (lines 138-140) could be fragile if types change. Consider whether @obj or external functions could provide safer type coercion, though dynamic field naming may make this challenging.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4f34a2b and 6fd5c18.

⛔ Files ignored due to path filters (1)

scenarios/test_codegen/pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (10)

codegenerator/cli/npm/envio/index.d.ts (1 hunks)
codegenerator/cli/npm/envio/src/Envio.gen.ts (1 hunks)
codegenerator/cli/npm/envio/src/Envio.res (1 hunks)
codegenerator/cli/npm/envio/src/EventRegister.res (0 hunks)
codegenerator/cli/npm/envio/src/Internal.gen.ts (0 hunks)
codegenerator/cli/npm/envio/src/Internal.res (1 hunks)
codegenerator/cli/npm/envio/src/Platform.res (1 hunks)
codegenerator/cli/templates/dynamic/codegen/src/Handlers.res.hbs (1 hunks)
codegenerator/cli/templates/dynamic/codegen/src/TestHelpers_MockDb.res.hbs (1 hunks)
codegenerator/cli/templates/static/codegen/src/EventProcessing.res (4 hunks)

💤 Files with no reviewable changes (2)

codegenerator/cli/npm/envio/src/EventRegister.res
codegenerator/cli/npm/envio/src/Internal.gen.ts

🧰 Additional context used

📓 Path-based instructions (6)

codegenerator/cli/**