algosdk 2.9.0 → 3.0.0-beta.1

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

@@ -1,23 +1,23 @@
-import JSONRequest from '../jsonrequest';
-import HTTPClient from '../../client';
-import * as encoding from '../../../encoding/encoding';
+import JSONRequest from '../jsonrequest.js';
+import { HTTPClient, HTTPClientResponse } from '../../client.js';
+import { decodeMsgpack } from '../../../encoding/encoding.js';
+import { PendingTransactionResponse } from './models/types.js';
 
 /**
  * returns the transaction information for a specific txid of a pending transaction
  */
-export default class PendingTransactionInformation extends JSONRequest {
-  constructor(c: HTTPClient, private txid: string) {
+export default class PendingTransactionInformation extends JSONRequest<PendingTransactionResponse> {
+  constructor(
+    c: HTTPClient,
+    private txid: string
+  ) {
     super(c);
-    this.txid = txid;
     this.query.format = 'msgpack';
   }
 
   // eslint-disable-next-line class-methods-use-this
-  prepare(body: Uint8Array) {
-    if (body && body.byteLength > 0) {
-      return encoding.decode(body) as Record<string, any>;
-    }
-    return undefined;
+  prepare(response: HTTPClientResponse): PendingTransactionResponse {
+    return decodeMsgpack(response.body, PendingTransactionResponse);
   }
 
   path() {

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

@@ -1,11 +1,12 @@
-import JSONRequest from '../jsonrequest';
-import HTTPClient from '../../client';
-import * as encoding from '../../../encoding/encoding';
+import JSONRequest from '../jsonrequest.js';
+import { HTTPClient, HTTPClientResponse } from '../../client.js';
+import { decodeMsgpack } from '../../../encoding/encoding.js';
+import { PendingTransactionsResponse } from './models/types.js';
 
 /**
  * pendingTransactionsInformation returns transactions that are pending in the pool
  */
-export default class PendingTransactions extends JSONRequest {
+export default class PendingTransactions extends JSONRequest<PendingTransactionsResponse> {
   constructor(c: HTTPClient) {
     super(c);
     this.query.format = 'msgpack';
@@ -16,11 +17,8 @@ export default class PendingTransactions extends JSONRequest {
     return '/v2/transactions/pending';
   }
 
-  prepare(body: Uint8Array) {
-    if (body && body.byteLength > 0) {
-      return encoding.decode(body) as Record<string, any>;
-    }
-    return undefined;
+  prepare(response: HTTPClientResponse): PendingTransactionsResponse {
+    return decodeMsgpack(response.body, PendingTransactionsResponse);
   }
   /* eslint-enable class-methods-use-this */
 

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

@@ -1,23 +1,24 @@
-import JSONRequest from '../jsonrequest';
-import HTTPClient from '../../client';
-import * as encoding from '../../../encoding/encoding';
+import JSONRequest from '../jsonrequest.js';
+import { HTTPClient, HTTPClientResponse } from '../../client.js';
+import { decodeMsgpack } from '../../../encoding/encoding.js';
+import { PendingTransactionsResponse } from './models/types.js';
+import { Address } from '../../../encoding/address.js';
 
 /**
  * returns all transactions for a PK [addr] in the [first, last] rounds range.
  */
-export default class PendingTransactionsByAddress extends JSONRequest {
-  constructor(c: HTTPClient, private address: string) {
+export default class PendingTransactionsByAddress extends JSONRequest<PendingTransactionsResponse> {
+  private address: string;
+
+  constructor(c: HTTPClient, address: string | Address) {
     super(c);
-    this.address = address;
+    this.address = address.toString();
     this.query.format = 'msgpack';
   }
 
   // eslint-disable-next-line class-methods-use-this
-  prepare(body: Uint8Array): Record<string, any> {
-    if (body && body.byteLength > 0) {
-      return encoding.decode(body) as Record<string, any>;
-    }
-    return undefined;
+  prepare(response: HTTPClientResponse): PendingTransactionsResponse {
+    return decodeMsgpack(response.body, PendingTransactionsResponse);
   }
 
   path() {

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

@@ -1,8 +1,12 @@
-import JSONRequest from '../jsonrequest';
+import JSONRequest from '../jsonrequest.js';
+import { HTTPClientResponse } from '../../client.js';
 
-export default class Ready extends JSONRequest {
+export default class Ready extends JSONRequest<void> {
   // eslint-disable-next-line class-methods-use-this
   path() {
     return `/ready`;
   }
+
+  // eslint-disable-next-line class-methods-use-this, @typescript-eslint/no-unused-vars
+  prepare(_response: HTTPClientResponse): void {}
 }

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

@@ -1,14 +1,17 @@
-import { Buffer } from 'buffer';
-import JSONRequest from '../jsonrequest';
-import HTTPClient from '../../client';
-import { concatArrays } from '../../../utils/utils';
+import { concatArrays } from '../../../utils/utils.js';
+import { PostTransactionsResponse } from './models/types.js';
+import { HTTPClient, HTTPClientResponse } from '../../client.js';
+import { decodeJSON } from '../../../encoding/encoding.js';
+import JSONRequest from '../jsonrequest.js';
 
 /**
  * Sets the default header (if not previously set) for sending a raw
  * transaction.
  * @param headers - A headers object
  */
-export function setSendTransactionHeaders(headers = {}) {
+export function setSendTransactionHeaders(
+  headers: Record<string, string> = {}
+) {
   let hdrs = headers;
   if (Object.keys(hdrs).every((key) => key.toLowerCase() !== 'content-type')) {
     hdrs = { ...headers };
@@ -24,7 +27,7 @@ function isByteArray(array: any): array is Uint8Array {
 /**
  * broadcasts the passed signed txns to the network
  */
-export default class SendRawTransaction extends JSONRequest {
+export default class SendRawTransaction extends JSONRequest<PostTransactionsResponse> {
   private txnBytesToPost: Uint8Array;
 
   constructor(c: HTTPClient, stxOrStxs: Uint8Array | Uint8Array[]) {
@@ -48,13 +51,21 @@ export default class SendRawTransaction extends JSONRequest {
     return '/v2/transactions';
   }
 
-  async do(headers = {}) {
+  protected executeRequest(
+    headers?: Record<string, string>,
+    customOptions?: Record<string, unknown>
+  ): Promise<HTTPClientResponse> {
     const txHeaders = setSendTransactionHeaders(headers);
-    const res = await this.c.post(
-      this.path(),
-      Buffer.from(this.txnBytesToPost),
-      txHeaders
-    );
-    return res.body;
+    return this.c.post({
+      relativePath: this.path(),
+      data: this.txnBytesToPost,
+      requestHeaders: txHeaders,
+      customOptions,
+    });
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(response: HTTPClientResponse): PostTransactionsResponse {
+    return decodeJSON(response.getJSONText(), PostTransactionsResponse);
   }
 }

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

@@ -1,20 +1,30 @@
-import JSONRequest from '../jsonrequest';
-import HTTPClient from '../../client';
-import IntDecoding from '../../../types/intDecoding';
+import JSONRequest from '../jsonrequest.js';
+import { HTTPClient, HTTPClientResponse } from '../../client.js';
 
-export default class SetBlockOffsetTimestamp extends JSONRequest {
-  constructor(c: HTTPClient, intDecoding: IntDecoding, private offset: number) {
-    super(c, intDecoding);
-
-    this.offset = offset;
+export default class SetBlockOffsetTimestamp extends JSONRequest<void> {
+  constructor(
+    c: HTTPClient,
+    private offset: number
+  ) {
+    super(c);
   }
 
   path() {
     return `/v2/devmode/blocks/offset/${this.offset}`;
   }
 
-  async do(headers = {}) {
-    const res = await this.c.post(this.path(), headers);
-    return res.body;
+  protected executeRequest(
+    headers?: Record<string, string>,
+    customOptions?: Record<string, unknown>
+  ): Promise<HTTPClientResponse> {
+    return this.c.post({
+      relativePath: this.path(),
+      data: null,
+      requestHeaders: headers,
+      customOptions,
+    });
   }
+
+  // eslint-disable-next-line class-methods-use-this, @typescript-eslint/no-unused-vars
+  prepare(_response: HTTPClientResponse): void {}
 }

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

@@ -1,20 +1,30 @@
-import JSONRequest from '../jsonrequest';
-import HTTPClient from '../../client';
-import IntDecoding from '../../../types/intDecoding';
+import JSONRequest from '../jsonrequest.js';
+import { HTTPClient, HTTPClientResponse } from '../../client.js';
 
-export default class SetSyncRound extends JSONRequest {
-  constructor(c: HTTPClient, intDecoding: IntDecoding, private round: number) {
-    super(c, intDecoding);
-
-    this.round = round;
+export default class SetSyncRound extends JSONRequest<void> {
+  constructor(
+    c: HTTPClient,
+    private round: number
+  ) {
+    super(c);
   }
 
   path() {
     return `/v2/ledger/sync/${this.round}`;
   }
 
-  async do(headers = {}) {
-    const res = await this.c.post(this.path(), headers);
-    return res.body;
+  protected executeRequest(
+    headers?: Record<string, string>,
+    customOptions?: Record<string, unknown>
+  ): Promise<HTTPClientResponse> {
+    return this.c.post({
+      relativePath: this.path(),
+      data: null,
+      requestHeaders: headers,
+      customOptions,
+    });
   }
+
+  // eslint-disable-next-line class-methods-use-this, @typescript-eslint/no-unused-vars
+  prepare(_response: HTTPClientResponse): void {}
 }

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

@@ -1,15 +1,16 @@
-import { Buffer } from 'buffer';
-import * as encoding from '../../../encoding/encoding';
-import HTTPClient from '../../client';
-import JSONRequest from '../jsonrequest';
-import { SimulateRequest, SimulateResponse } from './models/types';
+import { HTTPClient, HTTPClientResponse } from '../../client.js';
+import { encodeMsgpack, decodeMsgpack } from '../../../encoding/encoding.js';
+import JSONRequest from '../jsonrequest.js';
+import { SimulateRequest, SimulateResponse } from './models/types.js';
 
 /**
  * Sets the default header (if not previously set) for simulating a raw
  * transaction.
  * @param headers - A headers object
  */
-export function setSimulateTransactionsHeaders(headers = {}) {
+export function setSimulateTransactionsHeaders(
+  headers: Record<string, any> = {}
+) {
   let hdrs = headers;
   if (Object.keys(hdrs).every((key) => key.toLowerCase() !== 'content-type')) {
     hdrs = { ...headers };
@@ -21,16 +22,13 @@ export function setSimulateTransactionsHeaders(headers = {}) {
 /**
  * Simulates signed txns.
  */
-export default class SimulateRawTransactions extends JSONRequest<
-  SimulateResponse,
-  Uint8Array
-> {
+export default class SimulateRawTransactions extends JSONRequest<SimulateResponse> {
   private requestBytes: Uint8Array;
 
   constructor(c: HTTPClient, request: SimulateRequest) {
     super(c);
     this.query.format = 'msgpack';
-    this.requestBytes = encoding.rawEncode(request.get_obj_for_encoding(true));
+    this.requestBytes = encodeMsgpack(request);
   }
 
   // eslint-disable-next-line class-methods-use-this
@@ -38,21 +36,22 @@ export default class SimulateRawTransactions extends JSONRequest<
     return '/v2/transactions/simulate';
   }
 
-  async do(headers = {}) {
+  protected executeRequest(
+    headers?: Record<string, string>,
+    customOptions?: Record<string, unknown>
+  ): Promise<HTTPClientResponse> {
     const txHeaders = setSimulateTransactionsHeaders(headers);
-    const res = await this.c.post(
-      this.path(),
-      Buffer.from(this.requestBytes),
-      txHeaders,
-      this.query,
-      false
-    );
-    return this.prepare(res.body);
+    return this.c.post({
+      relativePath: this.path(),
+      data: this.requestBytes,
+      query: this.query,
+      requestHeaders: txHeaders,
+      customOptions,
+    });
   }
 
   // eslint-disable-next-line class-methods-use-this
-  prepare(body: Uint8Array): SimulateResponse {
-    const decoded = encoding.decode(body);
-    return SimulateResponse.from_obj_for_encoding(decoded);
+  prepare(response: HTTPClientResponse): SimulateResponse {
+    return decodeMsgpack(response.body, SimulateResponse);
   }
 }

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

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

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

@@ -1,8 +1,16 @@
-import JSONRequest from '../jsonrequest';
+import JSONRequest from '../jsonrequest.js';
+import { HTTPClientResponse } from '../../client.js';
+import { decodeJSON } from '../../../encoding/encoding.js';
+import { NodeStatusResponse } from './models/types.js';
 
-export default class Status extends JSONRequest {
+export default class Status extends JSONRequest<NodeStatusResponse> {
   // eslint-disable-next-line class-methods-use-this
   path() {
     return '/v2/status';
   }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(response: HTTPClientResponse): NodeStatusResponse {
+    return decodeJSON(response.getJSONText(), NodeStatusResponse);
+  }
 }

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

@@ -1,15 +1,23 @@
-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 { NodeStatusResponse } from './models/types.js';
 
-export default class StatusAfterBlock extends JSONRequest {
-  constructor(c: HTTPClient, intDecoding: IntDecoding, private round: number) {
-    super(c, intDecoding);
+export default class StatusAfterBlock extends JSONRequest<NodeStatusResponse> {
+  constructor(
+    c: HTTPClient,
+    private round: number
+  ) {
+    super(c);
     if (!Number.isInteger(round)) throw Error('round should be an integer');
-    this.round = round;
   }
 
   path() {
     return `/v2/status/wait-for-block-after/${this.round}`;
   }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(response: HTTPClientResponse): NodeStatusResponse {
+    return decodeJSON(response.getJSONText(), NodeStatusResponse);
+  }
 }

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

@@ -1,24 +1,54 @@
-import JSONRequest from '../jsonrequest';
-import { SuggestedParamsWithMinFee } from '../../../types/transactions/base';
+import JSONRequest from '../jsonrequest.js';
+import { HTTPClientResponse } from '../../client.js';
+import { decodeJSON } from '../../../encoding/encoding.js';
+import { TransactionParametersResponse } from './models/types.js';
+import { SuggestedParams } from '../../../types/transactions/base.js';
+
+/**
+ * SuggestedParamsFromAlgod contains the suggested parameters for a new transaction, as returned by
+ * the algod REST API.
+ *
+ * This exists because the SuggestedParams interface is purposefully general (e.g. fee can be a
+ * number or a bigint), and compared to that the algod API returns a narrower type.
+ */
+export interface SuggestedParamsFromAlgod extends SuggestedParams {
+  flatFee: boolean;
+  fee: bigint;
+  minFee: bigint;
+  firstValid: bigint;
+  lastValid: bigint;
+  genesisID: string;
+  genesisHash: Uint8Array;
+
+  /**
+   * ConsensusVersion indicates the consensus protocol version as of the last round.
+   */
+  consensusVersion: string;
+}
 
 /**
  * Returns the common needed parameters for a new transaction, in a format the transaction builder expects
  */
-export default class SuggestedParamsRequest extends JSONRequest<SuggestedParamsWithMinFee> {
+export default class SuggestedParamsRequest extends JSONRequest<SuggestedParamsFromAlgod> {
   /* eslint-disable class-methods-use-this */
   path() {
     return '/v2/transactions/params';
   }
 
-  prepare(body: Record<string, any>): SuggestedParamsWithMinFee {
+  prepare(response: HTTPClientResponse): SuggestedParamsFromAlgod {
+    const params = decodeJSON(
+      response.getJSONText(),
+      TransactionParametersResponse
+    );
     return {
       flatFee: false,
-      fee: body.fee,
-      firstRound: body['last-round'],
-      lastRound: body['last-round'] + 1000,
-      genesisID: body['genesis-id'],
-      genesisHash: body['genesis-hash'],
-      minFee: body['min-fee'],
+      fee: params.fee,
+      firstValid: params.lastRound,
+      lastValid: params.lastRound + BigInt(1000),
+      genesisID: params.genesisId,
+      genesisHash: params.genesisHash,
+      minFee: params.minFee,
+      consensusVersion: params.consensusVersion,
     };
   }
   /* eslint-enable class-methods-use-this */

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

@@ -1,8 +1,16 @@
-import JSONRequest from '../jsonrequest';
+import JSONRequest from '../jsonrequest.js';
+import { HTTPClientResponse } from '../../client.js';
+import { decodeJSON } from '../../../encoding/encoding.js';
+import { SupplyResponse } from './models/types.js';
 
-export default class Supply extends JSONRequest {
+export default class Supply extends JSONRequest<SupplyResponse> {
   // eslint-disable-next-line class-methods-use-this
   path() {
     return '/v2/ledger/supply';
   }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(response: HTTPClientResponse): SupplyResponse {
+    return decodeJSON(response.getJSONText(), SupplyResponse);
+  }
 }

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

@@ -1,13 +1,24 @@
-import JSONRequest from '../jsonrequest';
+import JSONRequest from '../jsonrequest.js';
+import { HTTPClientResponse } from '../../client.js';
 
-export default class UnsetSyncRound extends JSONRequest {
+export default class UnsetSyncRound extends JSONRequest<void> {
   // eslint-disable-next-line class-methods-use-this
   path() {
     return `/v2/ledger/sync`;
   }
 
-  async do(headers = {}) {
-    const res = await this.c.delete(this.path(), headers);
-    return res.body;
+  protected executeRequest(
+    headers?: Record<string, string>,
+    customOptions?: Record<string, unknown>
+  ): Promise<HTTPClientResponse> {
+    return this.c.delete({
+      relativePath: this.path(),
+      data: undefined,
+      requestHeaders: headers,
+      customOptions,
+    });
   }
+
+  // eslint-disable-next-line class-methods-use-this, @typescript-eslint/no-unused-vars
+  prepare(_response: HTTPClientResponse): void {}
 }

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

@@ -1,11 +1,19 @@
-import JSONRequest from '../jsonrequest';
+import JSONRequest from '../jsonrequest.js';
+import { HTTPClientResponse } from '../../client.js';
+import { decodeJSON } from '../../../encoding/encoding.js';
+import { Version } from './models/types.js';
 
 /**
  * retrieves the VersionResponse from the running node
  */
-export default class Versions extends JSONRequest {
+export default class Versions extends JSONRequest<Version> {
   // eslint-disable-next-line class-methods-use-this
   path() {
     return '/versions';
   }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(response: HTTPClientResponse): Version {
+    return decodeJSON(response.getJSONText(), Version);
+  }
 }

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

@@ -0,0 +1,3 @@
+// Indexer
+export { IndexerClient } from './indexer.js';
+export * from './models/types.js';