algosdk 2.9.0 → 3.0.0-beta.2

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

@@ -1,7 +1,9 @@
-import { Buffer } from 'buffer';
-import JSONRequest from '../jsonrequest';
-import HTTPClient from '../../client';
-import IntDecoding from '../../../types/intDecoding';
+import { bytesToBase64 } from '../../../encoding/binarydata.js';
+import { HTTPClient, HTTPClientResponse } from '../../client.js';
+import { decodeJSON } from '../../../encoding/encoding.js';
+import JSONRequest from '../jsonrequest.js';
+import { Address } from '../../../encoding/address.js';
+import { TransactionsResponse } from './models/types.js';
 
 /**
  * Accept base64 string or Uint8Array and output base64 string
@@ -12,10 +14,12 @@ export function base64StringFunnel(data: Uint8Array | string) {
   if (typeof data === 'string') {
     return data;
   }
-  return Buffer.from(data).toString('base64');
+  return bytesToBase64(data);
 }
 
-export default class LookupAccountTransactions extends JSONRequest {
+export default class LookupAccountTransactions extends JSONRequest<TransactionsResponse> {
+  private account: string;
+
   /**
    * Returns transactions relating to the given account.
    *
@@ -28,13 +32,9 @@ export default class LookupAccountTransactions extends JSONRequest {
    * [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;
+  constructor(c: HTTPClient, account: string | Address) {
+    super(c);
+    this.account = account.toString();
   }
 
   /**
@@ -145,7 +145,7 @@ export default class LookupAccountTransactions extends JSONRequest {
    * @param round
    * @category query
    */
