warden-protocol / wardenprotocol

Monorepo for the Warden Protocol.
https://wardenprotocol.org
Apache License 2.0
1.1k stars 112 forks source link

Registry contract #1080

Closed mn13 closed 6 days ago

mn13 commented 6 days ago

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 6 days ago
📝 Walkthrough
📝 Walkthrough ## Walkthrough The changes in this pull request primarily focus on modifications to the `BasicOrder`, `IExecution`, `OrderFactory`, and the newly introduced `Registry` contract. Key updates include the addition of a new error for invalid registry addresses, an updated constructor in `BasicOrder` to include a registry parameter, and changes to the `execute` function's return type. The `OrderFactory` now uses an immutable registry variable, and the `Registry` contract manages execution addresses and transactions with appropriate error handling. Tests have also been updated to reflect these changes. ## Changes | File | Change Summary | |----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `solidity/orders/src/BasicOrder.sol` | - Added `InvalidRegistry` error.
- Updated constructor to include `registry` parameter.
- Introduced `REGISTRY` state variable.
- Modified `execute` return type to `(bool, bytes32)`.
- Changed `isExecuted` to `public`.
- Added `getTx` function. | | `solidity/orders/src/IExecution.sol` | - Modified `execute` return type to `(bool, bytes32)`.
- Added `getTx` function. | | `solidity/orders/src/OrderFactory.sol`| - Replaced `registry` variable with immutable `REGISTRY`.
- Updated constructor to accept `registry` parameter.
- Modified `createOrder` to register with `REGISTRY`. | | `solidity/orders/src/Registry.sol` | - Introduced `Registry` contract with error handling for execution addresses and transactions.
- Added functions `register` and `addTransaction`.
- Defined mappings for `executions` and `transactions`. | | `solidity/orders/test/BasicOrder.t.sol`| - Added import for `Registry`.
- Updated `TestData` struct to include `Registry`.
- Refactored `beforeTestSetup`.
- Introduced new tests for `Registry` error handling.
- Modified `test_BasicOrder_Create`. | ## Possibly related PRs - **#1072**: The changes in this PR involve the `BasicOrder` contract, which is directly related to the modifications made in the main PR, specifically regarding the `execute` function's return type and the addition of the `getTx` function. ## Suggested reviewers - artur-abliazimov - backsapc - Svetomech

[!WARNING]

Rate limit exceeded

@mn13 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 16 minutes and 35 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](https://docs.coderabbit.ai/faq) for further information.
📥 Commits Reviewing files that changed from the base of the PR and between 441e0f8e60baf729e220c88d1e34049d8a59110c and 01a388685d6982a82c8959881943c20d9671ecd8.

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 , please review it.` - `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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@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 using 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. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### Documentation and Community - Visit our [Documentation](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
vercel[bot] commented 6 days ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment | Name | Status | Preview | Comments | Updated (UTC) | | :--- | :----- | :------ | :------- | :------ | | **warden-help-center** | ⬜️ Ignored ([Inspect](https://vercel.com/qrdo-foundation/warden-help-center/8QoVBaJKG4zZQniwzRYnHr6Ed11W)) | [Visit Preview](https://warden-help-center-git-registry-contract-qrdo-foundation.vercel.app) | | Nov 18, 2024 8:22am |