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: audit #89

Merged
merged 5 commits into from
Jan 16, 2025
Merged

fix: audit #89

merged 5 commits into from
Jan 16, 2025

Conversation

beer-1
Copy link
Member

@beer-1 beer-1 commented Jan 14, 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, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • updated the relevant documentation or specification, including comments for documenting Go code
  • 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, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • New Features

    • Enhanced multi-send functionality with additional tracking and validation checks.
    • Improved before-send hook mechanism for token factory with contract validation.
    • Simplified burn command by removing the need for a burn-from address.
  • Tests

    • Added test case for handling invalid contract addresses in token factory before-send hook.
    • Streamlined test cases related to minting and burning tokens by removing unnecessary checks.
    • Removed tests associated with deprecated force transfer functionality.
  • Bug Fixes

    • Improved error handling for contract and address-related validations.
    • Removed deprecated force transfer functionality, enhancing overall system clarity.

@beer-1 beer-1 self-assigned this Jan 14, 2025
@beer-1 beer-1 requested a review from a team as a code owner January 14, 2025 04:10
Copy link

coderabbitai bot commented Jan 14, 2025

Walkthrough

The pull request introduces modifications to the bank and tokenfactory modules, focusing on enhancing the multi-send functionality and before-send hook mechanisms. The changes primarily involve improving address handling, adding new validation checks, and expanding test coverage for contract interactions. Several functions related to force transfers have been removed, streamlining the overall functionality and enhancing error handling.

Changes

File Change Summary
x/bank/keeper/msg_server.go - Enhanced MultiSend method with explicit variable declarations
- Improved address conversion and error handling
- Added new tracking function calls before sending coins
x/tokenfactory/keeper/before_send.go - Added logic to handle CosmWasm address validation
- Implemented cache context and contract sudo message creation
- Enhanced error handling for non-existent contracts
x/tokenfactory/keeper/before_send_test.go - Added useInvalidContract field to test cases
- Introduced new test scenario for invalid contract addresses
proto/miniwasm/tokenfactory/v1/tx.proto - Reordered and reformatted import statements
- Removed ForceTransfer method from service definition
- Adjusted message field options formatting
x/tokenfactory/client/cli/tx.go - Updated NewBurnCmd to remove required burn-from-address argument
- Simplified message creation logic for burning tokens
x/tokenfactory/keeper/admins_test.go - Removed test cases for ForceTransfer functionality
- Simplified logic for minting and burning tokens
x/tokenfactory/keeper/msg_server.go - Removed ForceTransfer method
- Updated Burn method to directly use msg.Sender
x/tokenfactory/keeper/msg_server_test.go - Removed TestForceTransferMsgFromModuleAcc test function
x/tokenfactory/types/codec.go - Removed MsgForceTransfer registration from codec functions
x/tokenfactory/types/msgs.go - Removed NewMsgForceTransfer and NewMsgBurnFrom functions
- Streamlined message types by removing force transfer functionality
x/tokenfactory/keeper/bankactions.go - Removed forceTransfer method and associated functionality

Poem

🐰 Tokens dance, addresses leap,
Validation checks, no errors to keep.
CosmWasm whispers, contracts so bright,
MultiSend sails with algorithmic might!
A rabbit's code, precise and clean,
Blockchain magic, forever serene. 🌟


📜 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 0e2a012 and ef0217c.

📒 Files selected for processing (1)
  • x/tokenfactory/keeper/bankactions.go (0 hunks)
💤 Files with no reviewable changes (1)
  • x/tokenfactory/keeper/bankactions.go
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Analyze (go)

🪧 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

@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 (3)
x/tokenfactory/keeper/before_send.go (1)

28-49: Enhance error handling in contract validation.

