algosdk 1.14.0 → 1.16.0

package/dist/types/src/client/v2/indexer/lookupAccountByID.d.ts

@@ -3,8 +3,85 @@ import HTTPClient from '../../client';
 import IntDecoding from '../../../types/intDecoding';
 export default class LookupAccountByID extends JSONRequest {
     private account;
+    /**
+     * 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
+     */
     constructor(c: HTTPClient, intDecoding: IntDecoding, account: string);
+    /**
+     * @returns `/v2/accounts/${account}`
+     */
     path(): string;
+    /**
+     * Specify round to filter with.
+     *
+     * #### Example
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const targetBlock = 18309917;
+     * const accountInfo = await indexerClient
+     *        .lookupAccountByID(address)
+     *        .round(targetBlock)
+     *        .do();
+     * ```
+     * @param round
+     */
     round(round: number): this;
+    /**
+     * Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.
+     *
+     * #### Example 1
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountInfo = await indexerClient
+     *        .lookupAccountByID(address)
+     *        .includeAll(false)
+     *        .do();
+     * ```
+     *
+     * #### Example 2
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountInfo = await indexerClient
+     *        .lookupAccountByID(address)
+     *        .includeAll()
+     *        .do();
+     * ```
+     * @param value
+     */
     includeAll(value?: boolean): this;
+    /**
+     * Exclude additional items such as asset holdings, application local data stored for this account, asset parameters created by this account, and application parameters created by this account.
+     *
+     * #### Example 1
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountInfo = await indexerClient
+     *        .lookupAccountByID(address)
+     *        .exclude("all")
+     *        .do();
+     * ```
+     *
+     * #### Example 2
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountInfo = await indexerClient
+     *        .lookupAccountByID(address)
+     *        .exclude("assets,created-assets")
+     *        .do();
+     * ```
+     * @remarks By default, it behaves as exclude=none
+     * @param exclude - Array of `all`, `assets`, `created-assets`, `apps-local-state`, `created-apps`, `none`
+     * @category query
+     */
+    exclude(exclude: string): this;
 }

package/dist/types/src/client/v2/indexer/lookupAccountCreatedApplications.d.ts

@@ -0,0 +1,111 @@
+import JSONRequest from '../jsonrequest';
+import HTTPClient from '../../client';
+import IntDecoding from '../../../types/intDecoding';
+export default class LookupAccountCreatedApplications extends JSONRequest {
+    private account;
+    /**
+     * Returns application information created by the given account.
+     *
+     * #### Example
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountCreatedApps = await indexerClient.lookupAccountCreatedApplications(address).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2accountsaccount-idcreated-applications)
+     * @param account - The address of the account to look up.
+     * @category GET
+     */
+    constructor(c: HTTPClient, intDecoding: IntDecoding, account: string);
+    /**
+     * @returns `/v2/accounts/${account}/created-applications`
+     */
+    path(): string;
+    /**
+     * Add a limit for filter.
+     *
+     * #### Example
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const maxResults = 20;
+     * const accountAssets = await indexerClient
+     *        .lookupAccountCreatedApplications(address)
+     *        .limit(maxResults)
+     *        .do();
+     * ```
+     *
+     * @param limit - maximum number of results to return.
+     * @category query
+     */
+    limit(limit: number): this;
+    /**
+     * Specify round to filter with.
+     *
+     * #### Example
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const targetBlock = 18309917;
+     * const accountAssets = await indexerClient
+     *        .lookupAccountCreatedApplications(address)
+     *        .round(targetBlock)
+     *        .do();
+     * ```
+     * @param round
+     * @category query
+     */
+    round(round: number): this;
+    /**
+     * Specify the next page of results.
+     *
+     * #### Example
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const maxResults = 20;
+     *
+     * const accountAssetsPage1 = await indexerClient
+     *        .lookupAccountCreatedApplications(address)
+     *        .limit(maxResults)
+     *        .do();
+     *
+     * const accountAssetsPage2 = await indexerClient
+     *        .lookupAccountCreatedApplications(address)
+     *        .limit(maxResults)
+     *        .next(accountAssetsPage1["next-token"])
+     *        .do();
+     * ```
+     * @param nextToken - provided by the previous results.
+     * @category query
+     */
+    nextToken(nextToken: string): this;
+    /**
+     * Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates
+     *
+     * #### Example
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountAssets = await indexerClient
+     *        .lookupAccountCreatedApplications(address)
+     *        .includeAll(false)
+     *        .do();
+     * ```
+     * @param value
+     * @category query
+     */
+    includeAll(value?: boolean): this;
+    /**
+     * Specify an applicationID to search for.
+     *
+     * #### Example
+     * ```typescript
+     * const applicationID = 163650;
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountApplications = await indexerClient
+     *        .lookupAccountAppLocalStates(address)
+     *        .applicationID(applicationID)
+     *        .do();
+     * ```
+     * @param index - the applicationID
+     * @category query
+     */
+    applicationID(index: number): this;
+}

