Add tx options param to prepare_claim_outputs() (#2237)

Thoralf-M · web-flow · commit 6696bfdff2f2 · 2024-05-02T14:42:04.000+02:00
* Add tx options param to prepare_claim_outputs()

* Add new param

* Bump version and set release data
diff --git a/bindings/core/src/method/wallet.rs b/bindings/core/src/method/wallet.rs
@@ -226,7 +226,11 @@ pub enum WalletMethod {
     /// Claim outputs.
     /// Expected response: [`PreparedTransaction`](crate::Response::PreparedTransaction)
     #[serde(rename_all = "camelCase")]
-    PrepareClaimOutputs { output_ids_to_claim: Vec<OutputId> },
+    PrepareClaimOutputs {
+        output_ids_to_claim: Vec<OutputId>,
+        #[serde(default)]
+        options: Option<TransactionOptions>,
+    },
     /// Consolidate outputs.
     /// Expected response: [`PreparedTransaction`](crate::Response::PreparedTransaction)
     PrepareConsolidateOutputs { params: ConsolidationParams },
diff --git a/bindings/core/src/method_handler/wallet.rs b/bindings/core/src/method_handler/wallet.rs
@@ -234,8 +234,11 @@ pub(crate) async fn call_wallet_method_internal(
             let data = wallet.prepare_burn(burn, options).await?;
             Response::PreparedTransaction(data)
         }
-        WalletMethod::PrepareClaimOutputs { output_ids_to_claim } => {
-            let data = wallet.prepare_claim_outputs(output_ids_to_claim).await?;
+        WalletMethod::PrepareClaimOutputs {
+            output_ids_to_claim,
+            options,
+        } => {
+            let data = wallet.prepare_claim_outputs(output_ids_to_claim, options).await?;
             Response::PreparedTransaction(data)
         }
         WalletMethod::PrepareConsolidateOutputs { params } => {
diff --git a/bindings/nodejs/CHANGELOG.md b/bindings/nodejs/CHANGELOG.md
@@ -19,6 +19,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Security -->
 
+## 2.0.0-alpha.9 - 2024-05-02
+
+### Added
+
+- `Wallet::prepareClaimOutputs()` optional transactionOptions parameter;
+
 ## 2.0.0-alpha.8 - 2024-04-22
 
 ### Fixed
diff --git a/bindings/nodejs/lib/types/wallet/bridge/wallet.ts b/bindings/nodejs/lib/types/wallet/bridge/wallet.ts
@@ -153,6 +153,7 @@ export type __PrepareClaimOutputsMethod__ = {
     name: 'prepareClaimOutputs';
     data: {
         outputIdsToClaim: OutputId[];
+        options?: TransactionOptions;
     };
 };
 
diff --git a/bindings/nodejs/lib/wallet/wallet.ts b/bindings/nodejs/lib/wallet/wallet.ts
@@ -419,8 +419,11 @@ export class Wallet {
      */
     async claimOutputs(
         outputIds: OutputId[],
+        transactionOptions?: TransactionOptions,
     ): Promise<TransactionWithMetadata> {
-        return (await this.prepareClaimOutputs(outputIds)).send();
+        return (
+            await this.prepareClaimOutputs(outputIds, transactionOptions)
+        ).send();
     }
 
     /**
@@ -431,11 +434,13 @@ export class Wallet {
      */
     async prepareClaimOutputs(
         outputIds: OutputId[],
+        transactionOptions?: TransactionOptions,
     ): Promise<PreparedTransaction> {
         const response = await this.methodHandler.callMethod({
             name: 'prepareClaimOutputs',
             data: {
                 outputIdsToClaim: outputIds,
+                options: transactionOptions,
             },
         });
         const parsed = JSON.parse(
diff --git a/bindings/nodejs/package.json b/bindings/nodejs/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@iota/sdk",
-    "version": "2.0.0-alpha.8",
+    "version": "2.0.0-alpha.9",
     "description": "Node.js binding to the IOTA SDK library",
     "main": "out/index.js",
     "types": "out/index.d.ts",
diff --git a/bindings/python/iota_sdk/wallet/wallet.py b/bindings/python/iota_sdk/wallet/wallet.py
@@ -286,18 +286,19 @@ def prepare_burn_nft(self,
         return PreparedTransaction(self, prepared)
 
     def claim_outputs(
-            self, output_ids_to_claim: List[OutputId]) -> TransactionWithMetadata:
+            self, output_ids_to_claim: List[OutputId], options: Optional[TransactionOptions] = None) -> TransactionWithMetadata:
         """Claim outputs.
         """
-        return self.prepare_claim_outputs(output_ids_to_claim).send()
+        return self.prepare_claim_outputs(output_ids_to_claim, options).send()
 
     def prepare_claim_outputs(
-            self, output_ids_to_claim: List[OutputId]) -> PreparedTransaction:
+            self, output_ids_to_claim: List[OutputId], options: Optional[TransactionOptions] = None) -> PreparedTransaction:
         """Claim outputs.
         """
         return PreparedTransaction(self, PreparedTransactionData.from_dict(self._call_method(
             'prepareClaimOutputs', {
-                'outputIdsToClaim': output_ids_to_claim
+                'outputIdsToClaim': output_ids_to_claim,
+                'options': options
             }
         )))
 
diff --git a/cli/src/wallet_cli/mod.rs b/cli/src/wallet_cli/mod.rs
@@ -568,7 +568,7 @@ pub async fn claim_command(wallet: &Wallet, output_id: Option<OutputId>) -> Resu
     if let Some(output_id) = output_id {
         println_log_info!("Claiming output {output_id}");
 
-        let transaction = wallet.claim_outputs([output_id]).await?;
+        let transaction = wallet.claim_outputs([output_id], None).await?;
 
         println_log_info!(
             "Claiming transaction sent:\n{:?}\n{:?}",
@@ -587,7 +587,7 @@ pub async fn claim_command(wallet: &Wallet, output_id: Option<OutputId>) -> Resu
         // Doing chunks of only 60, because we might need to create the double amount of outputs, because of potential
         // storage deposit return unlock conditions and also consider the remainder output.
         for output_ids_chunk in output_ids.chunks(60) {
-            let transaction = wallet.claim_outputs(output_ids_chunk.to_vec()).await?;
+            let transaction = wallet.claim_outputs(output_ids_chunk.to_vec(), None).await?;
             println_log_info!(
                 "Claiming transaction sent:\n{:?}\n{:?}",
                 transaction.transaction_id,
diff --git a/sdk/examples/how_tos/advanced_transactions/claim_transaction.rs b/sdk/examples/how_tos/advanced_transactions/claim_transaction.rs
@@ -37,7 +37,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
         println!("{}", output_id);
     }
 
-    let transaction = wallet.claim_outputs(output_ids).await?;
+    let transaction = wallet.claim_outputs(output_ids, None).await?;
     println!("Transaction sent: {}", transaction.transaction_id);
 
     wallet
diff --git a/sdk/src/wallet/operations/output_claiming.rs b/sdk/src/wallet/operations/output_claiming.rs
@@ -230,12 +230,15 @@ where
     pub async fn claim_outputs<I: IntoIterator<Item = OutputId> + Send>(
         &self,
         output_ids_to_claim: I,
+        transaction_options: impl Into<Option<TransactionOptions>> + Send,
     ) -> Result<TransactionWithMetadata, WalletError>
     where
         I::IntoIter: Send,
     {
         log::debug!("[OUTPUT_CLAIMING] claim_outputs");
-        let prepared_transaction = self.prepare_claim_outputs(output_ids_to_claim).await?;
+        let prepared_transaction = self
+            .prepare_claim_outputs(output_ids_to_claim, transaction_options)
+            .await?;
 
         let claim_tx = self.sign_and_submit_transaction(prepared_transaction, None).await?;
 
@@ -251,6 +254,7 @@ where
     pub async fn prepare_claim_outputs<I: IntoIterator<Item = OutputId> + Send>(
         &self,
         output_ids_to_claim: I,
+        transaction_options: impl Into<Option<TransactionOptions>> + Send,
     ) -> Result<PreparedTransactionData, WalletError>
     where
         I::IntoIter: Send,
@@ -278,7 +282,8 @@ where
             ));
         }
 
-        let wallet_address = self.address().await;
+        let transaction_options = transaction_options.into();
+        let remainder_address = self.get_remainder_address(transaction_options.clone()).await?;
         drop(wallet_ledger);
 
         let mut nft_outputs_to_send = Vec::new();
@@ -301,31 +306,39 @@ where
                     // deposit for the remaining amount and possible native tokens
                     NftOutputBuilder::from(nft_output)
                         .with_nft_id(nft_output.nft_id_non_null(&output_data.output_id))
-                        .with_unlock_conditions([AddressUnlockCondition::new(&wallet_address)])
+                        .with_unlock_conditions([AddressUnlockCondition::new(remainder_address.clone())])
                         .finish_output()?
                 } else {
                     NftOutputBuilder::from(nft_output)
                         .with_minimum_amount(storage_score_params)
                         .with_nft_id(nft_output.nft_id_non_null(&output_data.output_id))
-                        .with_unlock_conditions([AddressUnlockCondition::new(&wallet_address)])
+                        .with_unlock_conditions([AddressUnlockCondition::new(remainder_address.clone())])
                         .finish_output()?
                 };
 
                 nft_outputs_to_send.push(nft_output);
             }
         }
 
+        let required_inputs = outputs_to_claim
+            .iter()
+            .map(|o| o.output_id)
+            // add additional inputs
+            .chain(possible_additional_inputs.iter().map(|o| o.output_id))
+            .collect();
+
         self.prepare_send_outputs(
             // We only need to provide the NFT outputs, ISA automatically creates basic outputs as remainder outputs
             nft_outputs_to_send,
-            TransactionOptions {
-                required_inputs: outputs_to_claim
-                    .iter()
-                    .map(|o| o.output_id)
-                    // add additional inputs
-                    .chain(possible_additional_inputs.iter().map(|o| o.output_id))
-                    .collect(),
-                ..Default::default()
+            match transaction_options {
+                Some(mut tx_options) => {
+                    tx_options.required_inputs = required_inputs;
+                    tx_options
+                }
+                None => TransactionOptions {
+                    required_inputs,
+                    ..Default::default()
+                },
             },
         )
         .await
diff --git a/sdk/src/wallet/operations/transaction/prepare_output.rs b/sdk/src/wallet/operations/transaction/prepare_output.rs
@@ -259,7 +259,7 @@ impl<S: 'static + SecretManage> Wallet<S> {
     }
 
     // Get a remainder address based on transaction_options or use the first account address
-    async fn get_remainder_address(
+    pub(crate) async fn get_remainder_address(
         &self,
         transaction_options: impl Into<Option<TransactionOptions>> + Send,
     ) -> Result<Address, WalletError> {
diff --git a/sdk/tests/wallet/claim_outputs.rs b/sdk/tests/wallet/claim_outputs.rs
@@ -56,7 +56,10 @@ async fn claim_2_basic_micro_outputs() -> Result<(), Box<dyn std::error::Error>>
     let base_coin_amount_before_claiming = balance.base_coin().available();
 
     let tx = wallet_0
-        .claim_outputs(wallet_0.claimable_outputs(OutputsToClaim::MicroTransactions).await?)
+        .claim_outputs(
+            wallet_0.claimable_outputs(OutputsToClaim::MicroTransactions).await?,
+            None,
+        )
         .await?;
     wallet_0
         .wait_for_transaction_acceptance(&tx.transaction_id, None, None)
@@ -113,7 +116,7 @@ async fn claim_1_of_2_basic_outputs() -> Result<(), Box<dyn std::error::Error>>
     let base_coin_amount_before_claiming = balance.base_coin().available();
 
     let tx = wallet_0
-        .claim_outputs(wallet_0.claimable_outputs(OutputsToClaim::Amount).await?)
+        .claim_outputs(wallet_0.claimable_outputs(OutputsToClaim::Amount).await?, None)
         .await?;
     wallet_0
         .wait_for_transaction_acceptance(&tx.transaction_id, None, None)
@@ -193,7 +196,7 @@ async fn claim_2_basic_outputs_no_available_in_claim_account() -> Result<(), Box
     let base_coin_amount_before_claiming = balance.base_coin().available();
 
     let tx = wallet_1
-        .claim_outputs(wallet_1.claimable_outputs(OutputsToClaim::All).await?)
+        .claim_outputs(wallet_1.claimable_outputs(OutputsToClaim::All).await?, None)
         .await?;
     wallet_1
         .wait_for_transaction_acceptance(&tx.transaction_id, None, None)
@@ -281,7 +284,7 @@ async fn claim_2_native_tokens() -> Result<(), Box<dyn std::error::Error>> {
     assert_eq!(balance.potentially_locked_outputs().len(), 2);
 
     let tx = wallet_0
-        .claim_outputs(wallet_0.claimable_outputs(OutputsToClaim::NativeTokens).await?)
+        .claim_outputs(wallet_0.claimable_outputs(OutputsToClaim::NativeTokens).await?, None)
         .await?;
     wallet_0
         .wait_for_transaction_acceptance(&tx.transaction_id, None, None)
@@ -404,7 +407,7 @@ async fn claim_2_native_tokens_no_available_balance_in_claim_account() -> Result
     assert_eq!(balance.potentially_locked_outputs().len(), 2);
 
     let tx = wallet_1
-        .claim_outputs(wallet_1.claimable_outputs(OutputsToClaim::NativeTokens).await?)
+        .claim_outputs(wallet_1.claimable_outputs(OutputsToClaim::NativeTokens).await?, None)
         .await?;
     wallet_1
         .wait_for_transaction_acceptance(&tx.transaction_id, None, None)
@@ -470,7 +473,7 @@ async fn claim_2_nft_outputs() -> Result<(), Box<dyn std::error::Error>> {
     assert_eq!(balance.potentially_locked_outputs().len(), 2);
 
     let tx = wallet_0
-        .claim_outputs(wallet_0.claimable_outputs(OutputsToClaim::Nfts).await?)
+        .claim_outputs(wallet_0.claimable_outputs(OutputsToClaim::Nfts).await?, None)
         .await?;
     wallet_0
         .wait_for_transaction_acceptance(&tx.transaction_id, None, None)
@@ -547,7 +550,7 @@ async fn claim_2_nft_outputs_no_available_in_claim_account() -> Result<(), Box<d
     assert_eq!(balance.potentially_locked_outputs().len(), 2);
 
     let tx = wallet_1
-        .claim_outputs(wallet_1.claimable_outputs(OutputsToClaim::Nfts).await?)
+        .claim_outputs(wallet_1.claimable_outputs(OutputsToClaim::Nfts).await?, None)
         .await?;
     wallet_1
         .wait_for_transaction_acceptance(&tx.transaction_id, None, None)
@@ -612,7 +615,10 @@ async fn claim_basic_micro_output_error() -> Result<(), Box<dyn std::error::Erro
     assert_eq!(balance.potentially_locked_outputs().len(), 1);
 
     let result = wallet_1
-        .claim_outputs(wallet_1.claimable_outputs(OutputsToClaim::MicroTransactions).await?)
+        .claim_outputs(
+            wallet_1.claimable_outputs(OutputsToClaim::MicroTransactions).await?,
+            None,
+        )
         .await;
     assert!(matches!(
         result,

Original file line number	Diff line number	Diff line change
`@@ -234,8 +234,11 @@ pub(crate) async fn call_wallet_method_internal(`
`234`	`234`	`let data = wallet.prepare_burn(burn, options).await?;`
`235`	`235`	`Response::PreparedTransaction(data)`
`236`	`236`	`}`
`237`		`- WalletMethod::PrepareClaimOutputs { output_ids_to_claim } => {`
`238`		`- let data = wallet.prepare_claim_outputs(output_ids_to_claim).await?;`
	`237`	`+ WalletMethod::PrepareClaimOutputs {`
	`238`	`+ output_ids_to_claim,`
	`239`	`+ options,`
	`240`	`+ } => {`
	`241`	`+ let data = wallet.prepare_claim_outputs(output_ids_to_claim, options).await?;`
`239`	`242`	`Response::PreparedTransaction(data)`
`240`	`243`	`}`
`241`	`244`	`WalletMethod::PrepareConsolidateOutputs { params } => {`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@iota/sdk",`
`3`		`- "version": "2.0.0-alpha.8",`
	`3`	`+ "version": "2.0.0-alpha.9",`
`4`	`4`	`"description": "Node.js binding to the IOTA SDK library",`
`5`	`5`	`"main": "out/index.js",`
`6`	`6`	`"types": "out/index.d.ts",`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {`
`37`	`37`	`println!("{}", output_id);`
`38`	`38`	`}`
`39`	`39`
`40`		`- let transaction = wallet.claim_outputs(output_ids).await?;`
	`40`	`+ let transaction = wallet.claim_outputs(output_ids, None).await?;`
`41`	`41`	`println!("Transaction sent: {}", transaction.transaction_id);`
`42`	`42`
`43`	`43`	`wallet`
Original file line number	Diff line number	Diff line change
`@@ -259,7 +259,7 @@ impl<S: 'static + SecretManage> Wallet<S> {`
`259`	`259`	`}`
`260`	`260`
`261`	`261`	`// Get a remainder address based on transaction_options or use the first account address`
`262`		`- async fn get_remainder_address(`
	`262`	`+ pub(crate) async fn get_remainder_address(`
`263`	`263`	`&self,`
`264`	`264`	`transaction_options: impl Into<Option<TransactionOptions>> + Send,`
`265`	`265`	`) -> Result<Address, WalletError> {`