Replace reissue_transaction_until_included() with wait_for_transactio…

…n_acceptance() (iotaledger#1979) * reissue_transaction_until_included -> await_transaction_acceptance * Update log * Change interval to ms, update error * Fix wasm * Apply suggestions from code review Co-authored-by: DaughterOfMars <[email protected]> * Casing * Review suggestions * Don't build block, rename file, move failed code into TransactionState::Failed branch * Rename to wait_for * Apply suggestions from code review Co-authored-by: DaughterOfMars <[email protected]> * fmt * Adapt to rename * Rename part 2 * Duration const, use block id from node response, move timeouts after first request * Rename const --------- Co-authored-by: DaughterOfMars <[email protected]>
boxfish-studio · Feb 12, 2024 · 8a3933f · 8a3933f
1 parent 75cfa6f
commit 8a3933f
Show file tree

Hide file tree

Showing 83 changed files with 382 additions and 407 deletions.
diff --git a/bindings/core/src/method/wallet.rs b/bindings/core/src/method/wallet.rs
@@ -397,11 +397,11 @@ pub enum WalletMethod {
     // RegisterParticipationEvents {
     //     options: ParticipationEventRegistrationOptions,
     // },
-    /// Reissues a transaction sent from the wallet for a provided transaction id until it's
-    /// included (referenced by a milestone). Returns the included block id.
+    /// Checks the transaction state for a provided transaction id until it's accepted. Interval in milliseconds.
+    /// Returns the block id that contains this transaction.
     /// Expected response: [`BlockId`](crate::Response::BlockId)
     #[serde(rename_all = "camelCase")]
-    ReissueTransactionUntilIncluded {
+    WaitForTransactionAcceptance {
         /// Transaction id
         transaction_id: TransactionId,
         /// Interval

diff --git a/bindings/core/src/method_handler/wallet.rs b/bindings/core/src/method_handler/wallet.rs
@@ -373,13 +373,13 @@ pub(crate) async fn call_wallet_method_internal(wallet: &Wallet, method: WalletM
         //     let events = wallet.register_participation_events(&options).await?;
         //     Response::ParticipationEvents(events)
         // }
-        WalletMethod::ReissueTransactionUntilIncluded {
+        WalletMethod::WaitForTransactionAcceptance {
             transaction_id,
             interval,
             max_attempts,
         } => {
             let block_id = wallet
-                .reissue_transaction_until_included(&transaction_id, interval, max_attempts)
+                .wait_for_transaction_acceptance(&transaction_id, interval, max_attempts)
                 .await?;
             Response::BlockId(block_id)
         }

diff --git a/bindings/core/src/response.rs b/bindings/core/src/response.rs
@@ -266,7 +266,7 @@ pub enum Response {
     /// - [`BlockId`](crate::method::UtilsMethod::BlockId)
     /// - [`PostBlock`](crate::method::ClientMethod::PostBlock)
     /// - [`PostBlockRaw`](crate::method::ClientMethod::PostBlockRaw)
-    /// - [`ReissueTransactionUntilIncluded`](crate::method::WalletMethod::ReissueTransactionUntilIncluded)
+    /// - [`WaitForTransactionAcceptance`](crate::method::WalletMethod::WaitForTransactionAcceptance)
     BlockId(BlockId),
     /// Response for:
     /// - [`GetHealth`](crate::method::ClientMethod::GetHealth)

diff --git a/bindings/nodejs/examples/how_tos/account_output/create.ts b/bindings/nodejs/examples/how_tos/account_output/create.ts
@@ -49,12 +49,12 @@ async function run() {
 
         console.log(`Transaction sent: ${transaction.transactionId}`);
 
-        // Wait for transaction to get included
-        const blockId = await wallet.reissueTransactionUntilIncluded(
+        // Wait for transaction to get accepted
+        const blockId = await wallet.waitForTransactionAcceptance(
             transaction.transactionId,
         );
         console.log(
-            `Block included: ${process.env.EXPLORER_URL}/block/${blockId}`,
+            `Tx accepted in block: ${process.env.EXPLORER_URL}/block/${blockId}`,
         );
 
         balance = await wallet.sync();

diff --git a/bindings/nodejs/examples/how_tos/account_output/destroy.ts b/bindings/nodejs/examples/how_tos/account_output/destroy.ts
@@ -57,12 +57,12 @@ async function run() {
 
         console.log(`Transaction sent: ${transaction.transactionId}`);
 
-        // Wait for transaction to get included
-        const blockId = await wallet.reissueTransactionUntilIncluded(
+        // Wait for transaction to get accepted
+        const blockId = await wallet.waitForTransactionAcceptance(
             transaction.transactionId,
         );
         console.log(
-            `Block included: ${process.env.EXPLORER_URL}/block/${blockId}`,
+            `Tx accepted in block: ${process.env.EXPLORER_URL}/block/${blockId}`,
         );
         console.log(`Destroyed account output ${accountId}`);
 

diff --git a/bindings/nodejs/examples/how_tos/account_output/send-amount.ts b/bindings/nodejs/examples/how_tos/account_output/send-amount.ts
@@ -75,7 +75,7 @@ async function run() {
             allowMicroAmount: false,
         };
         const transaction = await wallet.sendWithParams(params, options);
-        await wallet.reissueTransactionUntilIncluded(transaction.transactionId);
+        await wallet.waitForTransactionAcceptance(transaction.transactionId);
         console.log(
             `Transaction with custom input: https://explorer.iota.org/testnet/transaction/${transaction.transactionId}`,
         );

diff --git a/bindings/nodejs/examples/how_tos/advanced_transactions/advanced_transaction.ts b/bindings/nodejs/examples/how_tos/advanced_transactions/advanced_transaction.ts
@@ -62,8 +62,8 @@ async function run() {
         const transaction = await wallet.sendOutputs([basicOutput]);
         console.log(`Transaction sent: ${transaction.transactionId}`);
 
-        console.log('Waiting until included in block...');
-        const blockId = await wallet.reissueTransactionUntilIncluded(
+        console.log('Waiting until transaction is accepted...');
+        const blockId = await wallet.waitForTransactionAcceptance(
             transaction.transactionId,
         );
         console.log(`Block sent: ${process.env.EXPLORER_URL}/block/${blockId}`);

diff --git a/bindings/nodejs/examples/how_tos/advanced_transactions/claim_transaction.ts b/bindings/nodejs/examples/how_tos/advanced_transactions/claim_transaction.ts
@@ -44,7 +44,7 @@ async function run() {
         const transaction = await wallet.claimOutputs(output_ids);
         console.log(`Transaction sent: ${transaction.transactionId}`);
 
-        const blockId = await wallet.reissueTransactionUntilIncluded(
+        const blockId = await wallet.waitForTransactionAcceptance(
             transaction.transactionId,
         );
         console.log(`Block sent: ${process.env.EXPLORER_URL}/block/${blockId}`);

diff --git a/bindings/nodejs/examples/how_tos/advanced_transactions/send_micro_transaction.ts b/bindings/nodejs/examples/how_tos/advanced_transactions/send_micro_transaction.ts
@@ -45,7 +45,7 @@ async function run() {
 
         console.log(`Transaction sent: ${transaction.transactionId}`);
 
-        const blockId = await wallet.reissueTransactionUntilIncluded(
+        const blockId = await wallet.waitForTransactionAcceptance(
             transaction.transactionId,
         );
 

diff --git a/bindings/nodejs/examples/how_tos/native_tokens/burn.ts b/bindings/nodejs/examples/how_tos/native_tokens/burn.ts
@@ -53,13 +53,13 @@ async function run() {
 
         console.log(`Transaction sent: ${transaction.transactionId}`);
 
-        // Wait for transaction to get included
-        const blockId = await wallet.reissueTransactionUntilIncluded(
+        // Wait for transaction to get accepted
+        const blockId = await wallet.waitForTransactionAcceptance(
             transaction.transactionId,
         );
 
         console.log(
-            `Block included: ${process.env.EXPLORER_URL}/block/${blockId}`,
+            `Tx accepted in block: ${process.env.EXPLORER_URL}/block/${blockId}`,
         );
 
         balance = await wallet.sync();

diff --git a/bindings/nodejs/examples/how_tos/native_tokens/create.ts b/bindings/nodejs/examples/how_tos/native_tokens/create.ts
@@ -38,13 +38,13 @@ async function run() {
                 .then((prepared) => prepared.send());
             console.log(`Transaction sent: ${transaction.transactionId}`);
 
-            // Wait for transaction to get included
-            const blockId = await wallet.reissueTransactionUntilIncluded(
+            // Wait for transaction to get accepted
+            const blockId = await wallet.waitForTransactionAcceptance(
                 transaction.transactionId,
             );
 
             console.log(
-                `Block included: ${process.env.EXPLORER_URL}/block/${blockId}`,
+                `Tx accepted in block: ${process.env.EXPLORER_URL}/block/${blockId}`,
             );
 
             await wallet.sync();
@@ -71,13 +71,13 @@ async function run() {
 
         console.log(`Transaction sent: ${transaction.transactionId}`);
 
-        // Wait for transaction to get included
-        const blockId = await wallet.reissueTransactionUntilIncluded(
+        // Wait for transaction to get accepted
+        const blockId = await wallet.waitForTransactionAcceptance(
             transaction.transactionId,
         );
 
         console.log(
-            `Block included: ${process.env.EXPLORER_URL}/block/${blockId}`,
+            `Tx accepted in block: ${process.env.EXPLORER_URL}/block/${blockId}`,
         );
 
         console.log(`Created token: ${prepared.tokenId()}`);

diff --git a/bindings/nodejs/examples/how_tos/native_tokens/destroy-foundry.ts b/bindings/nodejs/examples/how_tos/native_tokens/destroy-foundry.ts
@@ -40,12 +40,12 @@ async function run() {
 
         console.log(`Transaction sent: ${transaction.transactionId}`);
 
-        // Wait for transaction to get included
-        const blockId = await wallet.reissueTransactionUntilIncluded(
+        // Wait for transaction to get accepted
+        const blockId = await wallet.waitForTransactionAcceptance(
             transaction.transactionId,
         );
         console.log(
-            `Block included: ${process.env.EXPLORER_URL}/block/${blockId}`,
+            `Tx accepted in block: ${process.env.EXPLORER_URL}/block/${blockId}`,
         );
 
         balance = await wallet.sync();

diff --git a/bindings/nodejs/examples/how_tos/native_tokens/melt.ts b/bindings/nodejs/examples/how_tos/native_tokens/melt.ts
@@ -47,13 +47,13 @@ async function run() {
 
         console.log(`Transaction sent: ${transaction.transactionId}`);
 
-        // Wait for transaction to get included
-        const blockId = await wallet.reissueTransactionUntilIncluded(
+        // Wait for transaction to get accepted
+        const blockId = await wallet.waitForTransactionAcceptance(
             transaction.transactionId,
         );
 
         console.log(
-            `Block included: ${process.env.EXPLORER_URL}/block/${blockId}`,
+            `Tx accepted in block: ${process.env.EXPLORER_URL}/block/${blockId}`,
         );
 
         balance = await wallet.sync();

diff --git a/bindings/nodejs/examples/how_tos/native_tokens/mint.ts b/bindings/nodejs/examples/how_tos/native_tokens/mint.ts
@@ -48,13 +48,13 @@ async function run() {
 
         console.log(`Transaction sent: ${transaction.transactionId}`);
 
-        // Wait for transaction to get included
-        const blockId = await wallet.reissueTransactionUntilIncluded(
+        // Wait for transaction to get accepted
+        const blockId = await wallet.waitForTransactionAcceptance(
             transaction.transactionId,
         );
 
         console.log(
-            `Block included: ${process.env.EXPLORER_URL}/block/${blockId}`,
+            `Tx accepted in block: ${process.env.EXPLORER_URL}/block/${blockId}`,
         );
 
         balance = await wallet.sync();

diff --git a/bindings/nodejs/examples/how_tos/native_tokens/send.ts b/bindings/nodejs/examples/how_tos/native_tokens/send.ts
@@ -58,13 +58,13 @@ async function run() {
 
             console.log(`Transaction sent: ${transaction.transactionId}`);
 
-            // Wait for transaction to get included
-            const blockId = await wallet.reissueTransactionUntilIncluded(
+            // Wait for transaction to get accepted
+            const blockId = await wallet.waitForTransactionAcceptance(
                 transaction.transactionId,
             );
 
             console.log(
-                `Block included: ${process.env.EXPLORER_URL}/block/${blockId}`,
+                `Tx accepted in block: ${process.env.EXPLORER_URL}/block/${blockId}`,
             );
 
             balance = await wallet.sync();

diff --git a/bindings/nodejs/examples/how_tos/nft_collection/00_mint_issuer_nft.ts b/bindings/nodejs/examples/how_tos/nft_collection/00_mint_issuer_nft.ts
@@ -54,12 +54,12 @@ async function run() {
         };
         const transaction = await wallet.mintNfts([params]);
 
-        // Wait for transaction to get included
-        const blockId = await wallet.reissueTransactionUntilIncluded(
+        // Wait for transaction to get accepted
+        const blockId = await wallet.waitForTransactionAcceptance(
             transaction.transactionId,
         );
         console.log(
-            `Block included: ${process.env.EXPLORER_URL}/block/${blockId}`,
+            `Tx accepted in block: ${process.env.EXPLORER_URL}/block/${blockId}`,
         );
 
         transaction.payload.transaction.outputs.forEach(

diff --git a/bindings/nodejs/examples/how_tos/nft_collection/01_mint_collection_nft.ts b/bindings/nodejs/examples/how_tos/nft_collection/01_mint_collection_nft.ts
@@ -79,12 +79,12 @@ async function run() {
             );
             const transaction = await wallet.mintNfts(chunk);
 
-            // Wait for transaction to get included
-            const blockId = await wallet.reissueTransactionUntilIncluded(
+            // Wait for transaction to get accepted
+            const blockId = await wallet.waitForTransactionAcceptance(
                 transaction.transactionId,
             );
             console.log(
-                `Block included: ${process.env.EXPLORER_URL}/block/${blockId}`,
+                `Tx accepted in block: ${process.env.EXPLORER_URL}/block/${blockId}`,
             );
 
             // Sync so the new outputs are available again for new transactions

diff --git a/bindings/nodejs/examples/how_tos/nfts/burn_nft.ts b/bindings/nodejs/examples/how_tos/nfts/burn_nft.ts
@@ -53,12 +53,12 @@ async function run() {
 
         console.log(`Transaction sent: ${transaction.transactionId}`);
 
-        // Wait for transaction to get included
-        const blockId = await wallet.reissueTransactionUntilIncluded(
+        // Wait for transaction to get accepted
+        const blockId = await wallet.waitForTransactionAcceptance(
             transaction.transactionId,
         );
         console.log(
-            `Block included: ${process.env.EXPLORER_URL}/block/${blockId}`,
+            `Tx accepted in block: ${process.env.EXPLORER_URL}/block/${blockId}`,
         );
         console.log(`Burned NFT ${nftId}`);
 

diff --git a/bindings/nodejs/examples/how_tos/nfts/mint_nft.ts b/bindings/nodejs/examples/how_tos/nfts/mint_nft.ts
@@ -73,13 +73,13 @@ async function run() {
         let transaction = await wallet.mintNfts([params]);
         console.log(`Transaction sent: ${transaction.transactionId}`);
 
-        // Wait for transaction to get included
-        let blockId = await wallet.reissueTransactionUntilIncluded(
+        // Wait for transaction to get accepted
+        let blockId = await wallet.waitForTransactionAcceptance(
             transaction.transactionId,
         );
 
         console.log(
-            `Block included: ${process.env.EXPLORER_URL}/block/${blockId}`,
+            `Tx accepted in block: ${process.env.EXPLORER_URL}/block/${blockId}`,
         );
         console.log('Minted NFT 1');
 
@@ -104,13 +104,13 @@ async function run() {
         transaction = await wallet.sendOutputs([output]);
         console.log(`Transaction sent: ${transaction.transactionId}`);
 
-        // Wait for transaction to get included
-        blockId = await wallet.reissueTransactionUntilIncluded(
+        // Wait for transaction to get accepted
+        blockId = await wallet.waitForTransactionAcceptance(
             transaction.transactionId,
         );
 
         console.log(
-            `Block included: ${process.env.EXPLORER_URL}/block/${blockId}`,
+            `Tx accepted in block: ${process.env.EXPLORER_URL}/block/${blockId}`,
         );
 
         console.log('Minted NFT 2');

diff --git a/bindings/nodejs/examples/how_tos/nfts/send_nft.ts b/bindings/nodejs/examples/how_tos/nfts/send_nft.ts
@@ -59,13 +59,13 @@ async function run() {
 
         console.log(`Transaction sent: ${transaction.transactionId}`);
 
-        // Wait for transaction to get included
-        const blockId = await wallet.reissueTransactionUntilIncluded(
+        // Wait for transaction to get accepted
+        const blockId = await wallet.waitForTransactionAcceptance(
             transaction.transactionId,
         );
 
         console.log(
-            `Block included: ${process.env.EXPLORER_URL}/block/${blockId}`,
+            `Tx accepted in block: ${process.env.EXPLORER_URL}/block/${blockId}`,
         );
 
         // To send an NFT with expiration unlock condition prepareOutput() can be used like this:

diff --git a/bindings/nodejs/examples/how_tos/wallet/consolidate-outputs.ts b/bindings/nodejs/examples/how_tos/wallet/consolidate-outputs.ts
@@ -67,13 +67,13 @@ async function run() {
         });
         console.log('Transaction sent: %s', transaction.transactionId);
 
-        // Wait for the consolidation transaction to get confirmed
-        const blockId = wallet.reissueTransactionUntilIncluded(
+        // Wait for the consolidation transaction to get accepted
+        const blockId = wallet.waitForTransactionAcceptance(
             transaction.transactionId,
         );
 
         console.log(
-            'Transaction included: %s/block/$s',
+            'Transaction accepted: %s/block/$s',
             process.env.EXPLORER_URL,
             blockId,
         );

diff --git a/bindings/nodejs/examples/wallet/06-send-micro-transaction.ts b/bindings/nodejs/examples/wallet/06-send-micro-transaction.ts
@@ -45,13 +45,13 @@ async function run() {
         });
         console.log(`Transaction sent: ${transaction.transactionId}`);
 
-        // Wait for transaction to get included
-        const blockId = await wallet.reissueTransactionUntilIncluded(
+        // Wait for transaction to get accepted
+        const blockId = await wallet.waitForTransactionAcceptance(
             transaction.transactionId,
         );
 
         console.log(
-            `Block included: ${process.env.EXPLORER_URL}/block/${blockId}`,
+            `Tx accepted in block: ${process.env.EXPLORER_URL}/block/${blockId}`,
         );
     } catch (error) {
         console.log('Error: ', error);

diff --git a/bindings/nodejs/lib/types/error.ts b/bindings/nodejs/lib/types/error.ts
@@ -44,7 +44,7 @@ export type ClientErrorName =
     | 'secretManagerMismatch'
     | 'healthyNodePoolEmpty'
     | 'taggedData'
-    | 'tangleInclusion'
+    | 'transactionAcceptance'
     | 'taskJoin'
     | 'timeNotSynced'
     | 'transactionSemantic'

diff --git a/bindings/nodejs/lib/types/wallet/bridge/index.ts b/bindings/nodejs/lib/types/wallet/bridge/index.ts
@@ -33,7 +33,7 @@ import type {
     __PrepareEndStakingMethod__,
     __PrepareTransactionMethod__,
     __RegisterParticipationEventsMethod__,
-    __ReissueTransactionUntilIncludedMethod__,
+    __WaitForTransactionAcceptanceMethod__,
     __SendMethod__,
     __SendWithParamsMethod__,
     __PrepareSendNativeTokensMethod__,
@@ -114,7 +114,7 @@ export type __WalletMethod__ =
     | __PrepareEndStakingMethod__
     | __PrepareTransactionMethod__
     | __RegisterParticipationEventsMethod__
-    | __ReissueTransactionUntilIncludedMethod__
+    | __WaitForTransactionAcceptanceMethod__
     | __SendMethod__
     | __SendWithParamsMethod__
     | __PrepareSendNativeTokensMethod__

diff --git a/bindings/nodejs/lib/types/wallet/bridge/wallet.ts b/bindings/nodejs/lib/types/wallet/bridge/wallet.ts
@@ -372,8 +372,8 @@ export type __RegisterParticipationEventsMethod__ = {
     };
 };
 
-export type __ReissueTransactionUntilIncludedMethod__ = {
-    name: 'reissueTransactionUntilIncluded';
+export type __WaitForTransactionAcceptanceMethod__ = {
+    name: 'waitForTransactionAcceptance';
     data: {
         transactionId: TransactionId;
         interval?: number;