NibiruChain / nibiru

Nibiru Chain: The breakthrough smart contract platform ushering in the next era of money. Nibiru powers an ecosystem of dApps including perps, RWAs, and more.
https://nibiru.fi
Apache License 2.0
179 stars 200 forks source link

test(evm): more e2e test contracts for edge cases #1901

Closed onikonychev closed 1 month ago

onikonychev commented 1 month ago

Introduces 2 more test types:

  1. Sending native (non ERC-20) tokens via smart contract
  2. Executing smart contract with infinite loop to fail with "out of gas"
coderabbitai[bot] commented 1 month ago

Walkthrough

The recent updates enhance the EVM testing suite by adding new end-to-end test contracts and cases, particularly focusing on edge scenarios and smart contract interactions involving ERC-20 tokens. Key changes include the introduction of new Solidity contracts for handling infinite loops and token transfers, updates to configuration files for better test management, and the inclusion of comprehensive test cases to validate these functionalities.

Changes

File(s) Change Summary
CHANGELOG.md Added a summary of new end-to-end test contracts for edge cases in the EVM testing suite.
e2e/evm/README.md Updated to include new test cases for smart contracts and ERC-20 contracts with results showing 6 tests passing.
e2e/evm/contracts/InfiniteLoopGas.sol Introduced a Solidity contract demonstrating infinite loop gas consumption.
e2e/evm/contracts/SendReceiveNibi.sol Added two Solidity contracts (ReceiveNibi and SendNibi) for handling Nibi token transfers.
e2e/evm/jest.config.js Updated testMatch configuration and added maxWorkers setting.
e2e/evm/test/basic_queries.test.js Introduced a test suite for basic EVM queries, including transfers, balance checks, and transaction validations.
e2e/evm/test/contract_infinite_loop_gas.test.js Added tests for handling infinite loop gas exhaustion in EVM contracts.
e2e/evm/test/contract_send_nibi.test.js Introduced tests for sending Nibi tokens using various methods in smart contracts.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant EVM
    participant Contract as Smart Contract

    User->>Contract: Call sendViaTransfer()
    Contract->>EVM: Transfer Nibi
    EVM-->>Contract: Confirm transfer
    Contract-->>User: Transfer successful

    User->>Contract: Call forever()
    Contract->>EVM: Execute infinite loop
    EVM-->>Contract: Gas exhaustion, revert transaction
    Contract-->>User: Transaction failed

Poem

In the realm of code so wise,
New tests for EVM arise,
Infinite loops and tokens sent,
Through smart contracts, gas is spent.
With tests that pass and bugs that flee,
Our code runs smooth, as it should be.
🐇✨


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