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 issues #265

Closed skosito closed 2 months ago

skosito commented 2 months ago

closes: #261

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The recent changes focus on restructuring and enhancing the contract deployment functions within the codebase. Key functions were renamed and updated to improve clarity and functionality, while new parameters were introduced to facilitate better interaction with the protocol's contracts. Additionally, significant updates were made to task parameters for local network interactions, ensuring consistency across contract references and fostering correct operation in the evolving ecosystem.

Changes

Files Change Summary
scripts/worker.ts Renamed deploySystemContracts to deployProtocolContracts and added parameters for contract deployment. Updated deployTestContracts to reference protocolContracts.
tasks/localnet.ts Updated parameters for tasks (zevm-call, zevm-withdraw-and-call, evm-call, evm-deposit-and-call) to reflect new contract addresses, ensuring all tasks use correct references.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Worker
    participant Contract

    User->>Worker: Initiate deployProtocolContracts
    Worker->>Contract: Deploy contracts with new parameters
    Contract-->>Worker: Return contract addresses
    Worker-->>User: Output deployed contract addresses

Assessment against linked issues

Objective Addressed Explanation
Error when interacting with localnet (#225) ❌ The issue of not printing system contract addresses remains unresolved.

🐰 In the meadow, contracts bloom,
New names and paths dispel the gloom.
With clearer calls, we leap and play,
In vibrant fields, we find our way!
Hops of code, a joyful tune,
In our world, we'll all commune! 🌼

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

Codecov Report

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

Project coverage is 58.10%. Comparing base (d1746fd) to head (9a581fd).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #265 +/- ## ========================================== + Coverage 49.13% 58.10% +8.97% ========================================== Files 16 16 Lines 403 401 -2 Branches 108 28 -80 ========================================== + Hits 198 233 +35 - Misses 160 165 +5 + Partials 45 3 -42 ```

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

fadeev commented 2 months ago

yarn localnet now works for me 👍

skosito commented 2 months ago

Approving following @fadeev feedbacks, as I assume the yarn errors I listed will be solved with the v1/v2 separation

probably you can remove artifacts folder or force recompile to get artifacts from lib folder, but with separation it should be easier yes

@fadeev could you please approve if it works and i will merge this one?