@algorandfoundation/algokit-utils 9.0.2-beta.1 → 9.1.0-beta.2

package/types/composer.mjs

@@ -13,8 +13,37 @@ const address = (address) => {
     return typeof address === 'string' ? Address.fromString(address) : address;
 };
 const MAX_TRANSACTION_GROUP_SIZE = 16;
+class InvalidErrorTransformerValue extends Error {
+    constructor(originalError, value) {
+        super(`An error transformer returned a non-error value: ${value}. The original error before any transformation: ${originalError}`);
+    }
+}
+class ErrorTransformerError extends Error {
+    constructor(originalError, cause) {
+        super(`An error transformer threw an error: ${cause}. The original error before any transformation: ${originalError} `, { cause });
+    }
+}
 /** TransactionComposer helps you compose and execute transactions as a transaction group. */
 class TransactionComposer {
+    async transformError(originalError) {
+        // Transformers only work with Error instances, so immediately return anything else
+        if (!(originalError instanceof Error)) {
+            return originalError;
+        }
+        let transformedError = originalError;
+        for (const transformer of this.errorTransformers) {
+            try {
+                transformedError = await transformer(transformedError);
+                if (!(transformedError instanceof Error)) {
+                    return new InvalidErrorTransformerValue(originalError, transformedError);
+                }
+            }
+            catch (errorFromTransformer) {
+                return new ErrorTransformerError(originalError, errorFromTransformer);
+            }
+        }
+        return transformedError;
+    }
     /**
      * Create a `TransactionComposer`.
      * @param params The configuration for this composer
@@ -40,6 +69,16 @@ class TransactionComposer {
         this.defaultValidityWindow = params.defaultValidityWindow ?? this.defaultValidityWindow;
         this.defaultValidityWindowIsExplicit = params.defaultValidityWindow !== undefined;
         this.appManager = params.appManager ?? new AppManager(params.algod);
+        this.errorTransformers = params.errorTransformers ?? [];
+    }
+    /**
+     * Register a function that will be used to transform an error caught when simulating or executing
+     *
+     * @returns The composer so you can chain method calls
+     */
+    registerErrorTransformer(transformer) {
+        this.errorTransformers.push(transformer);
+        return this;
     }
     /**
      * Add a pre-built transaction to the transaction group.
@@ -1309,19 +1348,24 @@ class TransactionComposer {
             const { firstValid: firstRound } = suggestedParams;
             waitRounds = Number(BigInt(lastRound) - BigInt(firstRound)) + 1;
         }
-        return await sendAtomicTransactionComposer({
-            atc: this.atc,
-            suppressLog: params?.suppressLog,
-            maxRoundsToWaitForConfirmation: waitRounds,
-            populateAppCallResources: params?.populateAppCallResources,
-            coverAppCallInnerTransactionFees: params?.coverAppCallInnerTransactionFees,
-            additionalAtcContext: params?.coverAppCallInnerTransactionFees
-                ? {
-                    maxFees: this.txnMaxFees,
-                    suggestedParams: suggestedParams,
-                }
-                : undefined,
-        }, this.algod);
+        try {
+            return await sendAtomicTransactionComposer({
+                atc: this.atc,
+                suppressLog: params?.suppressLog,
+                maxRoundsToWaitForConfirmation: waitRounds,
+                populateAppCallResources: params?.populateAppCallResources,
+                coverAppCallInnerTransactionFees: params?.coverAppCallInnerTransactionFees,
+                additionalAtcContext: params?.coverAppCallInnerTransactionFees
+                    ? {
+                        maxFees: this.txnMaxFees,
+                        suggestedParams: suggestedParams,
+                    }
+                    : undefined,
+            }, this.algod);
+        }
+        catch (originalError) {
+            throw await this.transformError(originalError);
+        }
     }
     /**
      * @deprecated Use `send` instead.
@@ -1377,8 +1421,7 @@ class TransactionComposer {
             if (Config.debug) {
                 await Config.events.emitAsync(EventType.TxnGroupSimulated, { simulateResponse });
             }
-            error.simulateResponse = simulateResponse;
-            throw error;
+            throw await this.transformError(error);
         }
         if (Config.debug && Config.traceAll) {
             await Config.events.emitAsync(EventType.TxnGroupSimulated, { simulateResponse });