v1.18.0 mainnet upgrade handler for net asset values and block height of pricing timestamp

[nullpointer0x00]

Description

This PR updates marker Net Asset Values (NAV) on the blockchain using the latest data from the Figures Pricing API, ensuring values accurately reflect current market conditions. The API provides prices like $1.23, which we represent as an integer 1230 to maintain precision. Data is sourced from https://figure.tech/service-pricing-engine/external/api/v1/pricing/marker/new?time=2024-03-21T00:00:00.000000Z. Each update aligns the NAV with the blockchain block height according to the pricingTimestamp, enhancing transparency and accuracy in marker valuations.

closes: #XXXX

---

Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

• Targeted PR against correct branch (see CONTRIBUTING.md)
• Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
• Wrote unit and integration tests
• Updated relevant documentation (docs/) or specification (x/<module>/spec/)
• Added relevant godoc comments.
• Added a relevant changelog entry to the Unreleased section in CHANGELOG.md
• Re-reviewed Files changed in the Github PR explorer
• Review Codecov Report in the comment section below once CI passes

Summary by CodeRabbit

• New Features

  • Introduced an upgrade handler for setting net asset values and updating block heights for specific network markers.
  • Added functionality to update net asset values with corresponding heights for markers during the upgrade process.

• Chores

  • Added a note for future removal of specific functionality in the codebase.

• Tests

  • Implemented tests to verify the addition and update of marker net asset values with heights.

[coderabbitai]

Walkthrough

This update introduces a feature to manage net asset values (NAVs) with block heights for markers in the pio-mainnet-1 environment. It includes the ability to update NAVs alongside block heights, preparing the system for future upgrades. Additionally, it plans for the removal of saffron handler functionality, streamlining operations related to NAVs.

Changes

Files	Change Summary
app/navs_mainnet.go	Added a TODO to remove saffron handlers in future updates.
app/upgrades.go, app/upgrades_test.go	Added functions to update marker NAVs with heights, including tests to verify functionality.
x/marker/keeper/keeper.go	Introduced a function to set NAVs with block heights for markers, enhancing data accuracy and event logging.

"In the realm of code, where logic does play,
A rabbit hopped in, with an upgrade today.
🌟 With a flick and a hop, NAVs set to grow,
Block heights align, in a seamless flow.
🐾 Follow the tracks, where the data does weave,
A tale of markers, in the code we believe."
🚀🐰

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-tests 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 tests 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 tests.
  • @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.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 7ce0517 and dd35ab4.

Files selected for processing (5)

• CHANGELOG.md (1 hunks)
• app/navs_mainnet.go (1 hunks)
• app/upgrades.go (2 hunks)
• app/upgrades_test.go (2 hunks)
• x/marker/keeper/keeper.go (1 hunks)

Additional comments: 8

x/marker/keeper/keeper.go (1)

• 321-342: The implementation of SetNetAssetValueWithBlockHeight correctly updates the net asset value with a specific block height, validates the net asset value, emits an event, and stores the updated value. However, consider the following improvements for robustness and security:

• Ensure that the marker and netAssetValue parameters are validated at the beginning of the function to prevent processing invalid data.
• Verify that all possible error paths are handled appropriately to ensure that the function behaves predictably in all scenarios.

Overall, the function aligns with the objectives of updating net asset values with specific block heights and enhancing transparency and accuracy in marker valuations.

app/upgrades.go (2)

• 316-334: The implementation of addMarkerNavsWithHeight correctly iterates over net asset values with heights and updates the corresponding markers. Consider the following improvements for enhanced robustness and clarity:

• Ensure comprehensive error handling to address potential issues during marker retrieval and net asset value updates.
• Enhance logging to provide more detailed information for debugging purposes, especially in error scenarios.

These improvements will help maintain the function's reliability and ease troubleshooting in the future.

• 154-154: The addition of addMarkerNavsWithHeight to the tourmaline upgrade handler is appropriate and aligns with the upgrade's objectives of setting net asset values with heights for markers. Ensure that the function is called with the correct parameters and at the right point in the upgrade process to maintain the integrity and accuracy of the upgrade.

app/upgrades_test.go (2)

• 461-462: The addition of logging for "Adding marker net asset values with heights." and its completion is a good practice for transparency during the upgrade process. It helps in debugging and provides clear checkpoints within the upgrade logs.
• 815-889: This test function TestAddMarkerNavsWithHeight effectively covers the scenario of adding marker net asset values with specific heights. However, it's crucial to ensure that the test cases cover a wide range of scenarios, including edge cases such as markers with zero supply or markers that already have NAVs set. Additionally, verifying the absence of NAVs for markers where the addition is expected to fail (e.g., nosupplycoin1) is a good practice to ensure the robustness of the upgrade handler.

One improvement could be to add more comments within the test to explain the purpose of each block or scenario being tested, enhancing readability and maintainability for future developers.

CHANGELOG.md (1)

• 42-42: The addition of the upgrade handler for setting net asset values and updating block height for pio-mainnet-1 is a significant feature. Ensure that the implementation aligns with the project's objectives for accuracy and transparency in marker valuations.

app/navs_mainnet.go (2)

• 12-12: The TODO comment mentions removing functionality related to saffron handlers. It would be beneficial to provide more context or link to a tracking issue for better tracking and understanding of this future task.
• 12-12: The function GetPioMainnet1DenomToNav returns hardcoded net asset values. Consider fetching these values from a configuration file or an external service to improve maintainability and flexibility, especially if these values are subject to frequent updates or changes.