algosdk 2.3.0 → 2.4.0

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

@@ -40,6 +40,9 @@ import { EncodedSignedTransaction } from '../../../types';
 import * as encoding from '../../../encoding/encoding';
 import Ready from './ready';
 import UnsetSyncRound from './unsetSyncRound';
+import GetLedgerStateDeltaForTransactionGroup from './getLedgerStateDeltaForTransactionGroup';
+import GetLedgerStateDelta from './getLedgerStateDelta';
+import GetTransactionGroupLedgerStateDeltasForRound from './getTransactionGroupLedgerStateDeltasForRound';
 
 /**
  * Algod client connects an application to the Algorand blockchain. The algod client requires a valid algod REST endpoint IP address and algod token from an Algorand node that is connected to the network you plan to interact with.
@@ -751,4 +754,63 @@ export default class AlgodClient extends ServiceClient {
   ready() {
     return new Ready(this.c, this.intDecoding);
   }
+
+  /**
+   * GetLedgerStateDeltaForTransactionGroup returns the ledger delta for the txn group identified by id
+   *
+   * #### Example
+   * ```typescript
+   * const id = "ABC123";
+   * await client.getLedgerStateDeltaForTransactionGroup(id).do();
+   * ```
+   *
+   * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2deltastxngroupid)
+   * @param id txn ID or group ID to be searched for
+   * @category GET
+   */
+  getLedgerStateDeltaForTransactionGroup(id: string) {
+    return new GetLedgerStateDeltaForTransactionGroup(
+      this.c,
+      this.intDecoding,
+      id
+    );
+  }
+
+  /**
+   * GetLedgerStateDelta returns the ledger delta for the entire round
+   *
+   * #### Example
+   * ```typescript
+   * const round = 12345;
+   * await client.getLedgerStateDelta(round).do();
+   * ```
+   *
+   * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2deltasround)
+   * @param round the round number to be searched for
+   * @category GET
+   */
+  getLedgerStateDelta(round: bigint) {
+    return new GetLedgerStateDelta(this.c, this.intDecoding, round);
+  }
+
+  /**
+   * GetTransactionGroupLedgerStateDeltasForRound returns all ledger deltas for txn groups in the provided round
+   *
+   * #### Example
+   * ```typescript
+   * const round = 12345;
+   * await client.getTransactionGroupLedgerStateDeltasForRound(round).do();
+   * ```
+   *
+   * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2deltasroundtxngroup)
+   * @param round the round number to be searched for
+   * @category GET
+   */
+  getTransactionGroupLedgerStateDeltasForRound(round: bigint) {
+    return new GetTransactionGroupLedgerStateDeltasForRound(
+      this.c,
+      this.intDecoding,
+      round
+    );
+  }
 }

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

