ExocoreNetwork / exocore-contracts

5 stars 5 forks source link

feat: register whitelist tokens to Exocore from client chain contract #23

Closed adu-web3 closed 5 months ago

adu-web3 commented 5 months ago

Description

Closes: #12

TODO

Summary by CodeRabbit

coderabbitai[bot] commented 5 months ago

[!WARNING]

Review failed

The pull request is closed.

Walkthrough

The changes introduce enhanced functionality and refactoring in several core contracts of the ecosystem. Key updates include modifying how whitelist tokens are managed, the integration of additional RPC URLs, improvements to the request processing for delegation and undelegation, and the introduction of new functions for handling token registration and deregistration responses. These updates aim to provide a more robust and centralized method for managing whitelisted tokens across both the Client Chain Gateway and Exocore chain.

Changes

File(s) Change Summary
script/BaseScript.sol Added imports, updated initialization variables, modified mock deployment, and removed outdated contracts and logic.
src/core/BaseRestakingController.sol Refined request processing methods, encoded action arguments, removed ETH-specific logic, and added IVault import.
src/core/Bootstrap.sol Updated functions for whitelisting, added mappings for request hooks, and refined internal processes.
src/core/BootstrapLzReceiver.sol Added functions to handle token registration/deregistration responses.
src/core/ClientChainGateway.sol Enhanced token whitelisting methods, added token count functions.
src/core/ExocoreGateway.sol Extensive refactoring, new functions for managing Exocore assets.
src/core/LSTRestakingController.sol Utilized IVault for deposit and withdrawal functionality adjustments.
src/core/NativeRestakingController.sol Updated processDeposit function with encoded action arguments.
src/interfaces/IClientChainGateway.sol Interface updates to extend ITokenWhitelister.
src/interfaces/ITokenWhitelister.sol Modified token whitelisting functions to handle arrays and removed events/errors.
src/interfaces/precompiles/IAssets.sol Added IAssets interface with functions for managing assets in Exocore.
src/interfaces/precompiles/IClaimReward.sol Update includes comments for potential asset handling merger.
src/storage/BootstrapStorage.sol Removed ITokenWhitelister inheritance and functions, added new events.
src/storage/ClientChainGatewayStorage.sol Added new event RegisterTokensResult.
test/foundry/ExocoreDeployer.t.sol Updated imports, added test functions, and modified whitelist token management.
script/integration/1_DeployBootstrap.s.sol Updated import path for MyToken contract.
script/3_Setup.s.sol Enhanced setup process for client and Exocore chain interactions and whitelist token registration.
test/foundry/unit/Bootstrap.t.sol Change import paths, adjust function calls, and update whitelist token handling.
src/core/ClientGatewayLzReceiver.sol Adjusted parameter order in decode calls and added token registration response handling.

Assessment against linked issues

Objective (Issue #12) Addressed Explanation
Implement mechanism to register whitelist tokens from ClientChainGateway to Exocore
Remove duplicate code and unused logic specific to non-virtual staked ETH tokens and simplify action processing
Add flexibility and validation to token whitelisting and deregistering mechanisms in both ClientChainGateway and Exocore
Refactor process for handling and encoding actions and requests

Poem

In the fields of code where cyphers roam,
Tokens find their whitelisted home.
From gateway to Exocore, they tread,
With bytes encoded, the path is led.
Whitelists bloom, and logic refines,
In this blockchain dance, all aligns.
🐇✨


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.