fix: upgrade migrate error

[zakir-code]

Summary by CodeRabbit

• New Features

  • Enhanced crosschain parameter migration process during system upgrade
  • Updated token migration logic with new denomination checks

• Bug Fixes

  • Corrected denomination references in crosschain and token migration processes

• Refactor

  • Modified upgrade and migration functions to use consistent denomination (fxtypes.FXDenom)

[coderabbitai]

Walkthrough

The pull request introduces modifications to the upgrade process across multiple files, focusing on crosschain parameter migration and token handling. The changes primarily involve updating the denomination used in various migration and upgrade functions from fxtypes.DefaultDenom to fxtypes.FXDenom. A new function migrateCrosschainParams is added to the upgrade process, which updates crosschain keeper parameters during both testnet and mainnet upgrades.

Changes

File	Change Summary
app/upgrades/v8/upgrade.go	Added migrateCrosschainParams function to update crosschain keeper parameters during upgrade
x/erc20/migrations/v8/keys.go	Modified migrateTokenPair to check base denomination against fxtypes.FXDenom
x/erc20/migrations/v8/migrate.go	Updated token migration methods to use fxtypes.FXDenom instead of fxtypes.DefaultDenom

Sequence Diagram

sequenceDiagram
    participant Upgrade as Upgrade Process
    participant Keeper as Crosschain Keeper
    participant TokenMigration as Token Migration

    Upgrade->>Keeper: Call migrateCrosschainParams
    Keeper-->>Keeper: Update DelegateThreshold.Denom
    Upgrade->>TokenMigration: Migrate Tokens
    TokenMigration-->>TokenMigration: Check and Update Token Pairs

Loading

Possibly related PRs

• fix: token migration in upgrade #845: Modifications to the upgrade.go file related to the upgrade process
• fix: token pair migrate #847: Changes to the migrateTokenPair function in token migration
• fix: upgrade migrate token #854: Focuses on upgrade process and token migration

Poem

🐰 Hopping through code with glee,
Upgrades dance, parameters free!
From Default to FX, we leap,
Crosschain magic we shall keep,
Migration's rabbit-powered spree! 🚀

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e286cd0 and a9f7ea6.

📒 Files selected for processing (3)

• app/upgrades/v8/upgrade.go (3 hunks)
• x/erc20/migrations/v8/keys.go (1 hunks)
• x/erc20/migrations/v8/migrate.go (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: Mergify Merge Protections
• GitHub Check: Summary

🔇 Additional comments (5)

x/erc20/migrations/v8/keys.go (1)

Line range hint 76-82: Verify token pair migration behavior with the new denomination.

The condition for token pair migration has been updated to use fxtypes.FXDenom. This change affects how token pairs are processed during migration.

Run the following script to analyze the impact:

✅ Verification successful

Token pair migration behavior is properly implemented for FXDenom

The migration logic correctly handles token pairs with special consideration for FXDenom:

• Preserves token pairs in storage with proper base denomination mapping
• Maintains consistency with existing FXDenom usage across the codebase
• Includes appropriate metadata validation

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for any existing token pairs that might be affected by the denomination change

# Search for any references to DefaultDenom in token-related code
rg -A 5 "DefaultDenom.*token" 

# Search for any token pair migrations in previous versions
rg -A 5 "migrateTokenPair.*DefaultDenom"

Length of output: 74

---

Script:

#!/bin/bash
# Search for FXDenom usage and token pairs
rg -A 5 "FXDenom"
rg -A 5 "tokenPair"

# Look for keeper implementations
ast-grep --pattern 'type $_ struct {
  ERC20Token $_
  DenomIndex $_
}'

# Check for v8 migration files
fd "v8.*\.go$" --exec cat {}

Length of output: 7766

x/erc20/migrations/v8/migrate.go (3)

Line range hint 80-89: Verify bridge token addition conditions.

The condition for adding FX bridge tokens has been updated. This affects the token bridging process.

✅ Verification successful

Bridge token conditions are correctly implemented

The bridge token conditions implement proper security controls:

• FX tokens can only be bridged through the Ethereum bridge
• Other tokens are bridged through their respective modules
• Additional security measures are in place for mainnet

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check bridge token handling

