fix: token already paused unpaused and frozen validation

[pauldelucia]

Issue being fixed or feature implemented

There were no checks to see if tokens were already paused or unpaused when doing those transitions, as well as freezing an already-frozen identity token account.

What was done?

Added the checks and new error messages

How Has This Been Tested?

DET

Breaking Changes

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

• New Features

  • Enhanced error handling for token operations by providing clearer feedback when actions conflict with the current state (e.g., attempting to pause an already paused token or freeze an already frozen account).
  • Strengthened validation logic for emergency actions, freezing, and unfreezing to ensure operations only proceed when appropriate.
  • Introduced specific error types for better granularity in error handling related to token state management.

• Bug Fixes

  • Simplified conditional checks for frozen token accounts to improve code clarity without altering functionality.

• Documentation

  • Updated documentation for methods related to token status to reflect changes in return types and clarify expected behavior.

[coderabbitai]

Walkthrough

The changes introduce new error variants and error types for improved token state management. New variants are added to the StateError enum for handling token pause and freeze conditions. Additionally, new error structs have been defined with associated constructors and getters. Several modules now re-export the new token error types, and validation logic in state transition actions has been updated to leverage these new errors. Method and field names have been renamed (from “frozen_identity_id” to “identity_to_freeze_id”) for clarity, and return types in token status fetching functions have been updated.

Changes

File(s)	Change Summary
packages/rs-dpp/src/errors/consensus/codes.rs packages/rs-dpp/src/errors/consensus/state/state_error.rs	Added new StateError variants: IdentityTokenAccountAlreadyFrozenError, TokenAlreadyPausedError, and TokenNotPausedError; removed an obsolete import.
packages/rs-dpp/src/errors/consensus/state/token/identity_token_account_already_frozen_error.rs packages/rs-dpp/src/errors/consensus/state/token/token_already_paused_error.rs packages/rs-dpp/src/errors/consensus/state/token/token_not_paused_error.rs	Introduced new token error structs with constructors, getters, and From implementations to facilitate detailed error reporting.
packages/rs-dpp/src/errors/consensus/state/token/mod.rs	Added new module declarations and public use statements for the newly added token error types.
packages/rs-drive-abci/src/execution/validation/state_transition/state_transitions/batch/action_validation/token/token_emergency_action_transition_action/state_v0/mod.rs packages/rs-drive-abci/src/execution/validation/state_transition/state_transitions/batch/action_validation/token/token_freeze_transition_action/state_v0/mod.rs packages/rs-drive-abci/src/execution/validation/state_transition/state_transitions/batch/action_validation/token/token_unfreeze_transition_action/state_v0/mod.rs	Enhanced validation logic for token emergency, freeze, and unfreeze actions to check token states and return the appropriate new errors.
packages/rs-drive/src/drive/tokens/status/fetch_token_status/mod.rs	Updated function signatures and comments to return TokenStatus instead of Credits.
packages/rs-drive/src/state_transition_action/action_convert_to_operations/batch/token/token_freeze_transition.rs packages/rs-drive/src/state_transition_action/action_convert_to_operations/batch/token/token_transition.rs packages/rs-drive/src/state_transition_action/batch/batched_transition/token_transition/token_freeze_transition_action/mod.rs packages/rs-drive/src/state_transition_action/batch/batched_transition/token_transition/token_freeze_transition_action/v0/mod.rs packages/rs-drive/src/state_transition_action/batch/batched_transition/token_transition/token_freeze_transition_action/v0/transformer.rs	Renamed methods and fields from frozen_identity_id to identity_to_freeze_id for improved clarity in token freeze operations.
packages/wasm-dpp/src/errors/consensus/consensus_error.rs	Integrated the new token error types into the consensus error handling by adding match cases for them.

Sequence Diagram(s)

sequenceDiagram
  participant Validator as TokenEmergencyValidator
  participant TokenService as TokenStatusService

  Validator ->> TokenService: Fetch token paused status
  TokenService -->> Validator: Return token status
  alt Action is Pause Token
    Validator ->> Validator: If already paused, raise TokenAlreadyPausedError
  else Action is Unfreeze Token
    Validator ->> Validator: If not paused, raise TokenNotPausedError
  end

Loading

sequenceDiagram
  participant Validator as FreezeValidator
  participant TokenInfo as IdentityTokenService

  Validator ->> TokenInfo: Fetch identity token account info
  TokenInfo -->> Validator: Return account status
  alt Account is already frozen
    Validator ->> Validator: Raise IdentityTokenAccountAlreadyFrozenError
  else
    Validator ->> Validator: Proceed with freezing action
  end

Loading

Possibly related PRs

