warden-protocol / wardenprotocol

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

992 Transactions Relayer #1084

Closed backsapc closed 6 days ago

backsapc commented 1 week ago

Previous PR: https://github.com/warden-protocol/wardenprotocol/pull/1043 Closed due to too many differences after migration to viem.

Summary by CodeRabbit

coderabbitai[bot] commented 1 week ago
📝 Walkthrough
📝 Walkthrough
📝 Walkthrough ## Walkthrough The pull request introduces several significant changes to the blockchain library, including the addition of a new dependency, enhancements to the `EvmClient` class for transaction broadcasting, and the introduction of new classes such as `WardenRegistryClient` and `WardenClient`. Additionally, various types and interfaces have been defined to improve the structure of the codebase, particularly for handling signature requests and transaction processing. The changes also include updates to configuration files to accommodate new parameters for EVMOS, along with enhancements to error handling and retry mechanisms. ## Changes | File | Change Summary | |----------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------| | `automated-orders/packages/blockchain-library/package.json` | Added new dependency `"cockatiel": "^3.2.1"` to `dependencies`. | | `automated-orders/packages/blockchain-library/src/clients/evm.ts` | Updated `broadcastTx` method signature and implementation; added imports for `parseTransaction`, `parseSignature`, and `serializeTransaction`. | | `automated-orders/packages/blockchain-library/src/clients/registry.ts` | Introduced `WardenRegistryClient` class with `getTransaction` method. | | `automated-orders/packages/blockchain-library/src/clients/warden.ts` | Added `WardenClient` class with `pollSignatureRequests` method for handling signature requests. | | `automated-orders/packages/blockchain-library/src/index.ts` | Added new exports for various types and clients, including `WardenClient` and `WardenRegistryClient`. | | `automated-orders/packages/blockchain-library/src/processors/newSignatureProcessor.ts` | Updated `NewSignatureProcessor` to include retry and circuit breaker policies using `cockatiel`. | | `automated-orders/packages/blockchain-library/src/types/registry/configuration.ts` | Added new interface `IWardenRegistryConfiguration` with `contractAddress`. | | `automated-orders/packages/blockchain-library/src/types/registry/functions.ts` | Added new ABI function constants: `AddTransactionAbi`, `ExecutionsAbi`, `RegisterAbi`, `TransactionsAbi`. | | `automated-orders/packages/blockchain-library/src/types/warden/configuration.ts` | Modified `IWardenConfiguration` interface by removing `rpcURL` and adding new properties. | | `automated-orders/packages/blockchain-library/src/types/warden/functions.ts` | Added enums and interfaces for managing sign requests and broadcasting options. | | `automated-orders/packages/blockchain-library/src/types/warden/newSignatureRequest.ts` | Modified `INewSignatureRequest` interface to replace `signedData` with `signature` and `transactionHash`. | | `automated-orders/packages/relayer/src/config/config.ts` | Updated configuration schema with new required fields and properties for EVMOS. | | `automated-orders/packages/relayer/src/config/env.ts` | Modified `Env` interface to include new properties related to EVMOS. | | `automated-orders/packages/relayer/src/index.ts` | Enhanced `main` function for blockchain interactions, including instantiation of multiple clients. | | `automated-orders/packages/utils-library/src/index.ts` | Added new exports `empty` and `notEmpty` from `buffer.js`. | | `automated-orders/packages/utils-library/src/services/buffer.ts` | Introduced `notEmpty` and `empty` functions for utility in handling `Uint8Array`. | | `CHANGELOG.md` | Updated to include new feature `(relayer) #992 Added a service to relay transactions into Ethereum`. | | `precompiles/warden/query_types.go` | Modified error handling and input validation in request functions. | ## Possibly related PRs - **#840**: This PR involves the removal of the `template_id` fields, which may relate to the overall structure of requests and responses in the blockchain library, potentially impacting how dependencies are managed. - **#975**: The addition of the "slinky" precompile could be relevant as it may interact with the blockchain library's functionality, especially if it involves transaction handling or event processing. - **#1042**: The introduction of a new type field for signature requests enhances the functionality related to signature management, which may connect with the changes in the main PR regarding the addition of a new dependency. - **#1077**: This PR focuses on improving typings by utilizing enums consistently, which could relate to the overall type safety and structure of the blockchain library, aligning with the changes made in the main PR. - **#1078**: The transition to using `viem` and `wagmi` libraries in the blockchain library indicates a significant change in how blockchain interactions are handled, which is directly related to the updates made in the main PR regarding dependencies. ## Suggested labels `automated-uniswap`, `basic-automated-orders` ## Suggested reviewers - artur-abliazimov - mn13 - Svetomech - Pitasi

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.
github-actions[bot] commented 1 week ago

Hey @backsapc 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 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/2JWSo7Lp6zq4ZzXnvWBycRCehiyZ)) | [Visit Preview](https://warden-help-center-git-feature-992-relayer-qrdo-foundation.vercel.app) | | Nov 22, 2024 1:47pm |