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

fix(evm-precompile): use bank.MsgServer Send in precompile IFunToken.bankMsgSend #2160

Merged
merged 2 commits into from
Jan 10, 2025

Conversation

Unique-Divine
Copy link
Member

@Unique-Divine Unique-Divine commented Jan 10, 2025

Purpose / Abstract

The 3 methods where the above ticket might potentially play a role are sendToBank, sendToEvm and bankMsgSend.

  • sendToBank does not need any changes because it uses "SendCoinsFromModuleToAccount" to send Bank Coins, and this method correctly avoids sending funds to addresses blocked by the Bank module.
  • Similarly, sendToEvm does not need changes because the only bank.MsgSend operation involved is when the signer transfers funds to the EVM module
  • bankMsgSend does include a change because BaseSendKeeper.Send does not have the blocked address check, so I've switched that to use bank.MsgServer.Send, as it's safer and includes the blocking behavior.

Summary by CodeRabbit

  • Bug Fixes
    • Improved bank message sending functionality in EVM precompile
    • Updated bankMsgSend method to use bank.MsgServer Send

@Unique-Divine Unique-Divine requested a review from a team as a code owner January 10, 2025 17:30
Copy link
Contributor

coderabbitai bot commented Jan 10, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request modifies the bankMsgSend method in the funtoken.go file, transitioning from a direct coin sending approach to using a more structured bank.MsgSend object. The change involves constructing a bank message using bankkeeper.NewMsgServerImpl, which provides a more standardized way of executing bank transactions. The implementation now leverages the bankkeeper interface for sending coins, with implicit validation handled by the message structure itself.

Changes

File Change Summary
x/evm/precompile/funtoken.go - Replaced direct SendCoins call with bank.MsgSend construction
- Removed explicit positive amount check
- Added new import statements for bankkeeper and bank
CHANGELOG.md - Added entry for fix related to evm-precompile functionality, specifying the use of bank.MsgServer Send in precompile IFunToken.bankMsgSend

Assessment against linked issues

Objective Addressed Explanation
Fix vulnerability allowing funds to be sent to module addresses (#[2158])
Implement structured bank message sending (#[2158])

Possibly related issues

Possibly related PRs

Suggested reviewers

  • k-yang

Poem

🐰 A Rabbit's Ode to Bank Message Sending 🏦

With MsgSend, our coins now dance and flow,
Structured and clean, a blockchain's gentle glow.
No more direct calls, we've found a better way,
Keeper's magic makes transactions sway!
Hop, hop, hurray for code so bright! 🌟


📜 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 710f160 and 67bf579.

📒 Files selected for processing (2)
  • CHANGELOG.md (1 hunks)
  • x/evm/precompile/funtoken.go (3 hunks)

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.

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)
x/evm/precompile/funtoken.go (1)

717-726: LGTM! Consider adding pre-validations.

The implementation correctly uses the bank.MsgServer pattern with proper validation. Consider adding these pre-validations before constructing the message:

  1. Validate amount is positive
  2. Validate denom format
 // do the bank send
+if amount == nil || amount.Sign() != 1 {
+    return nil, fmt.Errorf("amount must be positive")
+}
+if err := sdk.ValidateDenom(denom); err != nil {
+    return nil, fmt.Errorf("invalid denom: %w", err)
+}
 coin := sdk.NewCoins(sdk.NewCoin(denom, math.NewIntFromBigInt(amount)))
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f7a7007 and 710f160.

📒 Files selected for processing (1)
  • x/evm/precompile/funtoken.go (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: integration-tests
🔇 Additional comments (2)
x/evm/precompile/funtoken.go (2)

9-10: LGTM! Necessary imports added.

The new imports are correctly added to support the bank.MsgServer implementation.


717-726: Verify denom validation across the codebase.

Let's verify that the denom being used is properly validated across the codebase.

✅ Verification successful

Denom validation is properly implemented

The denom validation is handled securely through multiple layers:

  • Bank module's ValidateBasic() validation
  • SDK's standard coin construction methods
  • Message validation before processing
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for denom validation patterns
echo "Searching for denom validation patterns..."
rg "ValidateDenom.*\(.*denom" -A 2

# Search for direct denom usage without validation
echo "Searching for potential missing denom validations..."
ast-grep --pattern 'sdk.NewCoin($denom, $_)'

Length of output: 293


Script:

#!/bin/bash
# Search for bank.MsgSend usage and validation
echo "Searching for MsgSend usage..."
rg "bank\.MsgSend" -A 5

# Search for coin creation patterns
echo "Searching for coin creation patterns..."
rg "NewCoin|NewCoins" -A 2

# Search for ValidateBasic usage
echo "Searching for ValidateBasic calls..."
rg "ValidateBasic\(\)" -A 2

# Search for custom validation methods
echo "Searching for custom validation methods..."
rg "func.*[Vv]alidate.*Denom" -A 5

Length of output: 62534

Comment on lines +721 to +730
bankMsg := &bank.MsgSend{
FromAddress: fromBech32.String(),
ToAddress: toBech32.String(),
Amount: coin,
}
if err := bankMsg.ValidateBasic(); err != nil {
return nil, err
}
if _, err := bankkeeper.NewMsgServerImpl(p.evmKeeper.Bank).Send(
sdk.WrapSDKContext(ctx), bankMsg,
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This adds the block address check to IFunToken.bankMsgSend

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant