feat(wasm-sdk): add token-paid document support (#3599)

PastaPastaPasta · web-flow · commit c7cb8e6f5fe9 · 2026-05-08T02:27:33.000+07:00
diff --git a/packages/js-evo-sdk/tests/unit/facades/documents.spec.ts b/packages/js-evo-sdk/tests/unit/facades/documents.spec.ts
@@ -8,6 +8,13 @@ describe('DocumentsFacade', () => {
   let document: wasmSDKPackage.Document;
   let identityKey: wasmSDKPackage.IdentityPublicKey;
   let signer: wasmSDKPackage.IdentitySigner;
+  const tokenPaymentInfo = {
+    paymentTokenContractId: 'BpJvvpPiR2obh7ueZixjtYXsmWQdgJhiZtQJWjD7Ruus',
+    tokenContractPosition: 0,
+    minimumTokenCost: BigInt(10),
+    maximumTokenCost: BigInt(25),
+    gasFeesPaidBy: 'PreferContractOwner',
+  };
 
   // Stub references for type-safe assertions
   let getDocumentsStub: SinonStub;
@@ -116,6 +123,7 @@ describe('DocumentsFacade', () => {
         document,
         identityKey,
         signer,
+        tokenPaymentInfo,
       };
 
       await client.documents.create(options);
@@ -130,6 +138,7 @@ describe('DocumentsFacade', () => {
         document,
         identityKey,
         signer,
+        tokenPaymentInfo,
         settings: { retries: 3 },
       };
 
@@ -145,6 +154,7 @@ describe('DocumentsFacade', () => {
         document,
         identityKey,
         signer,
+        tokenPaymentInfo,
       };
 
       await client.documents.delete(options);
@@ -162,6 +172,7 @@ describe('DocumentsFacade', () => {
         },
         identityKey,
         signer,
+        tokenPaymentInfo,
       };
 
       await client.documents.delete(options);
@@ -178,6 +189,7 @@ describe('DocumentsFacade', () => {
         recipientId,
         identityKey,
         signer,
+        tokenPaymentInfo,
       };
 
       await client.documents.transfer(options);
@@ -195,6 +207,7 @@ describe('DocumentsFacade', () => {
         price: BigInt(1000000), // 1M credits
         identityKey,
         signer,
+        tokenPaymentInfo,
       };
 
       await client.documents.purchase(options);
@@ -210,6 +223,7 @@ describe('DocumentsFacade', () => {
         price: BigInt(5000000), // 5M credits
         identityKey,
         signer,
+        tokenPaymentInfo,
       };
 
       await client.documents.setPrice(options);
diff --git a/packages/wasm-sdk/src/state_transitions/document.rs b/packages/wasm-sdk/src/state_transitions/document.rs
@@ -11,22 +11,84 @@ use dash_sdk::dpp::document::{Document, DocumentV0Getters};
 use dash_sdk::dpp::fee::Credits;
 use dash_sdk::dpp::identity::IdentityPublicKey;
 use dash_sdk::dpp::platform_value::Identifier;
+use dash_sdk::dpp::tokens::token_payment_info::TokenPaymentInfo;
 use dash_sdk::platform::documents::transitions::DocumentDeleteTransitionBuilder;
 use dash_sdk::platform::transition::purchase_document::PurchaseDocument;
 use dash_sdk::platform::transition::put_document::PutDocument;
 use dash_sdk::platform::transition::transfer_document::TransferDocument;
 use dash_sdk::platform::transition::update_price_of_document::UpdatePriceOfDocument;
+use js_sys::Reflect;
 use std::sync::Arc;
-use wasm_bindgen::prelude::*;
+use wasm_bindgen::{prelude::*, JsCast};
 use wasm_dpp2::data_contract::document::DocumentWasm;
 use wasm_dpp2::identifier::IdentifierWasm;
 use wasm_dpp2::identity::IdentityPublicKeyWasm;
+use wasm_dpp2::state_transitions::batch::token_payment_info::{
+    TokenPaymentInfoOptionsJs, TokenPaymentInfoWasm,
+};
 use wasm_dpp2::utils::{
     get_class_type, try_from_options_optional, try_from_options_with, try_to_string, try_to_u64,
     IntoWasm,
 };
 use wasm_dpp2::IdentitySignerWasm;
 
+#[wasm_bindgen(typescript_custom_section)]
+const TOKEN_PAYMENT_INFO_TS: &str = r#"
+/**
+ * Token-based payment metadata for document actions that require token cost agreement.
+ */
+export interface DocumentTokenPaymentInfo {
+  /**
+   * Optional external token contract ID.
+   * If omitted, the token is expected to come from the current document contract.
+   */
+  paymentTokenContractId?: IdentifierLike;
+
+  /**
+   * Token position within the token contract.
+   */
+  tokenContractPosition: number;
+
+  /**
+   * Optional minimum token amount the payer agrees to spend.
+   */
+  minimumTokenCost?: bigint;
+
+  /**
+   * Optional maximum token amount the payer agrees to spend.
+   */
+  maximumTokenCost?: bigint;
+
+  /**
+   * Which party covers gas fees for the document action.
+   */
+  gasFeesPaidBy?: GasFeesPaidByLike;
+}
+"#;
+
+fn try_from_options_optional_token_payment_info(
+    options: &JsValue,
+) -> Result<Option<TokenPaymentInfo>, WasmSdkError> {
+    let token_payment_info_value = Reflect::get(options, &JsValue::from_str("tokenPaymentInfo"))
+        .map_err(|err| {
+            WasmSdkError::invalid_argument(format!(
+                "Failed to read tokenPaymentInfo option: {:?}",
+                err
+            ))
+        })?;
+
+    if token_payment_info_value.is_null() || token_payment_info_value.is_undefined() {
+        return Ok(None);
+    }
+
+    let token_payment_info = TokenPaymentInfoWasm::constructor(
+        token_payment_info_value.unchecked_into::<TokenPaymentInfoOptionsJs>(),
+    )
+    .map_err(|err| WasmSdkError::invalid_argument(err.to_string()))?;
+
+    Ok(Some(token_payment_info.into()))
+}
+
 // ============================================================================
 // Document Create
 // ============================================================================
@@ -57,6 +119,11 @@ export interface DocumentCreateOptions {
    */
   signer: IdentitySigner;
 
+  /**
+   * Optional token payment agreement for document types with tokenCost.create.
+   */
+  tokenPaymentInfo?: DocumentTokenPaymentInfo;
+
   /**
    * Optional settings for the broadcast operation.
    * Includes retries, timeouts, userFeeIncrease, etc.
@@ -126,6 +193,7 @@ impl WasmSdk {
         // Extract settings from options
         let settings =
             try_from_options_optional::<PutSettingsInput>(&options, "settings")?.map(Into::into);
+        let token_payment_info = try_from_options_optional_token_payment_info(&options)?;
 
         // Use PutDocument trait for creation
         document
@@ -134,7 +202,7 @@ impl WasmSdk {
                 document_type,
                 Some(entropy_array),
                 identity_key,
-                None, // token_payment_info
+                token_payment_info,
                 &signer,
                 settings,
             )
@@ -174,6 +242,11 @@ export interface DocumentReplaceOptions {
    */
   signer: IdentitySigner;
 
+  /**
+   * Optional token payment agreement for document types with tokenCost.replace.
+   */
+  tokenPaymentInfo?: DocumentTokenPaymentInfo;
+
   /**
    * Optional settings for the broadcast operation.
    * Includes retries, timeouts, userFeeIncrease, etc.
@@ -229,6 +302,7 @@ impl WasmSdk {
         // Extract settings from options
         let settings =
             try_from_options_optional::<PutSettingsInput>(&options, "settings")?.map(Into::into);
+        let token_payment_info = try_from_options_optional_token_payment_info(&options)?;
 
         // Use PutDocument trait for replacement (revision > INITIAL_REVISION triggers replace)
         document
@@ -237,7 +311,7 @@ impl WasmSdk {
                 document_type,
                 None, // entropy not needed for replace
                 identity_key,
-                None, // token_payment_info
+                token_payment_info,
                 &signer,
                 settings,
             )
@@ -287,6 +361,11 @@ export interface DocumentDeleteOptions {
    */
   signer: IdentitySigner;
 
+  /**
+   * Optional token payment agreement for document types with tokenCost.delete.
+   */
+  tokenPaymentInfo?: DocumentTokenPaymentInfo;
+
   /**
    * Optional settings for the broadcast operation.
    * Includes retries, timeouts, userFeeIncrease, etc.
@@ -368,6 +447,7 @@ impl WasmSdk {
         // Extract settings from options
         let settings =
             try_from_options_optional::<PutSettingsInput>(&options, "settings")?.map(Into::into);
+        let token_payment_info = try_from_options_optional_token_payment_info(&options)?;
 
         // Build and execute delete transition using DocumentDeleteTransitionBuilder
         let builder = DocumentDeleteTransitionBuilder::new(
@@ -377,6 +457,12 @@ impl WasmSdk {
             owner_id,
         );
 
+        let builder = if let Some(token_payment_info) = token_payment_info {
+            builder.with_token_payment_info(token_payment_info)
+        } else {
+            builder
+        };
+
         let builder = if let Some(s) = settings {
             builder.with_settings(s)
         } else {
@@ -425,6 +511,11 @@ export interface DocumentTransferOptions {
    */
   signer: IdentitySigner;
 
+  /**
+   * Optional token payment agreement for document types with tokenCost.transfer.
+   */
+  tokenPaymentInfo?: DocumentTokenPaymentInfo;
+
   /**
    * Optional settings for the broadcast operation.
    * Includes retries, timeouts, userFeeIncrease, etc.
@@ -491,6 +582,7 @@ impl WasmSdk {
         // Extract settings from options
         let settings =
             try_from_options_optional::<PutSettingsInput>(&options, "settings")?.map(Into::into);
+        let token_payment_info = try_from_options_optional_token_payment_info(&options)?;
 
         // Use TransferDocument trait
         document
@@ -499,7 +591,7 @@ impl WasmSdk {
                 self.inner_sdk(),
                 document_type,
                 identity_key,
-                None, // token_payment_info
+                token_payment_info,
                 &signer,
                 settings,
             )
@@ -549,6 +641,11 @@ export interface DocumentPurchaseOptions {
    */
   signer: IdentitySigner;
 
+  /**
+   * Optional token payment agreement for document types with tokenCost.purchase.
+   */
+  tokenPaymentInfo?: DocumentTokenPaymentInfo;
+
   /**
    * Optional settings for the broadcast operation.
    * Includes retries, timeouts, userFeeIncrease, etc.
@@ -609,6 +706,7 @@ impl WasmSdk {
         // Extract settings from options
         let settings =
             try_from_options_optional::<PutSettingsInput>(&options, "settings")?.map(Into::into);
+        let token_payment_info = try_from_options_optional_token_payment_info(&options)?;
 
         // Use PurchaseDocument trait
         document
@@ -618,7 +716,7 @@ impl WasmSdk {
                 document_type,
                 buyer_id,
                 identity_key,
-                None, // token_payment_info
+                token_payment_info,
                 &signer,
                 settings,
             )
@@ -663,6 +761,11 @@ export interface DocumentSetPriceOptions {
    */
   signer: IdentitySigner;
 
+  /**
+   * Optional token payment agreement for document types with tokenCost.update_price.
+   */
+  tokenPaymentInfo?: DocumentTokenPaymentInfo;
+
   /**
    * Optional settings for the broadcast operation.
    * Includes retries, timeouts, userFeeIncrease, etc.
@@ -720,6 +823,7 @@ impl WasmSdk {
         // Extract settings from options
         let settings =
             try_from_options_optional::<PutSettingsInput>(&options, "settings")?.map(Into::into);
+        let token_payment_info = try_from_options_optional_token_payment_info(&options)?;
 
         // Use UpdatePriceOfDocument trait
         document
@@ -728,7 +832,7 @@ impl WasmSdk {
                 self.inner_sdk(),
                 document_type,
                 identity_key,
-                None, // token_payment_info
+                token_payment_info,
                 &signer,
                 settings,
             )
diff --git a/packages/wasm-sdk/tests/functional/transitions/documents.spec.ts b/packages/wasm-sdk/tests/functional/transitions/documents.spec.ts
