Automated Orders: use viem and wagmi

[artur-abliazimov]

Summary by CodeRabbit

• New Features

  • Introduced new interfaces IEvent and GasFeeData for structured event representation and gas fee data in Ethereum transactions.
  • Updated EvmClient to utilize the viem library for Ethereum interactions, enhancing compatibility and performance.
  • Added a new environment variable WARDEN_EVM_CHAIN_ID to enhance configuration options for the scheduler component.

• Bug Fixes

  • Improved event handling in OrderProcessor for better type safety and clarity.

• Documentation

  • Enhanced type definitions and comments for better understanding and maintainability.

• Chores

  • Added strict type-checking options in TypeScript configuration for improved code quality.

[coderabbitai[bot]]

📝 Walkthrough

📝 Walkthrough

## Walkthrough The pull request includes significant updates to the `@warden-automated-orders/blockchain` package, primarily focusing on dependency management and the transition from the `web3` library to the `viem` library for Ethereum interactions. Key changes involve the addition and removal of various dependencies in the `package.json`, modifications to the `EvmClient` class for event handling and transaction processing, and the introduction of new interfaces for structured event and gas fee data. These updates enhance the type safety and clarity of the codebase. ## Changes | File | Change Summary | |----------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------| | `automated-orders/packages/blockchain-library/package.json` | - Added dependency: `"@wagmi/core": "^2.14.6"`
- Removed dependencies: `"@tanstack/react-query"` and `"web3"`
- Added dependency: `"viem": "2.x"`
- Removed devDependencies: `"react"` and `"react-dom"` | | `automated-orders/packages/blockchain-library/src/clients/evm.ts` | - Transitioned from `web3` to `viem` in `EvmClient` class
- Updated method signatures and internal logic for event handling and transaction processing | | `automated-orders/packages/blockchain-library/src/index.ts` | - Updated export from `OrderRegistered` to `IOrderRegistered` | | `automated-orders/packages/blockchain-library/src/processors/orderProcessor.ts` | - Updated `OrderProcessor` to handle events as tuples containing a string and `IOrderRegistered` | | `automated-orders/packages/blockchain-library/src/types/evm/event.ts` | - Added new interface `IEvent` with properties `args` and `eventName` | | `automated-orders/packages/blockchain-library/src/types/evm/gas.ts` | - Added new interface `GasFeeData` with properties for gas fee data | | `automated-orders/packages/blockchain-library/src/types/order/events.ts` | - Replaced `OrderRegistered` with `IOrderRegistered` and updated property structure | | `automated-orders/packages/blockchain-library/src/types/order/functions.ts` | - Updated `IExecutionData` fields to use `Hex` instead of `string` or `Bytes` | | `automated-orders/packages/scheduler/src/index.ts` | - Updated `EvmClient` instantiation to include `sepolia` as a second argument | | `automated-orders/packages/scheduler/tsconfig.json` | - Added compiler option: `"strict": true` | | `automated-orders/README.md` | - Added new environment variable: `WARDEN_EVM_CHAIN_ID=1337` | | `automated-orders/packages/scheduler/src/config/config.ts` | - Added required property: `WARDEN_EVM_CHAIN_ID` to schema | | `automated-orders/packages/scheduler/src/config/env.ts` | - Added property: `WARDEN_EVM_CHAIN_ID: number` to `Env` interface | ## Possibly related PRs - **#1068**: The changes in this PR involve adding a new dependency `@wagmi/core` and modifying the `package.json` file, which aligns with the main PR's addition of the same dependency. - **#1074**: This PR introduces a custom key-value storage solution for the web3 wallet, which may relate to the overall improvements in handling blockchain interactions and state management seen in the main PR's updates to the `EvmClient` and related classes. ## Suggested labels `automated-uniswap` ## Suggested reviewers - jjheywood - backsapc

---

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]]

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/DxZmJimyyzJ4Y6ipPV7Lo9zLcDpZ)) | [Visit Preview](https://warden-help-center-git-feature-use-viem-0064bd-qrdo-foundation.vercel.app) | | Nov 18, 2024 10:43am |

[github-actions[bot]]

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.

[mn13]

LGTM