chore(ethereum-storage): add getter for eip-1559 support

[alexandre-abrioux]

Description of the changes

When using the EthereumTransactionSubmitter as a standalone class, it is helpful to know whether it supports EIP-1559, for instance, during a service startup's health checks to ensure the underlying RPC provides the feature.

Current solutions

Currently, the only two options are the following:

Current solution 1

const supportEip1559 = await isEip1559Supported(this.provider, this.logger)

This does not test the actual support of EIP-1559 for the EthereumTransactionSubmitter class:

• isEip1559Supported() can return false during the initialization phase with EthereumTransactionSubmitter.initialize() because the RPC times out, for instance ;
• and then return true when we test it by calling again isEip1559Supported().

In this case we're stuck with a EthereumTransactionSubmitter that doesn't support EIP-1559 even thought the RPC supports it.

Current solution 2

// check if the submitter supports Eip1559 - we only prepare the transaction, we do not send it
const testTransaction = await this.transactionSubmitter.prepareSubmit(
  'test',
  0,
);
const supportEip1559 = Boolean(testTransaction.maxFeePerGas);

This works but it wastes some RPC calls:

• One call to get the Request fee against the StorageFeeCollector.
• One call to get the current gas fee.

Proposed change

Since we already have that information in the class, I propose to expose it.

Summary by CodeRabbit

• New Features
  • Introduced a method to check if EIP-1559 support is enabled, enhancing user access to transaction submission features.

[coderabbitai]

Walkthrough

The changes introduce a new method named supportsEip1559 to the EthereumTransactionSubmitter class within the ethereum-tx-submitter.ts file. This method provides external access to the current state of the enableEip1559 property, allowing users to check if EIP-1559 support is enabled. The constructor and overall structure of the class remain unchanged.

Changes

File Path	Change Summary
packages/ethereum-storage/src/ethereum-tx-submitter.ts	Added method supportsEip1559() to EthereumTransactionSubmitter class.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant EthereumTransactionSubmitter

    User->>EthereumTransactionSubmitter: Call supportsEip1559()
    EthereumTransactionSubmitter-->>User: Return enableEip1559 status

Loading

---

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
• 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 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.

[coderabbitai]

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

📥 Commits

Files that changed from the base of the PR and between f2667d0 and e13bb8a.

📒 Files selected for processing (1)

• packages/ethereum-storage/src/ethereum-tx-submitter.ts (1 hunks)

🧰 Additional context used

🔇 Additional comments (1)

packages/ethereum-storage/src/ethereum-tx-submitter.ts (1)

78-80: Summary: Changes meet PR objectives with minor suggestions for improvement.

The addition of the supportsEip1559() method successfully addresses the PR's main objective of providing a getter for EIP-1559 support. The implementation is correct, efficient, and consistent with the existing code structure.

To further enhance the code quality:

1. Consider adding JSDoc comments for better documentation.
2. Implement unit tests to ensure the new method's reliability.

Overall, this change improves the EthereumTransactionSubmitter class by allowing users to easily check EIP-1559 support without unnecessary RPC calls, which is particularly useful for startup health checks as mentioned in the PR description.

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

📥 Commits

Files that changed from the base of the PR and between e13bb8a and 7c5cea1.

📒 Files selected for processing (1)

• packages/ethereum-storage/src/ethereum-tx-submitter.ts (1 hunks)

🧰 Additional context used

🔇 Additional comments (1)

packages/ethereum-storage/src/ethereum-tx-submitter.ts (1)

78-81: LGTM: New method successfully implements the getter for EIP-1559 support.

The supportsEip1559() method correctly returns the enableEip1559 property, providing an efficient way to check EIP-1559 support without making unnecessary RPC calls. This implementation aligns well with the PR objectives.