Skip to content

fix(dapi): invalid proof for destroy frozen funds transition #2513

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

Merged
merged 2 commits into from
Mar 26, 2025

Conversation

shumkov
Copy link
Contributor

@shumkov shumkov commented Mar 25, 2025

Issue being fixed or feature implemented

Proof verification for destroy frozen funds transition is failing:

Drive error: grovedb: invalid proof: invalid proof verification parameters: invalid proof error Proof is missing data for query

What was done?

  • Request historical token document proof

How Has This Been Tested?

  • With dash evo tool against local network

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

  • New Features
    • Enhanced token transition processing: Events for the destruction of frozen funds are no longer recorded in history, simplifying the handling of token transitions.
    • Consolidated handling for multiple token transition types into a more streamlined approach, reducing complexity in processing.

Copy link
Contributor

coderabbitai bot commented Mar 25, 2025

Walkthrough

This pull request introduces changes to the handling of certain token transitions, specifically adding cases in the keepsHistory function for TokenTransitionType.Claim, TokenTransitionType.ConfigUpdate, TokenTransitionType.EmergencyAction, and TokenTransitionType.DestroyFrozenFunds, all returning true. Additionally, it removes the handling of TokenTransitionType.DestroyFrozenFunds in the fetchProofForStateTransitionFactory function, which previously generated an IdentityTokenBalanceRequest. No public API declarations have been modified.

Changes

File(s) Change Summary
packages/dapi/.../fetchProofForStateTransitionFactory.js Added cases in keepsHistory for TokenTransitionType.Claim, ConfigUpdate, EmergencyAction, and DestroyFrozenFunds (all return true); removed handling for DestroyFrozenFunds in fetchProofForStateTransition.
packages/rs-drive/.../verify_state_transition/v0/mod.rs Removed specific checks and error handling for TokenTransition::DestroyFrozenFunds, EmergencyAction, ConfigUpdate, and Claim; consolidated into a single call to historical_query().

Possibly related PRs

Suggested reviewers

  • QuantumExplorer

Poem

I'm a rabbit who hops with delight,
Seeing code changes that make things right.
Destroyed frozen funds now keep a tale,
With each fixed branch, our efforts prevail.
Hoppity code on, through day and night!
🐰


📜 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 e486331 and 6548e7f.

📒 Files selected for processing (2)
  • packages/dapi/lib/externalApis/drive/fetchProofForStateTransitionFactory.js (1 hunks)
  • packages/rs-drive/src/verify/state_transition/verify_state_transition_was_executed_with_proof/v0/mod.rs (2 hunks)
🧰 Additional context used
🧠 Learnings (1)
packages/dapi/lib/externalApis/drive/fetchProofForStateTransitionFactory.js (1)
Learnt from: shumkov
PR: dashpay/platform#2449
File: packages/dapi/lib/externalApis/drive/fetchProofForStateTransitionFactory.js:110-112
Timestamp: 2025-03-25T08:03:56.379Z
Learning: The getRecipientId() method has different signatures for mint and transfer token transitions - mint requires tokenConfiguration parameter while transfer does not, due to their different logic and states.
⏰ Context from checks skipped due to timeout of 90000ms (11)
  • GitHub Check: Rust packages (dash-sdk) / Tests
  • GitHub Check: Rust packages (drive-abci) / Tests
  • GitHub Check: Rust packages (dash-sdk) / Linting
  • GitHub Check: Rust packages (drive-abci) / Check each feature
  • GitHub Check: Rust packages (drive-abci) / Linting
  • GitHub Check: Rust packages (drive-abci) / Unused dependencies
  • GitHub Check: Rust packages (drive) / Linting
  • GitHub Check: Rust packages (drive) / Tests
  • 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 JS packages / Build JS
🔇 Additional comments (2)
packages/dapi/lib/externalApis/drive/fetchProofForStateTransitionFactory.js (1)

32-37: Addition of history keeping support for more token transition types

The changes correctly add support for keeping history for additional token transition types: Claim, ConfigUpdate, EmergencyAction, and DestroyFrozenFunds. This ensures that historical token documents can be used for proof verification instead of relying on token balance checks, which addresses the proof verification issue mentioned in the PR objective.

packages/rs-drive/src/verify/state_transition/verify_state_transition_was_executed_with_proof/v0/mod.rs (1)

492-495: Consolidated token transition verification with historical query

Excellent consolidation of the token transition types (DestroyFrozenFunds, EmergencyAction, ConfigUpdate, and Claim) to all use the historical_query() function. This simplifies the code and ensures that these transitions are consistently verified using the historical document approach, which resolves the proof verification failure mentioned in the PR objective.

✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 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.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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 self-assigned this Mar 25, 2025
@shumkov shumkov moved this to In Progress in Platform team Mar 25, 2025
@shumkov shumkov moved this from In Progress to In review / testing in Platform team Mar 25, 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/dapi/lib/externalApis/drive/fetchProofForStateTransitionFactory.js (1)

32-34: Consider consistency with other transition types.

While this solution works, note that other transition types like Burn, Mint, etc. use specific configuration methods (e.g., keepsBurningHistory()) to determine history keeping. For consistency, consider asking the token configuration if it should keep history for DestroyFrozenFunds too, rather than hardcoding true.

If this is intentional and DestroyFrozenFunds should always keep history regardless of configuration, it would be helpful to add a comment explaining this design decision.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1b17083 and e486331.

📒 Files selected for processing (1)
  • packages/dapi/lib/externalApis/drive/fetchProofForStateTransitionFactory.js (1 hunks)
🧰 Additional context used
🧠 Learnings (1)
packages/dapi/lib/externalApis/drive/fetchProofForStateTransitionFactory.js (1)
Learnt from: shumkov
PR: dashpay/platform#2449
File: packages/dapi/lib/externalApis/drive/fetchProofForStateTransitionFactory.js:110-112
Timestamp: 2025-03-25T08:03:56.379Z
Learning: The getRecipientId() method has different signatures for mint and transfer token transitions - mint requires tokenConfiguration parameter while transfer does not, due to their different logic and states.
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Build Docker images (DAPI, dapi, dapi) / Build DAPI image
  • GitHub Check: Build JS packages / Build JS
🔇 Additional comments (1)
packages/dapi/lib/externalApis/drive/fetchProofForStateTransitionFactory.js (1)

32-34: Correctly implemented solution for token transition history handling.

This change addresses the proof verification issue identified in the PR objectives for the DestroyFrozenFunds token transition. By forcing this transition type to use the historical document proof path (returning true from keepsHistory), it ensures that a proper proof will be generated rather than hitting the default error case in the switch statement.

The implementation is elegant as it leverages the existing conditional structure in a minimally invasive way. The proof generation will now correctly follow the path at lines 106-119, generating document requests for token history.

@QuantumExplorer QuantumExplorer changed the title fix: invalid proof for destroy frozen funds transition fix(dapi): invalid proof for destroy frozen funds transition Mar 26, 2025
@QuantumExplorer QuantumExplorer merged commit f444e53 into v2.0-dev Mar 26, 2025
73 of 74 checks passed
@QuantumExplorer QuantumExplorer deleted the fix/frozen-funds-proof branch March 26, 2025 04:13
@github-project-automation github-project-automation bot moved this from In review / testing to Done in Platform team Mar 26, 2025
@thephez thephez added this to the v2.0.0 milestone Apr 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants