osmosis icon indicating copy to clipboard operation
osmosis copied to clipboard

[NonPoolSuperfluid] Add risk factors to individual denoms.

Open nicolaslara opened this issue 1 year ago • 2 comments

What is the purpose of the change

Add independent risk factors to different superfluid denoms

Testing and Verifying

Added necessary tests

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

nicolaslara avatar May 10 '24 09:05 nicolaslara

should I rename RiskFactor to DiscountFactor?

nicolaslara avatar May 10 '24 11:05 nicolaslara

Walkthrough

The recent updates to the Osmosis superfluid module bring enhancements for managing risk factors tied to specific denominations. Notable changes include new message types and RPC methods for setting and unsetting denomination risk factors, updated risk-adjusted value computations, and related test scenarios. Additionally, the time duration for adjusting Osmo equivalent multipliers has shifted from 1 epoch to 5 minutes.

Changes

File Summary
proto/.../superfluid.proto
proto/.../tx.proto
Introduce DenomRiskFactor message and RPC methods for setting/unsetting risk factors.
x/superfluid/keeper/epoch.go Adjust startTime calculation to 5 minutes in UpdateOsmoEquivalentMultipliers.
x/superfluid/keeper/msg_server.go
x/superfluid/keeper/msg_server_test.go
Add functions and tests for managing denomination risk factors.
x/superfluid/keeper/superfluid_asset.go
x/superfluid/keeper/superfluid_asset_store.go
Implement functions to handle denomination-specific risk factors.
x/superfluid/types/msgs.go Include message types for setting/unsetting denomination risk factors.
x/superfluid/keeper/epoch_test.go
x/superfluid/keeper/integration_test.go
Modify time-related functionalities and tests for enhanced precision.

🐇

In the world of superfluid streams,
Risk factors dance in data dreams.
With new methods to set and clear,
Denom values now crystal clear.
Five-minute tweaks to time's embrace,
Ensuring precision in every case.
Hopping through code, the rabbit's cheer,
For Osmosis grows, year by year.

🌟


Recent Review Details

Configuration used: CodeRabbit UI Review profile: CHILL

Commits Files that changed from the base of the PR and between 722bfb548927b8a78a58b95afa6a98a4fa3cfe9c and f3a3eb40bc2d92829a265d9f42835a07736046dd.
Files selected for processing (1)
  • x/superfluid/keeper/gov/gov_test.go (4 hunks)
Files skipped from review as they are similar to previous changes (1)
  • x/superfluid/keeper/gov/gov_test.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.

coderabbitai[bot] avatar May 21 '24 13:05 coderabbitai[bot]