Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: remove isActivatedAtEpoch check for ExoCapsule.verifyDepositProof #62

Merged
merged 4 commits into from
Jul 30, 2024

Conversation

adu-web3
Copy link
Collaborator

@adu-web3 adu-web3 commented Jul 29, 2024

Description

closes: #49

As long as the withdrawal_credentials of beacon chain validator points to the address of ExoCapsule, we could always take the validator's staked ETH into custody, so there is no need to require that validator must be activated when the proof is generated

Summary by CodeRabbit

  • New Features
    • Streamlined withdrawal process by removing the check for validator activation at a specific epoch, allowing for more flexible withdrawals.
  • Bug Fixes
    • Updated validation test to reflect the new behavior of the contract, ensuring the withdrawal process succeeds even with inactive validator containers.

Copy link
Contributor

coderabbitai bot commented Jul 29, 2024

Warning

Rate limit exceeded

@adu-web3 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 20 minutes and 11 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 for further information.

Commits

Files that changed from the base of the PR and between c276af4 and ad21b9e.

Walkthrough

The changes streamline the ExoCapsule contract by removing the activation check for validators during the withdrawal process. This modification allows withdrawals to occur without verifying a validator's activation status at a specific epoch, enhancing flexibility. Corresponding updates in the test suite reflect this change, shifting expectations from failure to successful execution, ensuring that validators can now be appropriately recognized as active.

Changes

Files Change Summary
src/core/ExoCapsule.sol Removed the _isActivatedAtEpoch check, allowing withdrawals without validator activation verification.
test/foundry/unit/ExoCapsule.t.sol Renamed test_verifyDepositProof_revert_inactiveValidatorContainer to test_verifyDepositProof_success_inactiveValidatorContainer and updated logic to expect successful execution instead of a revert due to an inactive validator.

Assessment against linked issues

Objective Addressed Explanation
Remove _isActivatedAtEpoch check for depositBeaconChainValidator (#49)

🐇 In the meadow where changes bloom,
A validator's life sheds its gloom.
Withdrawals now dance, free and bright,
No checks to hinder, just pure delight!
Hops of progress, we cheer and play,
Native restaking, hip-hip-hooray! 🌼


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
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • 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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 4cb7879 and c276af4.

Files selected for processing (2)
  • src/core/ExoCapsule.sol (1 hunks)
  • test/foundry/unit/ExoCapsule.t.sol (2 hunks)
Additional comments not posted (2)
src/core/ExoCapsule.sol (1)

Line range hint 98-99:
LGTM! But verify the function usage in the codebase.

The code changes are approved.

However, ensure that all function calls to verifyDepositProof are correctly updated to reflect the removal of the isActivatedAtEpoch check.

Verification successful

No issues found with the removal of the isActivatedAtEpoch check.

  • The verifyDepositProof function and its usage have been verified.
  • No dependencies on the removed isActivatedAtEpoch check were found.
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify all function calls to `verifyDepositProof` are correctly updated.

# Test: Search for the function usage. Expect: No references to the removed `isActivatedAtEpoch` check.
rg --type solidity -A 5 $'verifyDepositProof'

Length of output: 77


Script:

#!/bin/bash
# Description: Verify all function calls to `verifyDepositProof` are correctly updated.

# Find all Solidity files and search for the function usage within them.
fd -e sol -x rg 'verifyDepositProof' {}

Length of output: 1637


Script:

#!/bin/bash
# Description: Verify that there are no dependencies on the removed `isActivatedAtEpoch` check.

# Find all Solidity files and search for references to `isActivatedAtEpoch` within them.
fd -e sol -x rg 'isActivatedAtEpoch' {}

Length of output: 134


Script:

#!/bin/bash
# Description: Verify that `_isActivatedAtEpoch` is not called in a way that impacts the removed check.

# Find all Solidity files and search for calls to `_isActivatedAtEpoch` within them.
fd -e sol -x rg '_isActivatedAtEpoch' {}

Length of output: 135

test/foundry/unit/ExoCapsule.t.sol (1)

Line range hint 224-247:
LGTM!

The changes to the test function test_verifyDepositProof_success_inactiveValidatorContainer align with the updated contract behavior and ensure that the function executes successfully without the isActivatedAtEpoch check.

@adu-web3 adu-web3 requested a review from magj2006 July 29, 2024 09:25
@adu-web3 adu-web3 merged commit 4fea9a2 into ExocoreNetwork:main Jul 30, 2024
6 checks passed
@adu-web3 adu-web3 deleted the is-activated branch July 30, 2024 02:42
@adu-web3 adu-web3 restored the is-activated branch July 30, 2024 06:17
bwhour pushed a commit to bwhour/exocore-contracts that referenced this pull request Jul 30, 2024
…ositProof` (ExocoreNetwork#62)

* refactor: remove isActivated check

* refactor: remove isActivatedAtEpoch check for verifyDepositProof

* remove input.json

* remove _isActivatedAtEpoch
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

native restaking: remove _isActivatedAtEpoch check for depositBeaconChainValidator
3 participants