Add wait for confirmation function (#469)

* Added waitForConfirmation to v2 API

* Renamed timeout to waitRounds

* Move to waitForConfirmation function

* Change eslint settings

* Use in cucumber tests

* Delete file from algod folder

Co-authored-by: Damian Barabonkov <damianb@mit.edu>

Author: 2 people

.eslintrc.js

@@ -23,6 +23,7 @@ module.exports = {
         ts: 'never',
       },
     ],
+    'import/prefer-default-export': 'off',
     'lines-between-class-members': [
       'error',
       'always',

src/main.ts

@@ -233,6 +233,7 @@ export { default as Kmd } from './client/kmd';
 export { default as IntDecoding } from './types/intDecoding';
 export { default as Account } from './types/account';
 export { default as Indexer } from './client/v2/indexer/indexer';
+export { waitForConfirmation } from './wait';
 export {
   isValidAddress,
   encodeAddress,

src/wait.ts

@@ -0,0 +1,46 @@
+import Algodv2 from './client/v2/algod/algod';
+
+/**
+ * Wait until a transaction has been confirmed or rejected by the network, or
+ * until 'waitRounds' number of rounds have passed.
+ * @param client - An Algodv2 client
+ * @param txid - The ID of the transaction to wait for.
+ * @param waitRounds - The maximum number of rounds to wait for.
+ * @returns A promise that, upon success, will resolve to the output of the
+ *   `pendingTransactionInformation` call for the confirmed transaction.
+ */
+export async function waitForConfirmation(
+  client: Algodv2,
+  txid: string,
+  waitRounds: number
+): Promise<Record<string, any>> {
+  // Wait until the transaction is confirmed or rejected, or until 'waitRounds'
+  // number of rounds have passed.
+
+  const status = await client.status().do();
+  if (typeof status === 'undefined') {
+    throw new Error('Unable to get node status');
+  }
+  const startRound = status['last-round'] + 1;
+  let currentRound = startRound;
+
+  /* eslint-disable no-await-in-loop */
+  while (currentRound < startRound + waitRounds) {
+    const pendingInfo = await client.pendingTransactionInformation(txid).do();
+
+    if (pendingInfo['confirmed-round']) {
+      // Got the completed Transaction
+      return pendingInfo;
+    }
+
+    if (pendingInfo['pool-error']) {
+      // If there was a pool error, then the transaction has been rejected!
+      throw new Error(`Transaction Rejected: ${pendingInfo['pool-error']}`);
+    }
+
+    await client.statusAfterBlock(currentRound).do();
+    currentRound += 1;
+  }
+  /* eslint-enable no-await-in-loop */
+  throw new Error(`Transaction not confirmed after ${waitRounds} rounds!`);
+}

tests/cucumber/steps/steps.js

@@ -4242,11 +4242,12 @@ module.exports = function getSteps(options) {
       const fundingResponse = await this.v2Client
         .sendRawTransaction(stxKmd)
         .do();
-      await this.v2Client.statusAfterBlock(sp.firstRound + 2).do();
-      const fundingConfirmation = await this.acl.transactionById(
-        fundingResponse.txId
+      const info = await algosdk.waitForConfirmation(
+        this.v2Client,
+        fundingResponse.txId,
+        2
       );
-      assert.deepStrictEqual(true, 'type' in fundingConfirmation);
+      assert.ok(info['confirmed-round'] > 0);
     }
   );
 
@@ -4358,10 +4359,12 @@ module.exports = function getSteps(options) {
   );
 
   Given('I wait for the transaction to be confirmed.', async function () {
-    const sp = await this.v2Client.getTransactionParams().do();
-    await this.v2Client.statusAfterBlock(sp.firstRound + 2).do();
-    const confirmation = await this.acl.transactionById(this.appTxid.txId);
-    assert.deepStrictEqual(true, 'type' in confirmation);
+    const info = await algosdk.waitForConfirmation(
+      this.v2Client,
+      this.appTxid.txId,
+      2
+    );
+    assert.ok(info['confirmed-round'] > 0);
   });
 
   Given('I remember the new application ID.', async function () {