algosdk 1.14.0-beta.1 → 1.15.0

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

@@ -0,0 +1,85 @@
+import JSONRequest from '../jsonrequest';
+import HTTPClient from '../../client';
+import IntDecoding from '../../../types/intDecoding';
+export default class LookupAccountCreatedAssets extends JSONRequest {
+    private account;
+    constructor(c: HTTPClient, intDecoding: IntDecoding, account: string);
+    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.
+     */
+    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
+     */
+    round(round: number): this;
+    /**
+     * Specify the next page of results.
+     *
+     * #### Example
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const maxResults = 20;
+     * const nextToken = "APA6C7C3NCANRPIBUWQOF7WSKLJMK6RPQUVFLLDV4U5WCQE4DEF26D4E3E";
+     * const accountAssets = await indexerClient
+     *        .lookupAccountCreatedAssets(address)
+     *        .limit(maxResults)
+     *        .next(nextToken)
+     *        .do();
+     * ```
+     * @param nextToken - provided by the previous results.
+     */
+    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
+     */
+    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
+     */
+    assetID(index: number): this;
+}

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

@@ -9,25 +9,304 @@ import IntDecoding from '../../../types/intDecoding';
 export declare function base64StringFunnel(data: Uint8Array | string): string;
 export default class LookupAccountTransactions extends JSONRequest {
     private account;
+    /**
+     * 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.
+     */
     constructor(c: HTTPClient, intDecoding: IntDecoding, account: string);
+    /**
+     * @returns /v2/accounts/`${account}`/transactions
+     */
     path(): string;
     /**
-     * notePrefix to filter with
+     * Specifies a prefix which must be contained in the note field
+     *
+     * #### Example
+     * ```typescript
+     * const notePrefixBase64Encoded = "Y3JlYXRl";
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .notePrefix(notePrefixBase64Encoded)
+     *        .do();
+     * ```
+     *
      * @param prefix - base64 string or uint8array
+     * @category query
      */
     notePrefix(prefix: Uint8Array | string): this;
+    /**
+     * Type of transaction to filter with
+     *
+     * #### Example
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .txType("appl")
+     *        .do();
+     * ```
+     *
+     * @param type - one of “pay”, “keyreg”, “acfg”, “axfer”, “afrz”, "appl"
+     * @category query
+     */
     txType(type: string): this;
+    /**
+     * Type of signature to filter with
+     * - sig: Standard
+     * - msig: MultiSig
+     * - lsig: LogicSig
+     *
+     * #### Example
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .sigType("msig")
+     *        .do();
+     * ```
+     *
+     * @param type - one of “sig”, “msig”, “lsig”
+     * @category query
+     */
     sigType(type: string): this;
+    /**
+     * Lookup the specific transaction by ID
+     *
+     * #### Example
+     * ```typescript
+     * const txId = "MEUOC4RQJB23CQZRFRKYEI6WBO73VTTPST5A7B3S5OKBUY6LFUDA";
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .txid(txId)
+     *        .do();
+     * ```
+     *
+     * @param txid
+     * @category query
+     */
     txid(txid: string): this;
+    /**
+     * Include results for the specified round
+     *
+     * #### Example
+     * ```typescript
+     * const targetBlock = 18309917;
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .round(targetBlock)
+     *        .do();
+     * ```
+     *
+     * @param round
+     * @category query
+     */
     round(round: number): this;
+    /**
+     * Include results at or after the specified min-round
+     *
+     * #### Example
+     * ```typescript
+     * const minRound = 18309917;
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .minRound(minRound)
+     *        .do();
+     * ```
+     *
+     * @param round
+     * @category query
+     */
     minRound(round: number): this;
+    /**
+     * Include results at or before the specified max-round
+     *
+     * #### Example
+     * ```typescript
+     * const maxRound = 18309917;
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .maxRound(maxRound)
+     *        .do();
+     * ```
+     *
+     * @param round
+     * @category query
+     */
     maxRound(round: number): this;
+    /**
+     * Asset ID to filter with
+     *
+     * #### Example
+     * ```typescript
+     * const assetID = 163650;
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .assetID(assetID)
+     *        .do();
+     * ```
+     *
+     * @param id
+     * @category query
+     */
     assetID(id: number): this;
+    /**
+     * Maximum number of results to return
+     *
+     * #### Example
+     * ```typescript
+     * const limit = 25;
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .limit(limit)
+     *        .do();
+     * ```
+     *
+     * @param limit
+     * @category query
+     */
     limit(limit: number): this;
+    /**
+     * Include results before the given time
+     *
+     * #### Example
+     * ```typescript
+     * const beforeTime = "2022-02-02T20:20:22.02Z";
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .beforeTime(beforeTime)
+     *        .do();
+     * ```
+     *
+     * @param before - rfc3339 string
+     * @category query
+     */
     beforeTime(before: string): this;
+    /**
+     * Include results after the given time
+     *
+     * #### Example
+     * ```typescript
+     * const afterTime = "2022-10-21T00:00:11.55Z";
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .afterTime(afterTime)
+     *        .do();
+     * ```
+     *
+     * @param after - rfc3339 string
+     * @category query
+     */
     afterTime(after: string): this;
+    /**
+     * Filtered results should have an amount greater 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
+     * const minBalance = 300000;
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .currencyGreaterThan(minBalance - 1)
+     *        .do();
+     * ```
+     *
+     * #### Example 2
+     * ```typescript
+     * const assetID = 163650;
+     * const minBalance = 300000;
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .assetID(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: 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
+     *
+     * #### Example 1
+     * ```typescript
+     * const maxBalance = 500000;
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .currencyLessThan(maxBalance + 1)
+     *        .do();
+     * ```
+     *
+     * #### Example 2
+     * ```typescript
+     * const assetID = 163650;
+     * const maxBalance = 500000;
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .assetID(assetID)
+     *        .currencyLessThan(maxBalance + 1)
+     *        .do();
+     * ```
+     *
+     * @param lesser
+     * @category query
+     */
     currencyLessThan(lesser: number): this;
+    /**
+     * The next page of results. Use the next token provided by the previous results.
+     *
+     * #### Example
+     * ```typescript
+     * const limit = 25;
+     * const nextToken = "the next token returned in the previous query response";
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .limit(limit)
+     *        .nextToken(nextToken)
+     *        .do();
+     * ```
+     *
+     * @param nextToken
+     * @category query
+     */
     nextToken(nextToken: string): this;
+    /**
+     * Include results which include the rekey-to field
+     *
+     * #### Example
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .rekeyTo(false)
+     *        .do();
+     * ```
+     *
+     * @param rekeyTo
+     * @category query
+     */
     rekeyTo(rekeyTo: boolean): this;
 }

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

