feat(sdk): enable withdrawals v1 in JS SDK

[shumkov]

Issue being fixed or feature implemented

We should be able to withdraw credits with JS SDK

What was done?

• Switched to Identity Credit Withdrawal Transaction V1

How Has This Been Tested?

With test suite against local network

Breaking Changes

None

Checklist:

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

For repository code-owners and collaborators only

• [x] I have assigned this pull request to a milestone

Summary by CodeRabbit

• New Features

  • Enhanced flexibility in the credit withdrawal process by making the withdrawal address and output script optional.
  • Introduced new structures for managing withdrawal transitions, accommodating different versions for improved flexibility.

• Bug Fixes

  • Improved error handling for invalid withdrawal addresses.

• Documentation

  • Updated method signatures to reflect changes in parameter requirements and added new versioning structures related to identity credit withdrawals.

[coderabbitai[bot]]

Walkthrough

The pull request introduces several modifications across multiple files, primarily focusing on enhancing the flexibility of the creditWithdrawal function and related identity management methods. Key changes include making certain parameters optional, specifically the toAddress in the creditWithdrawal function and the output_script in various identity-related methods. This allows for more adaptable handling of withdrawal requests and identity transitions without requiring all parameters to be explicitly provided.

Changes

File	Change Summary
packages/js-dash-sdk/src/SDK/Client/Platform/methods/identities/creditWithdrawal.ts	Updated WithdrawalOptions type to make signingKeyIndex optional and added toAddress. Modified creditWithdrawal function to use options.toAddress.
packages/rs-dpp/src/identity/identity_factory.rs	Updated create_identity_credit_withdrawal_transition to use IdentityCreditWithdrawalTransitionV1 and changed output_script to Option<CoreScript>.
packages/rs-dpp/src/identity/identity_facade.rs	Changed output_script parameter in create_identity_credit_withdrawal_transition from CoreScript to Option<CoreScript>.
packages/wasm-dpp/src/identity/identity_facade.rs	Changed output_script parameter in create_identity_credit_withdrawal_transition from Vec<u8> to Option<Vec<u8>>. Commented out several unused methods.
packages/wasm-dpp/src/identity/identity_factory.rs	Modified create_identity_credit_withdrawal_transition to change output_script from Vec<u8> to Option<Vec<u8>>.
packages/wasm-dpp/test/integration/identity/IdentityFacade.spec.js	Updated parameter in getIdentityCreditWithdrawalTransitionFixture from 1 to 3 for the IdentityCreditWithdrawalTransition constructor.
packages/wasm-dpp/test/unit/identity/IdentityFactory.spec.js	Changed initialization parameter for IdentityFactory from 1 to 3.

Possibly related issues

• dashpay/platform#2101: This issue discusses enabling withdrawals and creating a new protocol version, which aligns with the changes made to the creditWithdrawal function and related identity management enhancements.

Possibly related PRs

• #2185: This PR focuses on enhancing withdrawal transaction management, which is related to the changes in the creditWithdrawal function that also deals with withdrawal processes.
• #2186: This PR addresses withdrawal fees, which ties into the broader context of withdrawal transactions and their handling, similar to the changes made in the creditWithdrawal function.
• #2191: This PR refactors withdrawal amount validation, which directly relates to the changes in the creditWithdrawal function that also involve withdrawal amounts and their handling.
• #2200: This PR includes small improvements and fixes to the SDK, which may encompass aspects related to the creditWithdrawal function and its integration within the SDK.

Suggested reviewers

• QuantumExplorer

Poem

🐰 In the meadow where bunnies play,
New options bloom, brightening the way.
With scripts that shift and keys that hide,
Flexibility leaps, like a joyful stride.
So hop along, let the changes flow,
For every withdrawal, new paths will grow! 🌼

---

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 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.