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

[WIP]fix: mint first then distribute #254

Closed
wants to merge 2 commits into from

Conversation

leonz789
Copy link
Contributor

@leonz789 leonz789 commented Nov 29, 2024

Description

At the epoch end(next begin block), exomint will mint the reward for the past epoch and transfer from mintAccount to distributionAccount. So the distribution could only distribute that coins after distributionAccount received those coins.


Closes #XXX

Summary by CodeRabbit

  • New Features

    • Enhanced management of epoch-related hooks within the application, ensuring that Exomint module hooks execute before distribution module hooks.
  • Bug Fixes

    • Refined interactions between modules to ensure proper epoch transitions.
  • Refactor

    • Improved the organization and initialization of application modules.

Copy link
Contributor

coderabbitai bot commented Nov 29, 2024

Walkthrough

The changes in this pull request primarily affect the app/app.go file, focusing on the management of epoch hooks within the EpochsKeeper. Key modifications include the addition of app.ExomintKeeper.EpochsHooks() to the SetHooks method, now executed before app.DistrKeeper.EpochsHooks(). This adjustment reorders the execution sequence for epoch hooks, indicating that Exomint module hooks will be processed prior to those of the distribution module. No changes were made to method signatures or public entities.

Changes

File Change Summary
app/app.go Modified SetHooks method: added app.ExomintKeeper.EpochsHooks() before app.DistrKeeper.EpochsHooks(). No changes to public method signatures.

Sequence Diagram(s)

sequenceDiagram
    participant App as Exocore App
    participant EpochsKeeper as Epochs Keeper
    participant DistrKeeper as Distribution Keeper
    participant ExomintKeeper as Exomint Keeper

    App->>EpochsKeeper: SetHooks()
    EpochsKeeper->>ExomintKeeper: EpochsHooks()
    ExomintKeeper-->>EpochsKeeper: Hooks Set
    EpochsKeeper->>DistrKeeper: EpochsHooks()
    DistrKeeper-->>EpochsKeeper: Hooks Retained
Loading

🐇 In the code where the epochs play,
A hook was lost, but one did stay.
The Exomint's here, leading the way,
While distribution's ready to sway!
With keepers aligned, the app's in tune,
Hopping along, like a bright, full moon! 🌙


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 5a979ec and 07d2eaf.

📒 Files selected for processing (1)
  • app/app.go (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • app/app.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>, 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.

CodeRabbit Configuration 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.

@leonz789 leonz789 requested review from MaxMustermann2, trestinlsd and mikebraver and removed request for MaxMustermann2 November 29, 2024 10:28
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: 0

🧹 Outside diff range and nitpick comments (1)
app/app.go (1)

789-793: LGTM! Hook order ensures correct minting and distribution sequence.

The order of epoch hooks is correct and aligns with the PR objective:

  1. ExomintKeeper mints first
  2. DistrKeeper distributes the minted rewards
  3. Remaining hooks follow in a logical sequence for USD value calculation

Consider documenting the rationale for this order in a more detailed comment, especially since there's a note about potential changes once distribution is fully implemented.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 1d03aa3 and 5a979ec.

📒 Files selected for processing (1)
  • app/app.go (1 hunks)

@leonz789
Copy link
Contributor Author

Walkthrough

The changes in this pull request primarily affect the app/app.go file, focusing on the initialization and management of application modules within the Exocore application. Key modifications include adjustments to the SetHooks method for the EpochsKeeper, specifically the removal of a hook related to the ExomintKeeper and the retention of a hook for the DistrKeeper. Additionally, updates were made to the NewExocoreApp constructor, refining the initialization of various keepers while maintaining the overall structure and integrity of the application.

Changes

File Change Summary
app/app.go Modified SetHooks method: removed app.ExomintKeeper.EpochsHooks(); retained app.DistrKeeper.EpochsHooks(). Updated NewExocoreApp constructor for keeper initialization. No changes to public method signatures.

Sequence Diagram(s)

sequenceDiagram
    participant App as Exocore App
    participant EpochsKeeper as Epochs Keeper
    participant DistrKeeper as Distribution Keeper
    participant ExomintKeeper as Exomint Keeper

    App->>EpochsKeeper: SetHooks()
    EpochsKeeper-->>App: Hooks Set
    App->>DistrKeeper: EpochsHooks()
    DistrKeeper-->>App: Hooks Retained
Loading

🐇 In the code where the epochs play,
A hook was lost, but one did stay.
The Exomint's gone, but don't you fret,
For distribution's here, no need to sweat!
With keepers aligned, the app's in tune,
Hopping along, like a bright, full moon! 🌙

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

The exomint is not removed, but just reordered. @coderabbitai

Copy link
Contributor

coderabbitai bot commented Nov 29, 2024

Tip

For best results, initiate chat on the files or code changes.

@leonz789: Thank you for the clarification. I understand now that the ExomintKeeper is not removed but has been reordered in the app/app.go file. I apologize for any confusion in my previous summary.


✏️ Learnings added
Learnt from: leonz789
URL: https://github.com/ExocoreNetwork/exocore/pull/254

Timestamp: 2024-11-29T10:37:46.580Z
Learning: In the Exocore application (`app/app.go`), the `ExomintKeeper` is not removed but is reordered in the code. Changes to the `SetHooks` method involve reordering hooks, and the `ExomintKeeper` remains active.

Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.

@cloud8little cloud8little added this to the Testnet V8 milestone Jan 7, 2025
@leonz789 leonz789 changed the title fix: mint first then distribute [WIP]fix: mint first then distribute Jan 10, 2025
@leonz789 leonz789 marked this pull request as draft February 8, 2025 12:54
@cloud8little cloud8little removed this from the Testnet V8 milestone Feb 10, 2025
Copy link

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 7 days-before-close if no further activity occurs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants