algosdk 2.2.0 → 2.3.0

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

@@ -0,0 +1,8 @@
+import JSONRequest from '../jsonrequest';
+
+export default class Ready extends JSONRequest {
+  // eslint-disable-next-line class-methods-use-this
+  path() {
+    return `/ready`;
+  }
+}

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

@@ -0,0 +1,20 @@
+import JSONRequest from '../jsonrequest';
+import HTTPClient from '../../client';
+import IntDecoding from '../../../types/intDecoding';
+
+export default class SetBlockOffsetTimestamp extends JSONRequest {
+  constructor(c: HTTPClient, intDecoding: IntDecoding, private offset: number) {
+    super(c, intDecoding);
+
+    this.offset = offset;
+  }
+
+  path() {
+    return `/v2/devmode/blocks/offset/${this.offset}`;
+  }
+
+  async do(headers = {}) {
+    const res = await this.c.post(this.path(), headers);
+    return res.body;
+  }
+}

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

@@ -0,0 +1,20 @@
+import JSONRequest from '../jsonrequest';
+import HTTPClient from '../../client';
+import IntDecoding from '../../../types/intDecoding';
+
+export default class SetSyncRound extends JSONRequest {
+  constructor(c: HTTPClient, intDecoding: IntDecoding, private round: number) {
+    super(c, intDecoding);
+
+    this.round = round;
+  }
+
+  path() {
+    return `/v2/ledger/sync/${this.round}`;
+  }
+
+  async do(headers = {}) {
+    const res = await this.c.post(this.path(), headers);
+    return res.body;
+  }
+}

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

@@ -1,9 +1,8 @@
 import { Buffer } from 'buffer';
 import * as encoding from '../../../encoding/encoding';
-import { concatArrays } from '../../../utils/utils';
 import HTTPClient from '../../client';
 import JSONRequest from '../jsonrequest';
-import { SimulateResponse } from './models/types';
+import { SimulateRequest, SimulateResponse } from './models/types';
 
 /**
  * Sets the default header (if not previously set) for simulating a raw
@@ -14,15 +13,11 @@ export function setSimulateTransactionsHeaders(headers = {}) {
   let hdrs = headers;
   if (Object.keys(hdrs).every((key) => key.toLowerCase() !== 'content-type')) {
     hdrs = { ...headers };
-    hdrs['Content-Type'] = 'application/x-binary';
+    hdrs['Content-Type'] = 'application/msgpack';
   }
   return hdrs;
 }
 
-function isByteArray(array: any): array is Uint8Array {
-  return array && array.byteLength !== undefined;
-}
-
 /**
  * Simulates signed txns.
  */
@@ -30,23 +25,12 @@ export default class SimulateRawTransactions extends JSONRequest<
   SimulateResponse,
   Uint8Array
 > {
-  private txnBytesToPost: Uint8Array;
+  private requestBytes: Uint8Array;
 
-  constructor(c: HTTPClient, stxOrStxs: Uint8Array | Uint8Array[]) {
+  constructor(c: HTTPClient, request: SimulateRequest) {
     super(c);
     this.query.format = 'msgpack';
-
-    let forPosting = stxOrStxs;
-    if (Array.isArray(stxOrStxs)) {
-      if (!stxOrStxs.every(isByteArray)) {
-        throw new TypeError('Array elements must be byte arrays');
-      }
-      // Flatten into a single Uint8Array
-      forPosting = concatArrays(...stxOrStxs);
-    } else if (!isByteArray(forPosting)) {
-      throw new TypeError('Argument must be byte array');
-    }
-    this.txnBytesToPost = forPosting;
+    this.requestBytes = encoding.rawEncode(request.get_obj_for_encoding(true));
   }
 
   // eslint-disable-next-line class-methods-use-this
@@ -58,7 +42,7 @@ export default class SimulateRawTransactions extends JSONRequest<
     const txHeaders = setSimulateTransactionsHeaders(headers);
     const res = await this.c.post(
       this.path(),
-      Buffer.from(this.txnBytesToPost),
+      Buffer.from(this.requestBytes),
       txHeaders,
       this.query,
       false

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

@@ -1,16 +1,16 @@
 import JSONRequest from '../jsonrequest';
-import { SuggestedParams } from '../../../types/transactions/base';
+import { SuggestedParamsWithMinFee } from '../../../types/transactions/base';
 
 /**
  * Returns the common needed parameters for a new transaction, in a format the transaction builder expects
  */
-export default class SuggestedParamsRequest extends JSONRequest<SuggestedParams> {
+export default class SuggestedParamsRequest extends JSONRequest<SuggestedParamsWithMinFee> {
   /* eslint-disable class-methods-use-this */
   path() {
     return '/v2/transactions/params';
   }
 
-  prepare(body: Record<string, any>): SuggestedParams {
+  prepare(body: Record<string, any>): SuggestedParamsWithMinFee {
     return {
       flatFee: false,
       fee: body.fee,
@@ -18,6 +18,7 @@ export default class SuggestedParamsRequest extends JSONRequest<SuggestedParams>
       lastRound: body['last-round'] + 1000,
       genesisID: body['genesis-id'],
       genesisHash: body['genesis-hash'],
+      minFee: body['min-fee'],
     };
   }
   /* eslint-enable class-methods-use-this */

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

@@ -0,0 +1,13 @@
+import JSONRequest from '../jsonrequest';
+
+export default class UnsetSyncRound extends JSONRequest {
+  // 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;
+  }
+}

package/src/composer.ts

@@ -12,7 +12,12 @@ import {
   ABIValue,
 } from './abi';
 import Algodv2 from './client/v2/algod/algod';
-import { SimulateResponse } from './client/v2/algod/models/types';
+import {
+  SimulateResponse,
+  SimulateRequest,
+  SimulateRequestTransactionGroup,
+} from './client/v2/algod/models/types';
+import { EncodedSignedTransaction } from './types';
 import { assignGroupID } from './group';
 import { makeApplicationCallTxnFromObject } from './makeTxn';
 import {
@@ -27,6 +32,7 @@ import {
   SuggestedParams,
 } from './types/transactions/base';
 import { waitForConfirmation } from './wait';
+import * as encoding from './encoding/encoding';
 
 // First 4 bytes of SHA-512/256 hash of "return"
 const RETURN_PREFIX = Buffer.from([21, 31, 124, 117]);
@@ -609,13 +615,17 @@ export class AtomicTransactionComposer {
    * Simulating the group will not change the composer's status.
    *
    * @param client - An Algodv2 client
+   * @param request - SimulateRequest with options in simulation.
+   *   If provided, the request's transaction group will be overrwritten by the composer's group,
+   *   only simulation related options will be used.
    *
    * @returns A promise that, upon success, resolves to an object containing an
    *   array of results containing one element for each method call transaction
    *   in this group (ABIResult[]) and the SimulateResponse object.
    */
   async simulate(
-    client: Algodv2
+    client: Algodv2,
+    request?: SimulateRequest
   ): Promise<{
     methodResults: ABIResult[];
     simulateResponse: SimulateResponse;
@@ -627,8 +637,22 @@ export class AtomicTransactionComposer {
     }
 
     const stxns = await this.gatherSignatures();
+    const txnObjects: EncodedSignedTransaction[] = stxns.map(
+      (stxn) => encoding.decode(stxn) as EncodedSignedTransaction
+    );
+
+    const currentRequest: SimulateRequest =
+      request == null ? new SimulateRequest({ txnGroups: [] }) : request;
+
+    currentRequest.txnGroups = [
+      new SimulateRequestTransactionGroup({
+        txns: txnObjects,
+      }),
+    ];
 
-    const simulateResponse = await client.simulateRawTransactions(stxns).do();
+    const simulateResponse = await client
+      .simulateTransactions(currentRequest)
+      .do();
 
     // Parse method response
     const methodResults: ABIResult[] = [];

package/src/main.ts

@@ -127,6 +127,13 @@ export {
   BaseHTTPClientResponse,
   BaseHTTPClientError,
 } from './client/baseHTTPClient';
+export {
+  AlgodTokenHeader,
+  IndexerTokenHeader,
+  KMDTokenHeader,
+  CustomTokenHeader,
+  TokenHeader,
+} from './client/urlTokenBaseHTTPClient';
 export { waitForConfirmation } from './wait';
 export {
   isValidAddress,

package/src/makeTxn.ts

@@ -200,10 +200,8 @@ export function makeKeyRegistrationTxnWithSuggestedParamsFromObject(
         'reKeyTo',
         'rekeyTo'
       >,
-      'from' | 'note' | 'suggestedParams' | 'rekeyTo'
-    > & {
-      nonParticipation: true;
-    }
+      'from' | 'note' | 'suggestedParams' | 'rekeyTo' | 'nonParticipation'
+    >
   >
 ): txnBuilder.Transaction;
 export function makeKeyRegistrationTxnWithSuggestedParamsFromObject(o: any) {

package/src/transaction.ts

@@ -1290,10 +1290,9 @@ export function encodeUnsignedSimulateTransaction(
   transactionObject: Transaction
 ) {
   const objToEncode: EncodedSignedTransaction = {
-    sig: null,
     txn: transactionObject.get_obj_for_encoding(),
   };
-  return encoding.rawEncode(objToEncode);
+  return encoding.encode(objToEncode);
 }
 
 /**

package/src/types/transactions/base.ts

@@ -130,6 +130,13 @@ export interface SuggestedParams {
   genesisHash: string;
 }
 
+export type SuggestedParamsWithMinFee = SuggestedParams & {
+  /**
+   * Minimum fee (not per byte) required for the transaction to be confirmed
+   */
+  minFee: number;
+};
+
 /**
  * A grouping of the app ID and name of the box in an Uint8Array
  */