algosdk 2.8.0 → 3.0.0-beta.1

package/src/client/v2/algod/compile.ts

@@ -1,12 +1,14 @@
-import { Buffer } from 'buffer';
-import JSONRequest from '../jsonrequest';
-import HTTPClient from '../../client';
+import { coerceToBytes } from '../../../encoding/binarydata.js';
+import { HTTPClient, HTTPClientResponse } from '../../client.js';
+import { decodeJSON } from '../../../encoding/encoding.js';
+import { CompileResponse } from './models/types.js';
+import JSONRequest from '../jsonrequest.js';
 
 /**
  * Sets the default header (if not previously set)
  * @param headers - A headers object
  */
-export function setHeaders(headers = {}) {
+export function setHeaders(headers: Record<string, any> = {}) {
   let hdrs = headers;
   if (Object.keys(hdrs).every((key) => key.toLowerCase() !== 'content-type')) {
     hdrs = { ...headers };
@@ -18,10 +20,12 @@ export function setHeaders(headers = {}) {
 /**
  * Executes compile
  */
-export default class Compile extends JSONRequest {
-  constructor(c: HTTPClient, private source: string | Uint8Array) {
+export default class Compile extends JSONRequest<CompileResponse> {
+  constructor(
+    c: HTTPClient,
+    private source: string | Uint8Array
+  ) {
     super(c);
-    this.source = source;
   }
 
   // eslint-disable-next-line class-methods-use-this
@@ -34,18 +38,22 @@ export default class Compile extends JSONRequest {
     return this;
   }
 
-  /**
-   * Executes compile
-   * @param headers - A headers object
-   */
-  async do(headers = {}) {
+  protected executeRequest(
+    headers?: Record<string, string>,
+    customOptions?: Record<string, unknown>
+  ): Promise<HTTPClientResponse> {
     const txHeaders = setHeaders(headers);
-    const res = await this.c.post(
-      this.path(),
-      Buffer.from(this.source),
-      txHeaders,
-      this.query
-    );
-    return res.body;
+    return this.c.post({
+      relativePath: this.path(),
+      data: coerceToBytes(this.source),
+      query: this.query,
+      requestHeaders: txHeaders,
+      customOptions,
+    });
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(response: HTTPClientResponse): CompileResponse {
+    return decodeJSON(response.getJSONText(), CompileResponse);
   }
 }

package/src/client/v2/algod/disassemble.ts

@@ -1,12 +1,14 @@
-import { Buffer } from 'buffer';
-import JSONRequest from '../jsonrequest';
-import HTTPClient from '../../client';
+import { coerceToBytes } from '../../../encoding/binarydata.js';
+import { HTTPClient, HTTPClientResponse } from '../../client.js';
+import { decodeJSON } from '../../../encoding/encoding.js';
+import { DisassembleResponse } from './models/types.js';
+import JSONRequest from '../jsonrequest.js';
 
 /**
  * Sets the default header (if not previously set)
  * @param headers - A headers object
  */
-export function setHeaders(headers = {}) {
+export function setHeaders(headers: Record<string, any> = {}) {
   let hdrs = headers;
   if (Object.keys(hdrs).every((key) => key.toLowerCase() !== 'content-type')) {
     hdrs = { ...headers };
@@ -18,10 +20,12 @@ export function setHeaders(headers = {}) {
 /**
  * Executes disassemble
  */
-export default class Disassemble extends JSONRequest {
-  constructor(c: HTTPClient, private source: string | Uint8Array) {
+export default class Disassemble extends JSONRequest<DisassembleResponse> {
+  constructor(
+    c: HTTPClient,
+    private source: string | Uint8Array
+  ) {
     super(c);
-    this.source = source;
   }
 
   // eslint-disable-next-line class-methods-use-this
@@ -29,18 +33,22 @@ export default class Disassemble extends JSONRequest {
     return `/v2/teal/disassemble`;
   }
 
-  /**
-   * Executes disassemble
-   * @param headers - A headers object
-   */
-  async do(headers = {}) {
+  protected executeRequest(
+    headers?: Record<string, string>,
+    customOptions?: Record<string, unknown>
+  ): Promise<HTTPClientResponse> {
     const txHeaders = setHeaders(headers);
-    const res = await this.c.post(
-      this.path(),
-      Buffer.from(this.source),
-      txHeaders,
-      this.query
-    );
-    return res.body;
+    return this.c.post({
+      relativePath: this.path(),
+      data: coerceToBytes(this.source),
+      query: this.query,
+      requestHeaders: txHeaders,
+      customOptions,
+    });
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(response: HTTPClientResponse): DisassembleResponse {
+    return decodeJSON(response.getJSONText(), DisassembleResponse);
   }
 }

package/src/client/v2/algod/dryrun.ts

@@ -1,16 +1,16 @@
-import { Buffer } from 'buffer';
-import JSONRequest from '../jsonrequest';
-import HTTPClient from '../../client';
-import * as modelsv2 from './models/types';
-import * as encoding from '../../../encoding/encoding';
-import { setHeaders } from './compile';
+import { HTTPClient, HTTPClientResponse } from '../../client.js';
+import { decodeJSON, encodeMsgpack } from '../../../encoding/encoding.js';
+import JSONRequest from '../jsonrequest.js';
+import { setHeaders } from './compile.js';
+import { DryrunResponse } from './models/types.js';
+import * as modelsv2 from './models/types.js';
 
-export default class Dryrun extends JSONRequest {
+export default class Dryrun extends JSONRequest<DryrunResponse> {
   private blob: Uint8Array;
 
   constructor(c: HTTPClient, dr: modelsv2.DryrunRequest) {
     super(c);
-    this.blob = encoding.encode(dr.get_obj_for_encoding(true));
+    this.blob = encodeMsgpack(dr);
   }
 
   // eslint-disable-next-line class-methods-use-this
@@ -18,17 +18,21 @@ export default class Dryrun extends JSONRequest {
     return '/v2/teal/dryrun';
   }
 
-  /**
-   * Executes dryrun
-   * @param headers - A headers object
-   */
-  async do(headers = {}) {
+  protected executeRequest(
+    headers?: Record<string, string>,
+    customOptions?: Record<string, unknown>
+  ): Promise<HTTPClientResponse> {
     const txHeaders = setHeaders(headers);
-    const res = await this.c.post(
-      this.path(),
-      Buffer.from(this.blob),
-      txHeaders
-    );
-    return res.body;
+    return this.c.post({
+      relativePath: this.path(),
+      data: this.blob,
+      requestHeaders: txHeaders,
+      customOptions,
+    });
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(response: HTTPClientResponse): DryrunResponse {
+    return decodeJSON(response.getJSONText(), DryrunResponse);
   }
 }

package/src/client/v2/algod/genesis.ts

@@ -1,8 +1,14 @@
-import JSONRequest from '../jsonrequest';
+import JSONRequest from '../jsonrequest.js';
+import { HTTPClientResponse } from '../../client.js';
 
-export default class Genesis extends JSONRequest {
+export default class Genesis extends JSONRequest<string> {
   // eslint-disable-next-line class-methods-use-this
   path() {
     return '/genesis';
   }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(response: HTTPClientResponse): string {
+    return response.getJSONText();
+  }
 }

package/src/client/v2/algod/getApplicationBoxByName.ts

@@ -1,8 +1,8 @@
-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';
 
 /**
  * Given an application ID and the box name (key), return the value stored in the box.
@@ -19,20 +19,15 @@ import { Box } from './models/types';
  * @param index - The application ID to look up.
  * @category GET
  */
-export default class GetApplicationBoxByName extends JSONRequest<
-  Box,
-  Record<string, any>
-> {
+export default class GetApplicationBoxByName extends JSONRequest<Box> {
   constructor(
     c: HTTPClient,
-    intDecoding: IntDecoding,
     private index: number,
     name: Uint8Array
   ) {
-    super(c, intDecoding);
-    this.index = index;
+    super(c);
     // Encode name in base64 format and append the encoding prefix.
-    const encodedName = Buffer.from(name).toString('base64');
+    const encodedName = bytesToBase64(name);
     this.query.name = encodeURI(`b64:${encodedName}`);
   }
 
@@ -44,7 +39,7 @@ export default class GetApplicationBoxByName 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/algod/getApplicationBoxes.ts

@@ -1,7 +1,7 @@
-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';
 
 /**
  * Given an application ID, return all the box names associated with the app.
@@ -17,13 +17,12 @@ import { BoxesResponse } from './models/types';
  * @param index - The application ID to look up.
  * @category GET
  */
-export default class GetApplicationBoxes extends JSONRequest<
-  BoxesResponse,
-  Record<string, any>
-> {
-  constructor(c: HTTPClient, intDecoding: IntDecoding, private index: number) {
-    super(c, intDecoding);
-    this.index = index;
+export default class GetApplicationBoxes extends JSONRequest<BoxesResponse> {
+  constructor(
+    c: HTTPClient,
+    private index: number
+  ) {
+    super(c);
     this.query.max = 0;
   }
 
@@ -55,7 +54,7 @@ export default class GetApplicationBoxes 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/algod/getApplicationByID.ts

@@ -1,14 +1,22 @@
-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 { Application } from './models/types.js';
 
-export default class GetApplicationByID extends JSONRequest {
-  constructor(c: HTTPClient, intDecoding: IntDecoding, private index: number) {
-    super(c, intDecoding);
-    this.index = index;
+export default class GetApplicationByID extends JSONRequest<Application> {
+  constructor(
+    c: HTTPClient,
+    private index: number | bigint
+  ) {
+    super(c);
   }
 
   path() {
     return `/v2/applications/${this.index}`;
   }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(response: HTTPClientResponse): Application {
+    return decodeJSON(response.getJSONText(), Application);
+  }
 }

package/src/client/v2/algod/getAssetByID.ts

@@ -1,14 +1,22 @@
-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 { Asset } from './models/types.js';
 
-export default class GetAssetByID extends JSONRequest {
-  constructor(c: HTTPClient, intDecoding: IntDecoding, private index: number) {
-    super(c, intDecoding);
-    this.index = index;
+export default class GetAssetByID extends JSONRequest<Asset> {
+  constructor(
+    c: HTTPClient,
+    private index: number | bigint
+  ) {
+    super(c);
   }
 
   path() {
     return `/v2/assets/${this.index}`;
   }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(response: HTTPClientResponse): Asset {
+    return decodeJSON(response.getJSONText(), Asset);
+  }
 }

package/src/client/v2/algod/getBlockHash.ts

@@ -1,18 +1,22 @@
-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 { BlockHashResponse } from './models/types.js';
 
-export default class GetBlockHash extends JSONRequest {
-  round: number;
+export default class GetBlockHash extends JSONRequest<BlockHashResponse> {
+  round: number | bigint;
 
-  constructor(c: HTTPClient, intDecoding: IntDecoding, roundNumber: number) {
-    super(c, intDecoding);
-    if (!Number.isInteger(roundNumber))
-      throw Error('roundNumber should be an integer');
+  constructor(c: HTTPClient, roundNumber: number) {
+    super(c);
     this.round = roundNumber;
   }
 
   path() {
     return `/v2/blocks/${this.round}/hash`;
   }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(response: HTTPClientResponse): BlockHashResponse {
+    return decodeJSON(response.getJSONText(), BlockHashResponse);
+  }
 }

package/src/client/v2/algod/getBlockOffsetTimestamp.ts

@@ -1,17 +1,16 @@
-import JSONRequest from '../jsonrequest';
-import { GetBlockTimeStampOffsetResponse } from './models/types';
+import JSONRequest from '../jsonrequest.js';
+import { HTTPClientResponse } from '../../client.js';
+import { decodeJSON } from '../../../encoding/encoding.js';
+import { GetBlockTimeStampOffsetResponse } from './models/types.js';
 
-export default class GetBlockOffsetTimestamp extends JSONRequest<
-  GetBlockTimeStampOffsetResponse,
-  Record<string, any>
-> {
+export default class GetBlockOffsetTimestamp extends JSONRequest<GetBlockTimeStampOffsetResponse> {
   // eslint-disable-next-line class-methods-use-this
   path() {
     return `/v2/devmode/blocks/offset`;
   }
 
   // eslint-disable-next-line class-methods-use-this
-  prepare(body: Record<string, any>): GetBlockTimeStampOffsetResponse {
-    return GetBlockTimeStampOffsetResponse.from_obj_for_encoding(body);
+  prepare(response: HTTPClientResponse): GetBlockTimeStampOffsetResponse {
+    return decodeJSON(response.getJSONText(), GetBlockTimeStampOffsetResponse);
   }
 }

package/src/client/v2/algod/getBlockTxids.ts

@@ -1,12 +1,13 @@
-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 { BlockTxidsResponse } from './models/types.js';
 
-export default class GetBlockTxids extends JSONRequest {
+export default class GetBlockTxids extends JSONRequest<BlockTxidsResponse> {
   round: number;
 
-  constructor(c: HTTPClient, intDecoding: IntDecoding, roundNumber: number) {
-    super(c, intDecoding);
+  constructor(c: HTTPClient, roundNumber: number) {
+    super(c);
     if (!Number.isInteger(roundNumber))
       throw Error('roundNumber should be an integer');
     this.round = roundNumber;
@@ -15,4 +16,9 @@ export default class GetBlockTxids extends JSONRequest {
   path() {
     return `/v2/blocks/${this.round}/txids`;
   }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(response: HTTPClientResponse): BlockTxidsResponse {
+    return decodeJSON(response.getJSONText(), BlockTxidsResponse);
+  }
 }

package/src/client/v2/algod/getLedgerStateDelta.ts

@@ -1,16 +1,24 @@
-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 { decodeMsgpack } from '../../../encoding/encoding.js';
+import { LedgerStateDelta } from '../../../types/statedelta.js';
 
-export default class GetLedgerStateDelta extends JSONRequest {
-  constructor(c: HTTPClient, intDecoding: IntDecoding, private round: bigint) {
-    super(c, intDecoding);
-    this.round = round;
-    this.query = { format: 'json' };
+export default class GetLedgerStateDelta extends JSONRequest<LedgerStateDelta> {
+  constructor(
+    c: HTTPClient,
+    private round: number
+  ) {
+    super(c);
+    this.query = { format: 'msgpack' };
   }
 
   // eslint-disable-next-line class-methods-use-this
   path() {
     return `/v2/deltas/${this.round}`;
   }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(response: HTTPClientResponse): LedgerStateDelta {
+    return decodeMsgpack(response.body, LedgerStateDelta);
+  }
 }

package/src/client/v2/algod/getLedgerStateDeltaForTransactionGroup.ts

@@ -1,16 +1,24 @@
-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 { decodeMsgpack } from '../../../encoding/encoding.js';
+import { LedgerStateDelta } from '../../../types/statedelta.js';
 
-export default class GetLedgerStateDeltaForTransactionGroup extends JSONRequest {
-  constructor(c: HTTPClient, intDecoding: IntDecoding, private id: string) {
-    super(c, intDecoding);
-    this.id = id;
-    this.query = { format: 'json' };
+export default class GetLedgerStateDeltaForTransactionGroup extends JSONRequest<LedgerStateDelta> {
+  constructor(
+    c: HTTPClient,
+    private id: string
+  ) {
+    super(c);
+    this.query = { format: 'msgpack' };
   }
 
   // eslint-disable-next-line class-methods-use-this
   path() {
     return `/v2/deltas/txn/group/${this.id}`;
   }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(response: HTTPClientResponse): LedgerStateDelta {
+    return decodeMsgpack(response.body, LedgerStateDelta);
+  }
 }

package/src/client/v2/algod/getSyncRound.ts

@@ -1,17 +1,16 @@
-import JSONRequest from '../jsonrequest';
-import { GetSyncRoundResponse } from './models/types';
+import JSONRequest from '../jsonrequest.js';
+import { HTTPClientResponse } from '../../client.js';
+import { decodeJSON } from '../../../encoding/encoding.js';
+import { GetSyncRoundResponse } from './models/types.js';
 
-export default class GetSyncRound extends JSONRequest<
-  GetSyncRoundResponse,
-  Record<string, any>
-> {
+export default class GetSyncRound extends JSONRequest<GetSyncRoundResponse> {
   // eslint-disable-next-line class-methods-use-this
   path() {
     return `/v2/ledger/sync`;
   }
 
   // eslint-disable-next-line class-methods-use-this
-  prepare(body: Record<string, any>): GetSyncRoundResponse {
-    return GetSyncRoundResponse.from_obj_for_encoding(body);
+  prepare(response: HTTPClientResponse): GetSyncRoundResponse {
+    return decodeJSON(response.getJSONText(), GetSyncRoundResponse);
   }
 }

package/src/client/v2/algod/getTransactionGroupLedgerStateDeltasForRound.ts

@@ -1,16 +1,15 @@
-import JSONRequest from '../jsonrequest';
-import { TransactionGroupLedgerStateDeltasForRoundResponse } from './models/types';
-import HTTPClient from '../../client';
-import IntDecoding from '../../../types/intDecoding';
+import JSONRequest from '../jsonrequest.js';
+import { TransactionGroupLedgerStateDeltasForRoundResponse } from './models/types.js';
+import { HTTPClient, HTTPClientResponse } from '../../client.js';
+import { decodeMsgpack } from '../../../encoding/encoding.js';
 
-export default class GetTransactionGroupLedgerStateDeltasForRound extends JSONRequest<
-  TransactionGroupLedgerStateDeltasForRoundResponse,
-  Record<string, any>
-> {
-  constructor(c: HTTPClient, intDecoding: IntDecoding, private round: bigint) {
-    super(c, intDecoding);
-    this.round = round;
-    this.query = { format: 'json' };
+export default class GetTransactionGroupLedgerStateDeltasForRound extends JSONRequest<TransactionGroupLedgerStateDeltasForRoundResponse> {
+  constructor(
+    c: HTTPClient,
+    private round: number
+  ) {
+    super(c);
+    this.query = { format: 'msgpack' };
   }
 
   // eslint-disable-next-line class-methods-use-this
@@ -20,10 +19,11 @@ export default class GetTransactionGroupLedgerStateDeltasForRound extends JSONRe
 
   // eslint-disable-next-line class-methods-use-this
   prepare(
-    body: Record<string, any>
+    response: HTTPClientResponse
   ): TransactionGroupLedgerStateDeltasForRoundResponse {
-    return TransactionGroupLedgerStateDeltasForRoundResponse.from_obj_for_encoding(
-      body
+    return decodeMsgpack(
+      response.body,
+      TransactionGroupLedgerStateDeltasForRoundResponse
     );
   }
 }

package/src/client/v2/algod/getTransactionProof.ts

@@ -1,18 +1,15 @@
-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 { TransactionProofResponse } from './models/types.js';
 
-export default class GetTransactionProof extends JSONRequest {
+export default class GetTransactionProof extends JSONRequest<TransactionProofResponse> {
   constructor(
     c: HTTPClient,
-    intDecoding: IntDecoding,
     private round: number,
     private txID: string
   ) {
-    super(c, intDecoding);
-
-    this.round = round;
-    this.txID = txID;
+    super(c);
   }
 
   path() {
@@ -40,4 +37,9 @@ export default class GetTransactionProof extends JSONRequest {
     this.query.hashtype = hashType;
     return this;
   }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(response: HTTPClientResponse): TransactionProofResponse {
+    return decodeJSON(response.getJSONText(), TransactionProofResponse);
+  }
 }

package/src/client/v2/algod/healthCheck.ts

@@ -1,19 +1,15 @@
-import JSONRequest from '../jsonrequest';
+import JSONRequest from '../jsonrequest.js';
+import { HTTPClientResponse } from '../../client.js';
 
 /**
  * healthCheck returns an empty object iff the node is running
  */
-export default class HealthCheck extends JSONRequest {
+export default class HealthCheck extends JSONRequest<void> {
   // eslint-disable-next-line class-methods-use-this
   path() {
     return '/health';
   }
 
-  async do(headers = {}) {
-    const res = await this.c.get(this.path(), {}, headers);
-    if (!res.ok) {
-      throw new Error(`Health response: ${res.status}`);
-    }
-    return {};
-  }
+  // eslint-disable-next-line class-methods-use-this, @typescript-eslint/no-unused-vars
+  prepare(_response: HTTPClientResponse): void {}
 }