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

Check for blocked address before withdrawing to it #2709

Merged
merged 1 commit into from
Feb 1, 2025
Merged

Conversation

roy-dydx
Copy link
Contributor

@roy-dydx roy-dydx commented Jan 30, 2025

Changelist

  • Checked if account is blocked prior to withdrawing to it.

Test Plan

  • Added test

Author/Reviewer Checklist

  • If this PR has changes that result in a different app state given the same prior state and transaction list, manually add the state-breaking label.
  • If the PR has breaking postgres changes to the indexer add the indexer-postgres-breaking label.
  • If this PR isn't state-breaking but has changes that modify behavior in PrepareProposal or ProcessProposal, manually add the label proposal-breaking.
  • If this PR is one of many that implement a specific feature, manually label them all feature:[feature-name].
  • If you wish to for mergify-bot to automatically create a PR to backport your change to a release branch, manually add the label backport/[branch-name].
  • Manually add any of the following labels: refactor, chore, bug.

Summary by CodeRabbit

  • New Features

    • Enhanced fund transfer validation by adding blocked address checks
    • Improved error handling for unauthorized transfers
  • Bug Fixes

    • Prevented transfers to blocked addresses in subaccount transactions
  • Tests

    • Added test case for blocked address transfer scenarios
    • Updated test infrastructure to support more flexible recipient address testing

@roy-dydx roy-dydx requested a review from a team as a code owner January 30, 2025 22:32
Copy link
Contributor

coderabbitai bot commented Jan 30, 2025

Walkthrough

This pull request introduces changes to address validation and transfer restrictions across multiple files in the subaccounts module. The modifications focus on enhancing the bank keeper's functionality to block specific addresses during fund transfers. The changes include updating the bank keeper initialization, adding a new method to check blocked addresses, and extending test cases to validate the new address restriction logic.

Changes

File Change Summary
protocol/testutil/keeper/bank.go Added imports for authtypes and distrtypes. Modified createBankKeeper to include a blocked distribution module address.
protocol/x/subaccounts/keeper/transfer.go Added sdkerrors import and implemented blocked address check before fund transfers.
protocol/x/subaccounts/keeper/transfer_test.go Added optionalRecipient field to test cases and introduced a new test for blocked address scenarios.
protocol/x/subaccounts/types/expected_keepers.go Added BlockedAddr method to BankKeeper interface for address blocking validation.

Sequence Diagram

sequenceDiagram
    participant Sender
    participant SubaccountKeeper
    participant BankKeeper
    participant Recipient

    Sender->>SubaccountKeeper: Initiate Fund Transfer
    SubaccountKeeper->>BankKeeper: Check Recipient Address
    BankKeeper-->>SubaccountKeeper: Is Address Blocked?
    alt Address Not Blocked
        SubaccountKeeper->>Recipient: Transfer Funds
    else Address Blocked
        SubaccountKeeper-->>Sender: Return Unauthorized Error
    end
Loading

Possibly related PRs

Suggested reviewers

  • vincentwschau
  • tqin7

Poem

🐰 Blockin' addresses with care,
A rabbit's dance of transfer flair!
No funds shall slip where they don't belong,
Our keeper's logic stands strong and long.
Security hops, restrictions tight! 🔒

✨ 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)
protocol/testutil/keeper/bank.go (1)

10-13: LGTM! Good security practice to block the distribution module address.

The changes correctly set up the bank keeper to block transfers to the distribution module address in tests. This aligns with the PR's objective of implementing address blocking and helps prevent accidental transfers to system module accounts.

Consider documenting why the distribution module address is blocked, either in code comments or in the test descriptions, to help future maintainers understand the security implications.

Also applies to: 30-32

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1f3787f and e1dc900.

📒 Files selected for processing (4)
  • protocol/testutil/keeper/bank.go (2 hunks)
  • protocol/x/subaccounts/keeper/transfer.go (2 hunks)
  • protocol/x/subaccounts/keeper/transfer_test.go (5 hunks)
  • protocol/x/subaccounts/types/expected_keepers.go (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • protocol/x/subaccounts/types/expected_keepers.go
  • protocol/x/subaccounts/keeper/transfer.go
⏰ Context from checks skipped due to timeout of 90000ms (9)
  • GitHub Check: test-sim-import-export
  • GitHub Check: test-sim-multi-seed-short
  • GitHub Check: test-sim-after-import
  • GitHub Check: unit-end-to-end-and-integration
  • GitHub Check: test-race
  • GitHub Check: liveness-test
  • GitHub Check: container-tests
  • GitHub Check: test-coverage-upload
  • GitHub Check: Summary
🔇 Additional comments (4)
protocol/x/subaccounts/keeper/transfer_test.go (4)

334-336: LGTM! Good addition of the optional recipient field.

The new optionalRecipient field with a default value mechanism enhances test flexibility by allowing custom recipient addresses while maintaining backward compatibility.


340-353: LGTM! Well-structured test case for blocked address.

The test case effectively verifies that withdrawals to blocked addresses (e.g., distribution module address) are rejected with an unauthorized error. The test setup includes:

  • Appropriate asset positions and perpetual positions
  • Correct error expectation (sdkerrors.ErrUnauthorized)
  • Use of a known blocked address (distrtypes.ModuleName)

488-493: LGTM! Clean implementation of the optional recipient logic.

The implementation properly handles the optional recipient by:

  1. Using a default test account if none is provided
  2. Properly handling any potential errors from address conversion

502-502: LGTM! Consistent usage of optional recipient.

The test setup correctly uses the optional recipient across all relevant operations:

  • Account funding
  • Withdrawal testing
  • Deposit testing
  • Balance verification

Also applies to: 554-554, 561-561, 590-590

@roy-dydx roy-dydx merged commit eb2bb4a into main Feb 1, 2025
22 checks passed
@roy-dydx roy-dydx deleted the roy/withdraw branch February 1, 2025 00:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging this pull request may close these issues.

2 participants