algosdk 1.23.2 → 1.24.1

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

@@ -0,0 +1,146 @@
+import JSONRequest from '../jsonrequest';
+import HTTPClient from '../../client';
+import IntDecoding from '../../../types/intDecoding';
+
+export default class LookupAssetBalances extends JSONRequest {
+  /**
+   * Returns the list of accounts which 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.
+   */
+  constructor(c: HTTPClient, intDecoding: IntDecoding, private index: number) {
+    super(c, intDecoding);
+    this.index = index;
+  }
+
+  /**
+   * @returns `/v2/assets/${index}/balances`
+   */
+  path() {
+    return `/v2/assets/${this.index}/balances`;
+  }
+
+  /**
+   * Limit results for pagination.
+   *
+   * #### Example
+   * ```typescript
+   * const assetId = 163650;
+   * const maxResults = 20;
+   * const assetBalances = await indexerClient
+   *        .lookupAssetBalances(assetId)
+   *        .limit(maxResults)
+   *        .do();
+   * ```
+   *
+   * @param limit - maximum number of results to return.
+   * @category query
+   */
+  limit(limit: number) {
+    this.query.limit = limit;
+    return this;
+  }
+
+  /**
+   * Filtered results should have an asset balance greater than this value.
+   *
+   * #### Example
+   * ```typescript
+   * const assetId = 163650;
+   * const minBalance = 1000000;
+   * const assetBalances = await indexerClient
+   *        .lookupAssetBalances(assetId)
+   *        .currencyGreaterThan(minBalance)
+   *        .do();
+   * ```
+   * @param greater
+   * @category query
+   */
+  currencyGreaterThan(greater: number) {
+    this.query['currency-greater-than'] = greater;
+    return this;
+  }
+
+  /**
+   * Filtered results should have an asset balance less than this value.
+   *
+   * #### Example
+   * ```typescript
+   * const assetId = 163650;
+   * const maxBalance = 2000000;
+   * const assetBalances = await indexerClient
+   *        .lookupAssetBalances(assetId)
+   *        .currencyLessThan(maxBalance)
+   *        .do();
+   * ```
+   * @param lesser
+   * @category query
+   */
+  currencyLessThan(lesser: number) {
+    this.query['currency-less-than'] = lesser;
+    return this;
+  }
+
+  /**
+   * Specify the next page of results.
+   *
+   * #### Example
+   * ```typescript
+   * const assetId = 163650;
+   * const maxResults = 20;
+   *
+   * const assetBalancesPage1 = await indexerClient
+   *        .lookupAssetBalances(assetId)
+   *        .limit(maxResults)
+   *        .do();
+   *
+   * const assetBalancesPage2 = await indexerClient
+   *        .lookupAssetBalances(assetId)
+   *        .limit(maxResults)
+   *        .nextToken(assetBalancesPage1["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 1
+   * ```typescript
+   * const assetId = 163650;
+   * const assetBalances = await indexerClient
+   *        .lookupAssetBalances(assetId)
+   *        .includeAll(false)
+   *        .do();
+   * ```
+   *
+   * #### Example 2
+   * ```typescript
+   * const assetId = 163650;
+   * const assetBalances = await indexerClient
+   *        .lookupAssetBalances(assetId)
+   *        .includeAll()
+   *        .do();
+   * ```
+   *
+   * @param value
+   * @category query
+   */
+  includeAll(value = true) {
+    this.query['include-all'] = value;
+    return this;
+  }
+}

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

@@ -0,0 +1,58 @@
+import JSONRequest from '../jsonrequest';
+import HTTPClient from '../../client';
+import IntDecoding from '../../../types/intDecoding';
+
+export default class LookupAssetByID extends JSONRequest {
+  /**
+   * 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, private index: number) {
+    super(c, intDecoding);
+    this.index = index;
+  }
+
+  /**
+   * @returns `/v2/assets/${index}`
+   */
+  path() {
+    return `/v2/assets/${this.index}`;
+  }
+
+  /**
+   * Includes all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates
+   *
+   * #### Example 1
+   * ```typescript
+   * const assetId = 163650;
+   * const assetInfo = await indexerClient
+   *        .lookupAssetByID(assetId)
+   *        .includeAll(false)
+   *        .do();
+   * ```
+   *
+   * #### Example 2
+   * ```typescript
+   * const assetId = 163650;
+   * const assetInfo = await indexerClient
+   *        .lookupAssetByID(assetId)
+   *        .includeAll()
+   *        .do();
+   * ```
+   *
+   * @param value - default true when called without passing a value
+   * @category query
+   */
+  includeAll(value = true) {
+    this.query['include-all'] = value;
+    return this;
+  }
+}

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

