feat(x/mint): Mint issuance using epochs

[likhita-809]

Description

Closes: #19952 Note: This work is referenced from osmosis

---

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.

I have...

• [ ] included the correct type prefix in the PR title
• [ ] confirmed ! in the type prefix if API or client breaking change
• [ ] targeted the correct branch (see PR Targeting)
• [ ] provided a link to the relevant issue or specification
• [ ] reviewed "Files changed" and left comments if necessary
• [ ] included the necessary unit and integration tests
• [ ] added a changelog entry to CHANGELOG.md
• [ ] updated the relevant documentation or specification, including comments for documenting Go code
• [ ] confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.

I have...

• [ ] confirmed the correct type prefix in the PR title
• [ ] confirmed all author checklist items have been addressed
• [ ] reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

• New Features

  • Added a new function to retrieve epoch information.
  • Introduced epoch provisions retrieval function and updated minting module parameters.

• Bug Fixes

  • Updated tests and functions for compatibility with epoch-based minting features.

• Documentation

  • Enhanced README with new epoch-based minting parameters and endpoints.

• Refactor

  • Restructured keeper and module functions to support epoch-based minting.

• Tests

  • Added and updated tests for epoch-based minting functionalities.

• Chores

  • Updated import paths and removed deprecated mock structures to align with new requirements.

[coderabbitai[bot]]

Walkthrough

Walkthrough

The changes migrate the x/mint module from block-based to epoch-based token issuance. This involves modifying the issuance calculation logic to use epochs, defining epoch timers, and adjusting parameters and functions to support this new mechanism. The update ensures consistency and predictability in token issuance by using time-based metrics rather than block numbers.

Changes

File Path	Change Summary
x/epochs/keeper/epoch.go	Added GetEpochInfo function to retrieve epoch information by identifier.
x/mint/depinject.go	Added EpochsKeeper to ModuleInputs struct and included it in the ProvideModule function.
x/mint/keeper/abci.go	Updated BeginBlocker function to include mintAtBeginBlock parameter.
x/mint/keeper/genesis_test.go	Updated GenesisTestSuite to initialize new parameters and include epochsKeeper.
x/mint/keeper/grpc_query_test.go	Added test for equality between epochProvisions.EpochProvisions and minter.EpochProvisions.
x/mint/keeper/keeper.go	Added LastReductionEpoch field to Keeper struct and methods to manipulate it.
x/mint/keeper/keeper_test.go	Removed stakingKeeper and added epochsKeeper in IntegrationTestSuite SetupTest function.
x/mint/module.go	Added migration registration for version 3 to version 4 in RegisterMigrations function.
x/mint/simulation/genesis_test.go	Removed functionality related to BlockProvision, NextAnnualProvisions, and NextInflationRate in TestRandomizedGenState.
x/mint/testutil/expected_keepers_mocks.go	Removed MockStakingKeeper and updated types to use new package location. Added MockEpochsKeeper.
x/mint/types/expected_keepers.go	Removed StakingKeeper interface and added AccountKeeper interface with AddressCodec method.
x/mint/types/genesis.go	Updated NewGenesisState and GenesisState struct to include ReductionStartedEpoch.
x/mint/types/minter.go	Updated NewMinter function to include epochProvisions and added functions to calculate epoch provisions.
x/mint/README.md	Added new parameters and endpoint for querying current minting epoch provisions value.
simapp/app.go	Updated NewSimApp function to modify initialization of app.MintKeeper and app.PoolKeeper.
tests/integration/example/example_test.go	Modified initialization of mintKeeper and mintModule to remove a nil argument.
x/mint/autocli.go	Added new RPC method EpochProvisions to query current minting epoch provisions value.
x/mint/keeper/grpc_query.go	Added EpochProvisions function to queryServer struct to retrieve epoch provisions.
x/mint/proto/cosmos/mint/v1beta1/mint.proto	Added new fields to Minter and Params messages to include epoch-related parameters.

Assessment against linked issues

Objective	Addressed	Explanation
Modify issuance calculation logic to use time-based metrics instead of block numbers (#19952)	✅
Implement mechanism to calculate issuance on a per-epoch basis (#19952)	✅
Define epochs on-chain timers and set module hooks for specific epoch identifiers (#19952)	✅
Remove block-based parameters and functions, replacing them with epoch-based equivalents (#19952)	✅
Update documentation to reflect the new epoch-based parameters and endpoints (#19952)	✅

---

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
• Mastodon
• Reddit
• LinkedIn

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.

[github-actions[bot]]

@likhita-809 your pull request is missing a changelog!

[tac0turtle]

closing in favour of https://github.com/cosmos/cosmos-sdk/pull/20363 for now. We may come back to this if needed