• fix(dpp): invalid feature flag usage #2477: The changes in the main PR are related to the addition of new error variants in the StateError enum, which are also referenced in the retrieved PR's modifications to the validate_state_v0 method for handling token state transitions.
• fix: destroy frozen funds used wrong identity and proof verification #2467: The changes in the main PR, which introduce new error variants to the StateError enum, are directly related to the changes in the retrieved PR, as both involve modifications to error handling for token states, specifically with the introduction of IdentityTokenAccountAlreadyFrozenError, TokenAlreadyPausedError, and TokenNotPausedError.
• fix: check if token is paused on token transfers #2458: The changes in the main PR are related to those in the retrieved PR as both introduce new error variants to the StateError enum, specifically for handling token state conditions, including the addition of error types for paused tokens.

Suggested labels

js-sdk

Suggested reviewers

• QuantumExplorer
• shumkov

Poem

Oh, I'm a rabbit, leaping through code so bright,
New errors and renames make my heart feel light.
With tokens and transitions checked just right,
I hop in joy from morning till night.
Bugs scatter like carrots, out of sight!
Happy hops and clean commits – what a delight!

---

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.

[pauldelucia]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

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

75-98: Use direct boolean check and consider adding a test case
Instead of if info.frozen() == true, consider a more idiomatic if info.frozen() { ... }. Also, ensure there is a corresponding test covering the scenario where the token is already frozen, confirming the validation logic.

packages/rs-drive/src/drive/tokens/status/fetch_token_status/mod.rs (1)

84-84: Update return type in documentation.

The return type in the documentation is incorrect. It should be Result<Option<TokenStatus>, Error> instead of Result<Option<Credits>, Error> to match the actual return type of the function.

-    /// * `Result<Option<Credits>, Error>` - The token info of the Identity if successful, or an error.
+    /// * `Result<Option<TokenStatus>, Error>` - The token status if successful, or an error.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ddf4e67 and e187380.

📒 Files selected for processing (16)

• packages/rs-dpp/src/errors/consensus/codes.rs (1 hunks)
• packages/rs-dpp/src/errors/consensus/state/state_error.rs (2 hunks)
• packages/rs-dpp/src/errors/consensus/state/token/identity_token_account_already_frozen_error.rs (1 hunks)
• packages/rs-dpp/src/errors/consensus/state/token/mod.rs (1 hunks)
• packages/rs-dpp/src/errors/consensus/state/token/token_already_paused_error.rs (1 hunks)
• packages/rs-dpp/src/errors/consensus/state/token/token_not_paused_error.rs (1 hunks)
• packages/rs-drive-abci/src/execution/validation/state_transition/state_transitions/batch/action_validation/token/token_emergency_action_transition_action/state_v0/mod.rs (2 hunks)
• packages/rs-drive-abci/src/execution/validation/state_transition/state_transitions/batch/action_validation/token/token_freeze_transition_action/state_v0/mod.rs (4 hunks)
• packages/rs-drive-abci/src/execution/validation/state_transition/state_transitions/batch/action_validation/token/token_unfreeze_transition_action/state_v0/mod.rs (2 hunks)
• packages/rs-drive/src/drive/tokens/status/fetch_token_status/mod.rs (1 hunks)
• packages/rs-drive/src/state_transition_action/action_convert_to_operations/batch/token/token_freeze_transition.rs (3 hunks)
• packages/rs-drive/src/state_transition_action/action_convert_to_operations/batch/token/token_transition.rs (1 hunks)
• packages/rs-drive/src/state_transition_action/batch/batched_transition/token_transition/token_freeze_transition_action/mod.rs (1 hunks)
• packages/rs-drive/src/state_transition_action/batch/batched_transition/token_transition/token_freeze_transition_action/v0/mod.rs (3 hunks)
• packages/rs-drive/src/state_transition_action/batch/batched_transition/token_transition/token_freeze_transition_action/v0/transformer.rs (2 hunks)
• packages/wasm-dpp/src/errors/consensus/consensus_error.rs (2 hunks)

🔇 Additional comments (19)

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

2-3: Imports appear correct and necessary
These additions cleanly integrate the new error type into the code. No issues spotted.

---

17-21: Imports for new features
These added imports are aligned with the newly introduced token info accessors and consensus error handling. Implementation is straightforward.

---

33-33: Blank line
No comment needed.

packages/rs-dpp/src/errors/consensus/state/token/token_not_paused_error.rs (1)

1-37: Strongly typed error definition looks good
The struct and traits are well-defined and consistent with existing error-handling patterns. Adding doc comments to detail usage scenarios (e.g., when a token is expected to be paused) would further improve maintainability.

