search

warden-protocol / wardenprotocol

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

Automated Orders: Scheduler #1069

Closed artur-abliazimov closed 1 week ago

artur-abliazimov commented 1 week ago

Summary by CodeRabbit

coderabbitai[bot] commented 1 week ago
📝 Walkthrough
📝 Walkthrough ## Walkthrough The pull request introduces significant updates to the `@warden-automated-orders` project, focusing on environment variable configurations, particularly for EVMOS. The `README.md` file reflects changes in the Ethereum RPC endpoint and the addition of multiple EVMOS-related environment variables. Additionally, new scripts are added to the `package.json` files to enhance build capabilities. The blockchain library sees the introduction of new classes, interfaces, and constants, particularly for handling events and order processing. Several GitHub Actions workflows are also created to automate builds and deployments for the scheduler and relayer components. ## Changes | File | Change Summary | |------|----------------| | `automated-orders/README.md` | Updated `ETHEREUM_NODE_RPC`, added multiple EVMOS environment variables, and removed some Ethereum-related variables. | | `automated-orders/package.json` | Added new scripts for building and starting various components like blockchain-lib, utils, scheduler, and relayer. | | `automated-orders/packages/blockchain-library/package.json` | Added `lru-cache` as a new dependency. | | `automated-orders/packages/blockchain-library/src/clients/evm.ts` | Modified `EvmClient` class with new properties and methods for event polling and transaction handling. | | `automated-orders/packages/blockchain-library/src/clients/warden.ts` | Removed several import statements and the `query` method, altering how signature requests are handled. | | `automated-orders/packages/blockchain-library/src/index.ts` | Added new exports for `ChainIds`, `OrderProcessor`, `OrderRegistered`, and `OrderRegisteredAbi`. | | `automated-orders/packages/blockchain-library/src/processors/orderProcessor.ts` | Introduced `OrderProcessor` class for handling `OrderRegistered` events with retry logic. | | `automated-orders/packages/blockchain-library/src/types/evm/configuration.ts` | Added optional properties to `IEvmConfiguration` for enhanced configuration options. | | `automated-orders/packages/blockchain-library/src/types/evm/constants.ts` | Introduced `ChainIds` enum with a member `Sepolia`. | | `automated-orders/packages/blockchain-library/src/types/evm/pollingConfiguration.ts` | Added `IEventPollingConfiguration` interface for event polling settings. | | `automated-orders/packages/blockchain-library/src/types/order/events.ts` | Added `OrderRegistered` interface and `OrderRegisteredAbi` constant for event handling. | | `automated-orders/packages/blockchain-library/src/types/order/functions.ts` | Added `IExecutionData` interface and multiple ABI constants for order execution functions. | | `automated-orders/packages/relayer/src/index.ts` | Removed previous implementation of the `main` function, leaving a placeholder log statement. | | `automated-orders/packages/scheduler/src/config/config.ts` | Updated configuration schema to include new EVMOS properties and removed `ETHEREUM_REGISTRY_ADDRESS`. | | `automated-orders/packages/scheduler/src/config/env.ts` | Expanded `Env` interface with new EVMOS properties and removed `ETHEREUM_REGISTRY_ADDRESS`. | | `automated-orders/packages/scheduler/src/index.ts` | Enhanced `main` function to integrate blockchain client functionality and event processing. | | `automated-orders/packages/blockchain-library/src/processors/newSignatureProcessor.ts` | Changed return type of `handle` method in `NewSignatureProcessor` from `Promise` to `Promise`. | | `automated-orders/packages/blockchain-library/src/processors/processor.ts` | Updated `start` method in `Processor` class to simplify control flow and change `handle` return type. | | `automated-orders/packages/blockchain-library/src/types/registry/events.ts` | Removed `OrderCreated` interface. | | `.github/workflows/build_push.yml` | Updated `service_name` input options to include new services for scheduler and relayer. | | `Dockerfile` | Added new build stages for `automated-orders-libs`, `automated-orders-scheduler`, and `automated-orders-relayer`. | | `.github/workflows/automated-orders-relayer.yml` | Introduced a new workflow for the Automated Orders Relayer project. | | `.github/workflows/automated-orders-scheduler.yml` | Introduced a new workflow for the Automated Orders Scheduler project. | ## Possibly related PRs - **#1030**: The changes in the main PR regarding environment variable configurations and the introduction of new variables related to the EVMOS network are relevant to the updates made in the "Docs chiado changes" PR, which also includes modifications to documentation related to the Chiado testnet and its environment. - **#1029**: The main PR's focus on setting up environment variables and configurations aligns with the "Automated Orders: workers project setup" PR, which introduces new configuration files and environment variable management for the automated orders project. - **#1068**: The changes in the main PR that enhance the configuration and management of environment variables are related to the "feat(spaceward): reduce calls to evm endpoint" PR, which aims to optimize interactions with the EVM endpoint, potentially leveraging the new configurations introduced in the main PR. ## Suggested labels `docs` ## Suggested reviewers - mn13 - jjheywood
📜 Recent review details **Configuration used: .coderabbit.yaml** **Review profile: CHILL**
📥 Commits Reviewing files that changed from the base of the PR and between 09a75cced9c5ee6f7b17341fa0d12ca77dc88108 and aa9c619102faf5a77caea40369b290a7efe95758.
📒 Files selected for processing (4) * `automated-orders/packages/blockchain-library/src/clients/warden.ts` (0 hunks) * `automated-orders/packages/blockchain-library/src/index.ts` (1 hunks) * `automated-orders/packages/blockchain-library/src/processors/orderProcessor.ts` (1 hunks) * `automated-orders/packages/scheduler/src/index.ts` (1 hunks)
💤 Files with no reviewable changes (1) * automated-orders/packages/blockchain-library/src/clients/warden.ts
🚧 Files skipped from review as they are similar to previous changes (3) * automated-orders/packages/blockchain-library/src/index.ts * automated-orders/packages/blockchain-library/src/processors/orderProcessor.ts * automated-orders/packages/scheduler/src/index.ts

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/7N6bzyVVma7vEudq8fHN1iy7VCB7)) | [Visit Preview](https://warden-help-center-git-feature-automated-36cc0a-qrdo-foundation.vercel.app) | | Nov 15, 2024 9:23am |
github-actions[bot] commented 1 week ago

Hey @artur-abliazimov and thank you for opening this pull request! 👋🏼

It looks like you forgot to add a changelog entry for your changes. Make sure to add a changelog entry in the 'CHANGELOG.md' file.