algosdk 2.8.0 → 3.0.0-beta.1

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

@@ -1,4 +1,8 @@
-import JSONRequest from '../jsonrequest';
+import JSONRequest from '../jsonrequest.js';
+import { HTTPClientResponse } from '../../client.js';
+import { decodeJSON } from '../../../encoding/encoding.js';
+import { Address } from '../../../encoding/address.js';
+import { AccountsResponse } from './models/types.js';
 
 /**
  * Returns information about indexed accounts.
@@ -11,7 +15,7 @@ import JSONRequest from '../jsonrequest';
  * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2accounts)
  * @category GET
  */
-export default class SearchAccounts extends JSONRequest {
+export default class SearchAccounts extends JSONRequest<AccountsResponse> {
   /**
    * @returns `/v2/accounts`
    */
@@ -186,8 +190,8 @@ export default class SearchAccounts extends JSONRequest {
    *
    * @param authAddr
    */
-  authAddr(authAddr: string) {
-    this.query['auth-addr'] = authAddr;
+  authAddr(authAddr: string | Address) {
+    this.query['auth-addr'] = authAddr.toString();
     return this;
   }
 
@@ -266,4 +270,9 @@ export default class SearchAccounts extends JSONRequest {
     this.query.exclude = exclude;
     return this;
   }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(response: HTTPClientResponse): AccountsResponse {
+    return decodeJSON(response.getJSONText(), AccountsResponse);
+  }
 }

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

@@ -1,12 +1,9 @@
-import JSONRequest from '../jsonrequest';
-import HTTPClient from '../../client';
-import IntDecoding from '../../../types/intDecoding';
-import { BoxesResponse } from './models/types';
+import JSONRequest from '../jsonrequest.js';
+import { HTTPClient, HTTPClientResponse } from '../../client.js';
+import { decodeJSON } from '../../../encoding/encoding.js';
+import { BoxesResponse } from './models/types.js';
 
-export default class SearchForApplicationBoxes extends JSONRequest<
-  BoxesResponse,
-  Record<string, any>
-> {
+export default class SearchForApplicationBoxes extends JSONRequest<BoxesResponse> {
   /**
    * Returns information about indexed application boxes.
    *
@@ -33,9 +30,11 @@ export default class SearchForApplicationBoxes extends JSONRequest<
    * @oaram index - application index.
    * @category GET
    */
-  constructor(c: HTTPClient, intDecoding: IntDecoding, private index: number) {
-    super(c, intDecoding);
-    this.index = index;
+  constructor(
+    c: HTTPClient,
+    private index: number
+  ) {
+    super(c);
   }
 
   /**
@@ -95,7 +94,7 @@ export default class SearchForApplicationBoxes extends JSONRequest<
   }
 
   // eslint-disable-next-line class-methods-use-this
-  prepare(body: Record<string, any>): BoxesResponse {
-    return BoxesResponse.from_obj_for_encoding(body);
+  prepare(response: HTTPClientResponse): BoxesResponse {
+    return decodeJSON(response.getJSONText(), BoxesResponse);
   }
 }

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

@@ -1,4 +1,8 @@
-import JSONRequest from '../jsonrequest';
+import JSONRequest from '../jsonrequest.js';
+import { HTTPClientResponse } from '../../client.js';
+import { decodeJSON } from '../../../encoding/encoding.js';
+import { Address } from '../../../encoding/address.js';
+import { ApplicationsResponse } from './models/types.js';
 
 /**
  * Returns information about indexed applications.
@@ -11,7 +15,7 @@ import JSONRequest from '../jsonrequest';
  * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2applications)
  * @category GET
  */
-export default class SearchForApplications extends JSONRequest {
+export default class SearchForApplications extends JSONRequest<ApplicationsResponse> {
   /**
    * @returns `/v2/applications`
    */
@@ -54,8 +58,8 @@ export default class SearchForApplications extends JSONRequest {
    * @param creator
    * @category query
    */
-  creator(creator: string) {
-    this.query.creator = creator;
+  creator(creator: string | Address) {
+    this.query.creator = creator.toString();
     return this;
   }
 
@@ -131,4 +135,9 @@ export default class SearchForApplications extends JSONRequest {
     this.query['include-all'] = value;
     return this;
   }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(response: HTTPClientResponse): ApplicationsResponse {
+    return decodeJSON(response.getJSONText(), ApplicationsResponse);
+  }
 }

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

@@ -1,4 +1,8 @@
-import JSONRequest from '../jsonrequest';
+import JSONRequest from '../jsonrequest.js';
+import { HTTPClientResponse } from '../../client.js';
+import { decodeJSON } from '../../../encoding/encoding.js';
+import { Address } from '../../../encoding/address.js';
+import { AssetsResponse } from './models/types.js';
 
 /**
  * Returns information about indexed assets.
@@ -11,7 +15,7 @@ import JSONRequest from '../jsonrequest';
  * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2assets)
  * @category GET
  */
-export default class SearchForAssets extends JSONRequest {
+export default class SearchForAssets extends JSONRequest<AssetsResponse> {
   /**
    * @returns `/v2/assets`
    */
@@ -55,8 +59,8 @@ export default class SearchForAssets extends JSONRequest {
    * @param creator
    * @category query
    */
-  creator(creator: string) {
-    this.query.creator = creator;
+  creator(creator: string | Address) {
+    this.query.creator = creator.toString();
     return this;
   }
 
@@ -172,4 +176,9 @@ export default class SearchForAssets extends JSONRequest {
     this.query['include-all'] = value;
     return this;
   }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(response: HTTPClientResponse): AssetsResponse {
+    return decodeJSON(response.getJSONText(), AssetsResponse);
+  }
 }

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

@@ -1,5 +1,9 @@
-import JSONRequest from '../jsonrequest';
-import { base64StringFunnel } from './lookupAccountTransactions';
+import JSONRequest from '../jsonrequest.js';
+import { 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';
 
 /**
  * Returns information about indexed transactions.
@@ -12,7 +16,7 @@ import { base64StringFunnel } from './lookupAccountTransactions';
  * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2transactions)
  * @category GET
  */
-export default class SearchForTransactions extends JSONRequest {
+export default class SearchForTransactions extends JSONRequest<TransactionsResponse> {
   /**
    * @returns `/v2/transactions`
    */
@@ -214,11 +218,12 @@ export default class SearchForTransactions 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;
   }
 
@@ -234,11 +239,12 @@ export default class SearchForTransactions 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;
   }
 
@@ -279,8 +285,8 @@ export default class SearchForTransactions extends JSONRequest {
    * @param address
    * @category query
    */
-  address(address: string) {
-    this.query.address = address;
+  address(address: string | Address) {
+    this.query.address = address.toString();
     return this;
   }
 
@@ -431,4 +437,9 @@ export default class SearchForTransactions extends JSONRequest {
     this.query['currency-less-than'] = lesser;
     return this;
   }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(response: HTTPClientResponse): TransactionsResponse {
+    return decodeJSON(response.getJSONText(), TransactionsResponse);
+  }
 }

package/src/client/v2/jsonrequest.ts

@@ -1,5 +1,4 @@
-import HTTPClient from '../client';
-import IntDecoding from '../../types/intDecoding';
+import { HTTPClient, HTTPClientResponse } from '../client.js';
 
 /**
  * Base abstract class for JSON requests.
@@ -8,24 +7,16 @@ import IntDecoding from '../../types/intDecoding';
  *
  * Body: The structure of the response's body
  */
-export default abstract class JSONRequest<
-  Data = Record<string, any>,
-  Body = Data | Uint8Array
-> {
+export default abstract class JSONRequest<Data> {
   c: HTTPClient;
   query: Record<string, any>;
-  intDecoding: IntDecoding;
 
   /**
    * @param client - HTTPClient object.
-   * @param intDecoding - The method to use
-   *   for decoding integers from this request's response. See the setIntDecoding method for more
-   *   details.
    */
-  constructor(client: HTTPClient, intDecoding?: IntDecoding) {
+  constructor(client: HTTPClient) {
     this.c = client;
     this.query = {};
-    this.intDecoding = intDecoding || IntDecoding.DEFAULT;
   }
 
   /**
@@ -37,67 +28,58 @@ export default abstract class JSONRequest<
   /**
    * Prepare a JSON response before returning it.
    *
-   * Use this method to change and restructure response
-   * data as needed after receiving it from the `do()` method.
-   * @param body - Response body received
+   * Use this method to unpack response ata as needed after receiving it from the `do()` method.
+   * @param response - Response body received
    * @category JSONRequest
    */
-  // eslint-disable-next-line class-methods-use-this
-  prepare(body: Body): Data {
-    return (body as unknown) as Data;
+  abstract prepare(response: HTTPClientResponse): Data;
+
+  /**
+   * Execute the request
+   */
+  protected executeRequest(
+    headers?: Record<string, string>,
+    customOptions?: Record<string, unknown>
+  ): Promise<HTTPClientResponse> {
+    return this.c.get({
+      relativePath: this.path(),
+      query: this.query,
+      requestHeaders: headers,
+      customOptions,
+    });
   }
 
   /**
-   * Execute the request.
+   * Execute the request and decode the response.
    * @param headers - Additional headers to send in the request. Optional.
-   * @returns A promise which resolves to the parsed response data.
+   * @param customOptions - Additional options to pass to the underlying BaseHTTPClient. For
+   *   {@link URLTokenBaseHTTPClient}, which is the default client, this will be treated as
+   *   additional options to pass to the network `fetch` method.
+   * @returns A promise which resolves to the parsed response object.
    * @category JSONRequest
    */
-  async do(headers: Record<string, any> = {}): Promise<Data> {
-    const jsonOptions: Record<string, any> = {};
-    if (this.intDecoding !== 'default') {
-      jsonOptions.intDecoding = this.intDecoding;
-    }
-    const res = await this.c.get(this.path(), this.query, headers, jsonOptions);
-    return this.prepare(res.body);
+  async do(
+    headers?: Record<string, string>,
+    customOptions?: Record<string, unknown>
+  ): Promise<Data> {
+    const res = await this.executeRequest(headers, customOptions);
+    return this.prepare(res);
   }
 
   /**
    * Execute the request, but do not process the response data in any way.
    * @param headers - Additional headers to send in the request. Optional.
+   * @param customOptions - Additional options to pass to the underlying BaseHTTPClient. For
+   *   {@link URLTokenBaseHTTPClient}, which is the default client, this will be treated as
+   *   additional options to pass to the network `fetch` method.
    * @returns A promise which resolves to the raw response data, exactly as returned by the server.
    * @category JSONRequest
    */
-  async doRaw(headers: Record<string, any> = {}): Promise<Uint8Array> {
-    const res = await this.c.get(this.path(), this.query, headers, {}, false);
+  async doRaw(
+    headers?: Record<string, string>,
+    customOptions?: Record<string, unknown>
+  ): Promise<Uint8Array> {
+    const res = await this.executeRequest(headers, customOptions);
     return res.body;
   }
-
-  /**
-   * Configure how integers in this request's JSON response will be decoded.
-   *
-   * The options are:
-   * * "default": Integers will be decoded according to JSON.parse, meaning they will all be
-   *   Numbers and any values greater than Number.MAX_SAFE_INTEGER will lose precision.
-   * * "safe": All integers will be decoded as Numbers, but if any values are greater than
-   *   Number.MAX_SAFE_INTEGER an error will be thrown.
-   * * "mixed": Integers will be decoded as Numbers if they are less than or equal to
-   *   Number.MAX_SAFE_INTEGER, otherwise they will be decoded as BigInts.
-   * * "bigint": All integers will be decoded as BigInts.
-   *
-   * @param method - The method to use when parsing the
-   *   response for this request. Must be one of "default", "safe", "mixed", or "bigint".
-   * @category JSONRequest
-   */
-  setIntDecoding(method: IntDecoding) {
-    if (
-      method !== 'default' &&
-      method !== 'safe' &&
-      method !== 'mixed' &&
-      method !== 'bigint'
-    )
-      throw new Error(`Invalid method for int decoding: ${method}`);
-    this.intDecoding = method;
-    return this;
-  }
 }

package/src/client/v2/serviceClient.ts

@@ -1,7 +1,6 @@
-import HTTPClient from '../client';
-import IntDecoding from '../../types/intDecoding';
-import { BaseHTTPClient } from '../baseHTTPClient';
-import { TokenHeader } from '../urlTokenBaseHTTPClient';
+import { HTTPClient } from '../client.js';
+import { BaseHTTPClient } from '../baseHTTPClient.js';
+import { TokenHeader } from '../urlTokenBaseHTTPClient.js';
 
 export type TokenHeaderIdentifier =
   | 'X-Indexer-API-Token'
@@ -15,15 +14,15 @@ export type TokenHeaderIdentifier =
  * @param headerIdentifier - An identifier for the token header
  */
 function convertTokenStringToTokenHeader(
-  token: string = '',
-  headerIdentifier: TokenHeaderIdentifier
+  headerIdentifier: TokenHeaderIdentifier,
+  token: string = ''
 ): TokenHeader {
-  const tokenHeader = {};
+  const tokenHeader: TokenHeader = {};
   if (token === '') {
     return tokenHeader;
   }
   tokenHeader[headerIdentifier] = token;
-  return tokenHeader as TokenHeader;
+  return tokenHeader;
 }
 
 function isBaseHTTPClient(
@@ -38,8 +37,6 @@ function isBaseHTTPClient(
 export default abstract class ServiceClient {
   /** @ignore */
   c: HTTPClient;
-  /** @ignore */
-  intDecoding: IntDecoding;
 
   constructor(
     tokenHeaderIdentifier: TokenHeaderIdentifier,
@@ -57,8 +54,8 @@ export default abstract class ServiceClient {
       let tokenHeader: TokenHeader;
       if (typeof tokenHeaderOrStrOrBaseClient === 'string') {
         tokenHeader = convertTokenStringToTokenHeader(
-          tokenHeaderOrStrOrBaseClient,
-          tokenHeaderIdentifier
+          tokenHeaderIdentifier,
+          tokenHeaderOrStrOrBaseClient
         );
       } else {
         tokenHeader = tokenHeaderOrStrOrBaseClient;
@@ -66,24 +63,5 @@ export default abstract class ServiceClient {
 
       this.c = new HTTPClient(tokenHeader, baseServer, port, defaultHeaders);
     }
-
-    this.intDecoding = IntDecoding.DEFAULT;
-  }
-
-  /**
-   * Set the default int decoding method for all JSON requests this client creates.
-   * @param method - \{"default" | "safe" | "mixed" | "bigint"\} method The method to use when parsing the
-   *   response for request. Must be one of "default", "safe", "mixed", or "bigint". See
-   *   JSONRequest.setIntDecoding for more details about what each method does.
-   */
-  setIntEncoding(method: IntDecoding) {
-    this.intDecoding = method;
-  }
-
-  /**
-   * Get the default int decoding method for all JSON requests this client creates.
-   */
-  getIntEncoding() {
-    return this.intDecoding;
   }
 }

package/src/client/v2/untypedmodel.ts

@@ -0,0 +1,25 @@
+import { Encodable, MsgpackEncodingData } from '../../encoding/encoding.js';
+import { UntypedSchema } from '../../encoding/schema/index.js';
+
+export class UntypedValue implements Encodable {
+  static readonly encodingSchema = new UntypedSchema();
+
+  public readonly data: MsgpackEncodingData;
+
+  constructor(data: MsgpackEncodingData) {
+    this.data = data;
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  public getEncodingSchema(): UntypedSchema {
+    return UntypedValue.encodingSchema;
+  }
+
+  public toEncodingData(): MsgpackEncodingData {
+    return this.data;
+  }
+
+  public static fromEncodingData(data: unknown): UntypedValue {
+    return new UntypedValue(data as MsgpackEncodingData);
+  }
+}