algosdk 2.4.0 → 2.5.0

package/dist/types/client/v2/algod/models/types.d.ts

@@ -668,6 +668,35 @@ export declare class AssetParams extends BaseModel {
     });
     static from_obj_for_encoding(data: Record<string, any>): AssetParams;
 }
+/**
+ * Represents an AVM value.
+ */
+export declare class AvmValue extends BaseModel {
+    /**
+     * value type. Value `1` refers to **bytes**, value `2` refers to **uint64**
+     */
+    type: number | bigint;
+    /**
+     * bytes value.
+     */
+    bytes?: Uint8Array;
+    /**
+     * uint value.
+     */
+    uint?: number | bigint;
+    /**
+     * Creates a new `AvmValue` object.
+     * @param type - value type. Value `1` refers to **bytes**, value `2` refers to **uint64**
+     * @param bytes - bytes value.
+     * @param uint - uint value.
+     */
+    constructor({ type, bytes, uint, }: {
+        type: number | bigint;
+        bytes?: string | Uint8Array;
+        uint?: number | bigint;
+    });
+    static from_obj_for_encoding(data: Record<string, any>): AvmValue;
+}
 /**
  * Hash of a block header.
  */
@@ -718,6 +747,10 @@ export declare class Box extends BaseModel {
      * (name) box name, base64 encoded
      */
     name: Uint8Array;
+    /**
+     * The round for which this information is relevant
+     */
+    round: number | bigint;
     /**
      * (value) box value, base64 encoded.
      */
@@ -725,10 +758,12 @@ export declare class Box extends BaseModel {
     /**
      * Creates a new `Box` object.
      * @param name - (name) box name, base64 encoded
+     * @param round - The round for which this information is relevant
      * @param value - (value) box value, base64 encoded.
      */
-    constructor({ name, value, }: {
+    constructor({ name, round, value, }: {
         name: string | Uint8Array;
+        round: number | bigint;
         value: string | Uint8Array;
     });
     static from_obj_for_encoding(data: Record<string, any>): Box;
@@ -1539,6 +1574,29 @@ export declare class PostTransactionsResponse extends BaseModel {
     });
     static from_obj_for_encoding(data: Record<string, any>): PostTransactionsResponse;
 }
+/**
+ * A write operation into a scratch slot.
+ */
+export declare class ScratchChange extends BaseModel {
+    /**
+     * Represents an AVM value.
+     */
+    newValue: AvmValue;
+    /**
+     * The scratch slot written.
+     */
+    slot: number | bigint;
+    /**
+     * Creates a new `ScratchChange` object.
+     * @param newValue - Represents an AVM value.
+     * @param slot - The scratch slot written.
+     */
+    constructor({ newValue, slot, }: {
+        newValue: AvmValue;
+        slot: number | bigint;
+    });
+    static from_obj_for_encoding(data: Record<string, any>): ScratchChange;
+}
 /**
  * Request type for simulation endpoint.
  */
@@ -1556,6 +1614,10 @@ export declare class SimulateRequest extends BaseModel {
      * Lifts limits on log opcode usage during simulation.
      */
     allowMoreLogging?: boolean;
+    /**
+     * An object that configures simulation execution trace.
+     */
+    execTraceConfig?: SimulateTraceConfig;
     /**
      * Applies extra opcode budget during simulation for each transaction group.
      */
@@ -1566,12 +1628,14 @@ export declare class SimulateRequest extends BaseModel {
      * @param allowEmptySignatures - Allow transactions without signatures to be simulated as if they had correct
      * signatures.
      * @param allowMoreLogging - Lifts limits on log opcode usage during simulation.
+     * @param execTraceConfig - An object that configures simulation execution trace.
      * @param extraOpcodeBudget - Applies extra opcode budget during simulation for each transaction group.
      */
-    constructor({ txnGroups, allowEmptySignatures, allowMoreLogging, extraOpcodeBudget, }: {
+    constructor({ txnGroups, allowEmptySignatures, allowMoreLogging, execTraceConfig, extraOpcodeBudget, }: {
         txnGroups: SimulateRequestTransactionGroup[];
         allowEmptySignatures?: boolean;
         allowMoreLogging?: boolean;
+        execTraceConfig?: SimulateTraceConfig;
         extraOpcodeBudget?: number | bigint;
     });
     static from_obj_for_encoding(data: Record<string, any>): SimulateRequest;
@@ -1616,6 +1680,10 @@ export declare class SimulateResponse extends BaseModel {
      * evaluation in certain ways.
      */
     evalOverrides?: SimulationEvalOverrides;
+    /**
+     * An object that configures simulation execution trace.
+     */
+    execTraceConfig?: SimulateTraceConfig;
     /**
      * Creates a new `SimulateResponse` object.
      * @param lastRound - The round immediately preceding this simulation. State changes through this
@@ -1625,15 +1693,50 @@ export declare class SimulateResponse extends BaseModel {
      * @param evalOverrides - The set of parameters and limits override during simulation. If this set of
      * parameters is present, then evaluation parameters may differ from standard
      * evaluation in certain ways.
+     * @param execTraceConfig - An object that configures simulation execution trace.
      */
-    constructor({ lastRound, txnGroups, version, evalOverrides, }: {
+    constructor({ lastRound, txnGroups, version, evalOverrides, execTraceConfig, }: {
         lastRound: number | bigint;
         txnGroups: SimulateTransactionGroupResult[];
         version: number | bigint;
         evalOverrides?: SimulationEvalOverrides;
+        execTraceConfig?: SimulateTraceConfig;
     });
     static from_obj_for_encoding(data: Record<string, any>): SimulateResponse;
 }
+/**
+ * An object that configures simulation execution trace.
+ */
+export declare class SimulateTraceConfig extends BaseModel {
+    /**
+     * A boolean option for opting in execution trace features simulation endpoint.
+     */
+    enable?: boolean;
+    /**
+     * A boolean option enabling returning scratch slot changes together with execution
+     * trace during simulation.
+     */
+    scratchChange?: boolean;
+    /**
+     * A boolean option enabling returning stack changes together with execution trace
+     * during simulation.
+     */
+    stackChange?: boolean;
+    /**
+     * Creates a new `SimulateTraceConfig` object.
+     * @param enable - A boolean option for opting in execution trace features simulation endpoint.
+     * @param scratchChange - A boolean option enabling returning scratch slot changes together with execution
+     * trace during simulation.
+     * @param stackChange - A boolean option enabling returning stack changes together with execution trace
+     * during simulation.
+     */
+    constructor({ enable, scratchChange, stackChange, }: {
+        enable?: boolean;
+        scratchChange?: boolean;
+        stackChange?: boolean;
+    });
+    static from_obj_for_encoding(data: Record<string, any>): SimulateTraceConfig;
+}
 /**
  * Simulation result for an atomic transaction group
  */
@@ -1697,6 +1800,11 @@ export declare class SimulateTransactionResult extends BaseModel {
      * budged used by inner app calls spawned by this transaction.
      */
     appBudgetConsumed?: number | bigint;
+    /**
+     * The execution trace of calling an app or a logic sig, containing the inner app
+     * call trace in a recursive way.
+     */
+    execTrace?: SimulationTransactionExecTrace;
     /**
      * Budget used during execution of a logic sig transaction.
      */
@@ -1707,11 +1815,14 @@ export declare class SimulateTransactionResult extends BaseModel {
      * includes confirmation details like the round and reward details.
      * @param appBudgetConsumed - Budget used during execution of an app call transaction. This value includes
      * budged used by inner app calls spawned by this transaction.
+     * @param execTrace - The execution trace of calling an app or a logic sig, containing the inner app
+     * call trace in a recursive way.
      * @param logicSigBudgetConsumed - Budget used during execution of a logic sig transaction.
      */
-    constructor({ txnResult, appBudgetConsumed, logicSigBudgetConsumed, }: {
+    constructor({ txnResult, appBudgetConsumed, execTrace, logicSigBudgetConsumed, }: {
         txnResult: PendingTransactionResponse;
         appBudgetConsumed?: number | bigint;
+        execTrace?: SimulationTransactionExecTrace;
         logicSigBudgetConsumed?: number | bigint;
     });
     static from_obj_for_encoding(data: Record<string, any>): SimulateTransactionResult;
@@ -1755,6 +1866,85 @@ export declare class SimulationEvalOverrides extends BaseModel {
     });
     static from_obj_for_encoding(data: Record<string, any>): SimulationEvalOverrides;
 }
+/**
+ * The set of trace information and effect from evaluating a single opcode.
+ */
+export declare class SimulationOpcodeTraceUnit extends BaseModel {
+    /**
+     * The program counter of the current opcode being evaluated.
+     */
+    pc: number | bigint;
+    /**
+     * The writes into scratch slots.
+     */
+    scratchChanges?: ScratchChange[];
+    /**
+     * The indexes of the traces for inner transactions spawned by this opcode, if any.
+     */
+    spawnedInners?: (number | bigint)[];
+    /**
+     * The values added by this opcode to the stack.
+     */
+    stackAdditions?: AvmValue[];
+    /**
+     * The number of deleted stack values by this opcode.
+     */
+    stackPopCount?: number | bigint;
+    /**
+     * Creates a new `SimulationOpcodeTraceUnit` object.
+     * @param pc - The program counter of the current opcode being evaluated.
+     * @param scratchChanges - The writes into scratch slots.
+     * @param spawnedInners - The indexes of the traces for inner transactions spawned by this opcode, if any.
+     * @param stackAdditions - The values added by this opcode to the stack.
+     * @param stackPopCount - The number of deleted stack values by this opcode.
+     */
+    constructor({ pc, scratchChanges, spawnedInners, stackAdditions, stackPopCount, }: {
+        pc: number | bigint;
+        scratchChanges?: ScratchChange[];
+        spawnedInners?: (number | bigint)[];
+        stackAdditions?: AvmValue[];
+        stackPopCount?: number | bigint;
+    });
+    static from_obj_for_encoding(data: Record<string, any>): SimulationOpcodeTraceUnit;
+}
+/**
+ * The execution trace of calling an app or a logic sig, containing the inner app
+ * call trace in a recursive way.
+ */
+export declare class SimulationTransactionExecTrace extends BaseModel {
+    /**
+     * Program trace that contains a trace of opcode effects in an approval program.
+     */
+    approvalProgramTrace?: SimulationOpcodeTraceUnit[];
+    /**
+     * Program trace that contains a trace of opcode effects in a clear state program.
+     */
+    clearStateProgramTrace?: SimulationOpcodeTraceUnit[];
+    /**
+     * An array of SimulationTransactionExecTrace representing the execution trace of
+     * any inner transactions executed.
+     */
+    innerTrace?: SimulationTransactionExecTrace[];
+    /**
+     * Program trace that contains a trace of opcode effects in a logic sig.
+     */
+    logicSigTrace?: SimulationOpcodeTraceUnit[];
+    /**
+     * Creates a new `SimulationTransactionExecTrace` object.
+     * @param approvalProgramTrace - Program trace that contains a trace of opcode effects in an approval program.
+     * @param clearStateProgramTrace - Program trace that contains a trace of opcode effects in a clear state program.
+     * @param innerTrace - An array of SimulationTransactionExecTrace representing the execution trace of
+     * any inner transactions executed.
+     * @param logicSigTrace - Program trace that contains a trace of opcode effects in a logic sig.
+     */
+    constructor({ approvalProgramTrace, clearStateProgramTrace, innerTrace, logicSigTrace, }: {
+        approvalProgramTrace?: SimulationOpcodeTraceUnit[];
+        clearStateProgramTrace?: SimulationOpcodeTraceUnit[];
+        innerTrace?: SimulationTransactionExecTrace[];
+        logicSigTrace?: SimulationOpcodeTraceUnit[];
+    });
+    static from_obj_for_encoding(data: Record<string, any>): SimulationTransactionExecTrace;
+}
 /**
  * Represents a state proof and its corresponding message
  */

package/dist/types/client/v2/indexer/lookupAccountTransactions.d.ts

@@ -238,8 +238,6 @@ export default class LookupAccountTransactions extends JSONRequest {
      *        .currencyGreaterThan(minBalance - 1)
      *        .do();
      * ```
-     * @remarks
-     * If you are looking for transactions with the currency amount greater than 0, simply construct the query without `currencyGreaterThan` because it doesn't accept `-1`, and passing the `0` `currency-greater-than` value would exclude transactions with a 0 amount.
      *
      * @param greater
      * @category query

package/dist/types/client/v2/indexer/lookupAssetTransactions.d.ts

@@ -204,9 +204,6 @@ export default class LookupAssetTransactions extends JSONRequest {
      *        .do();
      * ```
      *
-     * @remarks
-     * If you are looking for transactions with the currency amount greater than 0, simply construct the query without `currencyGreaterThan` because it doesn't accept `-1`, and passing the `0` `currency-greater-than` value would exclude transactions with a 0 amount.
-     *
      * @param greater
      * @category query
      */

package/dist/types/client/v2/indexer/searchForTransactions.d.ts

@@ -192,62 +192,6 @@ export default class SearchForTransactions extends JSONRequest {
      * @category query
      */
     afterTime(after: string): this;
-    /**
-     * Filtered results should have an amount greater than this value, as int, representing microAlgos, unless an asset-id is provided, in which case units are in the asset's units.
-     *
-     * #### Example 1
-     * ```typescript
-     * const minBalance = 300000;
-     * const txns = await indexerClient
-     *        .searchForTransactions()
-     *        .currencyGreaterThan(minBalance - 1)
-     *        .do();
-     * ```
-     *
-     * #### Example 2
-     * ```typescript
-     * const assetID = 163650;
-     * const minBalance = 300000;
-     * const txns = await indexerClient
-     *        .searchForTransactions()
-     *        .assetID(assetID)
-     *        .currencyGreaterThan(minBalance - 1)
-     *        .do();
-     * ```
-     * @remarks
-     * If you are looking for transactions with the currency amount greater than 0, simply construct the query without `currencyGreaterThan` because it doesn't accept `-1`, and passing the `0` `currency-greater-than` value would exclude transactions with a 0 amount.
-     *
-     * @param greater
-     * @category query
-     */
-    currencyGreaterThan(greater: number): this;
-    /**
-     * Filtered results should have an amount less than this value, as int, representing microAlgos, unless an asset-id is provided, in which case units are in the asset's units.
-     *
-     * #### Example 1
-     * ```typescript
-     * const maxBalance = 500000;
-     * const txns = await indexerClient
-     *        .searchForTransactions()
-     *        .currencyLessThan(maxBalance + 1)
-     *        .do();
-     * ```
-     *
-     * #### Example 2
-     * ```typescript
-     * const assetID = 163650;
-     * const maxBalance = 500000;
-     * const txns = await indexerClient
-     *        .searchForTransactions()
-     *        .assetID(assetID)
-     *        .currencyLessThan(maxBalance + 1)
-     *        .do();
-     * ```
-     *
-     * @param lesser
-     * @category query
-     */
-    currencyLessThan(lesser: number): this;
     /**
      * Combined with address, defines what address to filter on, as string.
      *
@@ -351,4 +295,58 @@ export default class SearchForTransactions extends JSONRequest {
      * @category query
      */
     applicationID(applicationID: number): this;
+    /**
+     * Filtered results should have an amount greater than this value, as int, representing microAlgos, unless an asset-id is provided, in which case units are in the asset's units.
+     *
+     * #### Example 1
+     * ```typescript
+     * const minBalance = 300000;
+     * const txns = await indexerClient
+     *        .searchForTransactions()
+     *        .currencyGreaterThan(minBalance - 1)
+     *        .do();
+     * ```
+     *
+     * #### Example 2
+     * ```typescript
+     * const assetID = 163650;
+     * const minBalance = 300000;
+     * const txns = await indexerClient
+     *        .searchForTransactions()
+     *        .assetID(assetID)
+     *        .currencyGreaterThan(minBalance - 1)
+     *        .do();
+     * ```
+     *
+     * @param greater
+     * @category query
+     */
+    currencyGreaterThan(greater: number): this;
+    /**
+     * Filtered results should have an amount less than this value, as int, representing microAlgos, unless an asset-id is provided, in which case units are in the asset's units.
+     *
+     * #### Example 1
+     * ```typescript
+     * const maxBalance = 500000;
+     * const txns = await indexerClient
+     *        .searchForTransactions()
+     *        .currencyLessThan(maxBalance + 1)
+     *        .do();
+     * ```
+     *
+     * #### Example 2
+     * ```typescript
+     * const assetID = 163650;
+     * const maxBalance = 500000;
+     * const txns = await indexerClient
+     *        .searchForTransactions()
+     *        .assetID(assetID)
+     *        .currencyLessThan(maxBalance + 1)
+     *        .do();
+     * ```
+     *
+     * @param lesser
+     * @category query
+     */
+    currencyLessThan(lesser: number): this;
 }

package/dist/types/utils/utils.d.ts

@@ -45,3 +45,8 @@ export declare function removeUndefinedProperties(obj: Record<string | number |
  * @returns True if Node.js environment, false otherwise
  */
 export declare function isNode(): boolean;
+/**
+ * Check whether the environment is ReactNative
+ * @returns True if ReactNative, false otherwise
+ */
+export declare function isReactNative(): boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "algosdk",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "description": "The official JavaScript SDK for Algorand",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -23,7 +23,7 @@
   "dependencies": {
     "algo-msgpack-with-bigint": "^2.1.1",
     "buffer": "^6.0.3",
-    "cross-fetch": "^3.1.5",
+    "cross-fetch": "^4.0.0",
     "hi-base32": "^0.5.1",
     "js-sha256": "^0.9.0",
     "js-sha3": "^0.8.0",
@@ -38,7 +38,7 @@
     "@typescript-eslint/eslint-plugin": "^4.26.1",
     "@typescript-eslint/parser": "^4.26.1",
     "assert": "^2.0.0",
-    "chromedriver": "^108.0.0",
+    "chromedriver": "^116.0.0",
     "concurrently": "^6.2.0",
     "cucumber": "^5.1.0",
     "es-abstract": "^1.18.3",
@@ -54,7 +54,7 @@
     "mocha": "^9.0.0",
     "mock-http-server": "^1.4.3",
     "prettier": "2.2.1",
-    "selenium-webdriver": "^4.2.0",
+    "selenium-webdriver": "^4.10.0",
     "source-map-loader": "^2.0.2",
     "ts-loader": "^9.3.1",
     "ts-node": "^10.9.1",

package/src/client/urlTokenBaseHTTPClient.ts

@@ -163,7 +163,6 @@ export class URLTokenBaseHTTPClient implements BaseHTTPClient {
     };
 
     const res = await fetch(this.getURL(relativePath, query), {
-      mode: 'cors',
       headers,
     });
 
@@ -185,7 +184,6 @@ export class URLTokenBaseHTTPClient implements BaseHTTPClient {
 
     const res = await fetch(this.getURL(relativePath, query), {
       method: 'POST',
-      mode: 'cors',
       body: data,
       headers,
     });
@@ -208,7 +206,6 @@ export class URLTokenBaseHTTPClient implements BaseHTTPClient {
 
     const res = await fetch(this.getURL(relativePath, query), {
       method: 'DELETE',
-      mode: 'cors',
       body: data,
       headers,
     });