package/dist/types/src/client/v2/indexer/lookupAccountCreatedAssets.d.ts

@@ -0,0 +1,112 @@
+import JSONRequest from '../jsonrequest';
+import HTTPClient from '../../client';
+import IntDecoding from '../../../types/intDecoding';
+export default class LookupAccountCreatedAssets extends JSONRequest {
+    private account;
+    /**
+     * Returns asset information created by the given account.
+     *
+     * #### Example
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountCreatedAssets = await indexerClient.lookupAccountCreatedAssets(address).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2accountsaccount-idcreated-assets)
+     * @param account - The address of the account to look up.
+     * @category GET
+     */
+    constructor(c: HTTPClient, intDecoding: IntDecoding, account: string);
+    /**
+     * @returns `/v2/accounts/${account}/created-assets`
+     */
+    path(): string;
+    /**
+     * Add a limit for filter.
+     *
+     * #### Example
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const maxResults = 20;
+     * const accountAssets = await indexerClient
+     *        .lookupAccountCreatedAssets(address)
+     *        .limit(maxResults)
+     *        .do();
+     * ```
+     *
+     * @param limit - maximum number of results to return.
+     * @category query
+     */
+    limit(limit: number): this;
+    /**
+     * Specify round to filter with.
+     *
+     * #### Example
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const targetBlock = 18309917;
+     * const accountAssets = await indexerClient
+     *        .lookupAccountCreatedAssets(address)
+     *        .round(targetBlock)
+     *        .do();
+     * ```
+     * @param round
+     * @category query
+     */
+    round(round: number): this;
+    /**
+     * Specify the next page of results.
+     *
+     * #### Example
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const maxResults = 20;
+     *
+     * const accountAssetsPage1 = await indexerClient
+     *        .lookupAccountCreatedAssets(address)
+     *        .limit(maxResults)
+     *        .do();
+     * ```
+     *
+     * const accountAssetsPage2 = await indexerClient
+     *        .lookupAccountCreatedAssets(address)
+     *        .limit(maxResults)
+     *        .next(accountAssetsPage1["next-token"])
+     *        .do();
+     * ```
+     * @param nextToken - provided by the previous results.
+     * @category query
+     */
+    nextToken(nextToken: string): this;
+    /**
+     * Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates
+     *
+     * #### Example
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountAssets = await indexerClient
+     *        .lookupAccountCreatedAssets(address)
+     *        .includeAll(false)
+     *        .do();
+     * ```
+     * @param value
+     * @category query
+     */
+    includeAll(value?: boolean): this;
+    /**
+     * Specify an assetID to search for.
+     *
+     * #### Example
+     * ```typescript
+     * const assetID = 163650;
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const assetAssets = await indexerClient
+     *        .lookupAccountCreatedAssets(address)
+     *        .assetID(assetID)
+     *        .do();
+     * ```
+     * @param index - the assetID
+     * @category query
+     */
+    assetID(index: number): this;
+}

package/dist/types/src/client/v2/indexer/lookupAccountTransactions.d.ts

