algosdk 2.8.0 → 3.0.0-beta.1

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

@@ -1,29 +1,30 @@
-import ServiceClient from '../serviceClient';
-import MakeHealthCheck from './makeHealthCheck';
-import LookupAssetBalances from './lookupAssetBalances';
-import LookupAssetTransactions from './lookupAssetTransactions';
-import LookupAccountTransactions from './lookupAccountTransactions';
-import LookupBlock from './lookupBlock';
-import LookupTransactionByID from './lookupTransactionByID';
-import LookupAccountByID from './lookupAccountByID';
-import LookupAccountAssets from './lookupAccountAssets';
-import LookupAccountCreatedAssets from './lookupAccountCreatedAssets';
-import LookupAccountAppLocalStates from './lookupAccountAppLocalStates';
-import LookupAccountCreatedApplications from './lookupAccountCreatedApplications';
-import LookupAssetByID from './lookupAssetByID';
-import LookupApplications from './lookupApplications';
-import LookupApplicationLogs from './lookupApplicationLogs';
-import LookupApplicationBoxByIDandName from './lookupApplicationBoxByIDandName';
-import SearchAccounts from './searchAccounts';
-import SearchForTransactions from './searchForTransactions';
-import SearchForAssets from './searchForAssets';
-import SearchForApplications from './searchForApplications';
-import SearchForApplicationBoxes from './searchForApplicationBoxes';
-import { BaseHTTPClient } from '../../baseHTTPClient';
+import ServiceClient from '../serviceClient.js';
+import MakeHealthCheck from './makeHealthCheck.js';
+import LookupAssetBalances from './lookupAssetBalances.js';
+import LookupAssetTransactions from './lookupAssetTransactions.js';
+import LookupAccountTransactions from './lookupAccountTransactions.js';
+import LookupBlock from './lookupBlock.js';
+import LookupTransactionByID from './lookupTransactionByID.js';
+import LookupAccountByID from './lookupAccountByID.js';
+import LookupAccountAssets from './lookupAccountAssets.js';
+import LookupAccountCreatedAssets from './lookupAccountCreatedAssets.js';
+import LookupAccountAppLocalStates from './lookupAccountAppLocalStates.js';
+import LookupAccountCreatedApplications from './lookupAccountCreatedApplications.js';
+import LookupAssetByID from './lookupAssetByID.js';
+import LookupApplications from './lookupApplications.js';
+import LookupApplicationLogs from './lookupApplicationLogs.js';
+import LookupApplicationBoxByIDandName from './lookupApplicationBoxByIDandName.js';
+import SearchAccounts from './searchAccounts.js';
+import SearchForTransactions from './searchForTransactions.js';
+import SearchForAssets from './searchForAssets.js';
+import SearchForApplications from './searchForApplications.js';
+import SearchForApplicationBoxes from './searchForApplicationBoxes.js';
+import { BaseHTTPClient } from '../../baseHTTPClient.js';
 import {
   CustomTokenHeader,
   IndexerTokenHeader,
-} from '../../urlTokenBaseHTTPClient';
+} from '../../urlTokenBaseHTTPClient.js';
+import { Address } from '../../../encoding/address.js';
 
 /**
  * The Indexer provides a REST API interface of API calls to support searching the Algorand Blockchain.
@@ -39,7 +40,7 @@ import {
  *
  * [Run Indexer in Postman OAS3](https://developer.algorand.org/docs/rest-apis/restendpoints/#algod-indexer-and-kmd-rest-endpoints)
  */