@@ -0,0 +1,16 @@
+import JSONRequest from '../jsonrequest';
+import HTTPClient from '../../client';
+import IntDecoding from '../../../types/intDecoding';
+
+export default class GetLedgerStateDelta extends JSONRequest {
+  constructor(c: HTTPClient, intDecoding: IntDecoding, private round: bigint) {
+    super(c, intDecoding);
+    this.round = round;
+    this.query = { format: 'json' };
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  path() {
+    return `/v2/deltas/${this.round}`;
+  }
+}

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

@@ -0,0 +1,16 @@
+import JSONRequest from '../jsonrequest';
+import HTTPClient from '../../client';
+import IntDecoding from '../../../types/intDecoding';
+
+export default class GetLedgerStateDeltaForTransactionGroup extends JSONRequest {
+  constructor(c: HTTPClient, intDecoding: IntDecoding, private id: string) {
+    super(c, intDecoding);
+    this.id = id;
+    this.query = { format: 'json' };
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  path() {
+    return `/v2/deltas/txn/group/${this.id}`;
+  }
+}

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

@@ -0,0 +1,29 @@
+import JSONRequest from '../jsonrequest';
+import { TransactionGroupLedgerStateDeltasForRoundResponse } from './models/types';
+import HTTPClient from '../../client';
+import IntDecoding from '../../../types/intDecoding';
+
+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' };
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  path() {
+    return `/v2/deltas/${this.round}/txn/group`;
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(
+    body: Record<string, any>
+  ): TransactionGroupLedgerStateDeltasForRoundResponse {
+    return TransactionGroupLedgerStateDeltasForRoundResponse.from_obj_for_encoding(
+      body
+    );
+  }
+}

package/src/client/v2/algod/models/types.ts

@@ -2558,6 +2558,52 @@ export class KvDelta extends BaseModel {
   }
 }
 
+/**
+ * Contains a ledger delta for a single transaction group
+ */
+export class LedgerStateDeltaForTransactionGroup extends BaseModel {
+  /**
+   * Ledger StateDelta object
+   */
+  public delta: Record<string, any>;
+
+  public ids: string[];
+
+  /**
+   * Creates a new `LedgerStateDeltaForTransactionGroup` object.
+   * @param delta - Ledger StateDelta object
+   * @param ids -
+   */
+  constructor({ delta, ids }: { delta: Record<string, any>; ids: string[] }) {
+    super();
+    this.delta = delta;
+    this.ids = ids;
+
+    this.attribute_map = {
+      delta: 'delta',
+      ids: 'ids',
+    };
+  }
+
+  // eslint-disable-next-line camelcase
+  static from_obj_for_encoding(
+    data: Record<string, any>
+  ): LedgerStateDeltaForTransactionGroup {
+    /* eslint-disable dot-notation */
+    if (typeof data['delta'] === 'undefined')
+      throw new Error(`Response is missing required field 'delta': ${data}`);
+    if (!Array.isArray(data['ids']))
+      throw new Error(
+        `Response is missing required array field 'ids': ${data}`
+      );
+    return new LedgerStateDeltaForTransactionGroup({
+      delta: data['delta'],
+      ids: data['ids'],
+    });
+    /* eslint-enable dot-notation */
+  }
+}
+
 /**
  * Proof of membership and position of a light block header.
  */
@@ -3318,31 +3364,41 @@ export class SimulateRequest extends BaseModel {
    */
   public allowMoreLogging?: boolean;
 
+  /**
+   * Applies extra opcode budget during simulation for each transaction group.
+   */
+  public extraOpcodeBudget?: number | bigint;
+
   /**
    * Creates a new `SimulateRequest` object.
    * @param txnGroups - The transaction groups to simulate.
    * @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 extraOpcodeBudget - Applies extra opcode budget during simulation for each transaction group.
    */
   constructor({
     txnGroups,
     allowEmptySignatures,
     allowMoreLogging,
+    extraOpcodeBudget,
   }: {
     txnGroups: SimulateRequestTransactionGroup[];
     allowEmptySignatures?: boolean;
     allowMoreLogging?: boolean;
+    extraOpcodeBudget?: number | bigint;
   }) {
     super();
     this.txnGroups = txnGroups;
     this.allowEmptySignatures = allowEmptySignatures;
     this.allowMoreLogging = allowMoreLogging;
+    this.extraOpcodeBudget = extraOpcodeBudget;
 
     this.attribute_map = {
       txnGroups: 'txn-groups',
       allowEmptySignatures: 'allow-empty-signatures',
       allowMoreLogging: 'allow-more-logging',
+      extraOpcodeBudget: 'extra-opcode-budget',
     };
   }
 
@@ -3359,6 +3415,7 @@ export class SimulateRequest extends BaseModel {
       ),
       allowEmptySignatures: data['allow-empty-signatures'],
       allowMoreLogging: data['allow-more-logging'],
+      extraOpcodeBudget: data['extra-opcode-budget'],
     });
     /* eslint-enable dot-notation */
   }
