fix: crosschain with origin token

[zakir-code]

Summary by CodeRabbit

Release Notes

• Improvements

  • Enhanced token bridge handling logic
  • Updated bridge token denomination generation method
  • Refined token processing for origin tokens

• Changes

  • Modified parameter names in token-related methods
  • Adjusted bridge token addition and retrieval processes

• Technical Updates

  • Improved cross-chain token management mechanisms

[coderabbitai]

Walkthrough

The pull request introduces modifications to the cross-chain and ERC20 token handling mechanisms across multiple files. The changes primarily focus on refining the bridge token processing logic, including updates to token denomination generation, origin token handling, and method signature adjustments. These modifications aim to improve the precision and flexibility of token management within the cross-chain ecosystem.

Changes

File	Change Summary
x/crosschain/keeper/bridge_token.go	Modified AddBridgeTokenExecuted to change the return value when claim.Symbol matches the default denomination
x/crosschain/keeper/many_to_one.go	Added early exit condition in BaseCoinToBridgeToken for origin tokens
x/erc20/keeper/bridge_token.go	- Renamed method parameters from denom to index in HasToken and GetBaseDenom methods - Updated AddBridgeToken to use types.NewBridgeDenom() instead of bridgeToken.BridgeDenom()

Sequence Diagram

sequenceDiagram
    participant Keeper
    participant BridgeToken
    participant DenomIndex
    
    Keeper->>BridgeToken: Check if origin token
    alt Is Origin Token
        BridgeToken-->>Keeper: Return token immediately
    else Not Origin Token
        Keeper->>DenomIndex: Generate Bridge Denomination
        Keeper->>DenomIndex: Set Denomination Index
    end

Loading

Possibly Related PRs

• refactor(bridge): automate the addition of bridge tokens #881: Changes in AddBridgeTokenExecuted function related to bridge token addition logic

Poem

🐰 Hopping through tokens, bridge and bright,
Crosschain magic takes its flight!
Parameters shift, denominations dance,
Origin tokens get their special chance.
Code hops forward with rabbity might! 🌉

---

📜 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 730035c and ec77830.

📒 Files selected for processing (3)

• x/crosschain/keeper/bridge_token.go (1 hunks)
• x/crosschain/keeper/many_to_one.go (1 hunks)
• x/erc20/keeper/bridge_token.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/keeper/bridge_token.go (3)

11-12: Parameter name change improves clarity

The parameter rename from denom to index better reflects its role as a lookup key in the DenomIndex.

---

15-16: Consistent parameter naming across methods

The parameter rename maintains consistency with the HasToken method, improving code maintainability.

---

61-61: Standardized bridge denomination generation

Using types.NewBridgeDenom instead of bridgeToken.BridgeDenom() ensures consistent bridge denomination generation across the codebase.

Let's verify the consistency of bridge denomination generation:

✅ Verification successful

Bridge denomination generation is standardized and consistent

The codebase consistently uses NewBridgeDenom for creating bridge denominations, with a single implementation in the erc20 module that's properly reused across modules. The BridgeDenom() method internally uses the same standardized implementation.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for all usages of BridgeDenom() and NewBridgeDenom
echo "Checking BridgeDenom usage patterns..."
rg -A 2 "BridgeDenom\(\)" 
echo "Checking NewBridgeDenom usage patterns..."
rg -A 2 "NewBridgeDenom\("

Length of output: 4827

x/crosschain/keeper/bridge_token.go (1)

23-23: Verify DefaultDenom token handling

Changed isNative to false for DefaultDenom tokens. This change affects how the default denomination is processed in the bridge.

Let's verify the impact of this change:

✅ Verification successful

DefaultDenom bridge token handling is correct

The change to set isNative=false for DefaultDenom in bridge token registration is consistent with the codebase architecture. This ensures proper wrapping/unwrapping of FX tokens during cross-chain operations while maintaining its native status within the chain.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for DefaultDenom usage patterns
echo "Checking DefaultDenom handling..."
rg -A 5 "DefaultDenom"

# Search for AddBridgeToken calls with isNative parameter
echo "Checking AddBridgeToken usage patterns..."
rg -A 2 "AddBridgeToken\(.+,.+,.+,.+,.+\)"

Length of output: 70237

---

Script:

#!/bin/bash
# Search for AddBridgeToken method calls with context
echo "Searching AddBridgeToken calls..."
rg -A 5 "AddBridgeToken\(" 

# Search for DefaultDenom handling in erc20 keeper
echo "Searching DefaultDenom in erc20 keeper..."
rg -A 5 "DefaultDenom" x/erc20/keeper/

Length of output: 9730

x/crosschain/keeper/many_to_one.go (1)

43-45: Optimized origin token handling

Added early return for origin tokens, which:

1. Maintains consistency with the BridgeTokenToBaseCoin function's pattern
2. Avoids unnecessary coin operations for origin tokens
3. Improves efficiency by skipping token conversion steps

Let's verify the symmetry of origin token handling:

✅ Verification successful

Verified: Origin token handling is consistent

The early return pattern for origin tokens in BaseCoinToBridgeToken is verified to be:

• Symmetric with BridgeTokenToBaseCoin
• Consistent with origin token handling across the codebase
• Properly integrated with other token operations

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for IsOrigin() checks and their handling patterns
echo "Checking IsOrigin handling patterns..."
rg -B 2 -A 5 "IsOrigin\(\)"

Length of output: 3908

Finishing Touches

• 📝 Generate Docstrings

---

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.