Adds waffle-compatibility layer

[robotoer]

Summary by CodeRabbit

• New Features

  • Introduced a mock contract framework for testing Ethereum smart contracts, enabling simulation of contract behavior without actual deployment.
  • Added functions to create and deploy mock contracts, enhancing testing capabilities.

• Tests

  • Implemented unit tests for the mocking functionality, covering various scenarios for read and write calls, including handling errors and undefined inputs.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes involve modifications to the hardhat.config.ts file's import syntax, the introduction of a new waffle.ts file that provides a mock contract framework for testing Ethereum smart contracts, and the creation of a test file waffle-compat.test.ts which contains unit tests for the mocking functionality. The new framework allows for comprehensive testing of smart contracts by simulating various scenarios without deploying actual contracts.

Changes

File	Change Summary
hardhat.config.ts	Modified the import statement for HardhatUserConfig type from import type { HardhatUserConfig } from "hardhat/config"; to import { type HardhatUserConfig } from "hardhat/config";. No functional changes were made.
src/compat/waffle.ts	Introduced a mock contract framework for testing, including a mock contract ABI, MockContract interface, Stub class for managing expectations, and functions createMock and deployMockContract for generating and deploying mock contracts.
test/waffle-compat.test.ts	Added unit tests for the mocking functionality in the Waffle compatibility layer, covering scenarios for read and write calls, simulating reverts, handling uninitialized mocks, and managing undefined call inputs. No alterations to exported or public entities were made.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant MockContract
    participant ContractController

    User->>MockContract: Call function (e.g., balanceOf)
    MockContract->>ContractController: Check expectations
    alt If expectation met
        ContractController-->>User: Return predefined value
    else If expectation not met
        ContractController-->>User: Throw error (not initialized)
    end

Loading

🐰 In the meadow, I hop and play,
With mocks and contracts, bright as day.
Testing smartly, all in a row,
Simulating calls, watch them flow!
A joyful leap, a code delight,
In Waffle's world, everything's right! 🌼

---

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.