-  round(round: number) {
+  round(round: number | bigint) {
     this.query.round = round;
     return this;
   }
@@ -166,7 +166,7 @@ export default class LookupAccountTransactions extends JSONRequest {
    * @param round
    * @category query
    */
-  minRound(round: number) {
+  minRound(round: number | bigint) {
     this.query['min-round'] = round;
     return this;
   }
@@ -187,7 +187,7 @@ export default class LookupAccountTransactions extends JSONRequest {
    * @param round
    * @category query
    */
-  maxRound(round: number) {
+  maxRound(round: number | bigint) {
     this.query['max-round'] = round;
     return this;
   }
@@ -208,7 +208,7 @@ export default class LookupAccountTransactions extends JSONRequest {
    * @param id
    * @category query
    */
-  assetID(id: number) {
+  assetID(id: number | bigint) {
     this.query['asset-id'] = id;
     return this;
   }
@@ -247,11 +247,12 @@ export default class LookupAccountTransactions extends JSONRequest {
    *        .do();
    * ```
    *
-   * @param before - rfc3339 string
+   * @param before - rfc3339 string or Date object
    * @category query
    */
-  beforeTime(before: string) {
-    this.query['before-time'] = before;
+  beforeTime(before: string | Date) {
+    this.query['before-time'] =
+      before instanceof Date ? before.toISOString() : before;
     return this;
   }
 
@@ -268,11 +269,12 @@ export default class LookupAccountTransactions extends JSONRequest {
    *        .do();
    * ```
    *
-   * @param after - rfc3339 string
+   * @param after - rfc3339 string or Date object
    * @category query
    */
-  afterTime(after: string) {
-    this.query['after-time'] = after;
+  afterTime(after: string | Date) {
+    this.query['after-time'] =
+      after instanceof Date ? after.toISOString() : after;
     return this;
   }
 
@@ -304,7 +306,7 @@ export default class LookupAccountTransactions extends JSONRequest {
    * @param greater
    * @category query
    */
-  currencyGreaterThan(greater: number) {
+  currencyGreaterThan(greater: number | bigint) {
     // We convert the following to a string for now to correctly include zero values in request parameters.
     this.query['currency-greater-than'] = greater.toString();
     return this;
@@ -338,7 +340,7 @@ export default class LookupAccountTransactions extends JSONRequest {
    * @param lesser
    * @category query
    */
-  currencyLessThan(lesser: number) {
+  currencyLessThan(lesser: number | bigint) {
     this.query['currency-less-than'] = lesser;
     return this;
   }
@@ -390,4 +392,9 @@ export default class LookupAccountTransactions extends JSONRequest {
     this.query['rekey-to'] = rekeyTo;
     return this;
   }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(response: HTTPClientResponse): TransactionsResponse {
+    return decodeJSON(response.getJSONText(), TransactionsResponse);
+  }
 }

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

@@ -1,13 +1,12 @@
-import { Buffer } from 'buffer';
-import JSONRequest from '../jsonrequest';
-import HTTPClient from '../../client';
-import IntDecoding from '../../../types/intDecoding';
-import { Box } from './models/types';
+import { bytesToBase64 } from '../../../encoding/binarydata.js';
+import { HTTPClient, HTTPClientResponse } from '../../client.js';
+import { decodeJSON } from '../../../encoding/encoding.js';
+import JSONRequest from '../jsonrequest.js';
+import { Box } from './models/types.js';
+
+export default class LookupApplicationBoxByIDandName extends JSONRequest<Box> {
+  private index: bigint;
 
-export default class LookupApplicationBoxByIDandName extends JSONRequest<
-  Box,
-  Record<string, any>
-> {
   /**
    * Returns information about indexed application boxes.
    *
@@ -24,16 +23,11 @@ export default class LookupApplicationBoxByIDandName extends JSONRequest<
    * @oaram index - application index.
    * @category GET
    */
-  constructor(
-    c: HTTPClient,
-    intDecoding: IntDecoding,
-    private index: number,
-    boxName: Uint8Array
-  ) {
-    super(c, intDecoding);
-    this.index = index;
+  constructor(c: HTTPClient, index: number | bigint, boxName: Uint8Array) {
+    super(c);
+    this.index = BigInt(index);
     // Encode query in base64 format and append the encoding prefix.
-    const encodedName = Buffer.from(boxName).toString('base64');
+    const encodedName = bytesToBase64(boxName);
     this.query.name = encodeURI(`b64:${encodedName}`);
   }
 
@@ -45,7 +39,7 @@ export default class LookupApplicationBoxByIDandName extends JSONRequest<
   }
 
   // eslint-disable-next-line class-methods-use-this
-  prepare(body: Record<string, any>): Box {
-    return Box.from_obj_for_encoding(body);
+  prepare(response: HTTPClientResponse): Box {
+    return decodeJSON(response.getJSONText(), Box);
   }
 }

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

@@ -1,8 +1,11 @@
-import JSONRequest from '../jsonrequest';
-import HTTPClient from '../../client';
-import IntDecoding from '../../../types/intDecoding';
+import JSONRequest from '../jsonrequest.js';
+import { HTTPClient, HTTPClientResponse } from '../../client.js';
+import { decodeJSON } from '../../../encoding/encoding.js';
+import { ApplicationLogsResponse } from './models/types.js';
+
+export default class LookupApplicationLogs extends JSONRequest<ApplicationLogsResponse> {
+  private appID: bigint;
 
-export default class LookupApplicationLogs extends JSONRequest {
   /**
    * Returns log messages generated by the passed in application.
    *
@@ -16,9 +19,9 @@ export default class LookupApplicationLogs extends JSONRequest {
    * @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;
+  constructor(c: HTTPClient, appID: number | bigint) {
+    super(c);
+    this.appID = BigInt(appID);
   }
 
   /**
@@ -62,7 +65,7 @@ export default class LookupApplicationLogs extends JSONRequest {
    * @param round
    * @category query
    */
-  minRound(round: number) {
+  minRound(round: number | bigint) {
     this.query['min-round'] = round;
     return this;
   }
@@ -82,7 +85,7 @@ export default class LookupApplicationLogs extends JSONRequest {
    * @param round
    * @category query
    */
-  maxRound(round: number) {
+  maxRound(round: number | bigint) {
     this.query['max-round'] = round;
     return this;
   }
@@ -153,4 +156,9 @@ export default class LookupApplicationLogs extends JSONRequest {
     this.query.txid = txid;
     return this;
   }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(response: HTTPClientResponse): ApplicationLogsResponse {
+    return decodeJSON(response.getJSONText(), ApplicationLogsResponse);
+  }
 }

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

@@ -1,8 +1,11 @@
-import JSONRequest from '../jsonrequest';
-import HTTPClient from '../../client';
-import IntDecoding from '../../../types/intDecoding';
+import JSONRequest from '../jsonrequest.js';
+import { HTTPClient, HTTPClientResponse } from '../../client.js';
+import { decodeJSON } from '../../../encoding/encoding.js';
+import { ApplicationResponse } from './models/types.js';
+
+export default class LookupApplications extends JSONRequest<ApplicationResponse> {
+  private index: bigint;
 
-export default class LookupApplications extends JSONRequest {
   /**
    * Returns information about the passed application.
    *
@@ -16,9 +19,9 @@ export default class LookupApplications extends JSONRequest {
    * @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;
+  constructor(c: HTTPClient, index: number | bigint) {
+    super(c);
+    this.index = BigInt(index);
   }
 
   /**
@@ -56,4 +59,9 @@ export default class LookupApplications extends JSONRequest {
     this.query['include-all'] = value;
     return this;
   }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(response: HTTPClientResponse): ApplicationResponse {
+    return decodeJSON(response.getJSONText(), ApplicationResponse);
+  }
 }

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

@@ -1,8 +1,11 @@
-import JSONRequest from '../jsonrequest';
-import HTTPClient from '../../client';
-import IntDecoding from '../../../types/intDecoding';
+import JSONRequest from '../jsonrequest.js';
+import { HTTPClient, HTTPClientResponse } from '../../client.js';
+import { decodeJSON } from '../../../encoding/encoding.js';
+import { AssetBalancesResponse } from './models/types.js';
+
+export default class LookupAssetBalances extends JSONRequest<AssetBalancesResponse> {
+  private index: bigint;
 
-export default class LookupAssetBalances extends JSONRequest {
   /**
    * Returns the list of accounts which hold the given asset and their balance.
    *
@@ -15,9 +18,9 @@ export default class LookupAssetBalances extends JSONRequest {
    * [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;
+  constructor(c: HTTPClient, index: number | bigint) {
+    super(c);
+    this.index = BigInt(index);
   }
 
   /**
@@ -63,7 +66,7 @@ export default class LookupAssetBalances extends JSONRequest {
    * @param greater
    * @category query
    */
-  currencyGreaterThan(greater: number) {
+  currencyGreaterThan(greater: number | bigint) {
     // We convert the following to a string for now to correctly include zero values in request parameters.
     this.query['currency-greater-than'] = greater.toString();
     return this;
@@ -84,7 +87,7 @@ export default class LookupAssetBalances extends JSONRequest {
    * @param lesser
    * @category query
    */
-  currencyLessThan(lesser: number) {
+  currencyLessThan(lesser: number | bigint) {
     this.query['currency-less-than'] = lesser;
     return this;
   }
@@ -144,4 +147,9 @@ export default class LookupAssetBalances extends JSONRequest {
     this.query['include-all'] = value;
     return this;
   }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(response: HTTPClientResponse): AssetBalancesResponse {
+    return decodeJSON(response.getJSONText(), AssetBalancesResponse);
+  }
 }

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

@@ -1,8 +1,11 @@
-import JSONRequest from '../jsonrequest';
-import HTTPClient from '../../client';
-import IntDecoding from '../../../types/intDecoding';
+import JSONRequest from '../jsonrequest.js';
+import { HTTPClient, HTTPClientResponse } from '../../client.js';
+import { decodeJSON } from '../../../encoding/encoding.js';
+import { AssetResponse } from './models/types.js';
+
+export default class LookupAssetByID extends JSONRequest<AssetResponse> {
+  private index: bigint;
 
-export default class LookupAssetByID extends JSONRequest {
   /**
    * Returns asset information of the queried asset.
    *
@@ -15,9 +18,9 @@ export default class LookupAssetByID extends JSONRequest {
    * [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;
+  constructor(c: HTTPClient, index: number | bigint) {
+    super(c);
+    this.index = BigInt(index);
   }
 
   /**
@@ -55,4 +58,9 @@ export default class LookupAssetByID extends JSONRequest {
     this.query['include-all'] = value;
     return this;
   }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(response: HTTPClientResponse): AssetResponse {
+    return decodeJSON(response.getJSONText(), AssetResponse);
+  }
 }

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

@@ -1,9 +1,13 @@
-import JSONRequest from '../jsonrequest';
-import HTTPClient from '../../client';
-import IntDecoding from '../../../types/intDecoding';
-import { base64StringFunnel } from './lookupAccountTransactions';
+import JSONRequest from '../jsonrequest.js';
+import { HTTPClient, HTTPClientResponse } from '../../client.js';
+import { decodeJSON } from '../../../encoding/encoding.js';
+import { base64StringFunnel } from './lookupAccountTransactions.js';
+import { Address } from '../../../encoding/address.js';
+import { TransactionsResponse } from './models/types.js';
+
+export default class LookupAssetTransactions extends JSONRequest<TransactionsResponse> {
+  private index: bigint;
 
-export default class LookupAssetTransactions extends JSONRequest {
   /**
    * Returns transactions relating to the given asset.
    *
@@ -16,9 +20,9 @@ export default class LookupAssetTransactions extends JSONRequest {
    * [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;
+  constructor(c: HTTPClient, index: number | bigint) {
+    super(c);
+    this.index = BigInt(index);
   }
 
   /**
@@ -129,7 +133,7 @@ export default class LookupAssetTransactions extends JSONRequest {
    * @param round
    * @category query
    */
-  round(round: number) {
+  round(round: number | bigint) {
     this.query.round = round;
     return this;
   }
@@ -150,7 +154,7 @@ export default class LookupAssetTransactions extends JSONRequest {
    * @param round
    * @category query
    */
-  minRound(round: number) {
+  minRound(round: number | bigint) {
     this.query['min-round'] = round;
     return this;
   }
@@ -171,7 +175,7 @@ export default class LookupAssetTransactions extends JSONRequest {
    * @param round
    * @category query
    */
-  maxRound(round: number) {
+  maxRound(round: number | bigint) {
     this.query['max-round'] = round;
     return this;
   }
@@ -210,11 +214,12 @@ export default class LookupAssetTransactions extends JSONRequest {
    *        .do();
    * ```
    *
-   * @param before - rfc3339 string
+   * @param before - rfc3339 string or Date object
    * @category query
    */
-  beforeTime(before: string) {
-    this.query['before-time'] = before;
+  beforeTime(before: string | Date) {
+    this.query['before-time'] =
+      before instanceof Date ? before.toISOString() : before;
     return this;
   }
 
@@ -231,11 +236,12 @@ export default class LookupAssetTransactions extends JSONRequest {
    *        .do();
    * ```
    *
-   * @param after - rfc3339 string
+   * @param after - rfc3339 string or Date object
    * @category query
    */
-  afterTime(after: string) {
-    this.query['after-time'] = after;
+  afterTime(after: string | Date) {
+    this.query['after-time'] =
+      after instanceof Date ? after.toISOString() : after;
     return this;
   }
 
@@ -255,7 +261,7 @@ export default class LookupAssetTransactions extends JSONRequest {
    * @param greater
    * @category query
    */
-  currencyGreaterThan(greater: number) {
+  currencyGreaterThan(greater: number | bigint) {
     // We convert the following to a string for now to correctly include zero values in request parameters.
     this.query['currency-greater-than'] = greater.toString();
     return this;
@@ -277,7 +283,7 @@ export default class LookupAssetTransactions extends JSONRequest {
    * @param lesser
    * @category query
    */
-  currencyLessThan(lesser: number) {
+  currencyLessThan(lesser: number | bigint) {
     this.query['currency-less-than'] = lesser;
     return this;
   }
@@ -321,8 +327,8 @@ export default class LookupAssetTransactions extends JSONRequest {
    * @param address
    * @category query
    */
-  address(address: string) {
-    this.query.address = address;
+  address(address: string | Address) {
+    this.query.address = address.toString();
     return this;
   }
 
@@ -393,4 +399,9 @@ export default class LookupAssetTransactions extends JSONRequest {
     this.query['rekey-to'] = rekeyTo;
     return this;
   }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(response: HTTPClientResponse): TransactionsResponse {
+    return decodeJSON(response.getJSONText(), TransactionsResponse);
+  }
 }

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

@@ -1,8 +1,11 @@
-import JSONRequest from '../jsonrequest';
-import HTTPClient from '../../client';
-import IntDecoding from '../../../types/intDecoding';
+import JSONRequest from '../jsonrequest.js';
+import { HTTPClient, HTTPClientResponse } from '../../client.js';
+import { decodeJSON } from '../../../encoding/encoding.js';
+import { Block } from './models/types.js';
+
+export default class LookupBlock extends JSONRequest<Block> {
+  private round: bigint;
 
-export default class LookupBlock extends JSONRequest {
   /**
    * Returns the block for the passed round.
    *
@@ -16,9 +19,9 @@ export default class LookupBlock extends JSONRequest {
    * @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;
+  constructor(c: HTTPClient, round: number | bigint) {
+    super(c);
+    this.round = BigInt(round);
   }
 
   /**
@@ -36,4 +39,9 @@ export default class LookupBlock extends JSONRequest {
     this.query['header-only'] = headerOnly;
     return this;
   }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(response: HTTPClientResponse): Block {
+    return decodeJSON(response.getJSONText(), Block);
+  }
 }

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

@@ -1,8 +1,9 @@
-import JSONRequest from '../jsonrequest';
-import HTTPClient from '../../client';
-import IntDecoding from '../../../types/intDecoding';
+import JSONRequest from '../jsonrequest.js';
+import { HTTPClient, HTTPClientResponse } from '../../client.js';
+import { decodeJSON } from '../../../encoding/encoding.js';
+import { TransactionResponse } from './models/types.js';
 
-export default class LookupTransactionByID extends JSONRequest {
+export default class LookupTransactionByID extends JSONRequest<TransactionResponse> {
   /**
    * Returns information about the given transaction.
    *
@@ -16,9 +17,11 @@ export default class LookupTransactionByID extends JSONRequest {
    * @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;
+  constructor(
+    c: HTTPClient,
+    private txID: string
+  ) {
+    super(c);
   }
 
   /**
@@ -27,4 +30,9 @@ export default class LookupTransactionByID extends JSONRequest {
   path() {
     return `/v2/transactions/${this.txID}`;
   }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(response: HTTPClientResponse): TransactionResponse {
+    return decodeJSON(response.getJSONText(), TransactionResponse);
+  }
 }

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

@@ -1,4 +1,7 @@
-import JSONRequest from '../jsonrequest';
+import JSONRequest from '../jsonrequest.js';
+import { HTTPClientResponse } from '../../client.js';
+import { decodeJSON } from '../../../encoding/encoding.js';
+import { HealthCheck } from './models/types.js';
 
 /**
  * Returns the health object for the service.
@@ -12,7 +15,7 @@ import JSONRequest from '../jsonrequest';
  * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-health)
  * @category GET
  */
-export default class MakeHealthCheck extends JSONRequest {
+export default class MakeHealthCheck extends JSONRequest<HealthCheck> {
   /**
    * @returns `/health`
    */
@@ -20,4 +23,9 @@ export default class MakeHealthCheck extends JSONRequest {
   path() {
     return '/health';
   }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(response: HTTPClientResponse): HealthCheck {
+    return decodeJSON(response.getJSONText(), HealthCheck);
+  }
 }