warden-protocol / wardenprotocol

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

refactor(wardend): encapsulate slinky initialization #1095

Open Pitasi opened 3 days ago

Pitasi commented 3 days ago

This creates a new struct called SlinkyClient that encapsulates everything Slinky-related. This is a first step towards making the app initialization more modular and extensible.

No functionalities have been changed, just the order of some calls that doesn't affect functionalities.

Summary by CodeRabbit

coderabbitai[bot] commented 3 days ago
📝 Walkthrough
📝 Walkthrough ## Walkthrough The changes in this pull request involve significant modifications to the oracle handling within the application. The `App` struct has been restructured to replace the `oracleClient` with a new `SlinkyClient` pointer, indicating a shift in the oracle service's implementation. The method `initializeOracle` has been renamed to `initializeOracles`, reflecting a broader approach to managing multiple oracles. Additionally, new setup methods and a `SlinkyClient` struct have been introduced, enhancing functionality and error handling. ## Changes | File | Change Summary | |--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `warden/app/app.go` | - Removed `oracleClient` and added `slinkyClient *SlinkyClient`.
- Renamed `initializeOracle` to `initializeOracles`.
- Updated initialization logic in `New`. | | `warden/app/oracle.go` | - Renamed `initializeOracle` to `initializeOracles`.
- Added methods: `setupMempool`, `setupSlinkyClient`, `baseProposalHandler`, and `setupABCILifecycle`.
- Defined new struct `SlinkyClient` with various methods for proposal handling and lifecycle integration.
- Modified `NewSlinkyClient` to return an error instead of panicking. | ## Possibly related PRs - **#425**: This PR integrates Slinky into the project, which includes changes to the `warden/app/app.go` file that relate to the restructuring of oracle-related components, specifically the introduction of the `SlinkyClient` and modifications to the `App` struct. - **#980**: This PR enhances the initialization and handling of the oracle service in `warden/app/oracle.go`, which is directly related to the changes made in the main PR regarding the `initializeOracles` method and the overall restructuring of oracle functionality. ## Suggested labels `test`

[!WARNING]

Rate limit exceeded

@Pitasi has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 2 minutes and 55 seconds before requesting another review.

⌛ How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
🚦 How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://docs.coderabbit.ai/faq) for further information.
📥 Commits Reviewing files that changed from the base of the PR and between 7ddd111ed06d94c21ff757406b92c3bae81a73dc and a28b0f336ffd5ecd88baa77ca99c9c7cb1167e7d.

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 3 days 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/5r7f5DvB1yo2aPbzhjCrSss9xfNG)) | [Visit Preview](https://warden-help-center-git-encapsulate-slinky-init-qrdo-foundation.vercel.app) | | Nov 21, 2024 11:52am |