@@ -33,21 +33,6 @@ export default class LookupAssetBalances extends JSONRequest {
      * @param limit - maximum number of results to return.
      */
     limit(limit: number): this;
-    /**
-     * 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: number): this;
     /**
      * Filtered results should have an asset balance greater than this value.
      *

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

@@ -3,7 +3,44 @@ import HTTPClient from '../../client';
 import IntDecoding from '../../../types/intDecoding';
 export default class LookupAssetByID extends JSONRequest {
     private index;
+    /**
+     * Returns asset information of the queried 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 asset ID to look up.
+     */
     constructor(c: HTTPClient, intDecoding: IntDecoding, index: number);
+    /**
+     * @returns `/v2/assets/${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 assetInfo = await indexerClient
+     *        .lookupAssetByID(assetId)
+     *        .includeAll(false)
+     *        .do();
+     * ```
+     *
+     * #### Example 2
+     * ```typescript
+     * const assetInfo = await indexerClient
+     *        .lookupAssetByID(assetId)
+     *        .includeAll()
+     *        .do();
+     * ```
+     *
+     * @param value - default true when called without passing a value
+     * @category query
+     */
     includeAll(value?: boolean): this;
 }

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

@@ -10,4 +10,5 @@ export default class SearchAccounts extends JSONRequest {
     authAddr(authAddr: string): this;
     applicationID(applicationID: number): this;
     includeAll(value?: boolean): this;
+    exclude(exclude: string): this;
 }

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

@@ -2,6 +2,7 @@ import JSONRequest from '../jsonrequest';
 export default class SearchForApplications extends JSONRequest {
     path(): string;
     index(index: number): this;
+    creator(creator: string): this;
     nextToken(next: string): this;
     limit(limit: number): this;
     includeAll(value?: boolean): this;

package/dist/types/src/client/v2/jsonrequest.d.ts

@@ -20,6 +20,7 @@ export default abstract class JSONRequest<Data = Record<string, any>, Body = Dat
     constructor(client: HTTPClient, intDecoding?: IntDecoding);
     /**
      * @returns The path of this request.
+     * @category JSONRequest
      */
     abstract path(): string;
     /**
@@ -28,12 +29,14 @@ export default abstract class JSONRequest<Data = Record<string, any>, Body = Dat
      * Use this method to change and restructure response
      * data as needed after receiving it from the `do()` method.
      * @param body - Response body received
+     * @category JSONRequest
      */
     prepare(body: Body): Data;
     /**
      * Execute the request.
      * @param headers - Additional headers to send in the request. Optional.
      * @returns A promise which resolves to the response data.
+     * @category JSONRequest
      */
     do(headers?: Record<string, any>): Promise<Data>;
     /**
@@ -50,6 +53,7 @@ export default abstract class JSONRequest<Data = Record<string, any>, Body = Dat
      *
      * @param method - The method to use when parsing the
      *   response for this request. Must be one of "default", "safe", "mixed", or "bigint".
+     * @category JSONRequest
      */
     setIntDecoding(method: IntDecoding): this;
 }