@@ -23,11 +23,11 @@ export default class LookupAccountTransactions extends JSONRequest {
      */
     constructor(c: HTTPClient, intDecoding: IntDecoding, account: string);
     /**
-     * @returns /v2/accounts/`${account}`/transactions
+     * @returns `/v2/accounts/${account}/transactions`
      */
     path(): string;
     /**
-     * Specifies a prefix which must be contained in the note field
+     * Specifies a prefix which must be contained in the note field.
      *
      * #### Example
      * ```typescript
@@ -44,7 +44,7 @@ export default class LookupAccountTransactions extends JSONRequest {
      */
     notePrefix(prefix: Uint8Array | string): this;
     /**
-     * Type of transaction to filter with
+     * Type of transaction to filter with.
      *
      * #### Example
      * ```typescript
@@ -55,12 +55,12 @@ export default class LookupAccountTransactions extends JSONRequest {
      *        .do();
      * ```
      *
-     * @param type - one of “pay”, “keyreg”, “acfg”, “axfer”, “afrz”, "appl"
+     * @param type - one of `pay`, `keyreg`, `acfg`, `axfer`, `afrz`, `appl`
      * @category query
      */
     txType(type: string): this;
     /**
-     * Type of signature to filter with
+     * Type of signature to filter with.
      * - sig: Standard
      * - msig: MultiSig
      * - lsig: LogicSig
@@ -74,12 +74,12 @@ export default class LookupAccountTransactions extends JSONRequest {
      *        .do();
      * ```
      *
-     * @param type - one of “sig”, “msig”, “lsig”
+     * @param type - one of `sig`, `msig`, `lsig`
      * @category query
      */
     sigType(type: string): this;
     /**
-     * Lookup the specific transaction by ID
+     * Lookup the specific transaction by ID.
      *
      * #### Example
      * ```typescript
@@ -90,13 +90,13 @@ export default class LookupAccountTransactions extends JSONRequest {
      *        .txid(txId)
      *        .do();
      * ```
-     *
+     * @remarks Alternatively, use `indexerClient.lookupTransactionByID(txnId).do()`
      * @param txid
      * @category query
      */
     txid(txid: string): this;
     /**
-     * Include results for the specified round
+     * Include results for the specified round.
      *
      * #### Example
      * ```typescript
@@ -113,7 +113,7 @@ export default class LookupAccountTransactions extends JSONRequest {
      */
     round(round: number): this;
     /**
-     * Include results at or after the specified min-round
+     * Include results at or after the specified min-round.
      *
      * #### Example
      * ```typescript
@@ -130,7 +130,7 @@ export default class LookupAccountTransactions extends JSONRequest {
      */
     minRound(round: number): this;
     /**
-     * Include results at or before the specified max-round
+     * Include results at or before the specified max-round.
      *
      * #### Example
      * ```typescript
@@ -147,7 +147,7 @@ export default class LookupAccountTransactions extends JSONRequest {
      */
     maxRound(round: number): this;
     /**
-     * Asset ID to filter with
+     * Asset ID to filter with.
      *
      * #### Example
      * ```typescript
@@ -164,15 +164,15 @@ export default class LookupAccountTransactions extends JSONRequest {
      */
     assetID(id: number): this;
     /**
-     * Maximum number of results to return
+     * Maximum number of results to return.
      *
      * #### Example
      * ```typescript
-     * const limit = 25;
+     * const maxResults = 25;
      * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
      * const accountTxns = await indexerClient
      *        .lookupAccountTransactions(address)
-     *        .limit(limit)
+     *        .limit(maxResults)
      *        .do();
      * ```
      *
@@ -181,7 +181,7 @@ export default class LookupAccountTransactions extends JSONRequest {
      */
     limit(limit: number): this;
     /**
-     * Include results before the given time
+     * Include results before the given time.
      *
      * #### Example
      * ```typescript
@@ -198,7 +198,7 @@ export default class LookupAccountTransactions extends JSONRequest {
      */
     beforeTime(before: string): this;
     /**
-     * Include results after the given time
+     * Include results after the given time.
      *
      * #### Example
      * ```typescript
@@ -246,7 +246,7 @@ export default class LookupAccountTransactions extends JSONRequest {
      */
     currencyGreaterThan(greater: number): this;
     /**
-     * Filtered results should have an amount less than this value, as int, representing microAlgos, unless an asset-id is provided, in which case units are in the asset's units
+     * Filtered results should have an amount less than this value, as int, representing microAlgos, unless an asset-id is provided, in which case units are in the asset's units.
      *
      * #### Example 1
      * ```typescript
@@ -279,22 +279,27 @@ export default class LookupAccountTransactions extends JSONRequest {
      *
      * #### Example
      * ```typescript
-     * const limit = 25;
-     * const nextToken = "the next token returned in the previous query response";
+     * const maxResults = 25;
      * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
-     * const accountTxns = await indexerClient
+     *
+     * const accountTxnsPage1 = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .limit(maxResults)
+     *        .do();
+     *
+     * const accountTxnsPage2 = await indexerClient
      *        .lookupAccountTransactions(address)
-     *        .limit(limit)
-     *        .nextToken(nextToken)
+     *        .limit(maxResults)
+     *        .nextToken(accountTxnsPage1["next-token"])
      *        .do();
      * ```
      *
-     * @param nextToken
+     * @param nextToken - provided by the previous results.
      * @category query
      */
     nextToken(nextToken: string): this;
     /**
-     * Include results which include the rekey-to field
+     * Whether or not to include rekeying transactions.
      *
      * #### Example
      * ```typescript

package/dist/types/src/client/v2/indexer/lookupApplicationLogs.d.ts

@@ -3,18 +3,124 @@ import HTTPClient from '../../client';
 import IntDecoding from '../../../types/intDecoding';
 export default class LookupApplicationLogs extends JSONRequest {
     private appID;
+    /**
+     * 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
+     */
     constructor(c: HTTPClient, intDecoding: IntDecoding, appID: number);
+    /**
+     * @returns `/v2/applications/${appID}/logs`
+     */
     path(): string;
-    /** limit for filter, as int */
+    /**
+     * Limit results for pagination.
+     *
+     * #### Example
+     * ```typescript
+     * const maxResults = 20;
+     * const appLogs = await indexerClient
+     *        .lookupApplicationLogs(appId)
+     *        .limit(maxResults)
+     *        .do();
+     * ```
+     *
+     * @param limit - maximum number of results to return.
+     */
     limit(limit: number): this;
-    /** min round to filter with, as int */
+    /**
+     * Include results at or after the specified min-round.
+     *
+     * #### Example
+     * ```typescript
+     * const minRound = 18309917;
+     * const appLogs = await indexerClient
+     *        .lookupApplicationLogs(appId)
+     *        .minRound(minRound)
+     *        .do();
+     * ```
+     *
+     * @param round
+     * @category query
+     */
     minRound(round: number): this;
-    /** max round to filter with, as int */
+    /**
+     * Include results at or before the specified max-round.
+     *
+     * #### Example
+     * ```typescript
+     * const maxRound = 18309917;
+     * const appLogs = await indexerClient
+     *        .lookupApplicationLogs(appId)
+     *        .maxRound(maxRound)
+     *        .do();
+     * ```
+     *
+     * @param round
+     * @category query
+     */
     maxRound(round: number): this;
-    /** used for pagination */
+    /**
+     * The next page of results.
+     *
+     * #### Example
+     * ```typescript
+     * const maxResults = 25;
+     *
+     * const appLogsPage1 = await indexerClient
+     *        .lookupApplicationLogs(appId)
+     *        .limit(maxResults)
+     *        .do();
+     *
+     * const appLogsPage2 = await indexerClient
+     *        .lookupApplicationLogs(appId)
+     *        .limit(maxResults)
+     *        .nextToken(appLogsPage1["next-token"])
+     *        .do();
+     * ```
+     *
+     * @param nextToken - provided by the previous results.
+     * @category query
+     */
     nextToken(nextToken: string): this;
-    /** only include transactions with this sender address */
+    /**
+     * Only include transactions with this sender address.
+     *
+     * #### Example
+     * ```typescript
+     * const sender = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const appLogs = await indexerClient
+     *        .lookupApplicationLogs(appId)
+     *        .sender(sender)
+     *        .do();
+     * ```
+     *
+     * @param senderAddress
+     * @category query
+     */
     sender(senderAddress: string): this;
-    /** txid to filter with, as string */
+    /**
+     * Lookup the specific transaction by ID.
+     *
+     * #### Example
+     * ```typescript
+     * const txId = "MEUOC4RQJB23CQZRFRKYEI6WBO73VTTPST5A7B3S5OKBUY6LFUDA";
+     * const appLogs = await indexerClient
+     *        .lookupApplicationLogs(appId)
+     *        .txid(txId)
+     *        .do();
+     * ```
+     *
+     * @param txid
+     * @category query
+     */
     txid(txid: string): this;
 }

package/dist/types/src/client/v2/indexer/lookupApplications.d.ts

@@ -3,7 +3,47 @@ import HTTPClient from '../../client';
 import IntDecoding from '../../../types/intDecoding';
 export default class LookupApplications extends JSONRequest {
     private 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
+     */
     constructor(c: HTTPClient, intDecoding: IntDecoding, index: number);
+    /**
+     * @returns `/v2/applications/${index}`
+     */
     path(): string;
+    /**
+     * Includes all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates
+     *
+     * #### Example 1
+     * ```typescript
+     * const appId = 60553466;
+     * const appInfo = await indexerClient
+     *        .lookupApplications(appId)
+     *        .includeAll(false)
+     *        .do();
+     * ```
+     *
+     * #### Example 2
+     * ```typescript
+     * const appId = 60553466;
+     * const appInfo = await indexerClient
+     *        .lookupApplications(appId)
+     *        .includeAll()
+     *        .do();
+     * ```
+     *
+     * @param value - default true when called without passing a value
+     * @category query
+     */
     includeAll(value?: boolean): this;
 }