@@ -3672,6 +3729,11 @@ export class SimulationEvalOverrides extends BaseModel {
    */
   public allowEmptySignatures?: boolean;
 
+  /**
+   * The extra opcode budget added to each transaction group during simulation
+   */
+  public extraOpcodeBudget?: number | bigint;
+
   /**
    * The maximum log calls one can make during simulation
    */
@@ -3686,25 +3748,30 @@ export class SimulationEvalOverrides extends BaseModel {
    * Creates a new `SimulationEvalOverrides` object.
    * @param allowEmptySignatures - If true, transactions without signatures are allowed and simulated as if they
    * were properly signed.
+   * @param extraOpcodeBudget - The extra opcode budget added to each transaction group during simulation
    * @param maxLogCalls - The maximum log calls one can make during simulation
    * @param maxLogSize - The maximum byte number to log during simulation
    */
   constructor({
     allowEmptySignatures,
+    extraOpcodeBudget,
     maxLogCalls,
     maxLogSize,
   }: {
     allowEmptySignatures?: boolean;
+    extraOpcodeBudget?: number | bigint;
     maxLogCalls?: number | bigint;
     maxLogSize?: number | bigint;
   }) {
     super();
     this.allowEmptySignatures = allowEmptySignatures;
+    this.extraOpcodeBudget = extraOpcodeBudget;
     this.maxLogCalls = maxLogCalls;
     this.maxLogSize = maxLogSize;
 
     this.attribute_map = {
       allowEmptySignatures: 'allow-empty-signatures',
+      extraOpcodeBudget: 'extra-opcode-budget',
       maxLogCalls: 'max-log-calls',
       maxLogSize: 'max-log-size',
     };
@@ -3717,6 +3784,7 @@ export class SimulationEvalOverrides extends BaseModel {
     /* eslint-disable dot-notation */
     return new SimulationEvalOverrides({
       allowEmptySignatures: data['allow-empty-signatures'],
+      extraOpcodeBudget: data['extra-opcode-budget'],
       maxLogCalls: data['max-log-calls'],
       maxLogSize: data['max-log-size'],
     });
@@ -4066,6 +4134,44 @@ export class TealValue extends BaseModel {
   }
 }
 
+/**
+ * Response containing all ledger state deltas for transaction groups, with their
+ * associated Ids, in a single round.
+ */
+export class TransactionGroupLedgerStateDeltasForRoundResponse extends BaseModel {
+  public deltas: LedgerStateDeltaForTransactionGroup[];
+
+  /**
+   * Creates a new `TransactionGroupLedgerStateDeltasForRoundResponse` object.
+   * @param deltas -
+   */
+  constructor({ deltas }: { deltas: LedgerStateDeltaForTransactionGroup[] }) {
+    super();
+    this.deltas = deltas;
+
+    this.attribute_map = {
+      deltas: 'deltas',
+    };
+  }
+
+  // eslint-disable-next-line camelcase
+  static from_obj_for_encoding(
+    data: Record<string, any>
+  ): TransactionGroupLedgerStateDeltasForRoundResponse {
+    /* eslint-disable dot-notation */
+    if (!Array.isArray(data['Deltas']))
+      throw new Error(
+        `Response is missing required array field 'Deltas': ${data}`
+      );
+    return new TransactionGroupLedgerStateDeltasForRoundResponse({
+      deltas: data['Deltas'].map(
+        LedgerStateDeltaForTransactionGroup.from_obj_for_encoding
+      ),
+    });
+    /* eslint-enable dot-notation */
+  }
+}
+
 /**
  * TransactionParams contains the parameters that help a client construct a new
  * transaction.

package/src/client/v2/serviceClient.ts

@@ -19,6 +19,9 @@ function convertTokenStringToTokenHeader(
   headerIdentifier: TokenHeaderIdentifier
 ): TokenHeader {
   const tokenHeader = {};
+  if (token === '') {
+    return tokenHeader;
+  }
   tokenHeader[headerIdentifier] = token;
   return tokenHeader as TokenHeader;
 }

package/src/composer.ts

@@ -351,7 +351,7 @@ export class AtomicTransactionComposer {
           !abiCheckTransactionType(argType, argValue.txn)
         ) {
           throw new Error(
-            `Expected ${argType} transaction for argument at index ${i}`
+            `Expected ${argType} TransactionWithSigner for argument at index ${i}`
           );
         }
         if (argValue.txn.group && argValue.txn.group.some((v) => v !== 0)) {