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

fix: fix localnet and tests #232

Closed skosito closed 2 months ago

skosito commented 2 months ago

fixes problem with localnet hanging and throwing errors, please use node 20 when running

also it fixes issues we have with yarn test timing out in CI constantly and also sometimes locally

reason is hardhat network config in zetachain/networks package (NOTE: this also makes localnet not working properly sometimes)

  const hardhat = {
    chainId: 1337,
    forking: { blockNumber: 14672712, url: "https://rpc.ankr.com/eth" },
  };

we don't need to fork on every unit test, it is really slow and unit test should not fork network in general

in this PR, i used reset function from hardhat to only apply forking to default hardhat network where it is needed (consumer tests) - to further improve this, is there a reason why we need to fork for these tests, can we rewrite them to be pure unit tests?

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

This update includes various improvements and modifications across different parts of the project. A new network configuration was added to Hardhat, the documentation was updated to include an additional command, contract addresses were updated in several tasks to reflect new interaction setups, and testing scripts were enhanced with new environment reset functionalities.

Changes

Files Change Summaries
hardhat.config.ts Added a new network configuration named hardhat to the networks section.
scripts/readme.md Added the command yarn compile before starting the localnet.
tasks/localnet.ts Updated contract addresses for various tasks to reflect modifications in contract interaction setups.
test/ZetaTokenConsumer.spec.ts Added environment reset functionality using reset from @nomicfoundation/hardhat-network-helpers.
test/ZetaTokenConsumerZEVM.spec.ts Added environment reset functionality and modified imports to include MAINNET_FORK_BLOCK and MAINNET_FORK_URL.
test/test.helpers.ts Added constants MAINNET_FORK_URL and MAINNET_FORK_BLOCK.

Poem

In code we trust, a rabbit's glee,
New networks bloom, compile with spree,
Contract paths, now clear and bright,
Tests reset, to set things right.
Hardhat shines, our guide anew,
Hopping forward, coding crew! 🐇

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

@fadeev could you please check locally if this fixes issues?

@andresaiello could you please check this one, especially about hardhat network having fork by default, do you see some issues with this change?

codecov-commenter commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 58.29%. Comparing base (a92fb24) to head (44c1fd8).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #232 +/- ## ======================================= Coverage 58.29% 58.29% ======================================= Files 11 11 Lines 235 235 Branches 61 61 ======================================= Hits 137 137 Misses 98 98 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

fadeev commented 2 months ago 
yarn localnet
[NODE] Account #19: 0x8626f6940E2eb28930eFb4CeF49B2d1F2C9C1199 (10000 ETH)
[NODE] Private Key: 0xdf57089febbacf7ba0bc227dafbffa9fc08a93fdc68e1e42411a14efcf23656e
[NODE] 
[NODE] WARNING: These accounts, and their private keys, are publicly known.
[NODE] Any funds sent to them on Mainnet or any other live network WILL BE LOST.
[NODE] 
$ npx hardhat run scripts/worker.ts --network localhost
[WORKER] Warning: Unused function parameter. Remove or comment out the variable name to silence this warning.
[WORKER]    --> contracts/prototypes/evm/GatewayEVMUpgradeTest.sol:106:45:
[WORKER]     |
[WORKER] 106 |     function send(bytes calldata recipient, uint256 amount) external payable {
[WORKER]     |                                             ^^^^^^^^^^^^^^
[WORKER] 
[WORKER] 
[WORKER] Compiled 15 Solidity files successfully (evm target: london).
[NODE] eth_accounts
[NODE] eth_chainId
[NODE] hardhat_impersonateAccount
[NODE] hardhat_setBalance
[NODE] eth_accounts
[NODE] eth_accounts (2)
[NODE] eth_chainId
[NODE] anvil_metadata - Method not supported
[NODE] hardhat_metadata
[NODE] eth_chainId
[NODE] anvil_metadata - Method not supported
[NODE] hardhat_metadata
[NODE] eth_blockNumber
[NODE] eth_chainId
[NODE] eth_chainId (2)
[NODE] eth_estimateGas
[NODE] eth_getBlockByNumber
[NODE] eth_feeHistory
[NODE] eth_sendTransaction
[NODE] 
[NODE]   Transaction maxFeePerGas (10752568781) is too low for the next block, which has a baseFeePerGas of 37327126355
[NODE] 
[WORKER] Failed to deploy contracts or set up listeners: ProviderError: Transaction maxFeePerGas (10752568781) is too low for the next block, which has a baseFeePerGas of 37327126355
[WORKER]     at HttpProvider.request (/Users/fadeev/github.com/zeta-chain/protocol-contracts/node_modules/hardhat/src/internal/core/providers/http.ts:96:21)
[WORKER]     at processTicksAndRejections (node:internal/process/task_queues:95:5)
[WORKER]     at async EthersProviderWrapper.send (/Users/fadeev/github.com/zeta-chain/protocol-contracts/node_modules/@nomiclabs/hardhat-ethers/src/internal/ethers-provider-wrapper.ts:13:20)
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
[WORKER] wait-on tcp:8545 && yarn worker exited with code 1
node -v
v20.15.1