algosdk 1.12.0 → 1.13.1

package/dist/esm/src/client/v2/indexer/indexer.js

@@ -13,99 +13,256 @@ import SearchAccounts from './searchAccounts';
 import SearchForTransactions from './searchForTransactions';
 import SearchForAssets from './searchForAssets';
 import SearchForApplications from './searchForApplications';
+/**
+ * The Indexer provides a REST API interface of API calls to support searching the Algorand Blockchain.
+ *
+ * The Indexer REST APIs retrieve the blockchain data from a PostgreSQL compatible database that must be populated.
+ *
+ * This database is populated using the same indexer instance or a separate instance of the indexer which must connect to the algod process of a running Algorand node to read block data.
+ *
+ * This node must also be an Archival node to make searching the entire blockchain possible.
+ *
+ * #### Relevant Information
+ * [Learn more about Indexer](https://developer.algorand.org/docs/get-details/indexer/)
+ *
+ * [Run Indexer in Postman OAS3](https://developer.algorand.org/docs/rest-apis/restendpoints/#algod-indexer-and-kmd-rest-endpoints)
+ */
 export default class IndexerClient extends ServiceClient {
-    constructor(token, baseServer = 'http://127.0.0.1', port = 8080, headers = {}) {
-        super('X-Indexer-API-Token', token, baseServer, port, headers);
+    /**
+     * Create an IndexerClient from
+     * * either a token, baseServer, port, and optional headers
+     * * or a base client server for interoperability with external dApp wallets
+     *
+     * #### Example
+     * ```typescript
+     * const token  = "";
+     * const server = "http://localhost";
+     * const port   = 8980;
+     * const indexerClient = new algosdk.Indexer(token, server, port);
+     * ```
+     * @remarks
+     * The above configuration is for a sandbox private network.
+     * For applications on production, you are encouraged to run your own node with indexer, or use an Algorand REST API provider with a dedicated API key.
+     *
+     * @param tokenOrBaseClient - The API token for the Indexer API
+     * @param baseServer - REST endpoint
+     * @param port - Port number if specifically configured by the server
+     * @param headers - Optional headers
+     */
+    constructor(tokenOrBaseClient, baseServer = 'http://127.0.0.1', port = 8080, headers = {}) {
+        super('X-Indexer-API-Token', tokenOrBaseClient, baseServer, port, headers);
     }
     /**
      * Returns the health object for the service.
+     * Returns 200 if healthy.
+     *
+     * #### Example
+     * ```typescript
+     * const health = await indexerClient.makeHealthCheck().do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-health)
+     * @category GET
      */
     makeHealthCheck() {
         return new MakeHealthCheck(this.c, this.intDecoding);
     }
     /**
-     * Returns holder balances for the given asset.
+     * Returns the list of accounts who hold the given asset and their balance.
+     *
+     * #### Example
+     * ```typescript
+     * const assetId = 163650;
+     * const assetBalances = await indexerClient.lookupAssetBalances(assetId).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2assetsasset-idbalances)
      * @param index - The asset ID to look up.
+     * @category GET
      */
     lookupAssetBalances(index) {
         return new LookupAssetBalances(this.c, this.intDecoding, index);
     }
     /**
      * Returns transactions relating to the given asset.
+     *
+     * #### Example
+     * ```typescript
+     * const assetId = 163650;
+     * const assetTxns = await indexerClient.lookupAssetTransactions(assetId).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2assetsasset-idtransactions)
      * @param index - The asset ID to look up.
+     * @category GET
      */
     lookupAssetTransactions(index) {
         return new LookupAssetTransactions(this.c, this.intDecoding, index);
     }
     /**
      * Returns transactions relating to the given account.
+     *
+     * #### Example
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient.lookupAccountTransactions(address).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2accountsaccount-idtransactions)
      * @param account - The address of the account.
+     * @category GET
      */
     lookupAccountTransactions(account) {
         return new LookupAccountTransactions(this.c, this.intDecoding, account);
     }
     /**
      * Returns the block for the passed round.
+     *
+     * #### Example
+     * ```typescript
+     * const targetBlock = 18309917;
+     * const blockInfo = await indexerClient.lookupBlock(targetBlock).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2blocksround-number)
      * @param round - The number of the round to look up.
+     * @category GET
      */
     lookupBlock(round) {
         return new LookupBlock(this.c, this.intDecoding, round);
     }
     /**
      * Returns information about the given transaction.
+     *
+     * #### Example
+     * ```typescript
+     * const txnId = "MEUOC4RQJB23CQZRFRKYEI6WBO73VTTPST5A7B3S5OKBUY6LFUDA";
+     * const txnInfo = await indexerClient.lookupTransactionByID(txnId).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2transactionstxid)
      * @param txID - The ID of the transaction to look up.
+     * @category GET
      */
     lookupTransactionByID(txID) {
         return new LookupTransactionByID(this.c, this.intDecoding, txID);
     }
     /**
      * Returns information about the given account.
+     *
+     * #### Example
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountInfo = await indexerClient.lookupAccountByID(address).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2accountsaccount-id)
      * @param account - The address of the account to look up.
+     * @category GET
      */
     lookupAccountByID(account) {
         return new LookupAccountByID(this.c, this.intDecoding, account);
     }
     /**
      * Returns information about the passed asset.
+     *
+     * #### Example
+     * ```typescript
+     * const assetId = 163650;
+     * const assetInfo = await indexerClient.lookupAssetByID(assetId).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2assetsasset-id)
      * @param index - The ID of the asset ot look up.
+     * @category GET
      */
     lookupAssetByID(index) {
         return new LookupAssetByID(this.c, this.intDecoding, index);
     }
     /**
      * Returns information about the passed application.
+     *
+     * #### Example
+     * ```typescript
+     * const appId = 60553466;
+     * const appInfo = await indexerClient.lookupApplications(appId).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2applicationsapplication-id)
      * @param index - The ID of the application to look up.
+     * @category GET
      */
     lookupApplications(index) {
         return new LookupApplications(this.c, this.intDecoding, index);
     }
     /**
      * Returns log messages generated by the passed in application.
+     *
+     * #### Example
+     * ```typescript
+     * const appId = 60553466;
+     * const appLogs = await indexerClient.lookupApplicationLogs(appId).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2applicationsapplication-idlogs)
      * @param appID - The ID of the application which generated the logs.
+     * @category GET
      */
     lookupApplicationLogs(appID) {
         return new LookupApplicationLogs(this.c, this.intDecoding, appID);
     }
     /**
      * Returns information about indexed accounts.
+     *
+     * #### Example
+     * ```typescript
+     * const accounts = await indexerClient.searchAccounts().do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2accounts)
+     * @category GET
      */
     searchAccounts() {
         return new SearchAccounts(this.c, this.intDecoding);
     }
     /**
      * Returns information about indexed transactions.
+     *
+     * #### Example
+     * ```typescript
+     * const txns = await indexerClient.searchForTransactions().do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2transactions)
+     * @category GET
      */
     searchForTransactions() {
         return new SearchForTransactions(this.c, this.intDecoding);
     }
     /**
      * Returns information about indexed assets.
+     *
+     * #### Example
+     * ```typescript
+     * const assets = await indexerClient.searchForAssets().do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2assets)
+     * @category GET
      */
     searchForAssets() {
         return new SearchForAssets(this.c, this.intDecoding);
     }
     /**
      * Returns information about indexed applications.
+     *
+     * #### Example
+     * ```typescript
+     * const apps = await indexerClient.searchForApplications().do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2applications)
+     * @category GET
      */
     searchForApplications() {
         return new SearchForApplications(this.c, this.intDecoding);

package/dist/esm/src/client/v2/indexer/indexer.js.map

@@ -1 +1 @@
-{"version":3,"file":"indexer.js","sourceRoot":"","sources":["../../../../../../src/client/v2/indexer/indexer.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,kBAAkB,CAAC;AAE7C,OAAO,eAAe,MAAM,mBAAmB,CAAC;AAChD,OAAO,mBAAmB,MAAM,uBAAuB,CAAC;AACxD,OAAO,uBAAuB,MAAM,2BAA2B,CAAC;AAChE,OAAO,yBAAyB,MAAM,6BAA6B,CAAC;AACpE,OAAO,WAAW,MAAM,eAAe,CAAC;AACxC,OAAO,qBAAqB,MAAM,yBAAyB,CAAC;AAC5D,OAAO,iBAAiB,MAAM,qBAAqB,CAAC;AACpD,OAAO,eAAe,MAAM,mBAAmB,CAAC;AAChD,OAAO,kBAAkB,MAAM,sBAAsB,CAAC;AACtD,OAAO,qBAAqB,MAAM,yBAAyB,CAAC;AAC5D,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,qBAAqB,MAAM,yBAAyB,CAAC;AAC5D,OAAO,eAAe,MAAM,mBAAmB,CAAC;AAChD,OAAO,qBAAqB,MAAM,yBAAyB,CAAC;AAE5D,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,aAAa;IACtD,YACE,KAAsD,EACtD,UAAU,GAAG,kBAAkB,EAC/B,OAAwB,IAAI,EAC5B,OAAO,GAAG,EAAE;QAEZ,KAAK,CAAC,qBAAqB,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;IAED;;OAEG;IACH,eAAe;QACb,OAAO,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IACvD,CAAC;IAED;;;OAGG;IACH,mBAAmB,CAAC,KAAa;QAC/B,OAAO,IAAI,mBAAmB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IAClE,CAAC;IAED;;;OAGG;IACH,uBAAuB,CAAC,KAAa;QACnC,OAAO,IAAI,uBAAuB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IACtE,CAAC;IAED;;;OAGG;IACH,yBAAyB,CAAC,OAAe;QACvC,OAAO,IAAI,yBAAyB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;IAED;;;OAGG;IACH,WAAW,CAAC,KAAa;QACvB,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IAC1D,CAAC;IAED;;;OAGG;IACH,qBAAqB,CAAC,IAAY;QAChC,OAAO,IAAI,qBAAqB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;IACnE,CAAC;IAED;;;OAGG;IACH,iBAAiB,CAAC,OAAe;QAC/B,OAAO,IAAI,iBAAiB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;OAGG;IACH,eAAe,CAAC,KAAa;QAC3B,OAAO,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IAC9D,CAAC;IAED;;;OAGG;IACH,kBAAkB,CAAC,KAAa;QAC9B,OAAO,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IACjE,CAAC;IAED;;;OAGG;IACH,qBAAqB,CAAC,KAAa;QACjC,OAAO,IAAI,qBAAqB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IACpE,CAAC;IAED;;OAEG;IACH,cAAc;QACZ,OAAO,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IACtD,CAAC;IAED;;OAEG;IACH,qBAAqB;QACnB,OAAO,IAAI,qBAAqB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IAC7D,CAAC;IAED;;OAEG;IACH,eAAe;QACb,OAAO,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IACvD,CAAC;IAED;;OAEG;IACH,qBAAqB;QACnB,OAAO,IAAI,qBAAqB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IAC7D,CAAC;CACF"}
+{"version":3,"file":"indexer.js","sourceRoot":"","sources":["../../../../../../src/client/v2/indexer/indexer.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,kBAAkB,CAAC;AAC7C,OAAO,eAAe,MAAM,mBAAmB,CAAC;AAChD,OAAO,mBAAmB,MAAM,uBAAuB,CAAC;AACxD,OAAO,uBAAuB,MAAM,2BAA2B,CAAC;AAChE,OAAO,yBAAyB,MAAM,6BAA6B,CAAC;AACpE,OAAO,WAAW,MAAM,eAAe,CAAC;AACxC,OAAO,qBAAqB,MAAM,yBAAyB,CAAC;AAC5D,OAAO,iBAAiB,MAAM,qBAAqB,CAAC;AACpD,OAAO,eAAe,MAAM,mBAAmB,CAAC;AAChD,OAAO,kBAAkB,MAAM,sBAAsB,CAAC;AACtD,OAAO,qBAAqB,MAAM,yBAAyB,CAAC;AAC5D,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,qBAAqB,MAAM,yBAAyB,CAAC;AAC5D,OAAO,eAAe,MAAM,mBAAmB,CAAC;AAChD,OAAO,qBAAqB,MAAM,yBAAyB,CAAC;AAO5D;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,aAAa;IACtD;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,YACE,iBAIkB,EAClB,UAAU,GAAG,kBAAkB,EAC/B,OAAwB,IAAI,EAC5B,UAAkC,EAAE;QAEpC,KAAK,CAAC,qBAAqB,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;;OAWG;IACH,eAAe;QACb,OAAO,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,mBAAmB,CAAC,KAAa;QAC/B,OAAO,IAAI,mBAAmB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,uBAAuB,CAAC,KAAa;QACnC,OAAO,IAAI,uBAAuB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,yBAAyB,CAAC,OAAe;QACvC,OAAO,IAAI,yBAAyB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,KAAa;QACvB,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,qBAAqB,CAAC,IAAY;QAChC,OAAO,IAAI,qBAAqB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,iBAAiB,CAAC,OAAe;QAC/B,OAAO,IAAI,iBAAiB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,eAAe,CAAC,KAAa;QAC3B,OAAO,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,kBAAkB,CAAC,KAAa;QAC9B,OAAO,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,qBAAqB,CAAC,KAAa;QACjC,OAAO,IAAI,qBAAqB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;OAUG;IACH,cAAc;QACZ,OAAO,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;;;;OAUG;IACH,qBAAqB;QACnB,OAAO,IAAI,qBAAqB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;;OAUG;IACH,eAAe;QACb,OAAO,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;;;OAUG;IACH,qBAAqB;QACnB,OAAO,IAAI,qBAAqB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IAC7D,CAAC;CACF"}

package/dist/esm/src/client/v2/indexer/lookupAssetBalances.js

@@ -1,5 +1,17 @@
 import JSONRequest from '../jsonrequest';
 export default class LookupAssetBalances extends JSONRequest {
+    /**
+     * Returns the list of accounts which hold the given asset and their balance.
+     *
+     * #### Example
+     * ```typescript
+     * const assetId = 163650;
+     * const assetBalances = await indexerClient.lookupAssetBalances(assetId).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2assetsasset-idbalances)
+     * @param index - The asset ID to look up.
+     */
     constructor(c, intDecoding, index) {
         super(c, intDecoding);
         this.index = index;
@@ -8,32 +20,112 @@ export default class LookupAssetBalances extends JSONRequest {
     path() {
         return `/v2/assets/${this.index}/balances`;
     }
-    // limit for filter, as int
+    /**
+     * Add a limit for filter.
+     *
+     * #### Example
+     * ```typescript
+     * const assetId = 163650;
+     * const maxResults = 20;
+     * const assetBalances = await indexerClient
+     *        .lookupAssetBalances(assetId)
+     *        .limit(maxResults)
+     *        .do();
+     * ```
+     *
+     * @param limit - maximum number of results to return.
+     */
     limit(limit) {
         this.query.limit = limit;
         return this;
     }
-    // round to filter with, as int
+    /**
+     * Specify round to filter with.
+     *
+     * #### Example
+     * ```typescript
+     * const assetId = 163650;
+     * const targetBlock = 18309917;
+     * const assetBalances = await indexerClient
+     *        .lookupAssetBalances(assetId)
+     *        .round(targetBlock)
+     *        .do();
+     * ```
+     * @param round
+     */
     round(round) {
         this.query.round = round;
         return this;
     }
-    // filtered results should have an amount greater than this value, as int, with units representing the asset
+    /**
+     * Filtered results should have an asset balance greater than this value.
+     *
+     * #### Example
+     * ```typescript
+     * const assetId = 163650;
+     * const minBalance = 1000000;
+     * const assetBalances = await indexerClient
+     *        .lookupAssetBalances(assetId)
+     *        .currencyGreaterThan(minBalance)
+     *        .do();
+     * ```
+     * @param greater
+     */
     currencyGreaterThan(greater) {
         this.query['currency-greater-than'] = greater;
         return this;
     }
-    // filtered results should have an amount less than this value, as int, with units representing the asset units
+    /**
+     * Filtered results should have an asset balance less than this value.
+     *
+     * #### Example
+     * ```typescript
+     * const assetId = 163650;
+     * const maxBalance = 2000000;
+     * const assetBalances = await indexerClient
+     *        .lookupAssetBalances(assetId)
+     *        .currencyLessThan(maxBalance)
+     *        .do();
+     * ```
+     * @param lesser
+     */
     currencyLessThan(lesser) {
         this.query['currency-less-than'] = lesser;
         return this;
     }
-    // used for pagination
+    /**
+     * Specify the next page of results.
+     *
+     * #### Example
+     * ```typescript
+     * const assetId = 163650;
+     * const maxResults = 20;
+     * const nextToken = "APA6C7C3NCANRPIBUWQOF7WSKLJMK6RPQUVFLLDV4U5WCQE4DEF26D4E3E";
+     * const assetBalances = await indexerClient
+     *        .lookupAssetBalances(assetId)
+     *        .limit(maxResults)
+     *        .next(nextToken)
+     *        .do();
+     * ```
+     * @param nextToken - provided by the previous results.
+     */
     nextToken(nextToken) {
         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
+    /**
+     * Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates
+     *
+     * #### Example
+     * ```typescript
+     * const assetId = 163650;
+     * const assetBalances = await indexerClient
+     *        .lookupAssetBalances(assetId)
+     *        .includeAll(false)
+     *        .do();
+     * ```
+     * @param value
+     */
     includeAll(value = true) {
         this.query['include-all'] = value;
         return this;

package/dist/esm/src/client/v2/indexer/lookupAssetBalances.js.map

@@ -1 +1 @@
-{"version":3,"file":"lookupAssetBalances.js","sourceRoot":"","sources":["../../../../../../src/client/v2/indexer/lookupAssetBalances.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,gBAAgB,CAAC;AAIzC,MAAM,CAAC,OAAO,OAAO,mBAAoB,SAAQ,WAAW;IAC1D,YAAY,CAAa,EAAE,WAAwB,EAAU,KAAa;QACxE,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;QADqC,UAAK,GAAL,KAAK,CAAQ;QAExE,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED,IAAI;QACF,OAAO,cAAc,IAAI,CAAC,KAAK,WAAW,CAAC;IAC7C,CAAC;IAED,2BAA2B;IAC3B,KAAK,CAAC,KAAa;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,+BAA+B;IAC/B,KAAK,CAAC,KAAa;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,4GAA4G;IAC5G,mBAAmB,CAAC,OAAe;QACjC,IAAI,CAAC,KAAK,CAAC,uBAAuB,CAAC,GAAG,OAAO,CAAC;QAC9C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,+GAA+G;IAC/G,gBAAgB,CAAC,MAAc;QAC7B,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAC,GAAG,MAAM,CAAC;QAC1C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,sBAAsB;IACtB,SAAS,CAAC,SAAiB;QACzB,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,SAAS,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,wJAAwJ;IACxJ,UAAU,CAAC,KAAK,GAAG,IAAI;QACrB,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}
+{"version":3,"file":"lookupAssetBalances.js","sourceRoot":"","sources":["../../../../../../src/client/v2/indexer/lookupAssetBalances.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,gBAAgB,CAAC;AAIzC,MAAM,CAAC,OAAO,OAAO,mBAAoB,SAAQ,WAAW;IAC1D;;;;;;;;;;;OAWG;IACH,YAAY,CAAa,EAAE,WAAwB,EAAU,KAAa;QACxE,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;QADqC,UAAK,GAAL,KAAK,CAAQ;QAExE,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED,IAAI;QACF,OAAO,cAAc,IAAI,CAAC,KAAK,WAAW,CAAC;IAC7C,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,KAAa;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,KAAa;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,mBAAmB,CAAC,OAAe;QACjC,IAAI,CAAC,KAAK,CAAC,uBAAuB,CAAC,GAAG,OAAO,CAAC;QAC9C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,gBAAgB,CAAC,MAAc;QAC7B,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAC,GAAG,MAAM,CAAC;QAC1C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,SAAS,CAAC,SAAiB;QACzB,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,SAAS,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,UAAU,CAAC,KAAK,GAAG,IAAI;QACrB,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}

package/dist/esm/src/client/v2/serviceClient.js

@@ -10,21 +10,30 @@ function convertTokenStringToTokenHeader(token = '', headerIdentifier) {
     tokenHeader[headerIdentifier] = token;
     return tokenHeader;
 }
+function isBaseHTTPClient(tbc) {
+    return typeof tbc.get === 'function';
+}
 /**
  * Abstract service client to encapsulate shared AlgodClient and IndexerClient logic
  */
 export default class ServiceClient {
-    constructor(tokenHeaderIdentifier, tokenHeaderOrStr, baseServer, port, defaultHeaders = {}) {
-        // Accept token header as string or object
-        // - workaround to allow backwards compatibility for multiple headers
-        let tokenHeader;
-        if (typeof tokenHeaderOrStr === 'string') {
-            tokenHeader = convertTokenStringToTokenHeader(tokenHeaderOrStr, tokenHeaderIdentifier);
+    constructor(tokenHeaderIdentifier, tokenHeaderOrStrOrBaseClient, baseServer, port, defaultHeaders = {}) {
+        if (isBaseHTTPClient(tokenHeaderOrStrOrBaseClient)) {
+            // we are using a base client
+            this.c = new HTTPClient(tokenHeaderOrStrOrBaseClient);
         }
         else {
-            tokenHeader = tokenHeaderOrStr;
+            // Accept token header as string or object
+            // - workaround to allow backwards compatibility for multiple headers
+            let tokenHeader;
+            if (typeof tokenHeaderOrStrOrBaseClient === 'string') {
+                tokenHeader = convertTokenStringToTokenHeader(tokenHeaderOrStrOrBaseClient, tokenHeaderIdentifier);
+            }
+            else {
+                tokenHeader = tokenHeaderOrStrOrBaseClient;
+            }
+            this.c = new HTTPClient(tokenHeader, baseServer, port, defaultHeaders);
         }
-        this.c = new HTTPClient(tokenHeader, baseServer, port, defaultHeaders);
         this.intDecoding = IntDecoding.DEFAULT;
     }
     /**

package/dist/esm/src/client/v2/serviceClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"serviceClient.js","sourceRoot":"","sources":["../../../../../src/client/v2/serviceClient.ts"],"names":[],"mappings":"AAAA,OAAO,UAA2B,MAAM,WAAW,CAAC;AACpD,OAAO,WAAW,MAAM,yBAAyB,CAAC;AAQlD;;;;GAIG;AACH,SAAS,+BAA+B,CACtC,QAAgB,EAAE,EAClB,gBAAuC;IAEvC,MAAM,WAAW,GAAG,EAAE,CAAC;IACvB,WAAW,CAAC,gBAAgB,CAAC,GAAG,KAAK,CAAC;IACtC,OAAO,WAA0B,CAAC;AACpC,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,OAAgB,aAAa;IAIzC,YACE,qBAA4C,EAC5C,gBAAsC,EACtC,UAAkB,EAClB,IAAsB,EACtB,iBAAsC,EAAE;QAExC,0CAA0C;QAC1C,qEAAqE;QACrE,IAAI,WAAwB,CAAC;QAC7B,IAAI,OAAO,gBAAgB,KAAK,QAAQ,EAAE;YACxC,WAAW,GAAG,+BAA+B,CAC3C,gBAAgB,EAChB,qBAAqB,CACtB,CAAC;SACH;aAAM;YACL,WAAW,GAAG,gBAAgB,CAAC;SAChC;QAED,IAAI,CAAC,CAAC,GAAG,IAAI,UAAU,CAAC,WAAW,EAAE,UAAU,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC;QACvE,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC,OAAO,CAAC;IACzC,CAAC;IAED;;;;;OAKG;IACH,cAAc,CAAC,MAAmB;QAChC,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,cAAc;QACZ,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;CACF"}
+{"version":3,"file":"serviceClient.js","sourceRoot":"","sources":["../../../../../src/client/v2/serviceClient.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,WAAW,CAAC;AACnC,OAAO,WAAW,MAAM,yBAAyB,CAAC;AAUlD;;;;GAIG;AACH,SAAS,+BAA+B,CACtC,QAAgB,EAAE,EAClB,gBAAuC;IAEvC,MAAM,WAAW,GAAG,EAAE,CAAC;IACvB,WAAW,CAAC,gBAAgB,CAAC,GAAG,KAAK,CAAC;IACtC,OAAO,WAA0B,CAAC;AACpC,CAAC;AAED,SAAS,gBAAgB,CACvB,GAA0C;IAE1C,OAAO,OAAQ,GAAsB,CAAC,GAAG,KAAK,UAAU,CAAC;AAC3D,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,OAAgB,aAAa;IAMzC,YACE,qBAA4C,EAC5C,4BAAmE,EACnE,UAAkB,EAClB,IAAsB,EACtB,iBAAsC,EAAE;QAExC,IAAI,gBAAgB,CAAC,4BAA4B,CAAC,EAAE;YAClD,6BAA6B;YAC7B,IAAI,CAAC,CAAC,GAAG,IAAI,UAAU,CAAC,4BAA4B,CAAC,CAAC;SACvD;aAAM;YACL,0CAA0C;YAC1C,qEAAqE;YACrE,IAAI,WAAwB,CAAC;YAC7B,IAAI,OAAO,4BAA4B,KAAK,QAAQ,EAAE;gBACpD,WAAW,GAAG,+BAA+B,CAC3C,4BAA4B,EAC5B,qBAAqB,CACtB,CAAC;aACH;iBAAM;gBACL,WAAW,GAAG,4BAA4B,CAAC;aAC5C;YAED,IAAI,CAAC,CAAC,GAAG,IAAI,UAAU,CAAC,WAAW,EAAE,UAAU,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC;SACxE;QAED,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC,OAAO,CAAC;IACzC,CAAC;IAED;;;;;OAKG;IACH,cAAc,CAAC,MAAmB;QAChC,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,cAAc;QACZ,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;CACF"}