warden-protocol / wardenprotocol

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

Feat/basic order contract #1072

Closed mn13 closed 1 week ago

mn13 commented 1 week ago

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 1 week ago
📝 Walkthrough
📝 Walkthrough ## Walkthrough The pull request includes significant changes to the `@wardenprotocol/orders` project. Key modifications involve the reintroduction of dependencies and updates to build and test scripts in `package.json`. New precompile mappings are added in `remappings.txt`. Several Solidity contracts are introduced, including `BasicOrder`, `OrderFactory`, and associated types in `Types.sol`, while existing contracts like `Deploy` and `Foo` are removed. Additionally, mock contracts for testing purposes are created, and a test suite for `BasicOrder` is established. ## Changes | File Path | Change Summary | |---------------------------------------------|----------------------------------------------------------------------------------------------------| | `solidity/orders/package.json` | - Dependency reintroduced: `@openzeppelin/contracts`
- Updated build command
- Modified test command with `--via-ir` | | `solidity/orders/remappings.txt` | - Added new mappings: `precompile-common`, `precompile-warden`, `precompile-slinky`, `@openzeppelin/contracts`, `forge-std` | | `solidity/orders/script/Deploy.s.sol` | - Contract removed: `Deploy` | | `solidity/orders/src/BasicOrder.sol` | - Contract added: `BasicOrder`
- Added multiple methods for order execution and management | | `solidity/orders/src/Foo.sol` | - Contract removed: `Foo` | | `solidity/orders/src/IExecution.sol` | - Interface added: `IExecution`
- Added methods for execution logic | | `solidity/orders/src/OrderFactory.sol` | - Contract added: `OrderFactory`
- Added order creation functionality and registry management | | `solidity/orders/src/Types.sol` | - Library added: `Types`
- Added various data structures and enumerations for order management | | `solidity/orders/test/BasicOrder.t.sol` | - Contract added: `BasicOrderTest`
- Established test framework for `BasicOrder` functionality | | `solidity/orders/test/Foo.t.sol` | - Contract removed: `FooTest` | | `solidity/orders/test/mocks/MockSlinkyPrecompile.sol` | - Contract added: `MockSlinkyPrecompile`
- Functions for price management | | `solidity/orders/test/mocks/MockWardenPrecompile.sol` | - Contract added: `MockWardenPrecompile`
- Functions for key management | ## Possibly related PRs - **#975**: The addition of the Slinky precompile is relevant as it introduces new functionality that may interact with the changes made in the main PR regarding the `@openzeppelin/contracts` dependency and the new `BasicOrder` contract. - **#1040**: The migration to Foundry aligns with the updates in the main PR, particularly in the context of modifying build and test commands in the `package.json`. - **#1069**: The changes related to the Scheduler may connect with the overall architecture and functionality introduced in the main PR, especially if they involve the management of orders or interactions with the blockchain. ## Suggested labels `basic-automated-orders`, `protocol` ## Suggested reviewers - backsapc - jjheywood - artur-abliazimov

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 1 week 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/gRu9nAkXFv9d7q2XNmnKxzkmZcP6)) | [Visit Preview](https://warden-help-center-git-feat-basic-order-a19e8d-qrdo-foundation.vercel.app) | | Nov 15, 2024 10:29am |