Support new features from indexer 2.3.2 (#296)

* Support new features from indexer 2.3.2

* Add helper function for includeAll

* Fix browser tests by adding equivalent helper function

* Add new endpoints

* Improve proof docstring

* Fix genesis path

Makefile

@@ -1,7 +1,7 @@
 unit:
-	node_modules/.bin/cucumber-js --tags "@unit.offline or @unit.algod or @unit.indexer or @unit.rekey or @unit.tealsign or @unit.dryrun or @unit.applications or @unit.responses or @unit.transactions" tests/cucumber/features --require tests/cucumber/steps/index.js
+	node_modules/.bin/cucumber-js --tags "@unit.offline or @unit.algod or @unit.indexer or @unit.rekey or @unit.tealsign or @unit.dryrun or @unit.applications or @unit.responses or @unit.transactions or @unit.responses.231" tests/cucumber/features --require tests/cucumber/steps/index.js
 integration:
-	node_modules/.bin/cucumber-js --tags "@algod or @assets or @auction or @kmd or @send or @template or @indexer or @rekey or @dryrun or @compile or @applications or @indexer.applications or @applications.verified" tests/cucumber/features --require tests/cucumber/steps/index.js
+	node_modules/.bin/cucumber-js --tags "@algod or @assets or @auction or @kmd or @send or @template or @indexer or @rekey or @dryrun or @compile or @applications or @indexer.applications or @applications.verified or @indexer.231" tests/cucumber/features --require tests/cucumber/steps/index.js
 
 docker-test:
 	./tests/cucumber/docker/run_docker.sh

src/client/v2/algod/algod.js

@@ -15,6 +15,8 @@ const sab = require('./statusAfterBlock');
 const sp = require('./suggestedParams');
 const supply = require('./supply');
 const versions = require('./versions');
+const genesis = require('./genesis');
+const proof = require('./proof');
 
 class AlgodClient {
   constructor(
@@ -157,6 +159,22 @@ class AlgodClient {
   getApplicationByID(index) {
     return new gapbid.GetApplicationByID(this.c, this.intDecoding, index);
   }
+
+  /**
+   * Returns the entire genesis file.
+   */
+  genesis() {
+    return new genesis.Genesis(this.c, this.intDecoding);
+  }
+
+  /**
+   * Get the proof for a given transaction in a round.
+   * @param {number} round The round in which the transaction appears.
+   * @param {string} txID The transaction ID for which to generate a proof.
+   */
+  getProof(round, txID) {
+    return new proof.Proof(this.c, this.intDecoding, round, txID);
+  }
 }
 
 module.exports = { AlgodClient };

src/client/v2/algod/genesis.js

@@ -0,0 +1,10 @@
+const { JSONRequest } = require('../jsonrequest');
+
+class Genesis extends JSONRequest {
+  // eslint-disable-next-line no-underscore-dangle,class-methods-use-this
+  _path() {
+    return '/genesis';
+  }
+}
+
+module.exports = { Genesis };

src/client/v2/algod/proof.js

@@ -0,0 +1,16 @@
+const { JSONRequest } = require('../jsonrequest');
+
+class Proof extends JSONRequest {
+  constructor(c, intDecoding, round, txID) {
+    super(c, intDecoding);
+    this.round = round;
+    this.txID = txID;
+  }
+
+  // eslint-disable-next-line no-underscore-dangle
+  _path() {
+    return `/v2/blocks/${this.round}/transactions/${this.txID}/proof`;
+  }
+}
+
+module.exports = { Proof };

src/client/v2/indexer/indexer.js

@@ -7,6 +7,7 @@ const lasb = require('./lookupAssetBalances');
 const lasbid = require('./lookupAssetByID');
 const last = require('./lookupAssetTransactions');
 const lb = require('./lookupBlock');
+const ltbid = require('./lookupTransactionByID');
 const sfas = require('./searchForAssets');
 const sfapp = require('./searchForApplications');
 const sft = require('./searchForTransactions');
@@ -90,6 +91,14 @@ class IndexerClient {
     return new lb.LookupBlock(this.c, this.intDecoding, round);
   }
 
+  /**
+   * Returns information about the given transaction.
+   * @param {string} txID The ID of the transaction to look up.
+   */
+  lookupTransactionByID(txID) {
+    return new ltbid.LookupTransactionByID(this.c, this.intDecoding, txID);
+  }
+
   /**
    * Returns information about the given account.
    * @param {string} account The address of the account to look up.

src/client/v2/indexer/lookupAccountByID.js

@@ -11,10 +11,17 @@ class LookupAccountByID extends JSONRequest {
     return `/v2/accounts/${this.account}`;
   }
 
+  // specific round to search
   round(round) {
     this.query.round = round;
     return this;
   }
+
+  // include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates
+  includeAll(value = true) {
+    this.query['include-all'] = value;
+    return this;
+  }
 }
 
 module.exports = { LookupAccountByID };

src/client/v2/indexer/lookupApplications.js

@@ -11,9 +11,9 @@ class LookupApplications extends JSONRequest {
     return `/v2/applications/${this.index}`;
   }
 
-  // specific round to search
-  round(round) {
-    this.query.round = round;
+  // include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates
+  includeAll(value = true) {
+    this.query['include-all'] = value;
     return this;
   }
 }

src/client/v2/indexer/lookupAssetBalances.js

@@ -40,6 +40,12 @@ class LookupAssetBalances extends JSONRequest {
     this.query.next = nextToken;
     return this;
   }
+
+  // include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates
+  includeAll(value = true) {
+    this.query['include-all'] = value;
+    return this;
+  }
 }
 
 module.exports = { LookupAssetBalances };

src/client/v2/indexer/lookupAssetByID.js

@@ -10,6 +10,12 @@ class LookupAssetByID extends JSONRequest {
   _path() {
     return `/v2/assets/${this.index}`;
   }
+
+  // include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates
+  includeAll(value = true) {
+    this.query['include-all'] = value;
+    return this;
+  }
 }
 
 module.exports = { LookupAssetByID };

src/client/v2/indexer/lookupTransactionByID.js

@@ -0,0 +1,15 @@
+const { JSONRequest } = require('../jsonrequest');
+
+class LookupTransactionByID extends JSONRequest {
+  constructor(c, intDecoding, txID) {
+    super(c, intDecoding);
+    this.txID = txID;
+  }
+
+  // eslint-disable-next-line no-underscore-dangle
+  _path() {
+    return `/v2/transactions/${this.txID}`;
+  }
+}
+
+module.exports = { LookupTransactionByID };

src/client/v2/indexer/searchAccounts.js

@@ -53,6 +53,12 @@ class SearchAccounts extends JSONRequest {
     this.query['application-id'] = applicationID;
     return this;
   }
+
+  // include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates
+  includeAll(value = true) {
+    this.query['include-all'] = value;
+    return this;
+  }
 }
 
 module.exports = { SearchAccounts };

src/client/v2/indexer/searchForApplications.js

@@ -12,12 +12,6 @@ class SearchForApplications extends JSONRequest {
     return this;
   }
 
-  // specific round to search
-  round(round) {
-    this.query.round = round;
-    return this;
-  }
-
   // token for pagination
   nextToken(next) {
     this.query.next = next;
@@ -29,6 +23,12 @@ class SearchForApplications extends JSONRequest {
     this.query.limit = limit;
     return this;
   }
+
+  // include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates
+  includeAll(value = true) {
+    this.query['include-all'] = value;
+    return this;
+  }
 }
 
 module.exports = { SearchForApplications };

src/client/v2/indexer/searchForAssets.js

@@ -41,6 +41,12 @@ class SearchForAssets extends JSONRequest {
     this.query.next = nextToken;
     return this;
   }
+
+  // include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates
+  includeAll(value = true) {
+    this.query['include-all'] = value;
+    return this;
+  }
 }
 
 module.exports = { SearchForAssets };

tests/cucumber/browser/test.js

@@ -46,3 +46,11 @@ window.makeUint8Array = function makeUint8Array(arg) {
 window.makeEmptyObject = function makeEmptyObject() {
   return {};
 };
+
+window.formatIncludeAll = function formatIncludeAll(includeAll) {
+  if (!['true', 'false'].includes(includeAll)) {
+    throw new Error(`Unknown value for includeAll: ${includeAll}`);
+  }
+
+  return includeAll === 'true';
+};

tests/cucumber/steps/steps.js

@@ -52,6 +52,14 @@ function makeEmptyObject() {
   return {};
 }
 
+function formatIncludeAll(includeAll) {
+  if (!['true', 'false'].includes(includeAll)) {
+    throw new Error(`Unknown value for includeAll: ${includeAll}`);
+  }
+
+  return includeAll === 'true';
+}
+
 const steps = {
   given: {},
   when: {},
@@ -3219,6 +3227,35 @@ module.exports = function getSteps(options) {
     }
   );
 
+  When(
+    'I use {int} to search for an account with {int}, {int}, {int}, {int}, {string}, {int}, {string} and token {string}',
+    async function (
+      clientNum,
+      assetIndex,
+      limit,
+      currencyGreater,
+      currencyLesser,
+      authAddr,
+      appID,
+      includeAll,
+      nextToken
+    ) {
+      const ic = indexerIntegrationClients[clientNum];
+      integrationSearchAccountsResponse = await ic
+        .searchAccounts()
+        .assetID(assetIndex)
+        .currencyGreaterThan(currencyGreater)
+        .currencyLessThan(currencyLesser)
+        .limit(limit)
+        .authAddr(authAddr)
+        .applicationID(appID)
+        .includeAll(formatIncludeAll(includeAll))
+        .nextToken(nextToken)
+        .do();
+      this.responseForDirectJsonComparison = integrationSearchAccountsResponse;
+    }
+  );
+
   Then(
     'There are {int}, the first has {int}, {int}, {int}, {int}, {string}, {int}, {string}, {string}',
     (
@@ -3435,6 +3472,20 @@ module.exports = function getSteps(options) {
     }
   );
 
+  When(
+    'I use {int} to search for applications with {int}, {int}, {string} and token {string}',
+    async function (clientNum, limit, appID, includeAll, token) {
+      const ic = indexerIntegrationClients[clientNum];
+      this.responseForDirectJsonComparison = await ic
+        .searchForApplications()
+        .limit(limit)
+        .index(appID)
+        .includeAll(formatIncludeAll(includeAll))
+        .nextToken(token)
+        .do();
+    }
+  );
+
   When(
     'I use {int} to lookup application with {int}',
     async function (clientNum, appID) {
@@ -3445,6 +3496,24 @@ module.exports = function getSteps(options) {
     }
   );
 
+  When(
+    'I use {int} to lookup application with {int} and {string}',
+    async function (clientNum, appID, includeAll) {
+      const ic = indexerIntegrationClients[clientNum];
+      try {
+        this.responseForDirectJsonComparison = await ic
+          .lookupApplications(appID)
+          .includeAll(formatIncludeAll(includeAll))
+          .do();
+      } catch (err) {
+        if (err.status !== 404) {
+          throw err;
+        }
+        this.responseForDirectJsonComparison = err.response.body;
+      }
+    }
+  );
+
   function sortKeys(x) {
     // recursively sorts on keys, unless the passed object is an array of dicts that all contain the property 'key',
     // in which case it sorts on the value corresponding to key 'key'