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

Set scope navs in umber upgrade. #2085

Merged
merged 9 commits into from
Jul 19, 2024
Merged

Set scope navs in umber upgrade. #2085

merged 9 commits into from
Jul 19, 2024

Conversation

SpicyLemon
Copy link
Contributor

@SpicyLemon SpicyLemon commented Jul 11, 2024

Description

This PR adds a step to the umber upgrade that will set the NAV info for a bunch of scopes.

It's in "draft" until we get a final updated csv of the entries.


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

  • Improvements

    • Enhanced the changelog for clearer documentation of recent upgrades, including scope NAV details.
    • Introduced new functionality for handling mainnet and testnet scope NAVs, improving data management.
    • Improved the upgrade process with enhanced error handling for better robustness.
    • Increased test coverage with additional scenarios for reading Scope NAVs, ensuring reliability.
  • Logging Updates

    • Added informative log messages during test executions for better insight into scope NAV addition processes.

Copy link
Contributor

coderabbitai bot commented Jul 11, 2024

Walkthrough

This update enhances the application's handling of scope NAVs by introducing new constants for mainnet and testnet configurations, improving test coverage, and incorporating robust error handling in the upgrade process. The changelog entries provide clarity on recent improvements, including the successful implementation of new functionalities, enhancing both the organization of constants and the overall upgrade mechanics.

Changes

Files Change Summary
CHANGELOG.md Added entry for recording scope NAVs related to pull request #2085; clarified improvements.
app/scope_navs_updater.go Introduced umberMainnetScopeNAVsFN; organized constants for scope NAVs.
app/scope_navs_updater_test.go Added new test case to TestReadScopeNAVs to improve test coverage with specific expected values.
app/upgrades.go Added addScopeNAVs function call with error handling for the upgrade process.
app/upgrades_test.go Introduced log messages in TestUmber to document operations during test execution without altering logic.

Sequence Diagram(s)

sequenceDiagram
    participant App
    participant UpgradeProcess
    participant AddScopeNAVs

    App->>UpgradeProcess: Initiate upgrade
    UpgradeProcess->>AddScopeNAVs: Call addScopeNAVs()
    AddScopeNAVs-->>UpgradeProcess: Return success or error
    UpgradeProcess-->>App: Complete upgrade with status
Loading

🐰 In fields of green, we hop with glee,
New NAVs in hand, oh what a spree!
With tests that dance and flows so bright,
Upgrades abound in morning light!
So let us cheer with joyful prance,
For every change, we’ll take a chance! 🎉


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.
    • @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 as 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.

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

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.

@nullpointer0x00 nullpointer0x00 marked this pull request as ready for review July 19, 2024 22:05
@nullpointer0x00 nullpointer0x00 requested a review from a team as a code owner July 19, 2024 22:05
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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 08aff56 and 857ffa3.

Files ignored due to path filters (1)
  • app/upgrade_files/umber/mainnet_scope_navs.csv is excluded by !**/*.csv
Files selected for processing (5)
  • CHANGELOG.md (1 hunks)
  • app/scope_navs_updater.go (1 hunks)
  • app/scope_navs_updater_test.go (1 hunks)
  • app/upgrades.go (1 hunks)
  • app/upgrades_test.go (1 hunks)
Files skipped from review due to trivial changes (1)
  • app/upgrades_test.go
Additional comments not posted (4)
app/scope_navs_updater.go (1)

12-15: LGTM! The constant declaration is well-organized.

The addition of umberMainnetScopeNAVsFN is appropriate and enhances the organization of constants.

app/scope_navs_updater_test.go (1)

35-48: LGTM! The new test case is well-structured.

The addition of the test case for mainnet Scope NAVs enhances test coverage.

app/upgrades.go (1)

150-154: LGTM! The new function call with error handling is well-implemented.

The addition of addScopeNAVs with error handling improves the robustness of the upgrade process.

CHANGELOG.md (1)

43-43: LGTM!

The new entry under the "Improvements" section is clear, follows the existing format, and includes a link to the relevant PR.

@SpicyLemon SpicyLemon enabled auto-merge (squash) July 19, 2024 22:39
@SpicyLemon SpicyLemon merged commit eb052c3 into main Jul 19, 2024
32 checks passed
@SpicyLemon SpicyLemon deleted the dwedul/mainnet-scope-navs branch July 19, 2024 22:41
SpicyLemon added a commit that referenced this pull request Jul 19, 2024
* Add a file with the mainnet navs in them and make sure it can be parsed properly.

* In the umber upgrade, set the scope navs using the mainnet data.

* Add changelog entry.

* update scope data

* add tests for new navs csv

* fix files with proper block height for more recent

---------

Co-authored-by: Carlton N Hanna <[email protected]>
SpicyLemon added a commit that referenced this pull request Jul 19, 2024
* Add a file with the mainnet navs in them and make sure it can be parsed properly.

* In the umber upgrade, set the scope navs using the mainnet data.

* Add changelog entry.

* update scope data

* add tests for new navs csv

* fix files with proper block height for more recent

---------

Co-authored-by: Carlton N Hanna <[email protected]>
Co-authored-by: Ira Miller <[email protected]>
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