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(drive): transfer to frozen account is allowed #2478

Open
wants to merge 2 commits into
base: v2.0-dev
Choose a base branch
from

Conversation

shumkov
Copy link
Member

@shumkov shumkov commented Feb 20, 2025

Issue being fixed or feature implemented

Transfer to frozen account is currently allowed.

What was done?

  • Added validation to prevent transfer to frozen account
  • Use correct version for transfer state validation

How Has This Been Tested?

With existing tests

Breaking Changes

None

Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added or updated relevant unit/integration/functional/e2e tests
  • I have added "!" to the title and described breaking changes in the corresponding section if my code contains any
  • I have made corresponding changes to the documentation if needed

For repository code-owners and collaborators only

  • I have assigned this pull request to a milestone

Summary by CodeRabbit

  • Bug Fixes
    • Updated the token transfer process to use the correct validation configuration, ensuring transfers are evaluated reliably.
    • Enhanced the security of token transfers by adding checks to prevent transactions when either the sender's or the recipient's account is frozen.

Copy link
Contributor

coderabbitai bot commented Feb 20, 2025

Walkthrough

This pull request updates the token transfer validation logic. In the main validation file, the platform version configuration is switched from token issuance validation to token transfer validation. In the version 0 implementation, the logic now additionally checks if the recipient's token account is frozen (in addition to the sender's account check) before proceeding with the token transfer process. All changes maintain the existing error handling and overall structure of the validation functions, without any changes to public APIs.

Changes

File Path Change Summary
packages/rs-drive-abci/.../token_transfer_transition_action/mod.rs Updated the validate_state method to reference token_transfer_transition_state_validation rather than token_issuance_transition_state_validation.
packages/rs-drive-abci/.../token_transfer_transition_action/state_v0/mod.rs Enhanced validate_state_v0 by adding validation for the recipient's token account freeze state alongside the sender's check; removed redundant comparisons and incorporated additional execution context operations.

Sequence Diagram(s)

sequenceDiagram
    participant Client as Caller
    participant Validator as TokenTransferValidation
    participant Sender as SenderAccount
    participant Receiver as RecipientAccount

    Client->>Validator: initiate state transfer validation
    Validator->>Sender: fetch sender identity token info & balance
    Sender-->>Validator: return sender status (frozen/not)
    alt sender account frozen
        Validator->>Client: return error (sender frozen)
    else
        Validator->>Receiver: fetch recipient token account info
        Receiver-->>Validator: return recipient status (frozen/not)
        alt recipient account frozen
            Validator->>Client: return error (recipient frozen)
        else
            Validator->>Client: validation passed, proceed with transfer
        end
    end
Loading

Possibly related PRs

Suggested reviewers

  • QuantumExplorer

Poem

Hop, hop, the tokens prance,
In our code where validations dance.
Sender and receiver now stand clear,
No frozen accounts causing fear.
With careful checks at every turn,
A bunny’s cheer we proudly earn!
🐇💻


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.

@shumkov shumkov changed the title fix/transfer-to-fronzen-account fix(drive): transfer to frozen account is allowed Feb 20, 2025
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)
packages/rs-drive-abci/src/execution/validation/state_transition/state_transitions/batch/action_validation/token/token_transfer_transition_action/state_v0/mod.rs (1)

79-130: Consider refactoring frozen account checks to reduce duplication.

