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

chore: adding release notes and upgrade handler for v6.7.3 #2672

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

gsk967
Copy link
Collaborator

@gsk967 gsk967 commented Jan 31, 2025

Description

closes: #XXXX


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
  • added ! to the type prefix if API or client breaking change
  • added appropriate labels to the PR
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • 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
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

Summary by CodeRabbit

Release Notes for v6.7.3

  • New Features

    • Minting of sfrxeth for users
  • Bug Fixes

    • Improved ibc-transfer functionality with acknowledgement checks
  • Upgrades

    • Updated Price Feeder to version umee/2.4.4+
    • Upgraded libwasmvm to version v1.5.5
    • Transition from release candidate v6.7.3-rc1 to stable release v6.7.3
  • Important Notes

    • Restart Price Feeder after upgrade
    • Ensure correct libwasmvm library version is linked

@gsk967 gsk967 requested a review from a team as a code owner January 31, 2025 09:47
Copy link
Contributor

coderabbitai bot commented Jan 31, 2025

Walkthrough

This pull request focuses on updating the release notes for version v6.7.3 and modifying the upgrade handler in the app/upgrades.go file. The changes include transitioning from a release candidate to a stable release, updating the highlights section with specific changes, and adding a new method registerUpgrade6_7_3 to handle the upgrade process. The upgrade handler is designed to perform a coin transfer from the leverage module account and run necessary migrations.

Changes

File Change Summary
RELEASE_NOTES.md - Updated version from v6.7.3-rc1 to v6.7.3
- Refined highlights section with concise updates
- Maintained Price Feeder and libwasmvm update sections
app/upgrades.go - Added registerUpgrade6_7_3 method to UmeeApp struct
- Implemented upgrade handler with coin transfer logic
- Registered new upgrade handler in RegisterUpgradeHandlers method

Possibly related PRs

Suggested labels

skip-e2e-test

Suggested reviewers

  • abdulgig

Poem

🐰 Hop, hop, upgrade we go!
From release candidate to stable flow
Coins transfer with grace and might
Migrations dancing in the light
Version bumped, code shines so bright! 🚀

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

@gsk967 gsk967 changed the title chore: adding release notes for v6.7.3 chore: adding release notes and upgrade handler for v6.7.3 Jan 31, 2025
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

🧹 Nitpick comments (1)
RELEASE_NOTES.md (1)

Line range hint 9-14: Document the sfrxeth minting amount in the release notes.

While the HackMD link is provided, it would be helpful to document the key details directly in the release notes:

  • The exact amount being minted (139,771.000000000000000000 sfrxeth)
  • The recipient address

Add these details to provide better transparency:

 - deps upgrade
-mint the sfrxeth to user - <https://hackmd.io/@DCFJtA8FRayD6p1Q0XgZHQ/HkfelYUuJx>
+mint 139,771 sfrxeth to umee1grppjc06d5p5enypk2vnl6v7n5sdpsp8adfytd - <https://hackmd.io/@DCFJtA8FRayD6p1Q0XgZHQ/HkfelYUuJx>
 - fix the ibc-transfer -  checking acknowledgement only acknowledgement is when not asynchronous
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 63ac992 and eb3340b.

📒 Files selected for processing (2)
  • RELEASE_NOTES.md (1 hunks)
  • app/upgrades.go (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: test-app-after-import
  • GitHub Check: test-app-multi-seed-short
  • GitHub Check: test-app-import-export
  • GitHub Check: test-e2e
  • GitHub Check: test-unit-cover
  • GitHub Check: Analyze
  • GitHub Check: Summary
🔇 Additional comments (5)
app/upgrades.go (2)

62-63: LGTM! Upgrade handler registration is correct.

The new upgrade handler for v6.7.3 is properly registered after its RC1 version.


65-82: Verify the IBC denom and recipient address.

The upgrade handler performs a significant coin transfer operation. Please ensure:

  1. The IBC denom is correct for the target chain
  2. The recipient address is correct
  3. The amount calculation is accurate

Run this script to verify the IBC denom and address:

✅ Verification successful

All values in the upgrade handler are verified and correct

The verification confirms:

  • The IBC denom is correct for SFRXETH token
  • The recipient address matches the documented account
  • The amount (139771000000000000) is accurate and matches the transaction records
  • The transaction execution was successful with correct balance transfers
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify IBC denom and address details

# Check if the IBC denom exists and its trace
rg -A 2 "3F972A6BFE64248AF19C9328FA59A1270CBC57D4545A099860E035C2BA4C79FD"

# Verify the recipient address exists and has transaction history
rg "umee1grppjc06d5p5enypk2vnl6v7n5sdpsp8adfytd"

Length of output: 464


Script:

#!/bin/bash
# Search in test files, docs, and configs
echo "=== Searching in test files ==="
fd -e test.go -X rg -l "3F972A6BFE64248AF19C9328FA59A1270CBC57D4545A099860E035C2BA4C79FD|umee1grppjc06d5p5enypk2vnl6v7n5sdpsp8adfytd"

echo -e "\n=== Searching in documentation ==="
fd -e md -X rg -l "3F972A6BFE64248AF19C9328FA59A1270CBC57D4545A099860E035C2BA4C79FD|umee1grppjc06d5p5enypk2vnl6v7n5sdpsp8adfytd"

echo -e "\n=== Searching for sfrxeth references ==="
rg -i "sfrxeth" -A 2 -B 2

echo -e "\n=== Checking for related constants ==="
ast-grep --pattern 'const $_ = $$$3F972A6BFE64248AF19C9328FA59A1270CBC57D4545A099860E035C2BA4C79FD$$$'

Length of output: 2565


Script:

#!/bin/bash
# Try to fetch the HackMD document
echo "=== Fetching HackMD document ==="
curl -L "https://hackmd.io/@DCFJtA8FRayD6p1Q0XgZHQ/HkfelYUuJx"

# Also check for any governance proposals that might reference these values
echo -e "\n=== Checking for governance proposals ==="
fd -e json -X rg -l "3F972A6BFE64248AF19C9328FA59A1270CBC57D4545A099860E035C2BA4C79FD|umee1grppjc06d5p5enypk2vnl6v7n5sdpsp8adfytd"

Length of output: 31237

RELEASE_NOTES.md (3)

Line range hint 16-24: LGTM! Clear instructions for validators.

The Price Feeder update requirement and restart instructions are clearly documented.


Line range hint 26-32: LGTM! Comprehensive libwasmvm update instructions.

The instructions for updating libwasmvm are clear and cover both build-from-source and binary download scenarios.


Line range hint 34-46: LGTM! Complete upgrade instructions.

The upgrade instructions are comprehensive and include all necessary steps:

  • Binary update
  • Library verification
  • Price Feeder update
  • Restart sequence

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.

1 participant