feat(sdk): enable withdrawals v1 in JS SDK (#2201)

dashpay · Oct 4, 2024 · 8773afa · 8773afa
1 parent 37b5ea4
commit 8773afa
Show file tree

Hide file tree

Showing 18 changed files with 138 additions and 53 deletions.
diff --git a/.yarn/cache/fsevents-patch-19706e7e35-10.zip b/.yarn/cache/fsevents-patch-19706e7e35-10.zip
diff --git a/packages/js-dash-sdk/src/SDK/Client/Platform/methods/identities/creditWithdrawal.ts b/packages/js-dash-sdk/src/SDK/Client/Platform/methods/identities/creditWithdrawal.ts
@@ -28,37 +28,50 @@ const MIN_ASSET_UNLOCK_CORE_FEE_PER_BYTE = 1;
 const MINIMAL_WITHDRAWAL_AMOUNT = ASSET_UNLOCK_TX_SIZE * MIN_ASSET_UNLOCK_CORE_FEE_PER_BYTE * 1000;
 
 type WithdrawalOptions = {
-  signingKeyIndex: number
+  signingKeyIndex?: number
+  toAddress?: string
 };
 
 /** Creates platform credits withdrawal request
  * @param identity - identity to withdraw from
  * @param amount - amount of credits to withdraw
- * @param to - Dash L1 address
  * @param options - withdrawal options
+ * @param [options] - withdrawal options
+ * @param [options.toAddress] - withdrawal destination address
  */
 export async function creditWithdrawal(
   this: Platform,
   identity: Identity,
   amount: number,
-  to: string,
-  options: WithdrawalOptions = {
-    signingKeyIndex: 3,
-  },
+  options: WithdrawalOptions = { },
 ): Promise<Metadata> {
   await this.initialize();
 
+  // eslint-disable-next-line no-param-reassign
+  options = {
+    ...options,
+    signingKeyIndex: 3,
+  };
+
   const { dpp } = this;
 
-  let toAddress: Address;
-  try {
-    toAddress = new Address(to, this.client.network);
-  } catch (e) {
-    throw new Error(`Invalid core recipient "${to}" for network ${this.client.network}`);
+  let outputScriptBytes: Buffer | undefined;
+  if (options.toAddress) {
+    let toAddress: Address;
+    try {
+      toAddress = new Address(options.toAddress, this.client.network);
+    } catch (e) {
+      throw new Error(`Invalid core recipient "${options.toAddress}" for network ${this.client.network}`);
+    }
+
+    const outputScript = Script.buildPublicKeyHashOut(toAddress);
+    // @ts-ignore
+    outputScriptBytes = outputScript.toBuffer();
+
+    this.logger.debug(`[Identity#creditWithdrawal] credits withdrawal from ${identity.getId().toString()} to ${toAddress.toString()} with amount ${amount}`);
+  } else {
+    this.logger.debug(`[Identity#creditWithdrawal] credits withdrawal from ${identity.getId().toString()} to recent withdrawal address with amount ${amount}`);
   }
-  this.logger.debug(`[Identity#creditWithdrawal] credits withdrawal from ${identity.getId().toString()} to ${toAddress.toString()} with amount ${amount}`);
-
-  const outputScript = Script.buildPublicKeyHashOut(toAddress);
 
   const balance = identity.getBalance();
   if (amount > balance) {
@@ -88,8 +101,7 @@ export async function creditWithdrawal(
       BigInt(amount),
       coreFeePerByte,
       DEFAULT_POOLING,
-      // @ts-ignore
-      outputScript.toBuffer(),
+      outputScriptBytes,
       BigInt(identityNonce),
     );
 

diff --git a/packages/rs-dpp/src/identity/identity_facade.rs b/packages/rs-dpp/src/identity/identity_facade.rs
@@ -123,7 +123,7 @@ impl IdentityFacade {
         amount: u64,
         core_fee_per_byte: u32,
         pooling: Pooling,
-        output_script: CoreScript,
+        output_script: Option<CoreScript>,
         identity_nonce: u64,
     ) -> Result<IdentityCreditWithdrawalTransition, ProtocolError> {
         self.factory.create_identity_credit_withdrawal_transition(

diff --git a/packages/rs-dpp/src/identity/identity_factory.rs b/packages/rs-dpp/src/identity/identity_factory.rs
@@ -43,6 +43,8 @@ use crate::state_transition::identity_credit_transfer_transition::IdentityCredit
 #[cfg(all(feature = "state-transitions", feature = "client"))]
 use crate::state_transition::identity_credit_withdrawal_transition::v0::IdentityCreditWithdrawalTransitionV0;
 #[cfg(all(feature = "state-transitions", feature = "client"))]
+use crate::state_transition::identity_credit_withdrawal_transition::v1::IdentityCreditWithdrawalTransitionV1;
+#[cfg(all(feature = "state-transitions", feature = "client"))]
 use crate::state_transition::identity_credit_withdrawal_transition::IdentityCreditWithdrawalTransition;
 #[cfg(all(feature = "state-transitions", feature = "client"))]
 use crate::state_transition::identity_topup_transition::accessors::IdentityTopUpTransitionAccessorsV0;
@@ -233,22 +235,61 @@ impl IdentityFactory {
         amount: u64,
         core_fee_per_byte: u32,
         pooling: Pooling,
-        output_script: CoreScript,
+        output_script: Option<CoreScript>,
         identity_nonce: IdentityNonce,
     ) -> Result<IdentityCreditWithdrawalTransition, ProtocolError> {
-        let identity_credit_withdrawal_transition = IdentityCreditWithdrawalTransitionV0 {
-            identity_id,
-            amount,
-            core_fee_per_byte,
-            pooling,
-            output_script,
-            nonce: identity_nonce,
-            ..Default::default()
+        let platform_version = PlatformVersion::get(self.protocol_version)?;
+
+        let identity_credit_withdrawal_transition = match platform_version
+            .dpp
+            .state_transitions
+            .identities
+            .credit_withdrawal
+            .default_constructor
+        {
+            0 => {
+                let output_script = output_script.ok_or_else(|| {
+                    ProtocolError::Generic(
+                        "Output script is required for IdentityCreditWithdrawalTransitionV0"
+                            .to_string(),
+                    )
+                })?;
+
+                let transition = IdentityCreditWithdrawalTransitionV0 {
+                    identity_id,
+                    amount,
+                    core_fee_per_byte,
+                    pooling,
+                    output_script,
+                    nonce: identity_nonce,
+                    ..Default::default()
+                };
+
+                IdentityCreditWithdrawalTransition::from(transition)
+            }
+            1 => {
+                let transition = IdentityCreditWithdrawalTransitionV1 {
+                    identity_id,
+                    amount,
+                    core_fee_per_byte,
+                    pooling,
+                    output_script,
+                    nonce: identity_nonce,
+                    ..Default::default()
+                };
+
+                IdentityCreditWithdrawalTransition::from(transition)
+            }
+            version => {
+                return Err(ProtocolError::UnknownVersionMismatch {
+                    method: "create_identity_credit_withdrawal_transition".to_string(),
+                    known_versions: vec![0, 1],
+                    received: version,
+                });
+            }
         };
 
-        Ok(IdentityCreditWithdrawalTransition::from(
-            identity_credit_withdrawal_transition,
-        ))
+        Ok(identity_credit_withdrawal_transition)
     }
 
     #[cfg(all(feature = "state-transitions", feature = "client"))]

diff --git a/.../state_transition/state_transitions/identity/identity_credit_withdrawal_transition/mod.rs b/.../state_transition/state_transitions/identity/identity_credit_withdrawal_transition/mod.rs
@@ -73,8 +73,10 @@ impl IdentityCreditWithdrawalTransition {
     pub fn default_versioned(platform_version: &PlatformVersion) -> Result<Self, ProtocolError> {
         match platform_version
             .dpp
-            .identity_versions
-            .identity_structure_version
+            .state_transitions
+            .identities
+            .credit_withdrawal
+            .default_constructor
         {
             0 => Ok(IdentityCreditWithdrawalTransition::V0(
                 IdentityCreditWithdrawalTransitionV0::default(),

diff --git a/packages/rs-platform-version/src/version/dpp_versions.rs b/packages/rs-platform-version/src/version/dpp_versions.rs
@@ -27,6 +27,12 @@ pub struct StateTransitionVersions {
 pub struct IdentityTransitionVersions {
     pub max_public_keys_in_creation: u16,
     pub asset_locks: IdentityTransitionAssetLockVersions,
+    pub credit_withdrawal: IdentityCreditWithdrawalTransitionVersions,
+}
+
+#[derive(Clone, Debug, Default)]
+pub struct IdentityCreditWithdrawalTransitionVersions {
+    pub default_constructor: FeatureVersion,
 }
 
 #[derive(Clone, Debug, Default)]

diff --git a/packages/rs-platform-version/src/version/mocks/v2_test.rs b/packages/rs-platform-version/src/version/mocks/v2_test.rs
@@ -7,8 +7,9 @@ use crate::version::dpp_versions::{
     DocumentTypeClassMethodVersions, DocumentTypeIndexVersions, DocumentTypeMethodVersions,
     DocumentTypeSchemaVersions, DocumentTypeValidationVersions, DocumentTypeVersions,
     DocumentVersions, DocumentsBatchTransitionValidationVersions, DocumentsBatchTransitionVersions,
-    IdentityKeyTypeMethodVersions, IdentityTransitionAssetLockVersions, IdentityTransitionVersions,
-    IdentityVersions, JsonSchemaValidatorVersions, PublicKeyInCreationMethodVersions,
+    IdentityCreditWithdrawalTransitionVersions, IdentityKeyTypeMethodVersions,
+    IdentityTransitionAssetLockVersions, IdentityTransitionVersions, IdentityVersions,
+    JsonSchemaValidatorVersions, PublicKeyInCreationMethodVersions,
     RecursiveSchemaValidatorVersions, StateTransitionConversionVersions,
     StateTransitionMethodVersions, StateTransitionSerializationVersions, StateTransitionVersions,
     VotingValidationVersions, VotingVersions,
@@ -1183,6 +1184,9 @@ pub const TEST_PLATFORM_V2: PlatformVersion = PlatformVersion {
                     validate_asset_lock_transaction_structure: 0,
                     validate_instant_asset_lock_proof_structure: 0,
                 },
+                credit_withdrawal: IdentityCreditWithdrawalTransitionVersions {
+                    default_constructor: 0,
+                },
             },
         },
         contract_versions: ContractVersions {

diff --git a/packages/rs-platform-version/src/version/mocks/v3_test.rs b/packages/rs-platform-version/src/version/mocks/v3_test.rs
@@ -7,8 +7,9 @@ use crate::version::dpp_versions::{
     DocumentTypeClassMethodVersions, DocumentTypeIndexVersions, DocumentTypeMethodVersions,
     DocumentTypeSchemaVersions, DocumentTypeValidationVersions, DocumentTypeVersions,
     DocumentVersions, DocumentsBatchTransitionValidationVersions, DocumentsBatchTransitionVersions,
-    IdentityKeyTypeMethodVersions, IdentityTransitionAssetLockVersions, IdentityTransitionVersions,
-    IdentityVersions, JsonSchemaValidatorVersions, PublicKeyInCreationMethodVersions,
+    IdentityCreditWithdrawalTransitionVersions, IdentityKeyTypeMethodVersions,
+    IdentityTransitionAssetLockVersions, IdentityTransitionVersions, IdentityVersions,
+    JsonSchemaValidatorVersions, PublicKeyInCreationMethodVersions,
     RecursiveSchemaValidatorVersions, StateTransitionConversionVersions,
     StateTransitionMethodVersions, StateTransitionSerializationVersions, StateTransitionVersions,
     VotingValidationVersions, VotingVersions,
@@ -1183,6 +1184,9 @@ pub const TEST_PLATFORM_V3: PlatformVersion = PlatformVersion {
                     validate_asset_lock_transaction_structure: 0,
                     validate_instant_asset_lock_proof_structure: 0,
                 },
+                credit_withdrawal: IdentityCreditWithdrawalTransitionVersions {
+                    default_constructor: 0,
+                },
             },
         },
         contract_versions: ContractVersions {

diff --git a/packages/rs-platform-version/src/version/v1.rs b/packages/rs-platform-version/src/version/v1.rs
@@ -7,8 +7,9 @@ use crate::version::dpp_versions::{
     DocumentTypeClassMethodVersions, DocumentTypeIndexVersions, DocumentTypeMethodVersions,
     DocumentTypeSchemaVersions, DocumentTypeValidationVersions, DocumentTypeVersions,
     DocumentVersions, DocumentsBatchTransitionValidationVersions, DocumentsBatchTransitionVersions,
-    IdentityKeyTypeMethodVersions, IdentityTransitionAssetLockVersions, IdentityTransitionVersions,
-    IdentityVersions, JsonSchemaValidatorVersions, PublicKeyInCreationMethodVersions,
+    IdentityCreditWithdrawalTransitionVersions, IdentityKeyTypeMethodVersions,
+    IdentityTransitionAssetLockVersions, IdentityTransitionVersions, IdentityVersions,
+    JsonSchemaValidatorVersions, PublicKeyInCreationMethodVersions,
     RecursiveSchemaValidatorVersions, StateTransitionConversionVersions,
     StateTransitionMethodVersions, StateTransitionSerializationVersions, StateTransitionVersions,
     VotingValidationVersions, VotingVersions,
@@ -1182,6 +1183,9 @@ pub const PLATFORM_V1: PlatformVersion = PlatformVersion {
                     validate_asset_lock_transaction_structure: 0,
                     validate_instant_asset_lock_proof_structure: 0,
                 },
+                credit_withdrawal: IdentityCreditWithdrawalTransitionVersions {
+                    default_constructor: 0,
+                },
             },
         },
         contract_versions: ContractVersions {

diff --git a/packages/rs-platform-version/src/version/v2.rs b/packages/rs-platform-version/src/version/v2.rs
@@ -7,8 +7,9 @@ use crate::version::dpp_versions::{
     DocumentTypeClassMethodVersions, DocumentTypeIndexVersions, DocumentTypeMethodVersions,
     DocumentTypeSchemaVersions, DocumentTypeValidationVersions, DocumentTypeVersions,
     DocumentVersions, DocumentsBatchTransitionValidationVersions, DocumentsBatchTransitionVersions,
-    IdentityKeyTypeMethodVersions, IdentityTransitionAssetLockVersions, IdentityTransitionVersions,
-    IdentityVersions, JsonSchemaValidatorVersions, PublicKeyInCreationMethodVersions,
+    IdentityCreditWithdrawalTransitionVersions, IdentityKeyTypeMethodVersions,
+    IdentityTransitionAssetLockVersions, IdentityTransitionVersions, IdentityVersions,
+    JsonSchemaValidatorVersions, PublicKeyInCreationMethodVersions,
     RecursiveSchemaValidatorVersions, StateTransitionConversionVersions,
     StateTransitionMethodVersions, StateTransitionSerializationVersions, StateTransitionVersions,
     VotingValidationVersions, VotingVersions,
@@ -1182,6 +1183,9 @@ pub const PLATFORM_V2: PlatformVersion = PlatformVersion {
                     validate_asset_lock_transaction_structure: 0,
                     validate_instant_asset_lock_proof_structure: 0,
                 },
+                credit_withdrawal: IdentityCreditWithdrawalTransitionVersions {
+                    default_constructor: 0,
+                },
             },
         },
         contract_versions: ContractVersions {

diff --git a/packages/rs-platform-version/src/version/v3.rs b/packages/rs-platform-version/src/version/v3.rs
@@ -7,8 +7,9 @@ use crate::version::dpp_versions::{
     DocumentTypeClassMethodVersions, DocumentTypeIndexVersions, DocumentTypeMethodVersions,
     DocumentTypeSchemaVersions, DocumentTypeValidationVersions, DocumentTypeVersions,
     DocumentVersions, DocumentsBatchTransitionValidationVersions, DocumentsBatchTransitionVersions,
-    IdentityKeyTypeMethodVersions, IdentityTransitionAssetLockVersions, IdentityTransitionVersions,
-    IdentityVersions, JsonSchemaValidatorVersions, PublicKeyInCreationMethodVersions,
+    IdentityCreditWithdrawalTransitionVersions, IdentityKeyTypeMethodVersions,
+    IdentityTransitionAssetLockVersions, IdentityTransitionVersions, IdentityVersions,
+    JsonSchemaValidatorVersions, PublicKeyInCreationMethodVersions,
     RecursiveSchemaValidatorVersions, StateTransitionConversionVersions,
     StateTransitionMethodVersions, StateTransitionSerializationVersions, StateTransitionVersions,
     VotingValidationVersions, VotingVersions,
@@ -1189,6 +1190,9 @@ pub const PLATFORM_V3: PlatformVersion = PlatformVersion {
                     validate_asset_lock_transaction_structure: 0,
                     validate_instant_asset_lock_proof_structure: 0,
                 },
+                credit_withdrawal: IdentityCreditWithdrawalTransitionVersions {
+                    default_constructor: 1,
+                },
             },
         },
         contract_versions: ContractVersions {

diff --git a/packages/rs-platform-version/src/version/v4.rs b/packages/rs-platform-version/src/version/v4.rs
@@ -7,8 +7,9 @@ use crate::version::dpp_versions::{
     DocumentTypeClassMethodVersions, DocumentTypeIndexVersions, DocumentTypeMethodVersions,
     DocumentTypeSchemaVersions, DocumentTypeValidationVersions, DocumentTypeVersions,
     DocumentVersions, DocumentsBatchTransitionValidationVersions, DocumentsBatchTransitionVersions,
-    IdentityKeyTypeMethodVersions, IdentityTransitionAssetLockVersions, IdentityTransitionVersions,
-    IdentityVersions, JsonSchemaValidatorVersions, PublicKeyInCreationMethodVersions,
+    IdentityCreditWithdrawalTransitionVersions, IdentityKeyTypeMethodVersions,
+    IdentityTransitionAssetLockVersions, IdentityTransitionVersions, IdentityVersions,
+    JsonSchemaValidatorVersions, PublicKeyInCreationMethodVersions,
     RecursiveSchemaValidatorVersions, StateTransitionConversionVersions,
     StateTransitionMethodVersions, StateTransitionSerializationVersions, StateTransitionVersions,
     VotingValidationVersions, VotingVersions,
@@ -1184,6 +1185,9 @@ pub const PLATFORM_V4: PlatformVersion = PlatformVersion {
                     validate_asset_lock_transaction_structure: 0,
                     validate_instant_asset_lock_proof_structure: 0,
                 },
+                credit_withdrawal: IdentityCreditWithdrawalTransitionVersions {
+                    default_constructor: 1,
+                },
             },
         },
         contract_versions: ContractVersions {

diff --git a/packages/wasm-dpp/lib/test/fixtures/getIdentityCreditWithdrawalTransitionFixture.js b/packages/wasm-dpp/lib/test/fixtures/getIdentityCreditWithdrawalTransitionFixture.js
@@ -6,7 +6,7 @@ module.exports = function getIdentityCreditWithdrawalTransitionFixture() {
   const privateKey = new PrivateKey('cSBnVM4xvxarwGQuAfQFwqDg9k5tErHUHzgWsEfD4zdwUasvqRVY');
   const address = privateKey.toAddress();
 
-  const stateTransition = new IdentityCreditWithdrawalTransition(1);
+  const stateTransition = new IdentityCreditWithdrawalTransition(3);
   stateTransition.setIdentityId(generateRandomIdentifier());
   // eslint-disable-next-line
   stateTransition.setAmount(BigInt(1000));

diff --git a/packages/wasm-dpp/src/identity/identity_facade.rs b/packages/wasm-dpp/src/identity/identity_facade.rs
@@ -206,7 +206,7 @@ impl IdentityFacadeWasm {
         amount: u64,
         core_fee_per_byte: u32,
         pooling: u8,
-        output_script: Vec<u8>,
+        output_script: Option<Vec<u8>>,
         identity_nonce: u64,
     ) -> Result<IdentityCreditWithdrawalTransitionWasm, JsValue> {
         let pooling = match pooling {
@@ -222,7 +222,7 @@ impl IdentityFacadeWasm {
                 amount,
                 core_fee_per_byte,
                 pooling,
-                CoreScript::from_bytes(output_script),
+                output_script.map(CoreScript::from_bytes),
                 identity_nonce as IdentityNonce,
             )
             .map(Into::into)

diff --git a/packages/wasm-dpp/src/identity/identity_factory.rs b/packages/wasm-dpp/src/identity/identity_factory.rs
@@ -210,7 +210,7 @@ impl IdentityFactoryWasm {
         amount: u64,
         core_fee_per_byte: u32,
         pooling: u8,
-        output_script: Vec<u8>,
+        output_script: Option<Vec<u8>>,
         identity_nonce: u64,
     ) -> Result<IdentityCreditWithdrawalTransitionWasm, JsValue> {
         let pooling = match pooling {
@@ -226,7 +226,7 @@ impl IdentityFactoryWasm {
                 amount,
                 core_fee_per_byte,
                 pooling,
-                CoreScript::from_bytes(output_script),
+                output_script.map(CoreScript::from_bytes),
                 identity_nonce as IdentityNonce,
             )
             .map(Into::into)

diff --git a/packages/wasm-dpp/test/integration/identity/IdentityFacade.spec.js b/packages/wasm-dpp/test/integration/identity/IdentityFacade.spec.js
@@ -24,7 +24,7 @@ describe('IdentityFacade', () => {
   beforeEach(async () => {
     dpp = new DashPlatformProtocol(
       { generate: () => crypto.randomBytes(32) },
-      1,
+      3,
     );
 
     const chainAssetLockProofJS = getChainAssetLockProofFixture();

diff --git a/packages/wasm-dpp/test/unit/identity/IdentityFactory.spec.js b/packages/wasm-dpp/test/unit/identity/IdentityFactory.spec.js
@@ -26,7 +26,7 @@ describe('IdentityFactory', () => {
 
     // const identityValidator = new IdentityValidator(blsAdapter);
 
-    factory = new IdentityFactory(1);
+    factory = new IdentityFactory(3);
 
     identity = await getIdentityFixture(instantAssetLockProof.createIdentifier());
     identity.setBalance(0);