feat: enable Ethereum native restaking for Bootstrap

adu-web3 commented 2 weeks ago

Description

As we need to support Ethereum native restaking during bootstrap, we should allow the stakers to deposit staked ETH of beacon chain to Exocore, by pointing withdrawal credentials to capsule contract the staker creates and owns.

TODO:

[x] let Bootstrap inherit INativeRestakingController and implement relative functions
[x] move ownerToCapsule state from ClientChainGatewayStorage to BootstrapStorage
[x] refactor BootstrapStorage constructor function by using ImmutableConfig struct to work around stack too deep compilation error
[x] add unit tests in Bootstrap.t.sol and integration test in BootstrapDepositNSTTest.t.sol
[x] add comments and docs

Summary by CodeRabbit

New Features
- Introduced a new verifyAndDepositNativeStake function for enhanced deposit verification and processing.
- Added withdrawNonBeaconChainETHFromCapsule function for ETH withdrawals from ExoCapsule.
- New ImmutableConfig struct consolidates configuration parameters for improved contract initialization.
Bug Fixes
- Enhanced error handling across various functions to manage invalid states and conditions.
- Added InvalidImmutableConfig error for better error management in configuration.
Tests
- Expanded testing coverage for staking and deposit functionalities, including new test cases for capsule creation and deposit verification.
Documentation
- Updated comments and event emissions for clarity in deposit and withdrawal processes.

coderabbitai[bot] commented 2 weeks ago

Walkthrough

This pull request introduces significant changes to the staking and deposit functionality within the Ethereum ecosystem. Key modifications include renaming the depositBeaconChainValidator method to verifyAndDepositNativeStake, reflecting a shift towards enhanced verification processes. The implementation of an ImmutableConfig struct across various contracts simplifies parameter management during contract initialization. Additionally, new validation checks and error handling mechanisms are introduced to ensure the integrity of deposit operations. Overall, these changes streamline the deposit process and improve the organization of code across multiple contracts.

Changes

File Path	Change Summary
docs/native_deposit_workflow.wsd	Renamed method: `depositBeaconChainValidator` → `verifyAndDepositNativeStake` in `NativeRestakingController`.
script/12_RedeployClientChainGateway.s.sol	Added import for `BootstrapStorage`. Updated `run` function to use `ImmutableConfig` struct for `ClientChainGateway` instantiation.
script/13_DepositValidator.s.sol	Updated method call from `clientGateway.depositBeaconChainValidator` to `clientGateway.verifyAndDepositNativeStake`.
script/14_CorrectBootstrapErrors.s.sol	Added import for `BootstrapStorage`. Updated `setUp` function with additional address checks. Replaced individual parameters with `ImmutableConfig` struct in `Bootstrap` instantiation.
script/2_DeployBoth.s.sol	Added import for `BootstrapStorage`. Updated `run` function to utilize `ImmutableConfig` struct for `ClientChainGateway` instantiation.
script/7_DeployBootstrap.s.sol	Added import for `BootstrapStorage`. Updated `run` function to deploy `Bootstrap` using `ImmutableConfig` struct.
script/integration/1_DeployBootstrap.s.sol	Added imports for `EigenLayerBeaconOracle`, `BootstrapStorage`, and `ExoCapsule`. Updated `deployContract` to use `ImmutableConfig` struct for `Bootstrap` initialization.
src/core/Bootstrap.sol	Added new methods for native restaking. Updated constructor to accept `ImmutableConfig` struct.
src/core/ClientChainGateway.sol	Updated constructor to accept `ImmutableConfig` struct.
src/core/NativeRestakingController.sol	Renamed function `depositBeaconChainValidator` to `verifyAndDepositNativeStake`. Removed `nativeRestakingEnabled` modifier.
src/interfaces/INativeRestakingController.sol	Renamed function `depositBeaconChainValidator` to `verifyAndDepositNativeStake`. Added new function `withdrawNonBeaconChainETHFromCapsule`.
src/storage/BootstrapStorage.sol	Added new mapping `ownerToCapsule` and `ImmutableConfig` struct. Updated constructor to accept `ImmutableConfig`.
src/storage/ClientChainGatewayStorage.sol	Removed `ownerToCapsule` mapping. Updated constructor to accept `ImmutableConfig` and simplified state management.
test/foundry/BootstrapDepositNST.t.sol	Introduced a new test contract for `Bootstrap` functionality, including various test cases for deposit processes and event emissions.
test/foundry/DepositWithdrawPrinciple.t.sol	Updated test cases to reflect the new method name `verifyAndDepositNativeStake`. Enhanced event emissions for deposit and withdrawal workflows.
test/foundry/ExocoreDeployer.t.sol	Added import for `BootstrapStorage`. Updated `ClientChainGateway` instantiation to use `ImmutableConfig` struct.
test/foundry/Governance.t.sol	Added import for `BootstrapStorage`. Updated `ClientChainGateway` constructor to use `ImmutableConfig`.
test/foundry/unit/Bootstrap.t.sol	Added tests for staking functionality and updated initialization to use `ImmutableConfig`.
test/foundry/unit/ClientChainGateway.t.sol	Modified test setup to use `ImmutableConfig` for `ClientChainGateway` initialization.

Possibly related PRs

#13: Directly relates to the renaming of the depositBeaconChainValidator function to verifyAndDepositNativeStake.
#52: Implements native restaking withdrawal workflow, related to enhanced deposit processes.
#85: Enhances withdrawal checks in the LSTRestakingController and Bootstrap contracts, ensuring adherence to necessary checks.
#90: Discusses changes to the markBootstrapped function, related to overall control flow and error handling improvements.
#116: Ensures successful reward submissions, relating to error handling and validation improvements.
#120: Enhances functionality for Solana client interactions, relevant to deposit process improvements.

Suggested reviewers

cloud8little
leonz789
bwhour

Poem

🐇 In the meadow where the stakes are high,
A rabbit hops beneath the sky.
With deposits verified, oh what a sight,
New structures in place, everything feels right!
So let us cheer for the code that's neat,
For every hop, a new feature's sweet! 🌼

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 , 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` or `@coderabbitai title` 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](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](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.