algosdk 1.14.0 → 1.16.0

package/dist/cjs/src/client/v2/indexer/lookupAssetTransactions.js

@@ -6,103 +6,383 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const jsonrequest_1 = __importDefault(require("../jsonrequest"));
 const lookupAccountTransactions_1 = require("./lookupAccountTransactions");
 class LookupAssetTransactions extends jsonrequest_1.default {
+    /**
+     * 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.
+     */
     constructor(c, intDecoding, index) {
         super(c, intDecoding);
         this.index = index;
         this.index = index;
     }
+    /**
+     * @returns `/v2/assets/${index}/transactions`
+     */
     path() {
         return `/v2/assets/${this.index}/transactions`;
     }
     /**
-     * notePrefix to filter with
+     * Specifies a prefix which must be contained in the note field.
+     *
+     * #### Example
+     * ```typescript
+     * const notePrefixBase64Encoded = "Y3JlYXRl";
+     * const assetId = 163650;
+     * const assetTxns = await indexerClient
+     *        .lookupAssetTransactions(assetId)
+     *        .notePrefix(notePrefixBase64Encoded)
+     *        .do();
+     * ```
+     *
      * @param prefix - base64 string or uint8array
+     * @category query
      */
     notePrefix(prefix) {
         this.query['note-prefix'] = lookupAccountTransactions_1.base64StringFunnel(prefix);
         return this;
     }
-    // txtype to filter with, as string
+    /**
+     * Type of transaction to filter with.
+     *
+     * #### Example
+     * ```typescript
+     * const assetId = 163650;
+     * const assetTxns = await indexerClient
+     *        .lookupAssetTransactions(assetId)
+     *        .txType("axfer")
+     *        .do();
+     * ```
+     *
+     * @param type - one of `pay`, `keyreg`, `acfg`, `axfer`, `afrz`, `appl`
+     * @category query
+     */
     txType(type) {
         this.query['tx-type'] = type;
         return this;
     }
-    // sigtype to filter with, as string
+    /**
+     * Type of signature to filter with.
+     * - sig: Standard
+     * - msig: MultiSig
+     * - lsig: LogicSig
+     *
+     * #### Example
+     * ```typescript
+     * const assetId = 163650;
+     * const assetTxns = await indexerClient
+     *        .lookupAssetTransactions(assetId)
+     *        .sigType("lsig")
+     *        .do();
+     * ```
+     *
+     * @param type - one of `sig`, `msig`, `lsig`
+     * @category query
+     */
     sigType(type) {
         this.query['sig-type'] = type;
         return this;
     }
-    // txid to filter with, as string
+    /**
+     * Lookup the specific transaction by ID.
+     *
+     * #### Example
+     * ```typescript
+     * const txId = "MEUOC4RQJB23CQZRFRKYEI6WBO73VTTPST5A7B3S5OKBUY6LFUDA";
+     * const assetId = 163650;
+     * const assetTxns = await indexerClient
+     *        .lookupAssetTransactions(assetId)
+     *        .txid(txId)
+     *        .do();
+     * ```
+     *
+     * @param txid
+     * @category query
+     */
     txid(txid) {
         this.query.txid = txid;
         return this;
     }
-    // round to filter with, as int
+    /**
+     * Include results for the specified round.
+     *
+     * #### Example
+     * ```typescript
+     * const targetBlock = 18309917;
+     * const assetId = 163650;
+     * const assetTxns = await indexerClient
+     *        .lookupAssetTransactions(assetId)
+     *        .round(targetBlock)
+     *        .do();
+     * ```
+     *
+     * @param round
+     * @category query
+     */
     round(round) {
         this.query.round = round;
         return this;
     }
-    // min round to filter with, as int
+    /**
+     * Include results at or after the specified min-round.
+     *
+     * #### Example
+     * ```typescript
+     * const minRound = 18309917;
+     * const assetId = 163650;
+     * const assetTxns = await indexerClient
+     *        .lookupAssetTransactions(assetId)
+     *        .minRound(minRound)
+     *        .do();
+     * ```
+     *
+     * @param round
+     * @category query
+     */
     minRound(round) {
         this.query['min-round'] = round;
         return this;
     }
-    // max round to filter with, as int
+    /**
+     * Include results at or before the specified max-round.
+     *
+     * #### Example
+     * ```typescript
+     * const maxRound = 18309917;
+     * const assetId = 163650;
+     * const assetTxns = await indexerClient
+     *        .lookupAssetTransactions(assetId)
+     *        .maxRound(maxRound)
+     *        .do();
+     * ```
+     *
+     * @param round
+     * @category query
+     */
     maxRound(round) {
         this.query['max-round'] = round;
         return this;
     }
-    // asset ID to filter with, as int
+    /**
+     * @deprecated Redundant query parameter. Asset ID is already passed into the method.
+     */
     assetID(id) {
         this.query['asset-id'] = id;
         return this;
     }
-    // limit for filter, as int
+    /**
+     * Maximum number of results to return.
+     *
+     * #### Example
+     * ```typescript
+     * const maxResults = 25;
+     * const assetId = 163650;
+     * const assetTxns = await indexerClient
+     *        .lookupAssetTransactions(assetId)
+     *        .limit(maxResults)
+     *        .do();
+     * ```
+     *
+     * @param limit
+     * @category query
+     */
     limit(limit) {
         this.query.limit = limit;
         return this;
     }
-    // before-time to filter with, as rfc3339 string
+    /**
+     * Include results before the given time.
+     *
+     * #### Example
+     * ```typescript
+     * const beforeTime = "2022-02-02T20:20:22.02Z";
+     * const assetId = 163650;
+     * const assetTxns = await indexerClient
+     *        .lookupAssetTransactions(assetId)
+     *        .beforeTime(beforeTime)
+     *        .do();
+     * ```
+     *
+     * @param before - rfc3339 string
+     * @category query
+     */
     beforeTime(before) {
         this.query['before-time'] = before;
         return this;
     }
-    // after-time to filter with, as rfc3339 string
+    /**
+     * Include results after the given time.
+     *
+     * #### Example
+     * ```typescript
+     * const afterTime = "2022-10-21T00:00:11.55Z";
+     * const assetId = 163650;
+     * const assetTxns = await indexerClient
+     *        .lookupAssetTransactions(assetId)
+     *        .afterTime(afterTime)
+     *        .do();
+     * ```
+     *
+     * @param after - rfc3339 string
+     * @category query
+     */
     afterTime(after) {
         this.query['after-time'] = after;
         return this;
     }
-    // filtered results should have an amount greater than this value, as int, representing asset units
+    /**
+     * Filtered results should have an amount greater than this value, as int, representing asset units.
+     *
+     * #### Example
+     * ```typescript
+     * const minBalance = 300000;
+     * const assetId = 163650;
+     * const assetTxns = await indexerClient
+     *        .lookupAssetTransactions(assetId)
+     *        .currencyGreaterThan(minBalance - 1)
+     *        .do();
+     * ```
+     *
+     * @remarks
+     * If you are looking for transactions with the currency amount greater than 0, simply construct the query without `currencyGreaterThan` because it doesn't accept `-1`, and passing the `0` `currency-greater-than` value would exclude transactions with a 0 amount.
+     *
+     * @param greater
+     * @category query
+     */
     currencyGreaterThan(greater) {
         this.query['currency-greater-than'] = greater;
         return this;
     }
-    // filtered results should have an amount less than this value, as int, representing asset units
+    /**
+     * Filtered results should have an amount less than this value, as int, representing asset units.
+     *
+     * #### Example
+     * ```typescript
+     * const maxBalance = 500000;
+     * const assetId = 163650;
+     * const assetTxns = await indexerClient
+     *        .lookupAssetTransactions(assetId)
+     *        .currencyLessThan(maxBalance + 1)
+     *        .do();
+     * ```
+     *
+     * @param lesser
+     * @category query
+     */
     currencyLessThan(lesser) {
         this.query['currency-less-than'] = lesser;
         return this;
     }
-    // combined with address, defines what address to filter on, as string
+    /**
+     * Combined with address, defines what address to filter on, as string.
+     *
+     * #### Example
+     * ```typescript
+     * const assetId = 163650;
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const role = "sender";
+     * const assetTxns = await indexerClient
+     *        .lookupAssetTransactions(assetId)
+     *        .address(address)
+     *        .addressRole(role)
+     *        .do();
+     * ```
+     *
+     * @param role - one of `sender`, `receiver`, `freeze-target`
+     * @category query
+     */
     addressRole(role) {
         this.query['address-role'] = role;
         return this;
     }
-    // address to filter on as string
+    /**
+     * Only include transactions with this address in one of the transaction fields.
+     *
+     * #### Example
+     * ```typescript
+     * const assetId = 163650;
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const assetTxns = await indexerClient
+     *        .lookupAssetTransactions(assetId)
+     *        .address(address)
+     *        .do();
+     * ```
+     *
+     * @param address
+     * @category query
+     */
     address(address) {
         this.query.address = address;
         return this;
     }
-    // whether or not to consider the close-to field as a receiver when filtering transactions, as bool. set to true to ignore close-to
+    /**
+     * Whether or not to consider the `close-to` field as a receiver when filtering transactions, as bool. Set to `true` to ignore `close-to`.
+     *
+     * #### Example
+     * ```typescript
+     * const assetId = 163650;
+     * const assetTxns = await indexerClient
+     *        .lookupAssetTransactions(assetId)
+     *        .excludeCloseTo(true)
+     *        .do();
+     * ```
+     *
+     * @param exclude
+     * @category query
+     */
     excludeCloseTo(exclude) {
         this.query['exclude-close-to'] = exclude;
         return this;
     }
-    // used for pagination
+    /**
+     * The next page of results.
+     *
+     * #### Example
+     * ```typescript
+     * const maxResults = 25;
+     * const assetId = 163650;
+     *
+     * const assetTxnsPage1 = await indexerClient
+     *        .lookupAssetTransactions(assetId)
+     *        .limit(maxResults)
+     *        .do();
+     *
+     * const assetTxnsPage2 = await indexerClient
+     *        .lookupAssetTransactions(assetId)
+     *        .limit(maxResults)
+     *        .nextToken(assetTxnsPage1["next-token"])
+     *        .do();
+     * ```
+     *
+     * @param nextToken - provided by the previous results.
+     * @category query
+     */
     nextToken(nextToken) {
         this.query.next = nextToken;
         return this;
     }
-    // whether or not to include rekeying transactions
+    /**
+     * Whether or not to include rekeying transactions.
+     *
+     * #### Example
+     * ```typescript
+     * const assetId = 163650;
+     * const assetTxns = await indexerClient
+     *        .lookupAssetTransactions(assetId)
+     *        .rekeyTo(false)
+     *        .do();
+     * ```
+     *
+     * @param rekeyTo
+     * @category query
+     */
     rekeyTo(rekeyTo) {
         this.query['rekey-to'] = rekeyTo;
         return this;

package/dist/cjs/src/client/v2/indexer/lookupAssetTransactions.js.map

@@ -1 +1 @@
-{"version":3,"file":"lookupAssetTransactions.js","sourceRoot":"","sources":["../../../../../../src/client/v2/indexer/lookupAssetTransactions.ts"],"names":[],"mappings":";;;;;AAAA,iEAAyC;AAGzC,2EAAiE;AAEjE,MAAqB,uBAAwB,SAAQ,qBAAW;IAC9D,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,eAAe,CAAC;IACjD,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,MAA2B;QACpC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,8CAAkB,CAAC,MAAM,CAAC,CAAC;QACvD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,mCAAmC;IACnC,MAAM,CAAC,IAAY;QACjB,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,oCAAoC;IACpC,OAAO,CAAC,IAAY;QAClB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;QAC9B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,iCAAiC;IACjC,IAAI,CAAC,IAAY;QACf,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC;QACvB,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,mCAAmC;IACnC,QAAQ,CAAC,KAAa;QACpB,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,mCAAmC;IACnC,QAAQ,CAAC,KAAa;QACpB,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,kCAAkC;IAClC,OAAO,CAAC,EAAU;QAChB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,2BAA2B;IAC3B,KAAK,CAAC,KAAa;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,gDAAgD;IAChD,UAAU,CAAC,MAAc;QACvB,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,MAAM,CAAC;QACnC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,+CAA+C;IAC/C,SAAS,CAAC,KAAa;QACrB,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,mGAAmG;IACnG,mBAAmB,CAAC,OAAe;QACjC,IAAI,CAAC,KAAK,CAAC,uBAAuB,CAAC,GAAG,OAAO,CAAC;QAC9C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,gGAAgG;IAChG,gBAAgB,CAAC,MAAc;QAC7B,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAC,GAAG,MAAM,CAAC;QAC1C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,sEAAsE;IACtE,WAAW,CAAC,IAAY;QACtB,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,iCAAiC;IACjC,OAAO,CAAC,OAAe;QACrB,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,mIAAmI;IACnI,cAAc,CAAC,OAAgB;QAC7B,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,GAAG,OAAO,CAAC;QACzC,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,kDAAkD;IAClD,OAAO,CAAC,OAAgB;QACtB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAxHD,0CAwHC"}
+{"version":3,"file":"lookupAssetTransactions.js","sourceRoot":"","sources":["../../../../../../src/client/v2/indexer/lookupAssetTransactions.ts"],"names":[],"mappings":";;;;;AAAA,iEAAyC;AAGzC,2EAAiE;AAEjE,MAAqB,uBAAwB,SAAQ,qBAAW;IAC9D;;;;;;;;;;;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;;OAEG;IACH,IAAI;QACF,OAAO,cAAc,IAAI,CAAC,KAAK,eAAe,CAAC;IACjD,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,UAAU,CAAC,MAA2B;QACpC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,8CAAkB,CAAC,MAAM,CAAC,CAAC;QACvD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,IAAY;QACjB,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,OAAO,CAAC,IAAY;QAClB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;QAC9B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CAAC,IAAY;QACf,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,KAAa;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,KAAa;QACpB,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,KAAa;QACpB,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,OAAO,CAAC,EAAU;QAChB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,KAAa;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,UAAU,CAAC,MAAc;QACvB,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,MAAM,CAAC;QACnC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,SAAS,CAAC,KAAa;QACrB,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,mBAAmB,CAAC,OAAe;QACjC,IAAI,CAAC,KAAK,CAAC,uBAAuB,CAAC,GAAG,OAAO,CAAC;QAC9C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,gBAAgB,CAAC,MAAc;QAC7B,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAC,GAAG,MAAM,CAAC;QAC1C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,WAAW,CAAC,IAAY;QACtB,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,OAAO,CAAC,OAAe;QACrB,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,cAAc,CAAC,OAAgB;QAC7B,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,GAAG,OAAO,CAAC;QACzC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,SAAS,CAAC,SAAiB;QACzB,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,SAAS,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,OAAgB;QACtB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAhZD,0CAgZC"}

package/dist/cjs/src/client/v2/indexer/lookupBlock.js

@@ -5,11 +5,27 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const jsonrequest_1 = __importDefault(require("../jsonrequest"));
 class LookupBlock extends jsonrequest_1.default {
+    /**
+     * 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
+     */
     constructor(c, intDecoding, round) {
         super(c, intDecoding);
         this.round = round;
         this.round = round;
     }
+    /**
+     * @returns `/v2/blocks/${round}`
+     */
     path() {
         return `/v2/blocks/${this.round}`;
     }

package/dist/cjs/src/client/v2/indexer/lookupBlock.js.map

@@ -1 +1 @@
-{"version":3,"file":"lookupBlock.js","sourceRoot":"","sources":["../../../../../../src/client/v2/indexer/lookupBlock.ts"],"names":[],"mappings":";;;;;AAAA,iEAAyC;AAIzC,MAAqB,WAAY,SAAQ,qBAAW;IAClD,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,EAAE,CAAC;IACpC,CAAC;CACF;AATD,8BASC"}
+{"version":3,"file":"lookupBlock.js","sourceRoot":"","sources":["../../../../../../src/client/v2/indexer/lookupBlock.ts"],"names":[],"mappings":";;;;;AAAA,iEAAyC;AAIzC,MAAqB,WAAY,SAAQ,qBAAW;IAClD;;;;;;;;;;;;OAYG;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;;OAEG;IACH,IAAI;QACF,OAAO,cAAc,IAAI,CAAC,KAAK,EAAE,CAAC;IACpC,CAAC;CACF;AAzBD,8BAyBC"}

package/dist/cjs/src/client/v2/indexer/lookupTransactionByID.js

@@ -5,11 +5,27 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const jsonrequest_1 = __importDefault(require("../jsonrequest"));
 class LookupTransactionByID extends jsonrequest_1.default {
+    /**
+     * 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
+     */
     constructor(c, intDecoding, txID) {
         super(c, intDecoding);
         this.txID = txID;
         this.txID = txID;
     }
+    /**
+     * @returns `/v2/transactions/${txID}`
+     */
     path() {
         return `/v2/transactions/${this.txID}`;
     }

package/dist/cjs/src/client/v2/indexer/lookupTransactionByID.js.map

@@ -1 +1 @@
-{"version":3,"file":"lookupTransactionByID.js","sourceRoot":"","sources":["../../../../../../src/client/v2/indexer/lookupTransactionByID.ts"],"names":[],"mappings":";;;;;AAAA,iEAAyC;AAIzC,MAAqB,qBAAsB,SAAQ,qBAAW;IAC5D,YAAY,CAAa,EAAE,WAAwB,EAAU,IAAY;QACvE,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;QADqC,SAAI,GAAJ,IAAI,CAAQ;QAEvE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,IAAI;QACF,OAAO,oBAAoB,IAAI,CAAC,IAAI,EAAE,CAAC;IACzC,CAAC;CACF;AATD,wCASC"}
+{"version":3,"file":"lookupTransactionByID.js","sourceRoot":"","sources":["../../../../../../src/client/v2/indexer/lookupTransactionByID.ts"],"names":[],"mappings":";;;;;AAAA,iEAAyC;AAIzC,MAAqB,qBAAsB,SAAQ,qBAAW;IAC5D;;;;;;;;;;;;OAYG;IACH,YAAY,CAAa,EAAE,WAAwB,EAAU,IAAY;QACvE,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;QADqC,SAAI,GAAJ,IAAI,CAAQ;QAEvE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED;;OAEG;IACH,IAAI;QACF,OAAO,oBAAoB,IAAI,CAAC,IAAI,EAAE,CAAC;IACzC,CAAC;CACF;AAzBD,wCAyBC"}

package/dist/cjs/src/client/v2/indexer/makeHealthCheck.js

@@ -4,7 +4,22 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const jsonrequest_1 = __importDefault(require("../jsonrequest"));
+/**
+ * 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
+ */
 class MakeHealthCheck extends jsonrequest_1.default {
+    /**
+     * @returns `/health`
+     */
     // eslint-disable-next-line class-methods-use-this
     path() {
         return '/health';

package/dist/cjs/src/client/v2/indexer/makeHealthCheck.js.map

@@ -1 +1 @@
-{"version":3,"file":"makeHealthCheck.js","sourceRoot":"","sources":["../../../../../../src/client/v2/indexer/makeHealthCheck.ts"],"names":[],"mappings":";;;;;AAAA,iEAAyC;AAEzC,MAAqB,eAAgB,SAAQ,qBAAW;IACtD,kDAAkD;IAClD,IAAI;QACF,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AALD,kCAKC"}
+{"version":3,"file":"makeHealthCheck.js","sourceRoot":"","sources":["../../../../../../src/client/v2/indexer/makeHealthCheck.ts"],"names":[],"mappings":";;;;;AAAA,iEAAyC;AAEzC;;;;;;;;;;;GAWG;AACH,MAAqB,eAAgB,SAAQ,qBAAW;IACtD;;OAEG;IACH,kDAAkD;IAClD,IAAI;QACF,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AARD,kCAQC"}