fix(drive): more than one key was returned when expecting only one result

[shumkov]

Issue being fixed or feature implemented

#2418

What was done?

• Limited number of recent withdrawal keys to 1 to comply with expected return type.
• Replaced unwrap to ?

How Has This Been Tested?

Added an integration test

Breaking Changes

Since this error is happening on check tx we shouldn't have such transitions in the chain

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

Release Notes

• New Features

  • Enhanced identity credit withdrawal process with improved key fetching and error handling
  • Added test coverage for identity credit withdrawal scenarios

• Bug Fixes

  • Improved error handling for transaction state transitions
  • Refined key request and document property conversion logic

• Tests

  • Added comprehensive test for identity credit withdrawal with multiple transfer keys

[coderabbitai]

Walkthrough

The pull request introduces modifications across three files in the Dash Drive repository, focusing on transaction handling, error logging, and identity credit withdrawal transitions. The changes include updating the check_tx function to pass transaction references, adding a new test for identity credit withdrawal, and enhancing the key retrieval and error handling logic in the try_from_identity_credit_withdrawal_v1 method. These modifications aim to improve error tracing, test coverage, and transaction processing robustness.

Changes

File	Change Summary
packages/rs-drive-abci/src/abci/handler/check_tx.rs	- Modified transaction hash generation to pass reference - Added transaction encoding to error logging
packages/rs-drive/src/state_transition_action/identity/identity_credit_withdrawal/transformer.rs	- Added new test module for identity credit withdrawal transitions
packages/rs-drive/src/state_transition_action/identity/identity_credit_withdrawal/v0/transformer.rs	- Adjusted key request limit to Some(1) - Enhanced error handling for disabled keys - Changed document property conversion to use ? operator - Updated timestamp source to block_info.time_ms

Possibly related PRs

• fix(drive): uncommitted state if db transaction fails #2305: Modifies error handling in the finalize_block function related to transaction processing
• feat: hardcoded identity transfers in strategy tests #2312: Enhances identity transfer operations with similar transaction handling logic
• fix(sdk): failed to deserialize consensus error #2410: Addresses deserialization errors related to consensus errors

Suggested reviewers

• QuantumExplorer

Poem

🐰 In the realm of Rust, where bits dance free,
Transactions now pass by reference with glee
Error logs bloom, keys dance their part
Withdrawal logic finds its smart art
CodeRabbit hops, code leaps with might! 🚀

---

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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

packages/rs-drive/src/state_transition_action/identity/identity_credit_withdrawal/transformer.rs (1)

46-107: Consider enhancing the test coverage.

While the test effectively validates the basic functionality with multiple transfer keys, it would be beneficial to explicitly verify that only one key is actually used in the withdrawal process.

Consider adding assertions to verify:

1. Which key was selected
2. That only one key was used in the process

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between be5cd6d and c19c0d3.

📒 Files selected for processing (3)

• packages/rs-drive-abci/src/abci/handler/check_tx.rs (1 hunks)
• packages/rs-drive/src/state_transition_action/identity/identity_credit_withdrawal/transformer.rs (1 hunks)
• packages/rs-drive/src/state_transition_action/identity/identity_credit_withdrawal/v0/transformer.rs (2 hunks)

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

• GitHub Check: Rust packages (drive) / Formatting
• GitHub Check: Rust packages (dash-sdk) / Tests
• GitHub Check: Rust packages (dash-sdk) / Check each feature
• GitHub Check: Rust packages (drive-abci) / Check each feature
• GitHub Check: Rust packages (dash-sdk) / Unused dependencies
• GitHub Check: Rust packages (dash-sdk) / Linting
• GitHub Check: Rust packages (drive-abci) / Tests
• GitHub Check: Rust packages (drive-abci) / Linting
• GitHub Check: Build Docker images (DAPI, dapi, dapi) / Build DAPI image
• GitHub Check: Build Docker images (Drive, drive, drive-abci) / Build Drive image
• GitHub Check: Build Docker images (Dashmate helper, dashmate-helper, dashmate-helper) / Build Dashmate helper image
• GitHub Check: Build JS packages / Build JS

🔇 Additional comments (4)

packages/rs-drive/src/state_transition_action/identity/identity_credit_withdrawal/v0/transformer.rs (3)

96-98: LGTM! This change directly addresses the core issue.

The modification to limit the key request to one result aligns perfectly with the PR's objective of preventing multiple withdrawal keys from being returned.

---

Line range hint 109-134: Well-structured fallback mechanism for handling disabled keys.

The implementation gracefully handles the case where the first key is disabled by:

1. Checking up to 5 additional keys
2. Using reverse iteration to find the most recent non-disabled key
3. Providing clear error messages when no valid keys are found

---

180-180: Good improvement in error handling.

Replacing unwrap() with the ? operator is a better practice as it properly propagates errors instead of panicking.

packages/rs-drive-abci/src/abci/handler/check_tx.rs (1)

154-158: Improved error logging and memory efficiency.

Two good improvements here:

1. Using &tx avoids unnecessary copying when hashing
2. Adding the encoded transaction to error logs will help with debugging

[QuantumExplorer]

This fix is good, well done.