@algorandfoundation/algokit-utils 9.2.0-beta.9 → 9.2.0

package/types/composer.d.ts

@@ -322,6 +322,8 @@ export type CommonAppCallParams = CommonTransactionParams & {
     boxReferences?: (BoxReference | BoxIdentifier)[];
     /** Access references unifies `accountReferences`, `appReferences`, `assetReferences`, and `boxReferences` under a single list. If non-empty, these other reference lists must be empty. If access is empty, those other reference lists may be non-empty. */
     accessReferences?: ResourceReference[];
+    /** If set, the transaction will be rejected when the app's version is greater than or equal to this value. This can be used to prevent calling an app after it has been updated. Set to 0 or leave undefined to skip the version check. */
+    rejectVersion?: number;
 };
 /** Parameters to define an app create transaction */
 export type AppCreateParams = Expand<Omit<CommonAppCallParams, 'appId'> & {
@@ -793,6 +795,7 @@ export declare class TransactionComposer {
      *  // Max fee doesn't make sense with extraFee AND staticFee
      *  //  already specified, but here for completeness
      *  maxFee: (3000).microAlgo(),
+     *  rejectVersion: 1,
      *  // Signer only needed if you want to provide one,
      *  //  generally you'd register it with AlgorandClient
      *  //  against the sender and not need to pass it in
@@ -836,6 +839,7 @@ export declare class TransactionComposer {
      *  // Max fee doesn't make sense with extraFee AND staticFee
      *  //  already specified, but here for completeness
      *  maxFee: (3000).microAlgo(),
+     *  rejectVersion: 1,
      *})
      * ```
      */
@@ -871,6 +875,7 @@ export declare class TransactionComposer {
      *  // Max fee doesn't make sense with extraFee AND staticFee
      *  //  already specified, but here for completeness
      *  maxFee: (3000).microAlgo(),
+     *  rejectVersion: 1,
      *})
      * ```
      */
@@ -908,6 +913,7 @@ export declare class TransactionComposer {
      *  // Max fee doesn't make sense with extraFee AND staticFee
      *  //  already specified, but here for completeness
      *  maxFee: (3000).microAlgo(),
+     *  rejectVersion: 1,
      *})
      * ```
      */
@@ -964,6 +970,7 @@ export declare class TransactionComposer {
      *  // Max fee doesn't make sense with extraFee AND staticFee
      *  //  already specified, but here for completeness
      *  maxFee: (3000).microAlgo(),
+     *  rejectVersion: 1,
      *})
      * ```
      */
@@ -1013,6 +1020,7 @@ export declare class TransactionComposer {
      *  // Max fee doesn't make sense with extraFee AND staticFee
      *  //  already specified, but here for completeness
      *  maxFee: (3000).microAlgo(),
+     *  rejectVersion: 1,
      *})
      * ```
      */
@@ -1060,6 +1068,7 @@ export declare class TransactionComposer {
      *  // Max fee doesn't make sense with extraFee AND staticFee
      *  //  already specified, but here for completeness
      *  maxFee: (3000).microAlgo(),
+     *  rejectVersion: 1,
      *})
      * ```
      */
@@ -1107,6 +1116,7 @@ export declare class TransactionComposer {
      *  // Max fee doesn't make sense with extraFee AND staticFee
      *  //  already specified, but here for completeness
      *  maxFee: (3000).microAlgo(),
+     *  rejectVersion: 1,
      *})
      * ```
      */

package/types/composer.js

@@ -412,6 +412,7 @@ class TransactionComposer {
      *  // Max fee doesn't make sense with extraFee AND staticFee
      *  //  already specified, but here for completeness
      *  maxFee: (3000).microAlgo(),
+     *  rejectVersion: 1,
      *  // Signer only needed if you want to provide one,
      *  //  generally you'd register it with AlgorandClient
      *  //  against the sender and not need to pass it in
@@ -458,6 +459,7 @@ class TransactionComposer {
      *  // Max fee doesn't make sense with extraFee AND staticFee
      *  //  already specified, but here for completeness
      *  maxFee: (3000).microAlgo(),
+     *  rejectVersion: 1,
      *})
      * ```
      */
@@ -496,6 +498,7 @@ class TransactionComposer {
      *  // Max fee doesn't make sense with extraFee AND staticFee
      *  //  already specified, but here for completeness
      *  maxFee: (3000).microAlgo(),
+     *  rejectVersion: 1,
      *})
      * ```
      */
@@ -536,6 +539,7 @@ class TransactionComposer {
      *  // Max fee doesn't make sense with extraFee AND staticFee
      *  //  already specified, but here for completeness
      *  maxFee: (3000).microAlgo(),
+     *  rejectVersion: 1,
      *})
      * ```
      */
@@ -595,6 +599,7 @@ class TransactionComposer {
      *  // Max fee doesn't make sense with extraFee AND staticFee
      *  //  already specified, but here for completeness
      *  maxFee: (3000).microAlgo(),
+     *  rejectVersion: 1,
      *})
      * ```
      */
@@ -647,6 +652,7 @@ class TransactionComposer {
      *  // Max fee doesn't make sense with extraFee AND staticFee
      *  //  already specified, but here for completeness
      *  maxFee: (3000).microAlgo(),
+     *  rejectVersion: 1,
      *})
      * ```
      */
@@ -697,6 +703,7 @@ class TransactionComposer {
      *  // Max fee doesn't make sense with extraFee AND staticFee
      *  //  already specified, but here for completeness
      *  maxFee: (3000).microAlgo(),
+     *  rejectVersion: 1,
      *})
      * ```
      */
@@ -747,6 +754,7 @@ class TransactionComposer {
      *  // Max fee doesn't make sense with extraFee AND staticFee
      *  //  already specified, but here for completeness
      *  maxFee: (3000).microAlgo(),
+     *  rejectVersion: 1,
      *})
      * ```
      */
@@ -1051,6 +1059,7 @@ class TransactionComposer {
                 return arg;
             })
                 .reverse(),
+            rejectVersion: params.rejectVersion,
             // note, lease, and rekeyTo are set in the common build step
             note: undefined,
             lease: undefined,
@@ -1163,6 +1172,7 @@ class TransactionComposer {
             access: params.accessReferences?.map(getResourceReference),
             approvalProgram,
             clearProgram: clearStateProgram,
+            rejectVersion: params.rejectVersion,
         };
         if (appId === 0n) {
             if (sdkParams.approvalProgram === undefined || sdkParams.clearProgram === undefined) {
@@ -1332,7 +1342,8 @@ class TransactionComposer {
             });
             this.atc['methodCalls'] = methodCalls;
         }
-        return { atc: this.atc, transactions: this.atc.buildGroup(), methodCalls: this.atc['methodCalls'] };
+        const transactions = this.atc.buildGroup();
+        return { atc: this.atc, transactions, methodCalls: this.atc['methodCalls'] };
     }
     /**
      * Rebuild the group, discarding any previously built transactions.