Automated Orders: add a layer to work with blockchains

artur-abliazimov commented 2 weeks ago

Summary by CodeRabbit

New Features
- Introduced new configuration files for Visual Studio Code to streamline launching and debugging of applications.
- Added environment variable configurations for the scheduler and relayer components in the README.
- Launched new blockchain library package with essential dependencies and configurations.
Bug Fixes
- Enhanced error handling in the main functions of the relayer and scheduler to ensure proper process termination on errors.
Documentation
- Updated README with examples of required environment variables for scheduler and relayer.
Chores
- Added new dependencies for the relayer and scheduler packages.

coderabbitai[bot] commented 2 weeks ago

📝 Walkthrough

## Walkthrough The changes in this pull request involve updates to several files within the `automated-orders` project. Key modifications include the addition of exceptions in the `.gitignore` file for certain Visual Studio Code configuration files, the introduction of new configuration files for launching applications, and the addition of several new interfaces and classes to support blockchain interactions. Additionally, updates were made to the `README.md` for improved documentation, and various packages were updated to include new dependencies. ## Changes | File | Change Summary | |------|----------------| | `automated-orders/.gitignore` | Added exceptions for `!.vscode/launch.json` and `!.vscode/settings.json`. | | `automated-orders/.vscode/launch.json` | Introduced a new launch configuration for the scheduler and relayer applications. | | `automated-orders/README.md` | Added sections for environment variable configurations for `@warden-automated-orders/scheduler` and `@warden-automated-orders/relayer`. | | `automated-orders/packages/blockchain-library/package.json` | Created new `package.json` for `@warden-automated-orders/blockchain`, specifying metadata, dependencies, and build scripts. | | `automated-orders/packages/blockchain-library/src/clients/evm.ts` | Added `EvmClient` class with methods for blockchain interaction. | | `automated-orders/packages/blockchain-library/src/clients/warden.ts` | Added `WardenClient` class for interacting with signature requests. | | `automated-orders/packages/blockchain-library/src/index.ts` | Exported new components: `WardenClient`, `EvmClient`, `NewSignatureProcessor`, and `INewSignatureRequest`. | | `automated-orders/packages/blockchain-library/src/processors/newSignatureProcessor.ts` | Introduced `NewSignatureProcessor` class for handling signature requests. | | `automated-orders/packages/blockchain-library/src/processors/processor.ts` | Added abstract `Processor` class for processing asynchronous requests. | | `automated-orders/packages/blockchain-library/src/types/evm/configuration.ts` | Added `IEvmConfiguration` interface for EVM configuration settings. | | `automated-orders/packages/blockchain-library/src/types/registry/events.ts` | Introduced `OrderCreated` interface for order creation events. | | `automated-orders/packages/blockchain-library/src/types/warden/configuration.ts` | Added `IWardenConfiguration` interface for Warden settings. | | `automated-orders/packages/blockchain-library/src/types/warden/newSignatureRequest.ts` | Introduced `INewSignatureRequest` interface for new signature requests. | | `automated-orders/packages/blockchain-library/tsconfig.json` | Added TypeScript configuration file for the blockchain library. | | `automated-orders/packages/relayer/package.json` | Updated to include dependency on `@warden-automated-orders/blockchain`. | | `automated-orders/packages/relayer/src/config/config.ts` | Introduced configuration schema for environment variables. | | `automated-orders/packages/relayer/src/config/env.ts` | Added `Env` interface for managing environment variables. | | `automated-orders/packages/relayer/src/index.ts` | Modified main function to instantiate clients and improve error handling. | | `automated-orders/packages/scheduler/package.json` | Updated to include dependency on `@warden-automated-orders/blockchain`. | | `automated-orders/packages/scheduler/src/config/config.ts` | Introduced configuration schema for environment variables. | | `automated-orders/packages/scheduler/src/config/env.ts` | Added `Env` interface for managing environment variables. | | `automated-orders/packages/scheduler/src/index.ts` | Enhanced error handling in the main function. | | `automated-orders/tsconfig.json` | Added reference to the `blockchain-library` package. | ## Possibly related PRs - **#1029**: Introduces a `.gitignore` file and ESLint configuration for the `automated-orders` project, relevant to project organization. - **#1030**: Updates documentation regarding the Chiado testnet, providing context that may relate to project setup and deployment. ## Suggested labels `automated-uniswap`, `spaceward` ## Suggested reviewers - alex-nax - mn13

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://coderabbit.ai/docs) 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.

github-actions[bot] commented 2 weeks 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.

vercel[bot] commented 2 weeks ago

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

1 Skipped Deployment

warden-protocol / wardenprotocol

Automated Orders: add a layer to work with blockchains #1039

Summary by CodeRabbit