chore: typed event hook callback, added optional callback to useAppKitEvents

Author: ignaciosantise

packages/ethers/src/index.tsx

@@ -13,7 +13,7 @@ export {
   NetworkButton,
   AppKit
 } from '@reown/appkit-scaffold-react-native';
-import type { EventName } from '@reown/appkit-scaffold-react-native';
+import type { EventName, EventsControllerState } from '@reown/appkit-scaffold-react-native';
 
 export { defaultConfig } from './utils/defaultConfig';
 
@@ -130,7 +130,7 @@ export function useAppKitError() {
   };
 }
 
-export function useAppKitEvents() {
+export function useAppKitEvents(callback?: (newEvent: EventsControllerState) => void) {
   if (!modal) {
     throw new Error('Please call "createAppKit" before using "useAppKitEvents" hook');
   }
@@ -140,17 +140,21 @@ export function useAppKitEvents() {
   useEffect(() => {
     const unsubscribe = modal?.subscribeEvents(newEvent => {
       setEvents({ ...newEvent });
+      callback?.(newEvent);
     });
 
     return () => {
       unsubscribe?.();
     };
-  }, []);
+  }, [callback]);
 
   return event;
 }
 
-export function useAppKitEventSubscription(event: EventName, callback: () => void) {
+export function useAppKitEventSubscription(
+  event: EventName,
+  callback: (newEvent: EventsControllerState) => void
+) {
   if (!modal) {
     throw new Error('Please call "createAppKit" before using "useAppKitEventSubscription" hook');
   }
@@ -162,6 +166,4 @@ export function useAppKitEventSubscription(event: EventName, callback: () => voi
       unsubscribe?.();
     };
   }, [callback, event]);
-
-  return event;
 }

packages/ethers5/src/index.tsx

@@ -6,7 +6,7 @@ export {
   NetworkButton,
   AppKit
 } from '@reown/appkit-scaffold-react-native';
-import type { EventName } from '@reown/appkit-scaffold-react-native';
+import type { EventName, EventsControllerState } from '@reown/appkit-scaffold-react-native';
 import {
   ConstantsUtil,
   EthersStoreUtil,
@@ -127,7 +127,7 @@ export function useAppKitError() {
   };
 }
 
-export function useAppKitEvents() {
+export function useAppKitEvents(callback?: (newEvent: EventsControllerState) => void) {
   if (!modal) {
     throw new Error('Please call "createAppKit" before using "useAppKitEvents" hook');
   }
@@ -137,17 +137,21 @@ export function useAppKitEvents() {
   useEffect(() => {
     const unsubscribe = modal?.subscribeEvents(newEvent => {
       setEvents({ ...newEvent });
+      callback?.(newEvent);
     });
 
     return () => {
       unsubscribe?.();
     };
-  }, []);
+  }, [callback]);
 
   return event;
 }
 
-export function useAppKitEventSubscription(event: EventName, callback: () => void) {
+export function useAppKitEventSubscription(
+  event: EventName,
+  callback: (newEvent: EventsControllerState) => void
+) {
   if (!modal) {
     throw new Error('Please call "createAppKit" before using "useAppKitEventSubscription" hook');
   }
@@ -159,6 +163,4 @@ export function useAppKitEventSubscription(event: EventName, callback: () => voi
       unsubscribe?.();
     };
   }, [callback, event]);
-
-  return event;
 }

packages/wagmi/src/index.tsx

@@ -6,7 +6,7 @@ export {
   NetworkButton,
   AppKit
 } from '@reown/appkit-scaffold-react-native';
-import type { EventName } from '@reown/appkit-scaffold-react-native';
+import type { EventName, EventsControllerState } from '@reown/appkit-scaffold-react-native';
 import { ConstantsUtil } from '@reown/appkit-scaffold-utils-react-native';
 export { defaultWagmiConfig } from './utils/defaultWagmiConfig';
 import { useEffect, useState, useSyncExternalStore } from 'react';
@@ -83,7 +83,7 @@ export function useWalletInfo() {
   return { walletInfo };
 }
 
-export function useAppKitEvents() {
+export function useAppKitEvents(callback?: (newEvent: EventsControllerState) => void) {
   if (!modal) {
     throw new Error('Please call "createAppKit" before using "useAppKitEvents" hook');
   }
@@ -93,17 +93,21 @@ export function useAppKitEvents() {
   useEffect(() => {
     const unsubscribe = modal?.subscribeEvents(newEvent => {
       setEvents({ ...newEvent });
+      callback?.(newEvent);
     });
 
     return () => {
       unsubscribe?.();
     };
-  }, []);
+  }, [callback]);
 
   return event;
 }
 
-export function useAppKitEventSubscription(event: EventName, callback: () => void) {
+export function useAppKitEventSubscription(
+  event: EventName,
+  callback: (newEvent: EventsControllerState) => void
+) {
   if (!modal) {
     throw new Error('Please call "createAppKit" before using "useAppKitEventSubscription" hook');
   }
@@ -115,6 +119,4 @@ export function useAppKitEventSubscription(event: EventName, callback: () => voi
       unsubscribe?.();
     };
   }, [callback, event]);
-
-  return event;
 }