update transaction response type

coinbase · Aug 5, 2024 · 466ec1f · 466ec1f
1 parent 9038ebe
commit 466ec1f
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 7 deletions.
diff --git a/site/docs/pages/transaction/types.mdx b/site/docs/pages/transaction/types.mdx
@@ -54,7 +54,7 @@ type TransactionProviderReact = {
   children: ReactNode; // The child components to be rendered within the provider component.
   contracts: ContractFunctionParameters[]; // An array of contract function parameters provided to the child components.
   onError?: (e: TransactionError) => void; // An optional callback function that handles errors within the provider.
-  onSuccess?: (response: TransactionReceipt | TransactionReceipt[]) => void; // An optional callback function that exposes transaction hash
+  onSuccess?: (response: TransactionResponse) => void; // An optional callback function that exposes the transaction receipts
 };
 ```
 
@@ -67,10 +67,19 @@ type TransactionReact = {
   className?: string; // An optional CSS class name for styling the component.
   contracts: ContractFunctionParameters[]; // An array of contract function parameters for the transaction.
   onError?: (e: TransactionError) => void; // An optional callback function that handles transaction errors.
-  onSuccess?: (response: TransactionReceipt | TransactionReceipt[]) => void; // An optional callback function that exposes transaction hash
+  onSuccess?: (response: TransactionResponse) => void; // An optional callback function that exposes the transaction receipts
 };
 ```
 
+## `TransactionResponse`
+
+```ts
+type TransactionResponse = {
+  transactionReceipts: TransactionReceipt[];
+};
+
+```
+
 ## `TransactionSponsorReact`
 
 ```ts

diff --git a/src/transaction/components/TransactionProvider.tsx b/src/transaction/components/TransactionProvider.tsx
@@ -189,10 +189,10 @@ export function TransactionProvider({
   }, [chainId, executeContracts, handleSubmitErrors, switchChain]);
 
   useEffect(() => {
-    if (receiptArray?.length > 1) {
-      onSuccess?.(receiptArray);
+    if (receiptArray?.length) {
+      onSuccess?.({ transactionReceipts: receiptArray });
     } else if (receipt) {
-      onSuccess?.(receipt);
+      onSuccess?.({ transactionReceipts: [receipt] });
     }
   }, [onSuccess, receipt, receiptArray]);
 

diff --git a/src/transaction/types.ts b/src/transaction/types.ts
@@ -62,7 +62,7 @@ export type TransactionProviderReact = {
   children: ReactNode; // The child components to be rendered within the provider component.
   contracts: ContractFunctionParameters[]; // An array of contract function parameters provided to the child components.
   onError?: (e: TransactionError) => void; // An optional callback function that handles errors within the provider.
-  onSuccess?: (response: TransactionReceipt | TransactionReceipt[]) => void; // An optional callback function that exposes transaction hash
+  onSuccess?: (response: TransactionResponse) => void; // An optional callback function that exposes the transaction receipts
 };
 
 /**
@@ -76,7 +76,14 @@ export type TransactionReact = {
   className?: string; // An optional CSS class name for styling the component.
   contracts: ContractFunctionParameters[]; // An array of contract function parameters for the transaction.
   onError?: (e: TransactionError) => void; // An optional callback function that handles transaction errors.
-  onSuccess?: (response: TransactionReceipt | TransactionReceipt[]) => void; // An optional callback function that exposes transaction hash
+  onSuccess?: (response: TransactionResponse) => void; // An optional callback function that exposes the transaction receipts
+};
+
+/**
+ * Note: exported as public Type
+ */
+export type TransactionResponse = {
+  transactionReceipts: TransactionReceipt[];
 };
 
 /**