The frozen account validation logic is duplicated for sender and recipient. Consider extracting this into a helper method to improve maintainability.

 impl TokenTransferTransitionActionStateValidationV0 for TokenTransferTransitionAction {
+    fn validate_frozen_account(
+        &self,
+        platform: &PlatformStateRef,
+        identity_id: Identifier,
+        block_info: &BlockInfo,
+        execution_context: &mut StateTransitionExecutionContext,
+        transaction: TransactionArg,
+        platform_version: &PlatformVersion,
+    ) -> Result<SimpleConsensusValidationResult, Error> {
+        let (info, fee_result) = platform.drive.fetch_identity_token_info_with_costs(
+            self.token_id().to_buffer(),
+            identity_id.to_buffer(),
+            block_info,
+            true,
+            transaction,
+            platform_version,
+        )?;
+
+        execution_context.add_operation(ValidationOperation::PrecalculatedOperation(fee_result));
+
+        if let Some(info) = info {
+            if info.frozen() {
+                return Ok(SimpleConsensusValidationResult::new_with_error(
+                    ConsensusError::StateError(StateError::IdentityTokenAccountFrozenError(
+                        IdentityTokenAccountFrozenError::new(
+                            self.token_id(),
+                            identity_id,
+                            "transfer".to_string(),
+                        ),
+                    )),
+                ));
+            }
+        };
+
+        Ok(SimpleConsensusValidationResult::new())
+    }
+
     fn validate_state_v0(
         &self,
         platform: &PlatformStateRef,
         owner_id: Identifier,
         block_info: &BlockInfo,
         execution_context: &mut StateTransitionExecutionContext,
         transaction: TransactionArg,
         platform_version: &PlatformVersion,
     ) -> Result<SimpleConsensusValidationResult, Error> {
         // ... existing balance validation ...

-        // We need to verify that our token account is not frozen
-        let (info, fee_result) = platform.drive.fetch_identity_token_info_with_costs(
-            self.token_id().to_buffer(),
-            owner_id.to_buffer(),
-            block_info,
-            true,
-            transaction,
-            platform_version,
-        )?;
-
-        execution_context.add_operation(ValidationOperation::PrecalculatedOperation(fee_result));
-
-        if let Some(info) = info {
-            if info.frozen() {
-                return Ok(SimpleConsensusValidationResult::new_with_error(
-                    ConsensusError::StateError(StateError::IdentityTokenAccountFrozenError(
-                        IdentityTokenAccountFrozenError::new(
-                            self.token_id(),
-                            owner_id,
-                            "transfer".to_string(),
-                        ),
-                    )),
-                ));
-            }
-        };
+        // Verify that sender's token account is not frozen
+        let validation_result = self.validate_frozen_account(
+            platform,
+            owner_id,
+            block_info,
+            execution_context,
+            transaction,
+            platform_version,
+        )?;
+        if !validation_result.is_valid() {
+            return Ok(validation_result);
+        }

-        // We need to verify that account we are transferring to not frozen
-        let (info, fee_result) = platform.drive.fetch_identity_token_info_with_costs(
-            self.token_id().to_buffer(),
-            self.recipient_id().to_buffer(),
-            block_info,
-            true,
-            transaction,
-            platform_version,
-        )?;
-
-        execution_context.add_operation(ValidationOperation::PrecalculatedOperation(fee_result));
-
-        if let Some(info) = info {
-            if info.frozen() {
-                return Ok(SimpleConsensusValidationResult::new_with_error(
-                    ConsensusError::StateError(StateError::IdentityTokenAccountFrozenError(
-                        IdentityTokenAccountFrozenError::new(
-                            self.token_id(),
-                            self.recipient_id(),
-                            "transfer".to_string(),
-                        ),
-                    )),
-                ));
-            }
-        };
+        // Verify that recipient's token account is not frozen
+        let validation_result = self.validate_frozen_account(
+            platform,
+            self.recipient_id(),
+            block_info,
+            execution_context,
+            transaction,
+            platform_version,
+        )?;
+        if !validation_result.is_valid() {
+            return Ok(validation_result);
+        }

         // ... existing token status validation ...
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5e32426 and a63f8f5.

📒 Files selected for processing (2)
  • packages/rs-drive-abci/src/execution/validation/state_transition/state_transitions/batch/action_validation/token/token_transfer_transition_action/mod.rs (1 hunks)
  • packages/rs-drive-abci/src/execution/validation/state_transition/state_transitions/batch/action_validation/token/token_transfer_transition_action/state_v0/mod.rs (4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: Rust packages (drive-abci) / Tests
  • GitHub Check: Rust packages (drive-abci) / Check each feature
  • GitHub Check: Rust packages (drive-abci) / Unused dependencies
  • GitHub Check: Rust packages (drive-abci) / Linting
  • GitHub Check: Rust packages (drive-abci) / Formatting
  • GitHub Check: Build Docker images (Drive, drive, drive-abci) / Build Drive image
  • GitHub Check: Build JS packages / Build JS
🔇 Additional comments (5)
packages/rs-drive-abci/src/execution/validation/state_transition/state_transitions/batch/action_validation/token/token_transfer_transition_action/mod.rs (1)

71-71: LGTM! Using the correct validation context.

The change from token_issuance_transition_state_validation to token_transfer_transition_state_validation ensures that the correct validation context is used for token transfers.

packages/rs-drive-abci/src/execution/validation/state_transition/state_transitions/batch/action_validation/token/token_transfer_transition_action/state_v0/mod.rs (4)

62-63: LGTM! Added cost tracking for balance retrieval.

Properly tracking the cost of balance retrieval operation in the execution context.


89-90: LGTM! Added cost tracking for sender's token info.

Properly tracking the cost of fetching sender's token info in the execution context.


105-130: LGTM! Added validation for recipient's frozen account.

The implementation prevents transfers to frozen accounts by validating the recipient's token account status. The error handling is consistent with the sender's frozen account check.

This change directly addresses the PR objective of preventing transfers to frozen accounts.


139-140: LGTM! Added cost tracking for token status.

Properly tracking the cost of fetching token status in the execution context.

@pauldelucia
Copy link
Member

The code LGTM except for breaking the test, but I'm not sure we want to do this. I can imagine scenarios where sending to a frozen identity would be useful. Like if we have a contract that collects funds in a frozen account to be unfrozen at a specific date/time.

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