packages/rs-dpp/src/errors/consensus/state/token/token_already_paused_error.rs (1)

1-37: Error struct complements the not-paused counterpart
This mirrors the structure of TokenNotPausedError, ensuring symmetrical error handling for pause states. No issues found.

packages/rs-dpp/src/errors/consensus/state/token/identity_token_account_already_frozen_error.rs (2)

9-23: Well-structured error type implementation!

The error type is well-designed with appropriate trait implementations and clear error message format.

---

25-45: LGTM! Efficient getter implementations.

The getters are implemented efficiently, returning references to avoid unnecessary cloning.

packages/rs-dpp/src/errors/consensus/state/token/mod.rs (1)

2-2: Clean module organization!

New error modules are well-organized and follow the existing pattern of module declarations and re-exports.

Also applies to: 10-10, 13-13, 18-18, 26-26, 29-29

packages/rs-drive/src/state_transition_action/batch/batched_transition/token_transition/token_freeze_transition_action/mod.rs (1)

32-42: Improved method naming for better clarity!

The rename from frozen_identity_id to identity_to_freeze_id better reflects the intent of the field, making it clear that this represents the target identity for freezing rather than an already frozen identity.

packages/rs-drive/src/state_transition_action/batch/batched_transition/token_transition/token_freeze_transition_action/v0/mod.rs (1)

13-14: Consistent renaming with improved documentation!

The field and method renames are applied consistently, with updated documentation that clearly describes the purpose of the field.

Also applies to: 77-83

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

53-70: LGTM! Improved validation order and error message clarity.

The changes improve the validation flow by:

1. Checking authorization before fetching token info, which is more efficient.
2. Using a more accurate error message "Unfreeze" that better reflects the action being performed.

Also applies to: 88-88

packages/rs-drive/src/state_transition_action/action_convert_to_operations/batch/token/token_freeze_transition.rs (1)

55-55: LGTM! Improved method naming for better clarity.

The renaming from frozen_identity_id() to identity_to_freeze_id() better communicates the intent of the operation, making it clear that this is the identity that will be frozen rather than one that is already frozen.

Also applies to: 80-80, 90-90

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

75-111: LGTM! Added robust state validation for emergency actions.

The changes add important validation checks that prevent invalid state transitions:

1. Prevents attempting to pause an already paused token
2. Prevents attempting to resume a token that isn't paused
3. Provides clear, action-specific error messages

This improves the robustness of the token emergency action system.

packages/rs-drive/src/state_transition_action/action_convert_to_operations/batch/token/token_transition.rs (1)

86-86: LGTM! Improved method name clarity.

The renaming from frozen_identity_id() to identity_to_freeze_id() better reflects the intent of the operation, making it clearer that this is the identity to be frozen rather than one that is already frozen.

packages/rs-drive/src/state_transition_action/batch/batched_transition/token_transition/token_freeze_transition_action/v0/transformer.rs (1)

114-114: LGTM! Consistent field renaming.

The field renaming from frozen_identity_id to identity_to_freeze_id maintains consistency with the method renaming and improves code clarity by better expressing the intent of the operation.

Also applies to: 223-223

packages/rs-dpp/src/errors/consensus/state/state_error.rs (1)

264-271: LGTM! Enhanced token state validation.

The addition of new error variants improves the token state validation by providing specific error types for:

1. Attempting to freeze an already frozen identity token account
2. Attempting to pause an already paused token
3. Attempting to unpause a token that is not paused

This enhancement aligns well with the PR's objective of implementing better state transition checks.

packages/rs-dpp/src/errors/consensus/codes.rs (1)

258-260: LGTM! Well-organized error codes.

The new error codes are:

• 40162: IdentityTokenAccountAlreadyFrozenError
• 40163: TokenAlreadyPausedError
• 40164: TokenNotPausedError

These are properly organized within the token errors range (40150-40199) and maintain sequential ordering.

packages/wasm-dpp/src/errors/consensus/consensus_error.rs (2)

87-87: LGTM! New token error types are properly imported.

The new token-related error types are correctly grouped with other token errors and follow the established naming pattern.

---

330-338: LGTM! Error handling is properly implemented.

The new match arms for token state errors are correctly implemented using the generic_consensus_error! macro, maintaining consistency with the codebase's error handling patterns.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (4)

packages/rs-dpp/src/state_transition/state_transitions/document/batch_transition/batched_transition/token_freeze_transition/v0/mod.rs (1)

24-28: Update serde attribute to match new field name.

The field has been renamed from frozen_identity_id to identity_to_freeze_id for better clarity. Consider updating the serde attribute to match this intent:

     #[cfg_attr(
         feature = "state-transition-serde-conversion",
