gencodec

[omerfirmak]

1. Purpose or design rationale of this PR

...

2. PR title

Your PR title must follow conventional commits (as we are doing squash merge for each PR), so it must start with one of the following types:

• build: Changes that affect the build system or external dependencies (example scopes: yarn, eslint, typescript)
• ci: Changes to our CI configuration files and scripts (example scopes: vercel, github, cypress)
• docs: Documentation-only changes
• feat: A new feature
• fix: A bug fix
• perf: A code change that improves performance
• refactor: A code change that doesn't fix a bug, or add a feature, or improves performance
• style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
• test: Adding missing tests or correcting existing tests

3. Deployment tag versioning

Has the version in params/version.go been updated?

• This PR doesn't involve a new deployment, git tag, docker image tag, and it doesn't affect traces
• Yes

4. Breaking change label

Does this PR have the breaking-change label?

• This PR is not a breaking change
• Yes

Summary by CodeRabbit

• New Features
  • Expanded block header information now includes additional metrics for improved transaction and gas usage insights.
  • Enhanced support for advanced blockchain header attributes.
• Chores
  • Updated the application version patch to reflect the latest release improvements.

[coderabbitai]

Walkthrough

The update extends block header related structures by adding new fields in core files. In core/types/block.go, two new pointer fields (BlobGasUsed and ExcessBlobGas) are introduced to the headerMarshaling struct. In core/types/gen_header_json.go, the Header struct is enhanced with additional fields (BlockSignature, IsEuclidV2, RequestsHash, and Requested) alongside updates to JSON marshaling and unmarshaling logic. Additionally, params/version.go has the patch version incremented from 23 to 24.

Changes

File(s)	Change Summary
core/types/block.go core/types/gen_header_json.go	- block.go: Added fields BlobGasUsed *hexutil.Uint64 and ExcessBlobGas *hexutil.Uint64 to headerMarshaling. - gen_header_json.go: Enhanced Header struct with new fields BlockSignature []byte, IsEuclidV2 bool, RequestsHash *common.Hash, and Requested bool; updated JSON marshal/unmarshal logic and field ordering.
params/version.go	Incremented VersionPatch constant from 23 to 24.

Poem

I'm just a bunny coding with delight,
Adding new fields to make headers bright.
With extra gas metrics and JSON flair,
My version hops up, floating in the air.
🐇 A patch so swift, a change so fair!

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 61cfff3 and ca1ca28.

📒 Files selected for processing (3)

• core/types/block.go (1 hunks)
• core/types/gen_header_json.go (5 hunks)
• params/version.go (1 hunks)

🔇 Additional comments (7)

params/version.go (1)

27-27: Version patch incremented appropriately

The patch version has been updated from 23 to 24, which is consistent with the changes in this PR that add new fields to core structures. This follows semantic versioning practices where patch updates indicate backward-compatible changes.

core/types/block.go (1)

134-135: New blob gas fields added to match Header fields

The new fields BlobGasUsed and ExcessBlobGas have been properly added to the headerMarshaling struct to correspond with the same fields in the Header struct (defined on lines 108-112). These fields are related to EIP-4844 for blob transactions and are included for Ethereum compatibility in the Scroll SDK.

core/types/gen_header_json.go (5)

35-36: Added proper JSON struct fields for EuclidV2 compatibility

The new fields BlockSignature and IsEuclidV2 are correctly marked with json:"-" to exclude them from JSON serialization, matching their definition in the Header struct where they're annotated with comments indicating they're for internal use only and not included in network wire protocol.

---

41-43: New fields added to JSON struct and Hash field repositioned

The new fields RequestsHash and Requested have been added. RequestsHash is correctly exposed in JSON while Requested is excluded (marked with json:"-"). The Hash field has been moved to the end of the struct, which maintains proper JSON serialization order where computed fields typically appear last.

---

62-63: Marshal implementation updated for new fields

The implementation of MarshalJSON has been updated to properly assign values from the Header instance to the corresponding fields in the encoding struct, ensuring the new fields are correctly serialized.

Also applies to: 68-70

---

93-94: Unmarshal struct definition updated for new fields

The unmarshal struct correctly declares the new fields with appropriate types. Note that IsEuclidV2 and Requested are defined as pointers to bool, which is standard practice in Go JSON unmarshaling to distinguish between false values and missing fields.

Also applies to: 99-100

---

166-171: Unmarshal implementation updated to handle new fields

The implementation of UnmarshalJSON has been extended to properly handle the new fields, with appropriate null checks before assignment. The pointer-to-bool fields are correctly dereferenced when assigned to their corresponding struct fields.

Also applies to: 184-189

✨ Finishing Touches

• 📝 Generate Docstrings

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.