ExocoreNetwork / exocore-contracts

5 stars 5 forks source link

refactor: use `_handleResponse` to handle all responses to reduce code size #54

Closed adu-web3 closed 3 months ago

adu-web3 commented 4 months ago

Description

closes: #42

before refactoring, the code size of ClientChainGateway has exceeded the size limit (24576 bytes):

 Contract                      | Size (B) | Margin (B) |
|-------------------------------|----------|------------|
| Address                       |       86 |     24,490 |
| AddressCast                   |       86 |     24,490 |
| AddressUpgradeable            |       86 |     24,490 |
| AssetsMock                    |    3,329 |     21,247 |
| BeaconChainProofs             |       86 |     24,490 |
| BeaconProxyBytecode           |    2,614 |     21,962 |
| BitMaps                       |       86 |     24,490 |
| Bootstrap                     |   22,100 |      2,476 |
| BootstrapStorage              |    3,031 |     21,545 |
| BytesLib                      |       86 |     24,490 |
| CalldataBytesLib              |       86 |     24,490 |
| ClaimRewardMock               |      624 |     23,952 |
| ClientChainGateway            |   24,788 |       -212 |

One of the approaches to reduce code size is to removing redundant functions, so I tried to use a single internal function _handleResponse to deal with all kinds of responses, instead of the original response hook functions that are public(public functions seem occupy more space). After refactoring, the code size has been significantly reduced:

| Contract                      | Size (B) | Margin (B) |
|-------------------------------|----------|------------|
| Address                       |       86 |     24,490 |
| AddressCast                   |       86 |     24,490 |
| AddressUpgradeable            |       86 |     24,490 |
| AssetsMock                    |    3,329 |     21,247 |
| BeaconChainProofs             |       86 |     24,490 |
| BeaconProxyBytecode           |    2,614 |     21,962 |
| BitMaps                       |       86 |     24,490 |
| Bootstrap                     |   22,100 |      2,476 |
| BootstrapStorage              |    3,031 |     21,545 |
| BytesLib                      |       86 |     24,490 |
| CalldataBytesLib              |       86 |     24,490 |
| ClaimRewardMock               |      624 |     23,952 |
| ClientChainGateway            |   22,725 |      1,851 |

Roughly 2 kb size is saved after refactoring. Removing ITokenWhitelister also helps with this issue. So we might be able to find more approaches to optimize the code size while this PR aims to solve the most urgent issue.

Summary by CodeRabbit

coderabbitai[bot] commented 4 months ago

Walkthrough

The changes focus on optimizing the ClientChainGateway and Bootstrap contracts to address code size limitations. By streamlining functionalities, enhancing event handling, and refactoring response processes, the codebase is made more organized and maintainable. Key contracts such as ClientGatewayLzReceiver and ExocoreGateway have been improved for clarity and efficiency, ensuring compliance with deployment constraints while retaining essential functionalities.

Changes

File Change Summary
src/core/ClientChainGateway.sol Removed redundant response hooks; simplified whitelist management.
src/core/ClientGatewayLzReceiver.sol Centralized response handling in _handleResponse; added internal methods for better organization.
src/core/ExocoreGateway.sol Enhanced event emissions; introduced a result variable for capturing success status.
src/interfaces/IClientChainGateway.sol Simplified inheritance by removing ITokenWhitelister.
src/storage/BootstrapStorage.sol Deleted the DepositThenDelegateResult event and its documentation.
src/storage/ClientChainGatewayStorage.sol Replaced WithdrawRewardResult with RequestFinished; removed _registeredResponseHooks.
src/storage/ExocoreGatewayStorage.sol Added new event declarations for asset and staking results.
src/storage/GatewayStorage.sol Introduced a private __gap array; updated nonce verification; added inbound nonce mapping.
test/foundry/Delegation.t.sol Modified event definitions; replaced some emissions with RequestFinished.
test/foundry/DepositThenDelegateTo.t.sol Replaced DepositThenDelegateResult with DepositResult and DelegateResult, adjusting parameters.
test/foundry/DepositWithdrawPrinciple.t.sol Updated events to use bytes32, added new functions and checks, modified event emissions.
test/foundry/ExocoreDeployer.t.sol Added RequestFinished event.
test/foundry/WithdrawReward.t.sol Updated WithdrawRewardResult to use bytes32; introduced RequestFinished event.
test/foundry/unit/ClientChainGateway.t.sol Removed functions related to whitelist token management.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ClientGatewayLzReceiver
    participant ExocoreGateway
    participant Storage

    User->>ClientGatewayLzReceiver: Send Request
    ClientGatewayLzReceiver->>ClientGatewayLzReceiver: _handleResponse
    ClientGatewayLzReceiver->>ExocoreGateway: Process Request
    ExocoreGateway->>Storage: Update State
    ExocoreGateway->>User: Emit Event

    Note over ClientGatewayLzReceiver, ExocoreGateway: Refactored internal handling and event emissions

Assessment against linked issues

Objective (Issues) Addressed Explanation
Reduce code size of ClientChainGateway and Bootstrap (#42)
Improve code readability and organization
Refactor response handling and event emissions
Simplify interface inheritance in IClientChainGateway

Poem

In the blockchain's enchanted land,
Contracts trimmed with a careful hand,
Refactored code, events that bloom,
In smart contracts' endless room.
Whitelist trimmed, responses clear,
Code size limits, no more fear!
🐰✨


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.