The contract validation logic could be improved in the following ways:

  1. The error from CacheContext() is being ignored.
  2. The test message could be defined as a constant to avoid repeated allocations.
  3. Consider adding a timeout for the contract call to prevent long-running validations.
 } else {
     // if a contract is being set, call the contract using cache context
     // to test if the contract is an existing, valid contract.
-    cacheCtx, _ := sdk.UnwrapSDKContext(ctx).CacheContext()
+    cacheCtx, writeCache := sdk.UnwrapSDKContext(ctx).CacheContext()
+    defer writeCache()
 
     cwAddr, err := sdk.AccAddressFromBech32(cosmwasmAddress)
     if err != nil {
         return err
     }
 
-    tempMsg := types.TrackBeforeSendSudoMsg{
-        TrackBeforeSend: types.TrackBeforeSendMsg{},
-    }
-    msgBz, err := json.Marshal(tempMsg)
+    msgBz, err := getTestMessage()
     if err != nil {
         return err
     }
     _, err = k.contractKeeper.Sudo(cacheCtx, cwAddr, msgBz)

Add this helper function:

var testMessage = types.TrackBeforeSendSudoMsg{
    TrackBeforeSend: types.TrackBeforeSendMsg{},
}

func getTestMessage() ([]byte, error) {
    return json.Marshal(testMessage)
}
x/bank/keeper/msg_server.go (1)

108-111: Consider adding transaction batching for multiple outputs.

The current implementation processes each output individually, which could be inefficient for transactions with many outputs. Consider batching the before-send hooks for better performance.

 inAddr, err := k.ak.AddressCodec().StringToBytes(input.Address)
 if err != nil {
     return nil, err
 }
 
+// Process all outputs in batches
+const batchSize = 100
+for i := 0; i < len(msg.Outputs); i += batchSize {
+    end := i + batchSize
+    if end > len(msg.Outputs) {
+        end = len(msg.Outputs)
+    }
+    batch := msg.Outputs[i:end]
+    
+    // Process batch...
+}

Also applies to: 114-127

x/tokenfactory/keeper/before_send_test.go (1)

222-233: Consider using a more realistic invalid address.

Instead of using a zeroed address, consider using a valid but non-existent contract address to make the test more realistic.

-cosmwasmAddress = make(sdk.AccAddress, 32)
+// Use a valid bech32 address that doesn't have a contract
+cosmwasmAddress, _ = sdk.AccAddressFromBech32("initia1qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqq9ht8qf")
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3d3584c and cd9e13c.

⛔ Files ignored due to path filters (1)
  • x/tokenfactory/types/tx.pb.go is excluded by !**/*.pb.go
📒 Files selected for processing (3)
  • x/bank/keeper/msg_server.go (2 hunks)
  • x/tokenfactory/keeper/before_send.go (2 hunks)
  • x/tokenfactory/keeper/before_send_test.go (3 hunks)
🔇 Additional comments (4)
x/bank/keeper/msg_server.go (2)

94-95: LGTM! Improved readability.

The change to use a named variable input instead of directly accessing msg.Inputs[0] improves code readability.


130-130: Verify error handling in InputOutputCoins.

The error from InputOutputCoins is properly captured and returned, which is good practice.

x/tokenfactory/keeper/before_send_test.go (2)

150-156: LGTM! Good test structure.

The test case structure is well-organized with clear fields for different test scenarios.


180-186: LGTM! Good test coverage.

The new test case for invalid contract handling improves the test coverage.

Copy link

codecov bot commented Jan 14, 2025

Codecov Report

Attention: Patch coverage is 42.50000% with 23 lines in your changes missing coverage. Please review.

Project coverage is 64.83%. Comparing base (b41cc8d) to head (2087252).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
x/bank/keeper/msg_server.go 0.00% 13 Missing ⚠️
x/tokenfactory/keeper/before_send.go 66.66% 4 Missing and 3 partials ⚠️
x/tokenfactory/client/cli/tx.go 0.00% 3 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main      #89      +/-   ##
==========================================
+ Coverage   64.38%   64.83%   +0.45%     
==========================================
  Files          39       39              
  Lines        3229     3171      -58     
==========================================
- Hits         2079     2056      -23     
+ Misses        972      938      -34     
+ Partials      178      177       -1     
Files with missing lines Coverage Δ
x/tokenfactory/keeper/bankactions.go 48.78% <ø> (-0.38%) ⬇️
x/tokenfactory/keeper/msg_server.go 77.96% <100.00%> (-1.65%) ⬇️
x/tokenfactory/types/codec.go 100.00% <ø> (ø)
x/tokenfactory/types/msgs.go 52.77% <ø> (+12.35%) ⬆️
x/tokenfactory/client/cli/tx.go 0.00% <0.00%> (ø)
x/tokenfactory/keeper/before_send.go 75.45% <66.66%> (-1.22%) ⬇️
x/bank/keeper/msg_server.go 20.32% <0.00%> (-1.61%) ⬇️

Copy link
Contributor

@sh-cha sh-cha left a comment

Choose a reason for hiding this comment

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

LGTM

@beer-1 beer-1 merged commit 01a6543 into main Jan 16, 2025
9 of 10 checks passed
@beer-1 beer-1 deleted the fix/audit branch January 16, 2025 04:17
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.

2 participants