search

ExocoreNetwork / exocore-contracts

5 stars 5 forks source link

refactor: remove governance role `exocoreValidatorSet` and keep owner only #47

Closed adu-web3 closed 4 months ago

adu-web3 commented 4 months ago

Description

closes: #30

As described in the issue, we have two governance roles for contracts: owner and exocoreValidatorSetAddress. Given we decide to use a multi-sig contract as the owner of the contracts and exocoreValidatorSetAddress is previously intended for TSS bridge, we should remove exocoreValidatorSetAddress from state variables and use owner as the only governance role instead, since we do not use TSS bridge right now.

Summary by CodeRabbit

coderabbitai[bot] commented 4 months ago

Walkthrough

The changes across the codebase aim to simplify the governance model by removing the exocoreValidatorSetAddress and replacing it with owner_, thus shifting control to a multi-sig wallet. This affects various contract initialization, pause/unpause logic, and payment handling. The modernization enhances the clarity and security of ownership and management processes within the system.

Changes

File Path Change Summary
script/.../7_DeployBootstrap.s.sol Removed payable(exocoreValidatorSet.addr) parameter from a function call.
script/.../integration/1_DeployBootstrap.s.sol Removed payable(exocoreValidatorSet) parameter from a function call.
src/core/BaseRestakingController.sol Modified _lzSend function to pass msg.sender instead of exocoreValidatorSetAddress.
src/core/Bootstrap.sol Removed exocoreValidatorSetAddress_ parameter from the initializer function.
src/core/ClientChainGateway.sol Changed initialize function to use owner_ and updated ownership-related logic.
src/core/ExocoreGateway.sol Updated initialize function to use owner_, added onlyOwner modifier for pause/unpause, updated _lzSend.
src/storage/GatewayStorage.sol Removed exocoreValidatorSetAddress, fixed inboundNonce mapping syntax.
test/foundry/unit/Bootstrap.t.sol Modified abi.encodeCall arguments to exclude exocoreValidatorSet and offsetDuration.
test/foundry/unit/ClientChainGateway.t.sol Updated error messages and removed a test for Exocore validator set address initialization.
test/foundry/unit/ExocoreGateway.t.sol Changed error message in test_RevertWhen_UnauthorizedPauser.
test/mocks/ExocoreGatewayMock.sol Updated initialize, pause, unpause, and _lzSend functions to use owner_ and msg.sender.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Contract
    participant Owner (Multi-Sig Wallet)

    User ->> Contract: Call initialize(owner_)
    Contract ->> Owner: Set owner as owner_

    User ->> Contract: Call pause()
    Contract ->> Owner: Verify onlyOwner
    Contract ->> Contract: Pause execution

    User ->> Contract: Call unpause()
    Contract ->> Owner: Verify onlyOwner
    Contract ->> Contract: Unpause execution

Assessment against linked issues

Objective (Issue #30) Addressed Explanation
Remove exocoreValidatorSetAddress parameter ✅
Use multi-sig wallet as contract owner ✅

Poem

In code, the rules we do reset,
With changes fine and governance set.
No longer tied to validators' might,
Ownership clear in multi-sig's light.
The contracts dance, they now align,
A brighter path, in code we sign.
🐇✨

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.