@openzeppelin/ui-renderer 1.1.1 → 1.2.0

package/dist/index.cjs

@@ -761,6 +761,44 @@ function extractRuntimeSecrets(data, fields) {
 	};
 }
 
+//#endregion
+//#region src/utils/transactionSuccessCallback.ts
+/**
+* Normalizes adapter `txHash` for the success callback (non-empty trimmed string or omitted).
+* Expects the `txHash` string from `signAndBroadcast`, not arbitrary values (avoids coercing objects).
+*/
+function normalizeTransactionSuccessHash(finalTxHash) {
+	if (finalTxHash == null) return;
+	const trimmed = finalTxHash.trim();
+	return trimmed !== "" ? trimmed : void 0;
+}
+/**
+* Builds the {@link TransactionSuccessPayload} passed to `onTransactionSuccess`.
+*/
+function buildTransactionSuccessPayload(options) {
+	const hash = normalizeTransactionSuccessHash(options.finalTxHash);
+	return {
+		network_id: options.networkId,
+		ecosystem: options.ecosystem,
+		execution_method: options.executionMethod,
+		...hash !== void 0 ? { transaction_hash: hash } : {}
+	};
+}
+/**
+* Invokes `onTransactionSuccess` with error containment: synchronous throws and async
+* rejections are logged and never rethrown, so host callbacks cannot break transaction flow.
+*/
+function invokeOnTransactionSuccess(callback, payload, log) {
+	try {
+		const maybePromise = callback?.(payload);
+		Promise.resolve(maybePromise).catch((error) => {
+			log.error("TransactionForm", "onTransactionSuccess callback rejected with an error", error);
+		});
+	} catch (error) {
+		log.error("TransactionForm", "onTransactionSuccess callback threw an error", error);
+	}
+}
+
 //#endregion
 //#region src/components/fieldRegistry.ts
 /**
@@ -1208,7 +1246,7 @@ const PENDING_STATES = [
 *
 * @returns The rendered form component
 */
-function TransactionForm({ schema, contractSchema, adapter, isWalletConnected = false, executionConfig }) {
+function TransactionForm({ schema, contractSchema, adapter, isWalletConnected = false, executionConfig, onTransactionSuccess }) {
 	const [formError, setFormError] = (0, react.useState)(null);
 	const [executionConfigError, setExecutionConfigError] = (0, react.useState)(null);
 	const [runtimeApiKey, setRuntimeApiKey] = (0, react.useState)("");
@@ -1295,9 +1333,19 @@ function TransactionForm({ schema, contractSchema, adapter, isWalletConnected =
 				setTxResult(result);
 				_openzeppelin_ui_utils.logger.info("TransactionForm", "Execution result received:", result);
 			}
+			const reportTransactionSuccess = () => {
+				const executionMethod = executionConfig?.method ?? "eoa";
+				invokeOnTransactionSuccess(onTransactionSuccess, buildTransactionSuccessPayload({
+					networkId: adapter.networkConfig.id,
+					ecosystem: adapter.networkConfig.ecosystem,
+					executionMethod,
+					finalTxHash
+				}), _openzeppelin_ui_utils.logger);
+			};
 			if (canExecuteLocally) {
 				setTxStatus("success");
 				setTxError(null);
+				reportTransactionSuccess();
 				return;
 			}
 			if (adapter.waitForTransactionConfirmation) {
@@ -1308,6 +1356,7 @@ function TransactionForm({ schema, contractSchema, adapter, isWalletConnected =
 					_openzeppelin_ui_utils.logger.info("TransactionForm", `Transaction confirmed: ${finalTxHash}`, confirmationResult.receipt);
 					setTxStatus("success");
 					setTxError(null);
+					reportTransactionSuccess();
 				} else {
 					_openzeppelin_ui_utils.logger.error("TransactionForm", `Transaction failed confirmation: ${finalTxHash}`, confirmationResult.error);
 					setTxError(confirmationResult.error?.message ?? "Transaction failed during confirmation.");
@@ -1317,6 +1366,7 @@ function TransactionForm({ schema, contractSchema, adapter, isWalletConnected =
 				_openzeppelin_ui_utils.logger.warn("TransactionForm", "Adapter does not support waitForTransactionConfirmation. Marking as success after submission.");
 				setTxStatus("success");
 				setTxError(null);
+				reportTransactionSuccess();
 			}
 		} catch (error) {
 			_openzeppelin_ui_utils.logger.error("TransactionForm", "Transaction error during submission process:", error);
@@ -2818,6 +2868,7 @@ exports.NetworkSettingsDialog = NetworkSettingsDialog;
 exports.TransactionExecuteButton = TransactionExecuteButton;
 exports.TransactionForm = TransactionForm;
 exports.WalletConnectionWithSettings = WalletConnectionWithSettings;
+exports.buildTransactionSuccessPayload = buildTransactionSuccessPayload;
 exports.createAddressTransform = createAddressTransform;
 exports.createArrayObjectTransform = createArrayObjectTransform;
 exports.createArrayTransform = createArrayTransform;
@@ -2831,6 +2882,8 @@ exports.createTextTransform = createTextTransform;
 exports.createTransformForFieldType = createTransformForFieldType;
 exports.generateDefaultValue = generateDefaultValue;
 exports.getDefaultValueByFieldType = getDefaultValueByFieldType;
+exports.invokeOnTransactionSuccess = invokeOnTransactionSuccess;
+exports.normalizeTransactionSuccessHash = normalizeTransactionSuccessHash;
 exports.rendererConfig = rendererConfig;
 exports.useAliasEditState = useAliasEditState;
 exports.validateField = validateField;