algosdk 1.24.0 → 2.0.0

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

@@ -0,0 +1,393 @@
+import JSONRequest from '../jsonrequest';
+import HTTPClient from '../../client';
+import IntDecoding from '../../../types/intDecoding';
+
+/**
+ * Accept base64 string or Uint8Array and output base64 string
+ * @param data - Base64 string or Uint8Array
+ * @returns The inputted base64 string, or a base64 string representation of the Uint8Array
+ */
+export function base64StringFunnel(data: Uint8Array | string) {
+  if (typeof data === 'string') {
+    return data;
+  }
+  return Buffer.from(data).toString('base64');
+}
+
+export default class LookupAccountTransactions extends JSONRequest {
+  /**
+   * 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,
+    private account: string
+  ) {
+    super(c, intDecoding);
+    this.account = account;
+  }
+
+  /**
+   * @returns `/v2/accounts/${account}/transactions`
+   */
+  path() {
+    return `/v2/accounts/${this.account}/transactions`;
+  }
+
+  /**
+   * 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.query['note-prefix'] = base64StringFunnel(prefix);
+    return 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`, `stpf`
+   * @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 address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+   * const accountTxns = await indexerClient
+   *        .lookupAccountTransactions(address)
+   *        .sigType("msig")
+   *        .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 address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+   * const accountTxns = await indexerClient
+   *        .lookupAccountTransactions(address)
+   *        .txid(txId)
+   *        .do();
+   * ```
+   * @remarks Alternatively, use `indexerClient.lookupTransactionByID(txnId).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 address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+   * const accountTxns = await indexerClient
+   *        .lookupAccountTransactions(address)
+   *        .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 address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+   * const accountTxns = await indexerClient
+   *        .lookupAccountTransactions(address)
+   *        .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 address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+   * const accountTxns = await indexerClient
+   *        .lookupAccountTransactions(address)
+   *        .maxRound(maxRound)
+   *        .do();
+   * ```
+   *
+   * @param round
+   * @category query
+   */
+  maxRound(round: number) {
+    this.query['max-round'] = round;
+    return 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.query['asset-id'] = id;
+    return this;
+  }
+
+  /**
+   * Maximum number of results to return.
+   *
+   * #### Example
+   * ```typescript
+   * const maxResults = 25;
+   * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+   * const accountTxns = await indexerClient
+   *        .lookupAccountTransactions(address)
+   *        .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 address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+   * const accountTxns = await indexerClient
+   *        .lookupAccountTransactions(address)
+   *        .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 address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+   * const accountTxns = await indexerClient
+   *        .lookupAccountTransactions(address)
+   *        .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 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.query['currency-greater-than'] = greater;
+    return 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.query['currency-less-than'] = lesser;
+    return this;
+  }
+
+  /**
+   * The next page of results. Use the next token provided by the previous results.
+   *
+   * #### Example
+   * ```typescript
+   * const maxResults = 25;
+   * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+   *
+   * const accountTxnsPage1 = await indexerClient
+   *        .lookupAccountTransactions(address)
+   *        .limit(maxResults)
+   *        .do();
+   *
+   * const accountTxnsPage2 = await indexerClient
+   *        .lookupAccountTransactions(address)
+   *        .limit(maxResults)
+   *        .nextToken(accountTxnsPage1["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 address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+   * const accountTxns = await indexerClient
+   *        .lookupAccountTransactions(address)
+   *        .rekeyTo(false)
+   *        .do();
+   * ```
+   *
+   * @param rekeyTo
+   * @category query
+   */
+  rekeyTo(rekeyTo: boolean) {
+    this.query['rekey-to'] = rekeyTo;
+    return this;
+  }
+}

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

@@ -0,0 +1,50 @@
+import JSONRequest from '../jsonrequest';
+import HTTPClient from '../../client';
+import IntDecoding from '../../../types/intDecoding';
+import { Box } from './models/types';
+
+export default class LookupApplicationBoxByIDandName extends JSONRequest<
+  Box,
+  Record<string, any>
+> {
+  /**
+   * Returns information about indexed application boxes.
+   *
+   * #### Example
+   * ```typescript
+   * const boxName = Buffer.from("foo");
+   * const boxResponse = await indexerClient
+   *        .LookupApplicationBoxByIDandName(1234, boxName)
+   *        .do();
+   * const boxValue = boxResponse.value;
+   * ```
+   *
+   * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2applicationsapplication-idbox)
+   * @oaram index - application index.
+   * @category GET
+   */
+  constructor(
+    c: HTTPClient,
+    intDecoding: IntDecoding,
+    private index: number,
+    boxName: Uint8Array
+  ) {
+    super(c, intDecoding);
+    this.index = index;
+    // Encode query in base64 format and append the encoding prefix.
+    const encodedName = Buffer.from(boxName).toString('base64');
+    this.query.name = encodeURI(`b64:${encodedName}`);
+  }
+
+  /**
+   * @returns `/v2/applications/${index}/box`
+   */
+  path() {
+    return `/v2/applications/${this.index}/box`;
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(body: Record<string, any>): Box {
+    return Box.from_obj_for_encoding(body);
+  }
+}

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

@@ -0,0 +1,156 @@
+import JSONRequest from '../jsonrequest';
+import HTTPClient from '../../client';
+import IntDecoding from '../../../types/intDecoding';
+
+export default class LookupApplicationLogs extends JSONRequest {
+  /**
+   * 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, private appID: number) {
+    super(c, intDecoding);
+    this.appID = appID;
+  }
+
+  /**
+   * @returns `/v2/applications/${appID}/logs`
+   */
+  path() {
+    return `/v2/applications/${this.appID}/logs`;
+  }
+
+  /**
+   * 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.query.limit = limit;
+    return this;
+  }
+
+  /**
+   * 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.query['min-round'] = round;
+    return this;
+  }
+
+  /**
+   * 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.query['max-round'] = round;
+    return this;
+  }
+
+  /**
+   * 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.query.next = nextToken;
+    return this;
+  }
+
+  /**
+   * 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.query['sender-address'] = senderAddress;
+    return this;
+  }
+
+  /**
+   * 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.query.txid = txid;
+    return this;
+  }
+}

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

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