ExocoreNetwork / exocore-contracts

5 stars 5 forks source link

feat: add associateOperator and dissociateOperator to support self-delegate #61

Closed adu-web3 closed 3 months ago

adu-web3 commented 3 months ago

Description

This PR would collaborate with https://github.com/ExocoreNetwork/exocore/pull/125 to make self-delegate possible. As Chuang's design doc presents, there are generally three types of client chains regarding self-delegate process:

  1. the client chains that are EVM-compatible
  2. the client chains that have other types of VMs and could be bridged to Exocore
  3. the client chains that have no VM

For type 1 client chains, to associate an EVM address with an operator address is simple: the authority that holds the key for the EVM address could always send an EVM transaction to Exocore and call ExocoreGateway.associateOpratorWithEVMStaker, since the EVM address should remain the same for the same private key no matter which EVM-compatible chain the transaction is sent to.

function associateOperatorWithEVMStaker(uint32 clientChainId, string calldata operator)
        external
        whenNotPaused
        isValidBech32Address(operator)
    {}

function dissociateOperatorFromEVMStaker(uint32 clientChainId) external whenNotPaused {
}

Things get more difficult for type 2 client chains: even for the same private key, owing to different cryptographic schemes, the address could be different for EVM and other VM, and we can't link these two addresses without knowing the private key. So in this case, staker should initiate the request from client chain and send the request to Exocore via bridge, so that we could link a Non-EVM address with an operator address.

function requestAssociateOperatorWithStaker(uint32 srcChainId, uint64 lzNonce, bytes calldata payload)
        public
        onlyCalledFromThis
{
}

function requestDissociateOperatorFromStaker(uint32 srcChainId, uint64 lzNonce, bytes calldata payload)
        public
        onlyCalledFromThis
    {
}

It is most difficult for type 3 client chains, where we have to recover staker's address from its signature in Exocore's contracts and then link that address with some operator address. We would leave this for future implementation as it brings many complexities.

Summary by CodeRabbit

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

Walkthrough

The recent updates enhance the capabilities of smart contracts managing operator-staker associations. New public functions have been added for associating and dissociating operators, while outdated validation logic has been removed. These modifications aim to streamline operations in the multi-chain ecosystem, improving interactions and clarity in contract management.

Changes

Files Change Summary
src/core/ExocoreGateway.sol, src/interfaces/precompiles/IDelegation.sol Introduced functions for associating/dissociating operators with EVM stakers, enhancing management capabilities and clarifying parameter names.
src/storage/BootstrapStorage.sol Removed address validation constants and logic, simplifying address handling within the contract.
src/storage/ExocoreGatewayStorage.sol, src/storage/GatewayStorage.sol Added new constants, events, and a validation modifier for address formats, improving error handling and operation clarity.
test/foundry/unit/ExocoreGateway.t.sol Enhanced tests for operator association/dissociation, including new events and coverage for edge case scenarios.
test/mocks/DelegationMock.sol Introduced mappings and functions for managing operator-staker associations, improving error handling and contract usability.

Sequence Diagram(s)

sequenceDiagram
    participant Staker
    participant Operator
    participant Gateway

    Staker->>Gateway: Request Associate Operator
    Gateway->>Operator: Validate Staker
    Operator-->>Gateway: Confirmation
    Gateway-->>Staker: Association Success
sequenceDiagram
    participant Staker
    participant Operator
    participant Gateway

    Staker->>Gateway: Request Dissociate Operator
    Gateway->>Operator: Validate Staker Association
    Operator-->>Gateway: Confirmation
    Gateway-->>Staker: Dissociation Success

Poem

🐰 In the meadow where the bunnies play,
New changes sprout, brightening the day.
Operators and stakers, hand in paw,
Build a network, with no flaw.
With hops of joy, we celebrate,
Smart contracts dance, oh, isn’t it great! πŸŽ‰


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.