Chore(proxy)/openzeppelin v5 migration

Anmol-Dhiman commented 7 months ago

Updated the bytes calculation formula i.e. keccak256(abi.encode(uint256(keccak256(id)) - 1)) & ~bytes32(uint256(0xff))
Made changes for using Namespaced Storage Layout in proxy and mock proxy contracts.

Issue : https://github.com/kleros/kleros-v2/issues/1270 Test Result :

PR-Codex overview

The focus of this PR is to update storage locations in various contracts for better organization and efficiency.

Detailed summary

Updated storage locations in Initializable.sol, UUPSProxiable.sol, UUPSProxy.sol, and mock contracts.
Added storage structs and constants for improved storage management.
Implemented functions to access and update storage variables efficiently.

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

Summary by CodeRabbit

New Features
- Introduced structured storage patterns in several contracts to enhance state management and modularity.
- Added new getter functions for state variables in upgraded contracts.
Bug Fixes
- Updated storage slot constants for improved accuracy in contract interactions.
Refactor
- Refactored state management in multiple contracts to utilize dedicated storage structs, improving maintainability and reducing risks of storage collisions during upgrades.
Documentation
- Updated comments for constants to clarify new calculation methods for storage slots.

netlify[bot] commented 7 months ago

Deploy request for kleros-v2-testnet rejected.

Name	Link
Latest commit	413cea4f59e49f9fa565cbcd251a699f5de6cf4d

netlify[bot] commented 7 months ago

Deploy request for kleros-v2-university pending review.

Visit the deploys page to approve it

Name	Link
Latest commit	c78167d6eda5fde495d55ac170ad8c241abb1989

netlify[bot] commented 7 months ago

Deploy request for kleros-v2-neo pending review.

Visit the deploys page to approve it

Name	Link
Latest commit	c78167d6eda5fde495d55ac170ad8c241abb1989

coderabbitai[bot] commented 5 months ago

Walkthrough

The recent updates enhance the structure and maintainability of smart contracts by transitioning from direct state variable access to a defined storage pattern utilizing structs. This change promotes better encapsulation, aligns with best practices for proxy patterns, and improves gas efficiency. Key constants governing implementation slots were also updated, ensuring compatibility with current standards while maintaining the essential functionality of the contracts.

Changes

Files	Change Summary
`contracts/src/proxy/...`	Updated `_INITIALIZABLE_STORAGE` and `IMPLEMENTATION_SLOT` constants with new values; enhanced comments to reflect improved calculation methods.
`contracts/src/proxy/mock/...`	Refactored state management in `NonUpgradeableMock`, `UUPSUpgradeableMock`, `UpgradedByInheritance`, and `UpgradedByRewrite` to use structured storage.
`contracts/src/proxy/mock/by-rewrite/...`	Introduced `UpgradedByRewriteV2` with an additional state variable; transitioned to structured storage while maintaining existing functionalities.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Contract
    participant Storage

    User->>Contract: Call function (e.g., increment)
    Contract->>Storage: Access storage struct
    Storage-->>Contract: Return state variable (e.g., counter)
    Contract-->>User: Return result

🐇 "In the code's bright spring, new patterns sway,
With structures and slots, they find their way.
A hop and a skip, through bytes we glide,
In a world of smart contracts, we take pride!
With each little change, the future's in sight,
Let’s dance through the code, oh what a delight!" ✨

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.

codeclimate[bot] commented 3 months ago

Code Climate has analyzed commit c78167d6 and detected 0 issues on this pull request.

View more on Code Climate.

kleros / kleros-v2