Empty `miner` field on `eth_getBlockByNumber`

m-Peter commented 1 month ago

Closes: https://github.com/onflow/flow-evm-gateway/issues/454

Description

Note: The version bump of the flow-go dependency, comes with a backwards incompatible change on the block hash calculation. If we want to deploy this change on testnet, we'll have to add some custom logic to accommodate that breaking change.

For contributor use:

[x] Targeted PR against master branch
[x] Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
[x] Code follows the standards mentioned here.
[x] Updated relevant documentation
[x] Re-reviewed Files changed in the Github PR explorer
[x] Added appropriate labels

Summary by CodeRabbit

New Features
- Added a Miner field to block response, providing crucial miner address information.
- Introduced a PrevRandao field in block events for enhanced event tracking.
- Enhanced the Block structure with a new hash field and a method to return the block's hash.
- Enhanced test cases to validate new Miner field and updated block sizes.
Bug Fixes
- Adjusted expected block size in tests to reflect correct values.
Chores
- Updated various dependencies to newer, stable versions for improved performance and security.

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes involve updates to the blockchain API to include a Miner field in the block response, reflecting the address of the miner who produced the block. Additionally, the PrevRandao field was added to the block data structure in event handling. Dependency updates were made to ensure compatibility with newer versions of libraries, and test cases were improved to validate these changes.

Changes

Files	Change Summary
`api/api.go`	Added `Miner` field to `prepareBlockResponse` function to include the miner's address.
`models/block.go`	Introduced `PrevRandao` field in the returned `Block` structure and backward compatibility handling in `NewBlockFromBytes`.
`models/block_test.go`, `models/events_test.go`	Enhanced tests by adding `PrevRandao` to block structures, updating expected hash values, and modifying the `newBlock` function for additional parameters.
`go.mod`, `tests/go.mod`	Updated various dependencies to newer versions for stability and compatibility improvements.
`tests/web3js/eth_non_interactive_test.js`	Modified assertions to include checks for `block.size` and added verification for the `block.miner` field.

Assessment against linked issues

Objective	Addressed	Explanation
Empty `miner` field on `eth_getBlockByNumber` (#454)	✅
Ensure `PrevRandao` field is included in block data	✅
Update tests to validate miner address	✅

🐰 In the meadow where code does bloom,
Changes sprout and dispel the gloom.
A miner's address now shines so bright,
Validating blocks with newfound light.
Jumping through tests, we dance in delight! 🌼✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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 resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

sideninja commented 1 month ago

We should add logic for backward compatibility. Best, if you make it part of this PR

m-Peter commented 1 month ago

We should add logic for backward compatibility. Best, if you make it part of this PR

I have added such a logic in this commit: https://github.com/onflow/flow-evm-gateway/pull/463/commits/5b33fe18c01fda9e615ebe0330465c1081a1296a. But now that we're in testnet, these changes are no longer temporary, as was the case with previewnet. Because we have to support them for as long as testnet is running :sweat_smile: Let me know if you have some alternative solution in mind.

onflow / flow-evm-gateway