search

zeta-chain / protocol-contracts

Protocol contracts implementing the core logic of the protocol, deployed on ZetaChain and on connected chains
MIT License
68 stars 55 forks source link

feat: integrate hardhat-foundry and add example foundry tests #212

Closed skosito closed 2 months ago

skosito commented 2 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

[!WARNING]

Rate limit exceeded

@skosito has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 10 minutes and 50 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between ac14eba0e12c3012a0626b5bd50e580e37a697cd and 264dda67eff7d15dd6077aca1b4c734f7d290afe.

Walkthrough

The recent updates encompass several enhancements and refinements across multiple files, mainly focusing on upgrading the Node.js version from 16 to 18 within GitHub workflows, adding Foundry installation steps, refining Solidity contracts and tests, and updating .gitignore and .eslintignore files. Additionally, new configurations for Foundry and Echidna, as well as the integration of forge-std, were added to improve the development and testing environment.

Changes

File/Path Change Summary
.eslintignore Added crytic-export to ignored directories.
.gitignore Added crytic-export, out, and cache_forge to ignored directories.
.gitmodules Added a submodule entry for "lib/forge-std".
.github/workflows/... Updated Node.js version to 18, added Foundry installation steps, and introduced new test steps.
contracts/prototypes/evm/... Changed visibility of functions, added interfaces, and improved error and event handling.
contracts/prototypes/test/... Added new test contracts and functions for interaction testing.
contracts/prototypes/zevm/... Implemented new interfaces, added events and errors, and modified contract inheritance.
contracts/zevm/ZRC20.sol Updated imports, adjusted contract inheritance, and added overrides for variables.
contracts/zevm/ZRC20New.sol Similar updates to ZRC20.sol, but specific to the ZRC20New contract.
contracts/zevm/interfaces/... Introduced new interfaces and enums for system and ZRC20 contracts.
echidna.yaml Added configuration for crytic-compile, test limits, and contract inclusion.
foundry.toml Introduced Foundry configuration settings for profiles, directories, and optimizations.
hardhat.config.ts Added an import statement for @nomicfoundation/hardhat-foundry.
lib/forge-std Integrated a subproject commit for forge-std.

Poem

In the meadow of code, updates bloom bright,
Node leapt to eighteen, a soaring new height. 🌿
Foundry's now in, for tests that ignite,
Solidity crafted, contracts just right.
Git's paths are cleaner, ignored in the night,
With each line of code, a future in sight. 💻

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.
fadeev commented 2 months ago

Why do we need Foundry as a git submodule? Isn't it something developers can install with cargo, instead?

skosito commented 2 months ago

Why do we need Foundry as a git submodule? Isn't it something developers can install with cargo, instead?

this is import to be used in project, not a tool itself, we still need to install it as tool

this is automatically set up with hardhat-foundry plugin, and also what happens if you run forge init alternative is to use npm package, but i thought to not do many modifications to how plugin is supposed to work

skosito commented 2 months ago

NOTE: too many generated files, maybe we can consider only generating go and ts bindings for things that are needed? these new forge lib sol files dont need all these generated bindings, but lets clear it up in separate issue (add ignore folders to generate_go script and find a way to ignore contracts in typechain)

Yeah I think we can skip typechain generation for everything forge-std related

If this is not too complex I suggest to migrate all tests into Solidity for V2 these look much better than with Hardhat

The PR looks good to me right now

thanks for checking, i will handle both tests migration and generate files removal in separate PRs

issues: https://github.com/zeta-chain/protocol-contracts/issues/213 https://github.com/zeta-chain/protocol-contracts/issues/218