algosdk 1.24.0 → 1.24.1

package/src/client/v2/indexer/lookupAccountByID.ts

@@ -0,0 +1,109 @@
+import JSONRequest from '../jsonrequest';
+import HTTPClient from '../../client';
+import IntDecoding from '../../../types/intDecoding';
+
+export default class LookupAccountByID extends JSONRequest {
+  /**
+   * 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,
+    private account: string
+  ) {
+    super(c, intDecoding);
+    this.account = account;
+  }
+
+  /**
+   * @returns `/v2/accounts/${account}`
+   */
+  path() {
+    return `/v2/accounts/${this.account}`;
+  }
+
+  /**
+   * 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.query.round = round;
+    return 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 = true) {
+    this.query['include-all'] = value;
+    return 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.query.exclude = exclude;
+    return this;
+  }
+}

package/src/client/v2/indexer/lookupAccountCreatedApplications.ts

@@ -0,0 +1,141 @@
+import JSONRequest from '../jsonrequest';
+import HTTPClient from '../../client';
+import IntDecoding from '../../../types/intDecoding';
+
+export default class LookupAccountCreatedApplications extends JSONRequest {
+  /**
+   * 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,
+    private account: string
+  ) {
+    super(c, intDecoding);
+    this.account = account;
+  }
+
+  /**
+   * @returns `/v2/accounts/${account}/created-applications`
+   */
+  path() {
+    return `/v2/accounts/${this.account}/created-applications`;
+  }
+
+  /**
+   * 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.query.limit = limit;
+    return 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.query.round = round;
+    return 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.query.next = nextToken;
+    return 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 = true) {
+    this.query['include-all'] = value;
+    return 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.query['application-id'] = index;
+    return this;
+  }
+}

package/src/client/v2/indexer/lookupAccountCreatedAssets.ts

@@ -0,0 +1,142 @@
+import JSONRequest from '../jsonrequest';
+import HTTPClient from '../../client';
+import IntDecoding from '../../../types/intDecoding';
+
+export default class LookupAccountCreatedAssets extends JSONRequest {
+  /**
+   * 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,
+    private account: string
+  ) {
+    super(c, intDecoding);
+    this.account = account;
+  }
+
+  /**
+   * @returns `/v2/accounts/${account}/created-assets`
+   */
+  path() {
+    return `/v2/accounts/${this.account}/created-assets`;
+  }
+
+  /**
+   * 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.query.limit = limit;
+    return 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.query.round = round;
+    return 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.query.next = nextToken;
+    return 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 = true) {
+    this.query['include-all'] = value;
+    return 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.query['asset-id'] = index;
+    return this;
+  }
+}