-export default class IndexerClient extends ServiceClient {
+export class IndexerClient extends ServiceClient {
   /**
    * Create an IndexerClient from
    * * either a token, baseServer, port, and optional headers
@@ -87,7 +88,7 @@ export default class IndexerClient extends ServiceClient {
    * @category GET
    */
   makeHealthCheck() {
-    return new MakeHealthCheck(this.c, this.intDecoding);
+    return new MakeHealthCheck(this.c);
   }
 
   /**
@@ -104,7 +105,7 @@ export default class IndexerClient extends ServiceClient {
    * @category GET
    */
   lookupAssetBalances(index: number) {
-    return new LookupAssetBalances(this.c, this.intDecoding, index);
+    return new LookupAssetBalances(this.c, index);
   }
 
   /**
@@ -121,7 +122,7 @@ export default class IndexerClient extends ServiceClient {
    * @category GET
    */
   lookupAssetTransactions(index: number) {
-    return new LookupAssetTransactions(this.c, this.intDecoding, index);
+    return new LookupAssetTransactions(this.c, index);
   }
 
   /**
@@ -137,8 +138,8 @@ export default class IndexerClient extends ServiceClient {
    * @param account - The address of the account.
    * @category GET
    */
-  lookupAccountTransactions(account: string) {
-    return new LookupAccountTransactions(this.c, this.intDecoding, account);
+  lookupAccountTransactions(account: string | Address) {
+    return new LookupAccountTransactions(this.c, account);
   }
 
   /**
@@ -155,7 +156,7 @@ export default class IndexerClient extends ServiceClient {
    * @category GET
    */
   lookupBlock(round: number) {
-    return new LookupBlock(this.c, this.intDecoding, round);
+    return new LookupBlock(this.c, round);
   }
 
   /**
@@ -172,7 +173,7 @@ export default class IndexerClient extends ServiceClient {
    * @category GET
    */
   lookupTransactionByID(txID: string) {
-    return new LookupTransactionByID(this.c, this.intDecoding, txID);
+    return new LookupTransactionByID(this.c, txID);
   }
 
   /**
@@ -188,8 +189,8 @@ export default class IndexerClient extends ServiceClient {
    * @param account - The address of the account to look up.
    * @category GET
    */
-  lookupAccountByID(account: string) {
-    return new LookupAccountByID(this.c, this.intDecoding, account);
+  lookupAccountByID(account: string | Address) {
+    return new LookupAccountByID(this.c, account);
   }
 
   /**
@@ -205,8 +206,8 @@ export default class IndexerClient extends ServiceClient {
    * @param account - The address of the account to look up.
    * @category GET
    */
-  lookupAccountAssets(account: string) {
-    return new LookupAccountAssets(this.c, this.intDecoding, account);
+  lookupAccountAssets(account: string | Address) {
+    return new LookupAccountAssets(this.c, account);
   }
 
   /**
@@ -222,8 +223,8 @@ export default class IndexerClient extends ServiceClient {
    * @param account - The address of the account to look up.
    * @category GET
    */
-  lookupAccountCreatedAssets(account: string) {
-    return new LookupAccountCreatedAssets(this.c, this.intDecoding, account);
+  lookupAccountCreatedAssets(account: string | Address) {
+    return new LookupAccountCreatedAssets(this.c, account);
   }
 
   /**
@@ -239,8 +240,8 @@ export default class IndexerClient extends ServiceClient {
    * @param account - The address of the account to look up.
    * @category GET
    */
-  lookupAccountAppLocalStates(account: string) {
-    return new LookupAccountAppLocalStates(this.c, this.intDecoding, account);
+  lookupAccountAppLocalStates(account: string | Address) {
+    return new LookupAccountAppLocalStates(this.c, account);
   }
 
   /**
@@ -256,12 +257,8 @@ export default class IndexerClient extends ServiceClient {
    * @param account - The address of the account to look up.
    * @category GET
    */
-  lookupAccountCreatedApplications(account: string) {
-    return new LookupAccountCreatedApplications(
-      this.c,
-      this.intDecoding,
-      account
-    );
+  lookupAccountCreatedApplications(account: string | Address) {
+    return new LookupAccountCreatedApplications(this.c, account);
   }
 
   /**
@@ -278,7 +275,7 @@ export default class IndexerClient extends ServiceClient {
    * @category GET
    */
   lookupAssetByID(index: number) {
-    return new LookupAssetByID(this.c, this.intDecoding, index);
+    return new LookupAssetByID(this.c, index);
   }
 
   /**
@@ -295,7 +292,7 @@ export default class IndexerClient extends ServiceClient {
    * @category GET
    */
   lookupApplications(index: number) {
-    return new LookupApplications(this.c, this.intDecoding, index);
+    return new LookupApplications(this.c, index);
   }
 
   /**
@@ -312,7 +309,7 @@ export default class IndexerClient extends ServiceClient {
    * @category GET
    */
   lookupApplicationLogs(appID: number) {
-    return new LookupApplicationLogs(this.c, this.intDecoding, appID);
+    return new LookupApplicationLogs(this.c, appID);
   }
 
   /**
@@ -327,7 +324,7 @@ export default class IndexerClient extends ServiceClient {
    * @category GET
    */
   searchAccounts() {
-    return new SearchAccounts(this.c, this.intDecoding);
+    return new SearchAccounts(this.c);
   }
 
   /**
@@ -342,7 +339,7 @@ export default class IndexerClient extends ServiceClient {
    * @category GET
    */
   searchForTransactions() {
-    return new SearchForTransactions(this.c, this.intDecoding);
+    return new SearchForTransactions(this.c);
   }
 
   /**
@@ -357,7 +354,7 @@ export default class IndexerClient extends ServiceClient {
    * @category GET
    */
   searchForAssets() {
-    return new SearchForAssets(this.c, this.intDecoding);
+    return new SearchForAssets(this.c);
   }
 
   /**
@@ -372,7 +369,7 @@ export default class IndexerClient extends ServiceClient {
    * @category GET
    */
   searchForApplications() {
-    return new SearchForApplications(this.c, this.intDecoding);
+    return new SearchForApplications(this.c);
   }
 
   /**
@@ -402,7 +399,7 @@ export default class IndexerClient extends ServiceClient {
    * @category GET
    */
   searchForApplicationBoxes(appID: number) {
-    return new SearchForApplicationBoxes(this.c, this.intDecoding, appID);
+    return new SearchForApplicationBoxes(this.c, appID);
   }
 
   /**
@@ -422,11 +419,6 @@ export default class IndexerClient extends ServiceClient {
    * @category GET
    */
   lookupApplicationBoxByIDandName(appID: number, boxName: Uint8Array) {
-    return new LookupApplicationBoxByIDandName(
-      this.c,
-      this.intDecoding,
-      appID,
-      boxName
-    );
+    return new LookupApplicationBoxByIDandName(this.c, appID, boxName);
   }
 }

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

@@ -1,8 +1,12 @@
-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 { Address } from '../../../encoding/address.js';
+import { ApplicationLocalStatesResponse } from './models/types.js';
+
+export default class LookupAccountAppLocalStates extends JSONRequest<ApplicationLocalStatesResponse> {
+  private account: string | Address;
 
-export default class LookupAccountAppLocalStates extends JSONRequest {
   /**
    * Returns application local state about the given account.
    *
@@ -16,13 +20,9 @@ export default class LookupAccountAppLocalStates extends JSONRequest {
    * @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;
+  constructor(c: HTTPClient, account: string | Address) {
+    super(c);
+    this.account = account.toString();
   }
 
   /**
@@ -137,4 +137,9 @@ export default class LookupAccountAppLocalStates extends JSONRequest {
     this.query['application-id'] = index;
     return this;
   }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(response: HTTPClientResponse): ApplicationLocalStatesResponse {
+    return decodeJSON(response.getJSONText(), ApplicationLocalStatesResponse);
+  }
 }

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

@@ -1,8 +1,12 @@
-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 { Address } from '../../../encoding/address.js';
+import { AssetHoldingsResponse } from './models/types.js';
+
+export default class LookupAccountAssets extends JSONRequest<AssetHoldingsResponse> {
+  private account: string;
 
-export default class LookupAccountAssets extends JSONRequest {
   /**
    * Returns asset about the given account.
    *
@@ -16,13 +20,9 @@ export default class LookupAccountAssets extends JSONRequest {
    * @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;
+  constructor(c: HTTPClient, account: string | Address) {
+    super(c);
+    this.account = account.toString();
   }
 
   /**
@@ -138,4 +138,9 @@ export default class LookupAccountAssets extends JSONRequest {
     this.query['asset-id'] = index;
     return this;
   }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(response: HTTPClientResponse): AssetHoldingsResponse {
+    return decodeJSON(response.getJSONText(), AssetHoldingsResponse);
+  }
 }

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

@@ -1,8 +1,12 @@
-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 { Address } from '../../../encoding/address.js';
+import { AccountResponse } from './models/types.js';
+
+export default class LookupAccountByID extends JSONRequest<AccountResponse> {
+  private account: string;
 
-export default class LookupAccountByID extends JSONRequest {
   /**
    * Returns information about the given account.
    *
@@ -16,13 +20,9 @@ export default class LookupAccountByID extends JSONRequest {
    * @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;
+  constructor(c: HTTPClient, account: string | Address) {
+    super(c);
+    this.account = account.toString();
   }
 
   /**
@@ -106,4 +106,9 @@ export default class LookupAccountByID extends JSONRequest {
     this.query.exclude = exclude;
     return this;
   }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(response: HTTPClientResponse): AccountResponse {
+    return decodeJSON(response.getJSONText(), AccountResponse);
+  }
 }

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

@@ -1,8 +1,12 @@
-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 { Address } from '../../../encoding/address.js';
+import { ApplicationsResponse } from './models/types.js';
+
+export default class LookupAccountCreatedApplications extends JSONRequest<ApplicationsResponse> {
+  private account: string;
 
-export default class LookupAccountCreatedApplications extends JSONRequest {
   /**
    * Returns application information created by the given account.
    *
@@ -16,13 +20,9 @@ export default class LookupAccountCreatedApplications extends JSONRequest {
    * @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;
+  constructor(c: HTTPClient, account: string | Address) {
+    super(c);
+    this.account = account.toString();
   }
 
   /**
@@ -138,4 +138,9 @@ export default class LookupAccountCreatedApplications extends JSONRequest {
     this.query['application-id'] = index;
     return this;
   }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(response: HTTPClientResponse): ApplicationsResponse {
+    return decodeJSON(response.getJSONText(), ApplicationsResponse);
+  }
 }

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

@@ -1,8 +1,12 @@
-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 { Address } from '../../../encoding/address.js';
+import { AssetsResponse } from './models/types.js';
+
+export default class LookupAccountCreatedAssets extends JSONRequest<AssetsResponse> {
+  private account: string;
 
-export default class LookupAccountCreatedAssets extends JSONRequest {
   /**
    * Returns asset information created by the given account.
    *
@@ -16,13 +20,9 @@ export default class LookupAccountCreatedAssets extends JSONRequest {
    * @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;
+  constructor(c: HTTPClient, account: string | Address) {
+    super(c);
+    this.account = account.toString();
   }
 
   /**
@@ -139,4 +139,9 @@ export default class LookupAccountCreatedAssets extends JSONRequest {
     this.query['asset-id'] = index;
     return this;
   }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(response: HTTPClientResponse): AssetsResponse {
+    return decodeJSON(response.getJSONText(), AssetsResponse);
+  }
 }

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();
   }
 
   /**
@@ -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;
   }
 
@@ -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,10 @@
-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,
-  Record<string, any>
-> {
+export default class LookupApplicationBoxByIDandName extends JSONRequest<Box> {
   /**
    * Returns information about indexed application boxes.
    *
@@ -26,14 +23,12 @@ export default class LookupApplicationBoxByIDandName extends JSONRequest<
    */
   constructor(
     c: HTTPClient,
-    intDecoding: IntDecoding,
     private index: number,
     boxName: Uint8Array
   ) {
-    super(c, intDecoding);
-    this.index = index;
+    super(c);
     // 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 +40,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,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 { ApplicationLogsResponse } from './models/types.js';
 
-export default class LookupApplicationLogs extends JSONRequest {
+export default class LookupApplicationLogs extends JSONRequest<ApplicationLogsResponse> {
   /**
    * Returns log messages generated by the passed in application.
    *
@@ -16,9 +17,11 @@ 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,
+    private appID: number
+  ) {
+    super(c);
   }
 
   /**
@@ -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);
+  }
 }