# Search for bridge token patterns
ast-grep --pattern 'canAddFxBridgeToken := $_ == fxtypes.$_'

Length of output: 62

---

Script:

#!/bin/bash
# Search for FXDenom and bridge token related patterns
echo "=== Searching for FXDenom usage ==="
rg "FXDenom" -A 2 -B 2

echo -e "\n=== Searching for bridge token conditions ==="
rg "canAddBridgeToken|canAddFxBridgeToken" -A 3 -B 3

echo -e "\n=== Checking module definitions ==="
rg "ModuleName.*=.*\"(eth|arbitrum|optimism)\"" -A 1 -B 1

Length of output: 6122

---

20-20: ⚠️ Potential issue

Verify FX bridge token addition with new denomination.

The token addition now uses fxtypes.FXDenom. Ensure this aligns with the token migration strategy.

Run the following script to verify token handling:

✅ Verification successful

Token migration implementation verified as correct

The use of fxtypes.FXDenom is properly integrated into the token migration strategy with appropriate handling for bridge tokens and cross-chain scenarios. The implementation includes necessary validations and proper error handling.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for potential token handling inconsistencies

# Search for token addition patterns
ast-grep --pattern 'addToken($_, fxtypes.$_, $_)'

# Check for any remaining DefaultDenom usage in token addition
rg "addToken.*DefaultDenom"

Length of output: 81

---

Script:

#!/bin/bash
# Search for FXDenom references and usage
rg "FXDenom" -A 2

# Find addToken function implementations
ast-grep --pattern 'func $_ addToken($$$)'

# Look for token-related code in v8 migrations
fd migrate.go --exec cat {} \;

Length of output: 9637

---

27-27: Verify token exclusion logic.

The token exclusion condition has been updated to use fxtypes.FXDenom. This change affects which tokens are excluded from migration.

✅ Verification successful

Token exclusion logic is correctly implemented

The updated token exclusion logic using fxtypes.FXDenom is properly implemented and consistent with the broader migration context. The code correctly handles:

• FX token exclusion
• Empty metadata cases
• PUNDIX exception
• Integration with bridge tokens

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for potential token exclusion issues

# Search for token exclusion patterns
rg -A 5 "continue.*FXDenom"

Length of output: 29

---

Script:

#!/bin/bash
# Search for FXDenom usage in migration context
echo "=== FXDenom Usage ==="
rg -B 2 -A 2 "FXDenom" x/erc20/migrations/

# Search for token migration logic
echo -e "\n=== Token Migration Logic ==="
rg -B 2 -A 2 "DenomUnits|Symbol.*PUNDIX" x/erc20/migrations/

# Check for token metadata handling
echo -e "\n=== Token Metadata Handling ==="
ast-grep --pattern 'if $_ == fxtypes.FXDenom { $$$$ }'

Length of output: 2571

app/upgrades/v8/upgrade.go (1)

88-90: Verify the order of migration operations.

The migrateCrosschainParams function is called in both upgrade paths. Ensure this operation is performed at the correct stage of the upgrade process.

Also applies to: 106-108

✅ Verification successful

The migration order is correctly implemented

The migrateCrosschainParams function is appropriately placed in both upgrade paths:

• As part of the parameter migration sequence alongside other parameter updates
• As a prerequisite operation before running module migrations

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check the upgrade process flow

# Search for other parameter migrations
rg -A 5 "migrate.*Params.*ctx"

Length of output: 3726

---

Script:

#!/bin/bash
# Check upgrade handler registration and dependencies
rg -A 10 "NewUpgradeHandler.*v8"

# Check for any ordering requirements or dependencies
rg -B 5 -A 5 "RunMigrations.*ctx"

Length of output: 719

---

Script:

#!/bin/bash
# Search for the upgrade handler registration and the main upgrade function
ast-grep --pattern 'func CreateUpgradeHandler$_($_, $_, $_) upgradetypes.UpgradeHandler'

# Also check for any upgrade constants or configuration
rg "UpgradeName.*v8|const.*v8"

Length of output: 185

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

• 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>, 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.