warden-protocol / wardenprotocol

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

Automated orders: workers project setup #1029

Closed artur-abliazimov closed 2 weeks ago

artur-abliazimov commented 2 weeks ago

Summary by CodeRabbit

coderabbitai[bot] commented 2 weeks ago
📝 Walkthrough ## Walkthrough The changes in this pull request introduce several configuration files and a new project structure for the `automated-orders` project. Key additions include ESLint and Prettier configurations to enforce coding standards, a `.gitignore` file to exclude unnecessary files from version control, and TypeScript configuration files for multiple packages. New utility functions for logging and asynchronous operations are also introduced. Additionally, the project is organized into multiple packages, each with its own `package.json` file, facilitating modular development. ## Changes | File Path | Change Summary | |------------------------------------------------|-----------------------------------------------------------------------------------------------------| | automated-orders/.eslintignore | New file specifying directories and files to be ignored by ESLint. | | automated-orders/.eslintrc.yml | New ESLint configuration file with rules tailored for TypeScript projects. | | automated-orders/.gitignore | New file specifying patterns for files and directories to be ignored by Git. | | automated-orders/.prettierrc.yml | New Prettier configuration file defining code formatting options and import sorting rules. | | automated-orders/.vscode/settings.json | New Visual Studio Code settings for default code formatting and editor behavior. | | automated-orders/README.md | New section added to document environment variables. | | automated-orders/package.json | New `package.json` file defining project metadata and scripts for build and linting. | | automated-orders/packages/relayer/package.json | New `package.json` for the `relayer` package, including metadata, scripts, and dependencies. | | automated-orders/packages/relayer/src/index.ts | New asynchronous `main` function for application initialization and error handling. | | automated-orders/packages/relayer/tsconfig.json | New TypeScript configuration extending a base config with specific compiler options. | | automated-orders/packages/scheduler/package.json | New `package.json` for the `scheduler` package, including metadata, scripts, and dependencies. | | automated-orders/packages/scheduler/src/index.ts | New asynchronous `main` function for application initialization and error handling. | | automated-orders/packages/scheduler/tsconfig.json| New TypeScript configuration extending a base config with specific compiler options. | | automated-orders/packages/utils-library/package.json| New `package.json` for the `utils` package, including metadata and build script. | | automated-orders/packages/utils-library/src/index.ts| New exports for utility functions including logging and serialization. | | automated-orders/packages/utils-library/src/logging/console.ts| New logging functions for different log levels. | | automated-orders/packages/utils-library/src/serialization/json.ts| New `serialize` function for converting objects to JSON. | | automated-orders/packages/utils-library/src/services/async.ts| New `delay` function for asynchronous operations. | | automated-orders/packages/utils-library/src/services/buffer.ts| New `toUint8Array` function for converting various data types into a `Uint8Array`. | | automated-orders/packages/utils-library/tsconfig.json| New TypeScript configuration extending a base config with specific compiler options. | | automated-orders/tsconfig.json | New TypeScript configuration for the `automated-orders` project with various compiler options. | ## Possibly related PRs - **#385**: Modifications to ESLint configurations, related to the `.eslintignore` file added in this PR. - **#571**: Introduces a modal for receiving assets, potentially relating to ignored files in the linting process. - **#728**: Enhancements to the sidebar, possibly connected to the overall project structure changes. - **#862**: Addresses bug fixes that may involve linting issues, potentially linked to the changes in the `.eslintignore` file. - **#921**: Updates to the `wardenjs` package and proto files, which may relate to the overall project structure. ## Suggested reviewers - alex-nax - jjheywood

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 | Name | Status | Preview | Comments | Updated (UTC) | | :--- | :----- | :------ | :------- | :------ | | **warden-help-center** | ⬜️ Ignored ([Inspect](https://vercel.com/qrdo-foundation/warden-help-center/7uuM2cswtRpoCzQ6h4c3j2AgAV9g)) | [Visit Preview](https://warden-help-center-git-feature-automated-cf1171-qrdo-foundation.vercel.app) | | Nov 5, 2024 11:27am |