onflow / flow-evm-gateway

FlowEVM Gateway implements an Ethereum-equivalent JSON-RPC API for EVM clients to use
https://developers.flow.com/evm/about
Apache License 2.0
11 stars 9 forks source link

Add an example test case for utilizing the `Multicall3` contract #369

Closed m-Peter closed 2 months ago

m-Peter commented 2 months ago

Description

Multicall3: https://github.com/mds1/multicall


For contributor use:

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

This update introduces a new Multicall3 smart contract, enhancing the ability to batch multiple function calls into a single transaction, optimizing gas usage. It includes comprehensive tests for deploying and interacting with the contract using Web3.js. The changes improve the end-to-end test suite and expand functionality for efficient smart contract interactions, particularly in decentralized finance applications.

Changes

File Path Change Summary
tests/e2e_web3js_test.go Adds a test for deploying and interacting with the multicall3 contract, improving end-to-end test coverage for Web3 interactions.
tests/fixtures/multicall3.byte Introduces smart contract bytecode for the multicall3 functionality, allowing batching of multiple function calls to optimize gas usage and transaction efficiency.
tests/fixtures/multicall3.sol Introduces the Multicall3 smart contract with methods for aggregating calls, handling errors, and managing input/output efficiently, enhancing previous versions.
tests/fixtures/multicall3ABI.json Defines the ABI for the Multicall3 contract, specifying functions that enable batch processing of calls and retrieval of blockchain data, streamlining interactions.
tests/web3js/eth_multicall3_contract_test.js Adds unit tests for deploying the multicall3 contract and validating interactions with a storage contract, ensuring correct operation of the multicall functionality.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Web3
    participant Multicall3
    participant Storage

    User->>Web3: Deploy Storage Contract
    Web3->>Storage: Deploy
    Storage-->>Web3: Contract Address

    User->>Web3: Deploy Multicall3 Contract
    Web3->>Multicall3: Deploy
    Multicall3-->>Web3: Contract Address

    User->>Web3: Call aggregate3 on Multicall3
    Web3->>Multicall3: Execute Calls
    Multicall3->>Storage: Call sum(10, 10)
    Storage-->>Multicall3: Return 20
    Multicall3->>Storage: Call sum(10, 40)
    Storage-->>Multicall3: Return 50

    Multicall3-->>Web3: Return Results
    Web3-->>User: Display Results

🐇 In code and contracts, we now play,
With Multicall3, we save the day!
Batch our calls, how sweet the sound,
Efficiency and gas, all around!
Hop along with tests that shine,
In the world of Web3, we redefine! 🌟


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.