@@ -0,0 +1,406 @@
+import JSONRequest from '../jsonrequest';
+import HTTPClient from '../../client';
+import IntDecoding from '../../../types/intDecoding';
+import { base64StringFunnel } from './lookupAccountTransactions';
+
+export default class LookupAssetTransactions extends JSONRequest {
+  /**
+   * 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: HTTPClient, intDecoding: IntDecoding, private index: number) {
+    super(c, intDecoding);
+    this.index = index;
+  }
+
+  /**
+   * @returns `/v2/assets/${index}/transactions`
+   */
+  path() {
+    return `/v2/assets/${this.index}/transactions`;
+  }
+
+  /**
+   * 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: Uint8Array | string) {
+    this.query['note-prefix'] = base64StringFunnel(prefix);
+    return this;
+  }
+
+  /**
+   * 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: string) {
+    this.query['tx-type'] = type;
+    return this;
+  }
+
+  /**
+   * 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: string) {
+    this.query['sig-type'] = type;
+    return this;
+  }
+
+  /**
+   * 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: string) {
+    this.query.txid = txid;
+    return this;
+  }
+
+  /**
+   * 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: number) {
+    this.query.round = round;
+    return this;
+  }
+
+  /**
+   * 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: number) {
+    this.query['min-round'] = round;
+    return this;
+  }
+
+  /**
+   * 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: number) {
+    this.query['max-round'] = round;
+    return this;
+  }
+
+  /**
+   * @deprecated Redundant query parameter. Asset ID is already passed into the method.
+   */
+  assetID(id: number) {
+    this.query['asset-id'] = id;
+    return this;
+  }
+
+  /**
+   * 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: number) {
+    this.query.limit = limit;
+    return this;
+  }
+
+  /**
+   * 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: string) {
+    this.query['before-time'] = before;
+    return this;
+  }
+
+  /**
+   * 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: string) {
+    this.query['after-time'] = after;
+    return this;
+  }
+
+  /**
+   * 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: number) {
+    this.query['currency-greater-than'] = greater;
+    return this;
+  }
+
+  /**
+   * 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: number) {
+    this.query['currency-less-than'] = lesser;
+    return this;
+  }
+
+  /**
+   * 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: string) {
+    this.query['address-role'] = role;
+    return this;
+  }
+
+  /**
+   * 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: string) {
+    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`.
+   *
+   * #### Example
+   * ```typescript
+   * const assetId = 163650;
+   * const assetTxns = await indexerClient
+   *        .lookupAssetTransactions(assetId)
+   *        .excludeCloseTo(true)
+   *        .do();
+   * ```
+   *
+   * @param exclude
+   * @category query
+   */
+  excludeCloseTo(exclude: boolean) {
+    this.query['exclude-close-to'] = exclude;
+    return this;
+  }
+
+  /**
+   * 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: string) {
+    this.query.next = nextToken;
+    return this;
+  }
+
+  /**
+   * 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: boolean) {
+    this.query['rekey-to'] = rekeyTo;
+    return this;
+  }
+}

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

@@ -0,0 +1,39 @@
+import JSONRequest from '../jsonrequest';
+import HTTPClient from '../../client';
+import IntDecoding from '../../../types/intDecoding';
+
+export default class LookupBlock extends JSONRequest {
+  /**
+   * 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: HTTPClient, intDecoding: IntDecoding, private round: number) {
+    super(c, intDecoding);
+    this.round = round;
+  }
+
+  /**
+   * @returns `/v2/blocks/${round}`
+   */
+  path() {
+    return `/v2/blocks/${this.round}`;
+  }
+
+  /**
+   * Header only flag. When this is set to true, returned block does not contain the
+   * transactions.
+   */
+  headerOnly(headerOnly: boolean) {
+    this.query['header-only'] = headerOnly;
+    return this;
+  }
+}

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

@@ -0,0 +1,30 @@
+import JSONRequest from '../jsonrequest';
+import HTTPClient from '../../client';
+import IntDecoding from '../../../types/intDecoding';
+
+export default class LookupTransactionByID extends JSONRequest {
+  /**
+   * 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: HTTPClient, intDecoding: IntDecoding, private txID: string) {
+    super(c, intDecoding);
+    this.txID = txID;
+  }
+
+  /**
+   * @returns `/v2/transactions/${txID}`
+   */
+  path() {
+    return `/v2/transactions/${this.txID}`;
+  }
+}

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

@@ -0,0 +1,23 @@
+import JSONRequest from '../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
+ */
+export default class MakeHealthCheck extends JSONRequest {
+  /**
+   * @returns `/health`
+   */
+  // eslint-disable-next-line class-methods-use-this
+  path() {
+    return '/health';
+  }
+}