algosdk 1.13.0-beta.2 → 1.13.0

package/dist/cjs/src/client/v2/algod/algod.js

@@ -22,115 +22,363 @@ const supply_1 = __importDefault(require("./supply"));
 const versions_1 = __importDefault(require("./versions"));
 const genesis_1 = __importDefault(require("./genesis"));
 const proof_1 = __importDefault(require("./proof"));
+/**
+ * Algod client connects an application to the Algorand blockchain. The algod client requires a valid algod REST endpoint IP address and algod token from an Algorand node that is connected to the network you plan to interact with.
+ *
+ * Algod is the main Algorand process for handling the blockchain. Messages between nodes are processed, the protocol steps are executed, and the blocks are written to disk. The algod process also exposes a REST API server that developers can use to communicate with the node and the network. Algod uses the data directory for storage and configuration information.
+ *
+ * #### Relevant Information
+ * [How do I obtain an algod address and token?](https://developer.algorand.org/docs/archive/build-apps/setup/?from_query=algod#how-do-i-obtain-an-algod-address-and-token)
+ *
+ * [Run Algod in Postman OAS3](https://developer.algorand.org/docs/rest-apis/restendpoints/?from_query=algod#algod-indexer-and-kmd-rest-endpoints)
+ */
 class AlgodClient extends serviceClient_1.default {
     /**
      * Create an AlgodClient from
      * * either a token, baseServer, port, and optional headers
      * * or a base client server for interoperability with external dApp wallets
+     *
+     * #### Example
+     * ```typescript
+     * const token  = "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa";
+     * const server = "http://localhost";
+     * const port   = 4001;
+     * const algodClient = new algosdk.Algodv2(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, or use an Algorand REST API provider with a dedicated API key.
+     *
+     * @param tokenOrBaseClient - The algod token from the Algorand node you are interacting with
+     * @param baseServer - REST endpoint
+     * @param port - Port number if specifically configured by the server
+     * @param headers - Optional headers
      */
     constructor(tokenOrBaseClient, baseServer = 'http://r2.algorand.network', port = 4180, headers = {}) {
         super('X-Algo-API-Token', tokenOrBaseClient, baseServer, port, headers);
     }
+    /**
+     * Returns OK if healthy.
+     *
+     * #### Example
+     * ```typescript
+     * const health = await algodClient.healthCheck().do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-health)
+     * @category GET
+     */
     healthCheck() {
         return new healthCheck_1.default(this.c);
     }
+    /**
+     * Retrieves the supported API versions, binary build versions, and genesis information.
+     *
+     * #### Example
+     * ```typescript
+     * const versionsDetails = await algodClient.versionsCheck().do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-versions)
+     * @category GET
+     */
     versionsCheck() {
         return new versions_1.default(this.c);
     }
+    /**
+     * Broadcasts a raw transaction to the network.
+     *
+     * #### Example
+     * ```typescript
+     * const { txId } = await algodClient.sendRawTransaction(signedTxns).do();
+     * const result = await waitForConfirmation(algodClient, txid, 3);
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#post-v2transactions)
+     *
+     * @remarks
+     * Often used with {@linkcode waitForConfirmation}
+     * @param stxOrStxs - Signed transactions
+     * @category POST
+     */
     sendRawTransaction(stxOrStxs) {
         return new sendRawTransaction_1.default(this.c, stxOrStxs);
     }
     /**
-     * Returns the given account's information.
+     * Returns the given account's status, balance and spendable amounts.
+     *
+     * #### Example
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountInfo = await algodClient.accountInformation(address).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2accountsaddress)
      * @param account - The address of the account to look up.
+     * @category GET
      */
     accountInformation(account) {
         return new accountInformation_1.default(this.c, this.intDecoding, account);
     }
     /**
      * Gets the block info for the given round.
+     *
+     * #### Example
+     * ```typescript
+     * const roundNumber = 18038133;
+     * const block = await algodClient.block(roundNumber).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2blocksround)
      * @param roundNumber - The round number of the block to get.
+     * @category GET
      */
     block(roundNumber) {
         return new block_1.default(this.c, roundNumber);
     }
     /**
      * Returns the transaction information for a specific pending transaction.
+     *
+     * #### Example
+     * ```typescript
+     * const txId = "DRJS6R745A7GFVMXEXWP4TGVDGKW7VILFTA7HC2BR2GRLHNY5CTA";
+     * const pending = await algodClient.pendingTransactionInformation(txId).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2transactionspendingtxid)
+     *
+     * @remarks
+     * <br><br>
+     * There are several cases when this might succeed:
+     * - transaction committed (committed round > 0)
+     * - transaction still in the pool (committed round = 0, pool error = "")
+     * - transaction removed from pool due to error (committed round = 0, pool error != "")
+     *
+     * Or the transaction may have happened sufficiently long ago that the node no longer remembers it, and this will return an error.
+     *
      * @param txid - The TxID string of the pending transaction to look up.
+     * @category GET
      */
     pendingTransactionInformation(txid) {
         return new pendingTransactionInformation_1.default(this.c, txid);
     }
     /**
-     * Returns transactions that are pending in the pool.
+     * Returns the list of pending transactions in the pool, sorted by priority, in decreasing order, truncated at the end at MAX.
+     * If MAX = 0, returns all pending transactions.
+     *
+     * #### Example 1
+     * ```typescript
+     * const pendingTxns = await algodClient.pendingTransactionsInformation().do();
+     * ```
+     *
+     * #### Example 2
+     * ```typescript
+     * const maxTxns = 5;
+     * const pendingTxns = await algodClient
+     *     .pendingTransactionsInformation()
+     *     .max(maxTxns)
+     *     .do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2transactionspending)
+     * @category GET
      */
     pendingTransactionsInformation() {
         return new pendingTransactions_1.default(this.c);
     }
     /**
-     * Returns transactions that are pending in the pool sent by a specific sender.
+     * Returns the list of pending transactions sent by the address, sorted by priority, in decreasing order, truncated at the end at MAX.
+     * If MAX = 0, returns all pending transactions.
+     *
+     * #### Example 1
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const pendingTxnsByAddr = await algodClient.pendingTransactionByAddress(address).do();
+     * ```
+     *
+     * #### Example 2
+     * ```typescript
+     * const maxTxns = 5;
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const pendingTxns = await algodClient
+     *     .pendingTransactionByAddress(address)
+     *     .max(maxTxns)
+     *     .do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2accountsaddresstransactionspending)
      * @param address - The address of the sender.
+     * @category GET
      */
     pendingTransactionByAddress(address) {
         return new pendingTransactionsByAddress_1.default(this.c, address);
     }
     /**
      * Retrieves the StatusResponse from the running node.
+     *
+     * #### Example
+     * ```typescript
+     * const status = await algodClient.status().do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2status)
+     * @category GET
      */
     status() {
         return new status_1.default(this.c, this.intDecoding);
     }
     /**
-     * Waits for a specific round to occur then returns the StatusResponse for that round.
+     * Waits for a specific round to occur then returns the `StatusResponse` for that round.
+     *
+     * #### Example
+     * ```typescript
+     * const round = 18038133;
+     * const statusAfterBlock = await algodClient.statusAfterBlock(round).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2statuswait-for-block-afterround)
      * @param round - The number of the round to wait for.
+     * @category GET
      */
     statusAfterBlock(round) {
         return new statusAfterBlock_1.default(this.c, this.intDecoding, round);
     }
     /**
      * Returns the common needed parameters for a new transaction.
+     *
+     * #### Example
+     * ```typescript
+     * const suggestedParams = await algodClient.getTransactionParams().do();
+     * const amountInMicroAlgos = algosdk.algosToMicroalgos(2); // 2 Algos
+     * const unsignedTxn = algosdk.makePaymentTxnWithSuggestedParamsFromObject({
+     *   from: senderAddress,
+     *   to: receiverAddress,
+     *   amount: amountInMicroAlgos,
+     *   suggestedParams: suggestedParams,
+     * });
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2transactionsparams)
+     *
+     * @remarks
+     * Often used with
+     * {@linkcode makePaymentTxnWithSuggestedParamsFromObject}, {@linkcode algosToMicroalgos}
+     * @category GET
      */
     getTransactionParams() {
         return new suggestedParams_1.default(this.c);
     }
     /**
-     * Gets the supply details for the specified node's ledger.
+     * Returns the supply details for the specified node's ledger.
+     *
+     * #### Example
+     * ```typescript
+     * const supplyDetails = await algodClient.supply().do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2ledgersupply)
+     * @category GET
      */
     supply() {
         return new supply_1.default(this.c, this.intDecoding);
     }
+    /**
+     * Compiles TEAL source code to binary, returns base64 encoded program bytes and base32 SHA512_256 hash of program bytes (Address style).
+     *
+     * #### Example
+     * ```typescript
+     * const source = "TEAL SOURCE CODE";
+     * const compiledSmartContract = await algodClient.compile(source).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#post-v2tealcompile)
+     * @remarks
+     * This endpoint is only enabled when a node's configuration file sets `EnableDeveloperAPI` to true.
+     * @param source
+     * @category POST
+     */
     compile(source) {
         return new compile_1.default(this.c, source);
     }
+    /**
+     * Provides debugging information for a transaction (or group).
+     *
+     * Executes TEAL program(s) in context and returns debugging information about the execution. This endpoint is only enabled when a node's configureation file sets `EnableDeveloperAPI` to true.
+     *
+     * #### Example
+     * ```typescript
+     * const dryRunResult = await algodClient.dryrun(dr).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#post-v2tealdryrun)
+     * @param dr
+     * @category POST
+     */
     dryrun(dr) {
         return new dryrun_1.default(this.c, dr);
     }
     /**
      * Given an asset ID, return asset information including creator, name, total supply and
      * special addresses.
+     *
+     * #### Example
+     * ```typescript
+     * const asset_id = 163650;
+     * const asset = await algodClient.getAssetByID(asset_id).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2assetsasset-id)
      * @param index - The asset ID to look up.
+     * @category GET
      */
     getAssetByID(index) {
         return new getAssetByID_1.default(this.c, this.intDecoding, index);
     }
     /**
-     * Given an application ID, it returns application information including creator, approval
+     * Given an application ID, return the application information including creator, approval
      * and clear programs, global and local schemas, and global state.
+     *
+     * #### Example
+     * ```typescript
+     * const index = 60553466;
+     * const app = await algodClient.getApplicationByID(index).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2applicationsapplication-id)
      * @param index - The application ID to look up.
+     * @category GET
      */
     getApplicationByID(index) {
         return new getApplicationByID_1.default(this.c, this.intDecoding, index);
     }
     /**
      * Returns the entire genesis file.
+     *
+     * #### Example
+     * ```typescript
+     * const genesis = await algodClient.genesis().do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-genesis)
+     * @category GET
      */
     genesis() {
         return new genesis_1.default(this.c, this.intDecoding);
     }
     /**
-     * Get the proof for a given transaction in a round.
+     * Returns a Merkle proof for a given transaction in a block.
+     *
+     * #### Example
+     * ```typescript
+     * const round = 18038133;
+     * const txId = "MEUOC4RQJB23CQZRFRKYEI6WBO73VTTPST5A7B3S5OKBUY6LFUDA";
+     * const proof = await algodClient.getProof(round, txId).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2blocksroundtransactionstxidproof)
      * @param round - The round in which the transaction appears.
      * @param txID - The transaction ID for which to generate a proof.
+     * @category GET
      */
     getProof(round, txID) {
         return new proof_1.default(this.c, this.intDecoding, round, txID);

package/dist/cjs/src/client/v2/algod/algod.js.map

@@ -1 +1 @@
-{"version":3,"file":"algod.js","sourceRoot":"","sources":["../../../../../../src/client/v2/algod/algod.ts"],"names":[],"mappings":";;;;;AAAA,qEAA6C;AAE7C,8EAAsD;AACtD,oDAA4B;AAC5B,wDAAgC;AAChC,sDAA8B;AAC9B,kEAA0C;AAC1C,8EAAsD;AACtD,gEAAwC;AACxC,oGAA4E;AAC5E,gFAAwD;AACxD,kGAA0E;AAC1E,8EAAsD;AACtD,sDAA8B;AAC9B,0EAAkD;AAClD,wEAAgD;AAChD,sDAA8B;AAC9B,0DAAkC;AAClC,wDAAgC;AAChC,oDAA4B;AAO5B,MAAqB,WAAY,SAAQ,uBAAa;IACpD;;;;OAIG;IACH,YACE,iBAIkB,EAClB,UAAU,GAAG,4BAA4B,EACzC,OAAwB,IAAI,EAC5B,UAAkC,EAAE;QAEpC,KAAK,CAAC,kBAAkB,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;IAED,WAAW;QACT,OAAO,IAAI,qBAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACjC,CAAC;IAED,aAAa;QACX,OAAO,IAAI,kBAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC9B,CAAC;IAED,kBAAkB,CAAC,SAAoC;QACrD,OAAO,IAAI,4BAAkB,CAAC,IAAI,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;IACnD,CAAC;IAED;;;OAGG;IACH,kBAAkB,CAAC,OAAe;QAChC,OAAO,IAAI,4BAAkB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,WAAmB;QACvB,OAAO,IAAI,eAAK,CAAC,IAAI,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;IACxC,CAAC;IAED;;;OAGG;IACH,6BAA6B,CAAC,IAAY;QACxC,OAAO,IAAI,uCAA6B,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACH,8BAA8B;QAC5B,OAAO,IAAI,6BAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACzC,CAAC;IAED;;;OAGG;IACH,2BAA2B,CAAC,OAAe;QACzC,OAAO,IAAI,sCAA4B,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED;;OAEG;IACH,MAAM;QACJ,OAAO,IAAI,gBAAM,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IAC9C,CAAC;IAED;;;OAGG;IACH,gBAAgB,CAAC,KAAa;QAC5B,OAAO,IAAI,0BAAgB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IAC/D,CAAC;IAED;;OAEG;IACH,oBAAoB;QAClB,OAAO,IAAI,yBAAe,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACrC,CAAC;IAED;;OAEG;IACH,MAAM;QACJ,OAAO,IAAI,gBAAM,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IAC9C,CAAC;IAED,OAAO,CAAC,MAA2B;QACjC,OAAO,IAAI,iBAAO,CAAC,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;IACrC,CAAC;IAED,MAAM,CAAC,EAA0B;QAC/B,OAAO,IAAI,gBAAM,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACH,YAAY,CAAC,KAAa;QACxB,OAAO,IAAI,sBAAY,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACH,kBAAkB,CAAC,KAAa;QAC9B,OAAO,IAAI,4BAAkB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IACjE,CAAC;IAED;;OAEG;IACH,OAAO;QACL,OAAO,IAAI,iBAAO,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IAC/C,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,KAAa,EAAE,IAAY;QAClC,OAAO,IAAI,eAAK,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IAC1D,CAAC;CACF;AA5ID,8BA4IC"}
+{"version":3,"file":"algod.js","sourceRoot":"","sources":["../../../../../../src/client/v2/algod/algod.ts"],"names":[],"mappings":";;;;;AAAA,qEAA6C;AAE7C,8EAAsD;AACtD,oDAA4B;AAC5B,wDAAgC;AAChC,sDAA8B;AAC9B,kEAA0C;AAC1C,8EAAsD;AACtD,gEAAwC;AACxC,oGAA4E;AAC5E,gFAAwD;AACxD,kGAA0E;AAC1E,8EAAsD;AACtD,sDAA8B;AAC9B,0EAAkD;AAClD,wEAAgD;AAChD,sDAA8B;AAC9B,0DAAkC;AAClC,wDAAgC;AAChC,oDAA4B;AAO5B;;;;;;;;;GASG;AACH,MAAqB,WAAY,SAAQ,uBAAa;IACpD;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,YACE,iBAIkB,EAClB,UAAU,GAAG,4BAA4B,EACzC,OAAwB,IAAI,EAC5B,UAAkC,EAAE;QAEpC,KAAK,CAAC,kBAAkB,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;OAUG;IACH,WAAW;QACT,OAAO,IAAI,qBAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACjC,CAAC;IAED;;;;;;;;;;OAUG;IACH,aAAa;QACX,OAAO,IAAI,kBAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,kBAAkB,CAAC,SAAoC;QACrD,OAAO,IAAI,4BAAkB,CAAC,IAAI,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;IACnD,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,kBAAkB,CAAC,OAAe;QAChC,OAAO,IAAI,4BAAkB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,WAAmB;QACvB,OAAO,IAAI,eAAK,CAAC,IAAI,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,6BAA6B,CAAC,IAAY;QACxC,OAAO,IAAI,uCAA6B,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,8BAA8B;QAC5B,OAAO,IAAI,6BAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACzC,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,2BAA2B,CAAC,OAAe;QACzC,OAAO,IAAI,sCAA4B,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM;QACJ,OAAO,IAAI,gBAAM,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,gBAAgB,CAAC,KAAa;QAC5B,OAAO,IAAI,0BAAgB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,oBAAoB;QAClB,OAAO,IAAI,yBAAe,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACrC,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM;QACJ,OAAO,IAAI,gBAAM,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,MAA2B;QACjC,OAAO,IAAI,iBAAO,CAAC,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;IACrC,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAA0B;QAC/B,OAAO,IAAI,gBAAM,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAChC,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,YAAY,CAAC,KAAa;QACxB,OAAO,IAAI,sBAAY,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,kBAAkB,CAAC,KAAa;QAC9B,OAAO,IAAI,4BAAkB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO;QACL,OAAO,IAAI,iBAAO,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,KAAa,EAAE,IAAY;QAClC,OAAO,IAAI,eAAK,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IAC1D,CAAC;CACF;AA1XD,8BA0XC"}

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

@@ -18,104 +18,256 @@ const searchAccounts_1 = __importDefault(require("./searchAccounts"));
 const searchForTransactions_1 = __importDefault(require("./searchForTransactions"));
 const searchForAssets_1 = __importDefault(require("./searchForAssets"));
 const searchForApplications_1 = __importDefault(require("./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)
+ */
 class IndexerClient extends serviceClient_1.default {
     /**
      * 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_1.default(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_1.default(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_1.default(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_1.default(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_1.default(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_1.default(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_1.default(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_1.default(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_1.default(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_1.default(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_1.default(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_1.default(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_1.default(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_1.default(this.c, this.intDecoding);

package/dist/cjs/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,qEAA6C;AAC7C,wEAAgD;AAChD,gFAAwD;AACxD,wFAAgE;AAChE,4FAAoE;AACpE,gEAAwC;AACxC,oFAA4D;AAC5D,4EAAoD;AACpD,wEAAgD;AAChD,8EAAsD;AACtD,oFAA4D;AAC5D,sEAA8C;AAC9C,oFAA4D;AAC5D,wEAAgD;AAChD,oFAA4D;AAO5D,MAAqB,aAAc,SAAQ,uBAAa;IACtD;;;;OAIG;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;;OAEG;IACH,eAAe;QACb,OAAO,IAAI,yBAAe,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IACvD,CAAC;IAED;;;OAGG;IACH,mBAAmB,CAAC,KAAa;QAC/B,OAAO,IAAI,6BAAmB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IAClE,CAAC;IAED;;;OAGG;IACH,uBAAuB,CAAC,KAAa;QACnC,OAAO,IAAI,iCAAuB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IACtE,CAAC;IAED;;;OAGG;IACH,yBAAyB,CAAC,OAAe;QACvC,OAAO,IAAI,mCAAyB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;IAED;;;OAGG;IACH,WAAW,CAAC,KAAa;QACvB,OAAO,IAAI,qBAAW,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IAC1D,CAAC;IAED;;;OAGG;IACH,qBAAqB,CAAC,IAAY;QAChC,OAAO,IAAI,+BAAqB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;IACnE,CAAC;IAED;;;OAGG;IACH,iBAAiB,CAAC,OAAe;QAC/B,OAAO,IAAI,2BAAiB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;OAGG;IACH,eAAe,CAAC,KAAa;QAC3B,OAAO,IAAI,yBAAe,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IAC9D,CAAC;IAED;;;OAGG;IACH,kBAAkB,CAAC,KAAa;QAC9B,OAAO,IAAI,4BAAkB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IACjE,CAAC;IAED;;;OAGG;IACH,qBAAqB,CAAC,KAAa;QACjC,OAAO,IAAI,+BAAqB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IACpE,CAAC;IAED;;OAEG;IACH,cAAc;QACZ,OAAO,IAAI,wBAAc,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IACtD,CAAC;IAED;;OAEG;IACH,qBAAqB;QACnB,OAAO,IAAI,+BAAqB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IAC7D,CAAC;IAED;;OAEG;IACH,eAAe;QACb,OAAO,IAAI,yBAAe,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IACvD,CAAC;IAED;;OAEG;IACH,qBAAqB;QACnB,OAAO,IAAI,+BAAqB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IAC7D,CAAC;CACF;AA7HD,gCA6HC"}
+{"version":3,"file":"indexer.js","sourceRoot":"","sources":["../../../../../../src/client/v2/indexer/indexer.ts"],"names":[],"mappings":";;;;;AAAA,qEAA6C;AAC7C,wEAAgD;AAChD,gFAAwD;AACxD,wFAAgE;AAChE,4FAAoE;AACpE,gEAAwC;AACxC,oFAA4D;AAC5D,4EAAoD;AACpD,wEAAgD;AAChD,8EAAsD;AACtD,oFAA4D;AAC5D,sEAA8C;AAC9C,oFAA4D;AAC5D,wEAAgD;AAChD,oFAA4D;AAO5D;;;;;;;;;;;;;GAaG;AACH,MAAqB,aAAc,SAAQ,uBAAa;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,yBAAe,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,mBAAmB,CAAC,KAAa;QAC/B,OAAO,IAAI,6BAAmB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,uBAAuB,CAAC,KAAa;QACnC,OAAO,IAAI,iCAAuB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,yBAAyB,CAAC,OAAe;QACvC,OAAO,IAAI,mCAAyB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,KAAa;QACvB,OAAO,IAAI,qBAAW,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,qBAAqB,CAAC,IAAY;QAChC,OAAO,IAAI,+BAAqB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,iBAAiB,CAAC,OAAe;QAC/B,OAAO,IAAI,2BAAiB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,eAAe,CAAC,KAAa;QAC3B,OAAO,IAAI,yBAAe,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,kBAAkB,CAAC,KAAa;QAC9B,OAAO,IAAI,4BAAkB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,qBAAqB,CAAC,KAAa;QACjC,OAAO,IAAI,+BAAqB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;OAUG;IACH,cAAc;QACZ,OAAO,IAAI,wBAAc,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;;;;OAUG;IACH,qBAAqB;QACnB,OAAO,IAAI,+BAAqB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;;OAUG;IACH,eAAe;QACb,OAAO,IAAI,yBAAe,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;;;OAUG;IACH,qBAAqB;QACnB,OAAO,IAAI,+BAAqB,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IAC7D,CAAC;CACF;AAvQD,gCAuQC"}