Fix claim_outputs when no basic outputs are available (#1885)

iotaledger · Feb 23, 2023 · 33069b6 · 33069b6
1 parent f5a8b5b
commit 33069b6
Show file tree

Hide file tree

Showing 6 changed files with 319 additions and 28 deletions.
diff --git a/.changes/claimoutputs.md b/.changes/claimoutputs.md
@@ -0,0 +1,5 @@
+---
+"nodejs-binding": patch
+---
+
+Fix `Account::claimOutputs()` when no basic outputs are available.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -46,6 +46,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - `Account::get_participation_overview()` with multiple events and different nodes;
 - `prepare_nft_output` uses newly provided tag/metadata instead of previous ones from unspent output;
+- `Account::claim_outputs()` when the account has no basic outputs available;
 
 ## 1.0.0-rc.5 - 2023-02-09
 

diff --git a/bindings/nodejs/Cargo.lock b/bindings/nodejs/Cargo.lock
diff --git a/bindings/nodejs/examples/26-send-nft.js b/bindings/nodejs/examples/26-send-nft.js
@@ -6,11 +6,11 @@ const getUnlockedManager = require('./account-manager');
 async function run() {
     try {
         const { initLogger } = require('@iota/wallet');
-    initLogger({
-        name: './wallet.log',
-        levelFilter: 'debug',
-        targetExclusions: ["h2", "hyper", "rustls"]
-    });
+        initLogger({
+            name: './wallet.log',
+            levelFilter: 'debug',
+            targetExclusions: ["h2", "hyper", "rustls"]
+        });
         const manager = await getUnlockedManager();
 
         const account = await manager.getAccount('0');
@@ -25,11 +25,28 @@ async function run() {
             nftId: '0x09aa7871e126cc41f1f3784a479a5dd5f23e4dd8b97e932a001e77a11ad42f0c',
         }]);
 
+
+
         console.log(response);
 
         console.log(
             `Check your block on ${process.env.NODE_URL}/api/core/v2/blocks/${response.blockId}`,
         );
+
+        // To send an NFT with expiration unlock condition prepareOutput() can be used like this:
+        // const output = await account.prepareOutput({
+        //     recipientAddress: 'rms1qz6aj69rumk3qu0ra5ag6p6kk8ga3j8rfjlaym3wefugs3mmxgzfwa6kw3l',
+        //     amount: "47000",
+        //     unlocks: {
+        //         expirationUnixTime: 1677065933
+        //     },
+        //     assets: {
+        //         nftId: '0x447b20b81e2311a6c16a32eaeda2f2f2472c4b43ed4ffc80a0c0f850130fc4bb',
+        //     },
+        //     storageDeposit: { returnStrategy: 'Gift' }
+        // });
+
+        // const transaction = await account.sendOutputs([output]);
     } catch (error) {
         console.log('Error: ', error);
     }

diff --git a/src/account/operations/output_claiming.rs b/src/account/operations/output_claiming.rs
@@ -259,15 +259,26 @@ impl AccountHandle {
                 // build new output with same amount, nft_id, immutable/feature blocks and native tokens, just
                 // updated address unlock conditions
 
-                let nft_output = NftOutputBuilder::from(nft_output)
-                    .with_minimum_storage_deposit(rent_structure.clone())
-                    .with_nft_id(nft_output.nft_id_non_null(&output_data.output_id))
-                    .with_unlock_conditions([UnlockCondition::Address(AddressUnlockCondition::new(
-                        first_account_address.address.inner,
-                    ))])
-                    // Set native tokens empty, we will collect them from all inputs later
-                    .with_native_tokens([])
-                    .finish_output(token_supply)?;
+                let nft_output = if possible_additional_inputs.is_empty() {
+                    // Only update address and nft id if we have no additional inputs which can provide the storage
+                    // deposit for the remaining amount and possible NTs
+                    NftOutputBuilder::from(nft_output)
+                        .with_nft_id(nft_output.nft_id_non_null(&output_data.output_id))
+                        .with_unlock_conditions([UnlockCondition::Address(AddressUnlockCondition::new(
+                            first_account_address.address.inner,
+                        ))])
+                        .finish_output(token_supply)?
+                } else {
+                    NftOutputBuilder::from(nft_output)
+                        .with_minimum_storage_deposit(rent_structure.clone())
+                        .with_nft_id(nft_output.nft_id_non_null(&output_data.output_id))
+                        .with_unlock_conditions([UnlockCondition::Address(AddressUnlockCondition::new(
+                            first_account_address.address.inner,
+                        ))])
+                        // Set native tokens empty, we will collect them from all inputs later
+                        .with_native_tokens([])
+                        .finish_output(token_supply)?
+                };
 
                 // Add required amount for the new output
                 required_amount_for_nfts += nft_output.amount();
@@ -282,8 +293,12 @@ impl AccountHandle {
         };
 
         // Check if the new amount is enough for the storage deposit, otherwise increase it to this
-        let mut required_amount = required_amount_for_nfts
-            + minimum_storage_deposit_basic_output(&rent_structure, &option_native_token, token_supply)?;
+        let mut required_amount = if possible_additional_inputs.is_empty() {
+            required_amount_for_nfts
+        } else {
+            required_amount_for_nfts
+                + minimum_storage_deposit_basic_output(&rent_structure, &option_native_token, token_supply)?
+        };
 
         let mut additional_inputs = Vec::new();
         if available_amount < required_amount {
@@ -343,14 +358,20 @@ impl AccountHandle {
         }
 
         // Create output with claimed values
-        outputs_to_send.push(
-            BasicOutputBuilder::new_with_amount(available_amount - required_amount_for_nfts)?
-                .add_unlock_condition(UnlockCondition::Address(AddressUnlockCondition::new(
-                    first_account_address.address.inner,
-                )))
-                .with_native_tokens(new_native_tokens.finish()?)
-                .finish_output(token_supply)?,
-        );
+        if available_amount - required_amount_for_nfts > 0 {
+            outputs_to_send.push(
+                BasicOutputBuilder::new_with_amount(available_amount - required_amount_for_nfts)?
+                    .add_unlock_condition(UnlockCondition::Address(AddressUnlockCondition::new(
+                        first_account_address.address.inner,
+                    )))
+                    .with_native_tokens(new_native_tokens.finish()?)
+                    .finish_output(token_supply)?,
+            );
+        } else if !new_native_tokens.finish()?.is_empty() {
+            return Err(crate::Error::Client(
+                iota_client::Error::NoBalanceForNativeTokenRemainder.into(),
+            ));
+        }
 
         let claim_tx = self
             .finish_transaction(