-        serde(rename = "frozenIdentityId")
+        serde(rename = "identityToFreezeId")
     )]
     pub identity_to_freeze_id: Identifier,

packages/rs-dpp/src/state_transition/state_transitions/document/batch_transition/batched_transition/token_freeze_transition/v0/v0_methods.rs (3)

55-57: Update method name to match field name.

The method name frozen_identity_id is inconsistent with the field name identity_to_freeze_id it accesses. This could lead to confusion. Consider renaming the method to match the new field name.

-    fn frozen_identity_id(&self) -> Identifier {
+    fn identity_to_freeze_id(&self) -> Identifier {
         self.identity_to_freeze_id
     }

---

58-60: Update setter method and parameter names to match field name.

The setter method name set_frozen_identity_id and parameter name frozen_identity_id are inconsistent with the field name identity_to_freeze_id. Consider updating both for consistency.

-    fn set_frozen_identity_id(&mut self, frozen_identity_id: Identifier) {
-        self.identity_to_freeze_id = frozen_identity_id;
+    fn set_identity_to_freeze_id(&mut self, identity_to_freeze_id: Identifier) {
+        self.identity_to_freeze_id = identity_to_freeze_id;
     }

---

65-69: Use consistent naming in field destructuring.

The destructuring renames identity_to_freeze_id back to frozen_identity_id. Consider updating all references to use the new name consistently.

     let TokenFreezeTransitionV0 {
         base,
-        identity_to_freeze_id: frozen_identity_id,
+        identity_to_freeze_id,
         ..
     } = self;

Then update the method call to use the new name:

     TokenFreezeTransition::calculate_action_id_with_fields(
         base.token_id().as_bytes(),
         owner_id.as_bytes(),
         base.identity_contract_nonce(),
-        frozen_identity_id.as_bytes(),
+        identity_to_freeze_id.as_bytes(),
     )

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d055700 and 7553a78.

📒 Files selected for processing (4)

• packages/rs-dpp/src/state_transition/state_transitions/document/batch_transition/batched_transition/token_freeze_transition/v0/mod.rs (2 hunks)
• packages/rs-dpp/src/state_transition/state_transitions/document/batch_transition/batched_transition/token_freeze_transition/v0/v0_methods.rs (1 hunks)
• packages/rs-dpp/src/state_transition/state_transitions/document/batch_transition/v1/v0_methods.rs (1 hunks)
• packages/rs-drive/src/state_transition_action/batch/batched_transition/token_transition/token_freeze_transition_action/v0/transformer.rs (4 hunks)

✅ Files skipped from review due to trivial changes (1)

• packages/rs-dpp/src/state_transition/state_transitions/document/batch_transition/v1/v0_methods.rs

🚧 Files skipped from review as they are similar to previous changes (1)

• packages/rs-drive/src/state_transition_action/batch/batched_transition/token_transition/token_freeze_transition_action/v0/transformer.rs

⏰ Context from checks skipped due to timeout of 90000ms (19)

• GitHub Check: Rust packages (drive-abci) / Linting
• GitHub Check: Rust packages (drive-abci) / Detect immutable structure changes
• GitHub Check: Rust packages (drive-abci) / Check each feature
• GitHub Check: Rust packages (drive) / Unused dependencies
• GitHub Check: Rust packages (drive) / Tests
• GitHub Check: Rust packages (drive) / Linting
• GitHub Check: Rust packages (dpp) / Unused dependencies
• GitHub Check: Rust packages (dpp) / Tests
• GitHub Check: Rust packages (dpp) / Linting
• GitHub Check: Rust packages (dash-sdk) / Unused dependencies
• GitHub Check: Rust packages (dpp) / Check each feature
• GitHub Check: Rust packages (dash-sdk) / Tests
• GitHub Check: Rust packages (dash-sdk) / Check each feature
• GitHub Check: Rust packages (dash-sdk) / Linting
• GitHub Check: Build Docker images (Drive, drive, drive-abci) / Build Drive image
• GitHub Check: Build Docker images (DAPI, dapi, dapi) / Build DAPI image
• GitHub Check: Build Docker images (Dashmate helper, dashmate-helper, dashmate-helper) / Build Dashmate helper image
• GitHub Check: Build JS packages / Build JS
• GitHub Check: Rust crates security audit

🔇 Additional comments (1)

packages/rs-dpp/src/state_transition/state_transitions/document/batch_transition/batched_transition/token_freeze_transition/v0/mod.rs (1)

40-44: LGTM!

The Display implementation has been correctly updated to use the new field name while maintaining the same formatting structure.

[shumkov]

Good catch! 👍