Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix epoch hook registration in protorev #8054

Closed

Conversation

Eric-Warehime
Copy link

@Eric-Warehime Eric-Warehime commented Apr 15, 2024

What is the purpose of the change

Fixes the registration of epoch hooks in protorev.
EpochHooks are set for protorev by the EpochHooks() method. Those are created as an EpochHooks item, and not directly as part of the keeper.

In #7564 we added hooks directly to the keeper which were never registered with the epoch hooks. Instead of having these live in separate places I've just combined the newly added logic into the existing AfterEpoch hook.

All logic remains the same.

Testing and Verifying

Existing unit test coverage still applies to all changes--I've simply copy/pasted some of those to organize all epoch-specific logic into one place within protorev.

Not sure if you have e2e tests somewhere that I can update to test protorev distributions?

Documentation and Release Note

  • Does this pull request introduce a new feature or user-facing behavior changes?
  • Changelog entry added to Unreleased section of CHANGELOG.md?

Where is the change documented?

  • Specification (x/{module}/README.md)
  • Osmosis documentation site
  • Code comments?
  • N/A

Summary by CodeRabbit

  • Refactor
    • Moved epoch-related functionalities from Hooks to Keeper to streamline operations.
  • New Features
    • Enhanced the profit distribution process to occur after each epoch, improving financial operations.
  • Bug Fixes
    • Adjusted test suite to correctly invoke new epoch-ending processes, ensuring reliability.
  • Tests
    • Removed outdated tests and added new ones focusing on profit distribution and epoch transitions.

@Eric-Warehime Eric-Warehime requested a review from p0mvn as a code owner April 15, 2024 21:09
Copy link
Contributor

coderabbitai bot commented Apr 15, 2024

Walkthrough

The recent changes involve the restructuring of epoch-related functionalities in a software project. The Hooks struct's epoch responsibilities have been transferred to the Keeper struct, enhancing the separation of concerns. Additionally, profit distribution logic after an epoch ends has been refined and encapsulated in new methods, improving clarity and testability.

Changes

Files Change Summary
.../hooks.go, .../hooks_test.go,
.../epoch_hook.go, .../epoch_hook_test.go
Restructured epoch-related functionalities, moving methods and adding new logic for profit distribution and base denoms. Updated tests for epoch end behaviors.
.../rebalance_test.go Modified test to use EpochHooks().AfterEpochEnd for better encapsulation.

🐇🌟
In the land of code, where the bits roam free,
A rabbit hopped, changing epochs with glee.
From Hooks to Keeper, the duties did shift,
Ensuring the profits, they would uplift.
Oh, how the code dances, cleaner than ever,
Thanks to the rabbit, clever and clever! 🌼🚀


Recent Review Details

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 87eaa29 and 8cc3fe3.
Files selected for processing (1)
  • x/protorev/keeper/epoch_hook.go (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • x/protorev/keeper/epoch_hook.go

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
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

x/protorev/keeper/epoch_hook.go Show resolved Hide resolved
Copy link
Member

@mattverse mattverse left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, I have also spotted that we have two different hook registration recently.

Can we change it so that we have all hooks into hooks.go instead of having both files exist?

@PaddyMc
Copy link
Collaborator

PaddyMc commented Apr 19, 2024

Thanks for the PR, closing in favor of: #8106

Our e2e tests won't work on this branch atm, we're looking into a fix, sorry for cannibalising your PR 😓

@PaddyMc PaddyMc closed this Apr 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants