@cometh/connect-react-hooks 0.0.11 → 0.0.12-dev.2

package/dist/index.cjs

@@ -2266,6 +2266,75 @@ var useSwitchChain = () => {
   };
 };
 
+// src/hooks/useGetTransactionCost.ts
+var useGetTransactionCost = (mutationProps) => {
+  const { smartAccountClient, queryClient } = useSmartAccount();
+  const { mutate, mutateAsync, ...result } = useMutation(
+    {
+      mutationFn: async (variables) => {
+        if (!smartAccountClient) {
+          throw new Error("No smart account found");
+        }
+        const { transactions } = variables;
+        const userOperation = await smartAccountClient.account.buildUserOperation(
+          transactions
+        );
+        const estimateGas = await smartAccountClient.estimateGas({
+          userOperation
+        });
+        const totalGas = estimateGas.preVerificationGas + estimateGas.verificationGasLimit + estimateGas.callGasLimit;
+        return { totalGasCost: totalGas * estimateGas.maxFeePerGas };
+      },
+      ...mutationProps
+    },
+    queryClient
+  );
+  return {
+    data: _optionalChain([result, 'access', _98 => _98.data, 'optionalAccess', _99 => _99.totalGasCost]),
+    error: result.error,
+    isPending: result.isPending,
+    isSuccess: result.isSuccess,
+    isError: result.isError,
+    getTransactionCost: mutate,
+    getTransactionCostAsync: mutateAsync
+  };
+};
+
+// src/hooks/useEstimateGas.ts
+var useEstimateGas = (mutationProps) => {
+  const { smartAccountClient, queryClient } = useSmartAccount();
+  const { mutate, mutateAsync, ...result } = useMutation(
+    {
+      mutationFn: async (variables) => {
+        if (!smartAccountClient) {
+          throw new Error("No smart account found");
+        }
+        const { transactions } = variables;
+        const userOperation = await smartAccountClient.account.buildUserOperation(
+          transactions
+        );
+        const estimateGas = await smartAccountClient.estimateGas({
+          userOperation
+        });
+        return estimateGas;
+      },
+      ...mutationProps
+    },
+    queryClient
+  );
+  return {
+    data: result.data,
+    error: result.error,
+    isPending: result.isPending,
+    isSuccess: result.isSuccess,
+    isError: result.isError,
+    estimateGas: mutate,
+    estimateGasAsync: mutateAsync
+  };
+};
+
+
+
 
 
 
@@ -2298,4 +2367,4 @@ var useSwitchChain = () => {
 
 
 
-exports.ConnectProvider = ConnectProvider; exports.useAccount = useAccount; exports.useAddOwner = useAddOwner; exports.useAddSessionKey = useAddSessionKey; exports.useAddWhitelistDestination = useAddWhitelistDestination; exports.useCancelRecoveryRequest = useCancelRecoveryRequest; exports.useConnect = useConnect; exports.useCreateNewSigner = useCreateNewSigner; exports.useDisconnect = useDisconnect; exports.useGenerateQRCodeUrl = useGenerateQRCodeUrl; exports.useGetEnrichedOwners = useGetEnrichedOwners; exports.useGetGasPrice = useGetGasPrice; exports.useGetOwners = useGetOwners; exports.useGetRecoveryRequest = useGetRecoveryRequest; exports.useGetSessionFromAddress = useGetSessionFromAddress; exports.useIsAddressWhitelistDestination = useIsAddressWhitelistDestination; exports.useIsRecoveryActive = useIsRecoveryActive; exports.useRemoveOwner = useRemoveOwner; exports.useRemoveWhitelistDestination = useRemoveWhitelistDestination; exports.useRetrieveAccountAddressFromPasskeyId = useRetrieveAccountAddressFromPasskeyId; exports.useRetrieveAccountAddressFromPasskeys = useRetrieveAccountAddressFromPasskeys; exports.useRevokeSessionKey = useRevokeSessionKey; exports.useSendTransaction = useSendTransaction; exports.useSendTransactionWithSessionKey = useSendTransactionWithSessionKey; exports.useSerializeUrlWithSignerPayload = useSerializeUrlWithSignerPayload; exports.useSetUpRecovery = useSetUpRecovery; exports.useSignMessage = useSignMessage; exports.useSwitchChain = useSwitchChain; exports.useValidateAddDevice = useValidateAddDevice; exports.useVerifyMessage = useVerifyMessage; exports.useWriteContract = useWriteContract; exports.useWriteContractWithSessionKey = useWriteContractWithSessionKey;
+exports.ConnectProvider = ConnectProvider; exports.useAccount = useAccount; exports.useAddOwner = useAddOwner; exports.useAddSessionKey = useAddSessionKey; exports.useAddWhitelistDestination = useAddWhitelistDestination; exports.useCancelRecoveryRequest = useCancelRecoveryRequest; exports.useConnect = useConnect; exports.useCreateNewSigner = useCreateNewSigner; exports.useDisconnect = useDisconnect; exports.useEstimateGas = useEstimateGas; exports.useGenerateQRCodeUrl = useGenerateQRCodeUrl; exports.useGetEnrichedOwners = useGetEnrichedOwners; exports.useGetGasPrice = useGetGasPrice; exports.useGetOwners = useGetOwners; exports.useGetRecoveryRequest = useGetRecoveryRequest; exports.useGetSessionFromAddress = useGetSessionFromAddress; exports.useGetTransactionCost = useGetTransactionCost; exports.useIsAddressWhitelistDestination = useIsAddressWhitelistDestination; exports.useIsRecoveryActive = useIsRecoveryActive; exports.useRemoveOwner = useRemoveOwner; exports.useRemoveWhitelistDestination = useRemoveWhitelistDestination; exports.useRetrieveAccountAddressFromPasskeyId = useRetrieveAccountAddressFromPasskeyId; exports.useRetrieveAccountAddressFromPasskeys = useRetrieveAccountAddressFromPasskeys; exports.useRevokeSessionKey = useRevokeSessionKey; exports.useSendTransaction = useSendTransaction; exports.useSendTransactionWithSessionKey = useSendTransactionWithSessionKey; exports.useSerializeUrlWithSignerPayload = useSerializeUrlWithSignerPayload; exports.useSetUpRecovery = useSetUpRecovery; exports.useSignMessage = useSignMessage; exports.useSwitchChain = useSwitchChain; exports.useValidateAddDevice = useValidateAddDevice; exports.useVerifyMessage = useVerifyMessage; exports.useWriteContract = useWriteContract; exports.useWriteContractWithSessionKey = useWriteContractWithSessionKey;

package/dist/index.d.cts

@@ -1,6 +1,6 @@
 import { Address, Transport, Chain, Hash, Hex, Abi, ContractFunctionName, ContractFunctionArgs, Account, DeriveChain, ContractFunctionParameters, GetChainParameter, GetValue, FormattedTransactionRequest, UnionOmit, SignableMessage } from 'viem';
 import { createSafeSmartAccountParameters, ComethSmartAccountClient, SafeSmartAccount, EnrichedOwner, Session, AddSessionKeyParams, Signer, webAuthnOptions, QRCodeOptions, SetUpRecoveryModuleParams, IsRecoveryActiveParams, IsRecoveryActiveReturnType, RecoveryParamsResponse, GetRecoveryRequestParams, CancelRecoveryRequestParams } from '@cometh/connect-sdk-4337';
-import { y, z, O, aI, a3, at, aQ, aK, b } from './hydration-Bnn1iiSg.js';
+import { y, z, O, aI, a3, at, b } from './hydration-Bnn1iiSg.js';
 import React, { ReactNode } from 'react';
 import { ENTRYPOINT_ADDRESS_V07_TYPE, EntryPoint } from 'permissionless/types/entrypoint';
 import { GetAccountParameter } from 'viem/_types/types/account';
@@ -27,19 +27,6 @@ type UseBaseQueryResult<TData = unknown, TError = y> = at<TData, TError>;
 type UseQueryResult<TData = unknown, TError = y> = UseBaseQueryResult<TData, TError>;
 interface UseMutationOptions<TData = unknown, TError = y, TVariables = void, TContext = unknown> extends O<aI<TData, TError, TVariables, TContext>, '_defaulted'> {
 }
-type UseMutateFunction<TData = unknown, TError = y, TVariables = void, TContext = unknown> = (...args: Parameters<aK<TData, TError, TVariables, TContext>>) => void;
-type UseMutateAsyncFunction<TData = unknown, TError = y, TVariables = void, TContext = unknown> = aK<TData, TError, TVariables, TContext>;
-type UseBaseMutationResult<TData = unknown, TError = y, TVariables = unknown, TContext = unknown> = Override<aQ<TData, TError, TVariables, TContext>, {
-    mutate: UseMutateFunction<TData, TError, TVariables, TContext>;
-}> & {
-    mutateAsync: UseMutateAsyncFunction<TData, TError, TVariables, TContext>;
-};
-type UseMutationResult<TData = unknown, TError = y, TVariables = unknown, TContext = unknown> = UseBaseMutationResult<TData, TError, TVariables, TContext>;
-type Override<TTargetA, TTargetB> = {
-    [AKey in keyof TTargetA]: AKey extends keyof TTargetB ? TTargetB[AKey] : TTargetA[AKey];
-};
-
-declare function useMutation<TData = unknown, TError = y, TVariables = void, TContext = unknown>(options: UseMutationOptions<TData, TError, TVariables, TContext>, queryClient?: b): UseMutationResult<TData, TError, TVariables, TContext>;
 
 type NetworkParams = {
     chain?: Chain;
@@ -70,7 +57,7 @@ interface UseAccountResult {
 }
 declare const useAccount: () => UseAccountResult;
 
-type MutationOptionsWithoutMutationFn$1 = Omit<UseMutationOptions<any, any, any, any>, "mutationFn" | "mutationKey">;
+type MutationOptionsWithoutMutationFn = Omit<UseMutationOptions<any, any, any, any>, "mutationFn" | "mutationKey">;
 type Transaction = {
     to: Address;
     value: bigint;
@@ -101,7 +88,6 @@ type SendTransactionMutate = (variables: UseSendTransactionProps) => void;
  * This function returns a promise that resolves to the transaction hash.
  */
 type SendTransactionMutateAsync = (variables: UseSendTransactionProps) => Promise<Hash>;
-type MutationOptionsWithoutMutationFn = Omit<Parameters<typeof useMutation>[0], "mutationFn">;
 type UseSendTransactionReturn = QueryResultType & {
     sendTransaction: SendTransactionMutate;
     sendTransactionAsync: SendTransactionMutateAsync;
@@ -272,7 +258,7 @@ type WriteContractParameters<abi extends Abi | readonly unknown[] = Abi, functio
     /** Data to append to the end of the calldata. Useful for adding a ["domain" tag](https://opensea.notion.site/opensea/Seaport-Order-Attributions-ec2d69bf455041a5baa490941aad307f). */
     dataSuffix?: Hex;
 }> & UnionEvaluate<UnionOmit<FormattedTransactionRequest<derivedChain>, "data" | "from" | "to" | "value">>;
-declare const useWriteContract: (mutationProps?: MutationOptionsWithoutMutationFn$1) => UseWriteContractReturn;
+declare const useWriteContract: (mutationProps?: MutationOptionsWithoutMutationFn) => UseWriteContractReturn;
 
 /**
  * Props for the useSendTransactionWithSessionKey hook.
@@ -310,7 +296,7 @@ type UseSendTransactionWithSessionKeyReturn = QueryResultType & {
  *
  * @throws {Error} If no smart account is found when trying to send a transaction.
  */
-declare const useSendTransactionWithSessionKey: (mutationProps?: MutationOptionsWithoutMutationFn$1) => UseSendTransactionWithSessionKeyReturn;
+declare const useSendTransactionWithSessionKey: (mutationProps?: MutationOptionsWithoutMutationFn) => UseSendTransactionWithSessionKeyReturn;
 
 /**
  * @description A custom hook for writing to smart contracts through a smart account using a session key.
@@ -392,7 +378,7 @@ type WriteContractWithSessionKeyParameters<abi extends Abi | readonly unknown[]
     /** Data to append to the end of the calldata. Useful for adding a ["domain" tag](https://opensea.notion.site/opensea/Seaport-Order-Attributions-ec2d69bf455041a5baa490941aad307f). */
     dataSuffix?: Hex;
 }> & UnionEvaluate<UnionOmit<FormattedTransactionRequest<derivedChain>, "data" | "from" | "to" | "value">>;
-declare const useWriteContractWithSessionKey: (mutationProps?: MutationOptionsWithoutMutationFn$1) => UseWriteContractWithSessionKeyReturn;
+declare const useWriteContractWithSessionKey: (mutationProps?: MutationOptionsWithoutMutationFn) => UseWriteContractWithSessionKeyReturn;
 
 declare const useDisconnect: () => {
     disconnect: () => void;
@@ -516,7 +502,7 @@ type UseValidateAddDeviceReturn = QueryResultType & {
  *
  * @throws {Error} If no smart account is found when trying to validate adding a device.
  */
-declare const useValidateAddDevice: (mutationProps?: MutationOptionsWithoutMutationFn$1) => UseValidateAddDeviceReturn;
+declare const useValidateAddDevice: (mutationProps?: MutationOptionsWithoutMutationFn) => UseValidateAddDeviceReturn;
 
 /**
  * Props for the useVerifyMessage hook.
@@ -562,7 +548,7 @@ type UseVerifyMessageReturn = {
  *
  * @throws {Error} If no smart account is found when trying to verify a signature.
  */
-declare const useVerifyMessage: (mutationProps?: MutationOptionsWithoutMutationFn$1) => UseVerifyMessageReturn;
+declare const useVerifyMessage: (mutationProps?: MutationOptionsWithoutMutationFn) => UseVerifyMessageReturn;
 
 type GasPriceResult = {
     maxFeePerGas: bigint;
@@ -948,4 +934,226 @@ declare const useSwitchChain: () => {
     error: Error | null;
 };
 
-export { ConnectProvider, type SendTransactionMutate, type SendTransactionMutateAsync, type SendTransactionWithSessionKeyMutate, type SendTransactionWithSessionKeyMutateAsync, type UseAddOwnerReturn, type UseAddSessionKeyReturn, type UseAddWhitelistDestinationReturn, type UseRemoveOwnerReturn, type UseRemoveWhitelistDestinationReturn, type UseRetrieveAccountAddressFromPasskeyOptions, type UseRevokeSessionKeyReturn, type VerifyMessageMutate, type VerifyMessageMutateAsync, type WriteContractMutate, type WriteContractMutateAsync, type WriteContractWithSessionKeyMutate, type WriteContractWithSessionKeyMutateAsync, useAccount, useAddOwner, useAddSessionKey, useAddWhitelistDestination, useCancelRecoveryRequest, useConnect, useCreateNewSigner, useDisconnect, useGenerateQRCodeUrl, useGetEnrichedOwners, useGetGasPrice, useGetOwners, useGetRecoveryRequest, useGetSessionFromAddress, useIsAddressWhitelistDestination, useIsRecoveryActive, useRemoveOwner, useRemoveWhitelistDestination, useRetrieveAccountAddressFromPasskeyId, useRetrieveAccountAddressFromPasskeys, useRevokeSessionKey, useSendTransaction, useSendTransactionWithSessionKey, useSerializeUrlWithSignerPayload, useSetUpRecovery, useSignMessage, useSwitchChain, useValidateAddDevice, useVerifyMessage, useWriteContract, useWriteContractWithSessionKey };
+/**
+ * Props for the useGetTransactionCost hook.
+ * @property {Transaction | Transaction[]} transactions - A single transaction or an array of transactions to get cost for.
+ */
+type UseGetTransactionCostProps = {
+    transactions: Transaction | Transaction[];
+};
+/**
+ * Type for the getTransactionCost function.
+ * This function doesn't return a promise, suitable for fire-and-forget usage.
+ */
+type UseGetTransactionCostMutate = (variables: UseGetTransactionCostProps) => void;
+/**
+ * Type for the getTransactionCostAsync function.
+ * This function returns a promise that resolves to the transaction cost in wei.
+ */
+type UseGetTransactionCostMutateAsync = (variables: UseGetTransactionCostProps) => Promise<{
+    totalGasCost: bigint;
+}>;
+type UseGetTransactionCostReturn = {
+    data?: bigint;
+    error: unknown;
+    isPending: boolean;
+    isSuccess: boolean;
+    isError: boolean;
+    getTransactionCost: UseGetTransactionCostMutate;
+    getTransactionCostAsync: UseGetTransactionCostMutateAsync;
+};
+/**
+ * A custom hook for getting transaction costs.
+ *
+ * This hook provides functionality to get gas costs for transactions using the smart account client.
+ * It can handle both single transactions and batched transactions.
+ *
+ * @param mutationProps Optional mutation properties from @tanstack/react-query
+ *
+ * @example
+ * ```tsx
+ * import { useGetTransactionCost } from "@/hooks/useGetTransactionCost";
+ * import { parseEther, type Address } from "viem";
+ *
+ * export const TransactionCost = () => {
+ *   const { getTransactionCost, getTransactionCostAsync, isPending, isError, error, isSuccess, data } = useGetTransactionCost();
+ *
+ *   const handleGetCost = async () => {
+ *     try {
+ *       // Example of getting cost for a single transaction
+ *       const singleTxCost = await getTransactionCostAsync({
+ *         transactions: {
+ *           to: "0x..." as Address,
+ *           value: parseEther("0.1"),
+ *           data: "0x",
+ *         }
+ *       });
+ *       console.log("Transaction cost:", singleTxCost.totalGasCost);
+ *
+ *       // Example of getting cost for multiple transactions
+ *       const batchTxCost = await getTransactionCostAsync({
+ *         transactions: [
+ *           {
+ *             to: "0x..." as Address,
+ *             value: parseEther("0.1"),
+ *             data: "0x",
+ *           },
+ *           {
+ *             to: "0x..." as Address,
+ *             value: parseEther("0.2"),
+ *             data: "0x",
+ *           }
+ *         ]
+ *       });
+ *       console.log("Batch transaction cost:", batchTxCost.totalGasCost);
+ *     } catch (error) {
+ *       console.error("Error getting transaction cost:", error);
+ *     }
+ *   };
+ *
+ *   return (
+ *     <div>
+ *       <button onClick={handleGetCost} disabled={isPending}>
+ *         Get Transaction Cost
+ *       </button>
+ *       {isError && <p>Error: {(error as Error).message}</p>}
+ *       {isSuccess && <p>Transaction cost: {data?.toString()} wei</p>}
+ *     </div>
+ *   );
+ * };
+ * ```
+ *
+ * @returns An object containing:
+ * - `data`: The total transaction cost in wei (as bigint)
+ * - `error`: Any error that occurred during cost calculation
+ * - `isPending`: Whether the calculation is in progress
+ * - `isSuccess`: Whether the calculation was successful
+ * - `isError`: Whether an error occurred
+ * - `getTransactionCost`: A function to trigger cost calculation without waiting for the result
+ * - `getTransactionCostAsync`: A function to trigger cost calculation and wait for the result
+ */
+declare const useGetTransactionCost: (mutationProps?: MutationOptionsWithoutMutationFn) => UseGetTransactionCostReturn;
+
+/**
+ * Props for the useEstimateGas hook.
+ * @property {Transaction | Transaction[]} transactions - A single transaction or an array of transactions to estimate gas for.
+ */
+type UseEstimateGasProps = {
+    transactions: Transaction | Transaction[];
+};
+/**
+ * Gas estimation result type
+ */
+type GasEstimationResult = {
+    callGasLimit: bigint;
+    verificationGasLimit: bigint;
+    preVerificationGas: bigint;
+    maxFeePerGas: bigint;
+    maxPriorityFeePerGas: bigint;
+    paymasterVerificationGasLimit?: bigint;
+    paymasterPostOpGasLimit?: bigint;
+};
+/**
+ * Type for the estimateGas function.
+ * This function doesn't return a promise, suitable for fire-and-forget usage.
+ */
+type EstimateGasMutate = (variables: UseEstimateGasProps) => void;
+/**
+ * Type for the estimateGasAsync function.
+ * This function returns a promise that resolves to the detailed gas estimation.
+ */
+type EstimateGasMutateAsync = (variables: UseEstimateGasProps) => Promise<GasEstimationResult>;
+type UseEstimateGasReturn = {
+    data?: GasEstimationResult;
+    error: unknown;
+    isPending: boolean;
+    isSuccess: boolean;
+    isError: boolean;
+    estimateGas: EstimateGasMutate;
+    estimateGasAsync: EstimateGasMutateAsync;
+};
+/**
+ * A custom hook for estimating detailed gas parameters for transactions.
+ *
+ * This hook provides functionality to estimate various gas parameters for transactions
+ * using the smart account client. It can handle both single transactions and batched transactions.
+ *
+ * @param mutationProps Optional mutation properties from @tanstack/react-query
+ *
+ * @example
+ * ```tsx
+ * import { useEstimateGas } from "@/hooks/useEstimateGas";
+ * import { parseEther, type Address } from "viem";
+ *
+ * export const GasEstimator = () => {
+ *   const { estimateGas, estimateGasAsync, isPending, isError, error, isSuccess, data } = useEstimateGas();
+ *
+ *   const handleEstimateGas = async () => {
+ *     try {
+ *       // Example of estimating gas for a single transaction
+ *       const singleTxEstimate = await estimateGasAsync({
+ *         transactions: {
+ *           to: "0x..." as Address,
+ *           value: parseEther("0.1"),
+ *           data: "0x",
+ *         }
+ *       });
+ *       console.log("Gas limits:", {
+ *         callGas: singleTxEstimate.callGasLimit.toString(),
+ *         verificationGas: singleTxEstimate.verificationGasLimit.toString(),
+ *         preVerificationGas: singleTxEstimate.preVerificationGas.toString(),
+ *       });
+ *
+ *       // Example of estimating gas for multiple transactions
+ *       const batchTxEstimate = await estimateGasAsync({
+ *         transactions: [
+ *           {
+ *             to: "0x..." as Address,
+ *             value: parseEther("0.1"),
+ *             data: "0x",
+ *           },
+ *           {
+ *             to: "0x..." as Address,
+ *             value: parseEther("0.2"),
+ *             data: "0x",
+ *           }
+ *         ]
+ *       });
+ *       console.log("Batch transaction gas parameters:", batchTxEstimate);
+ *     } catch (error) {
+ *       console.error("Error estimating gas:", error);
+ *     }
+ *   };
+ *
+ *   return (
+ *     <div>
+ *       <button onClick={handleEstimateGas} disabled={isPending}>
+ *         Estimate Gas Parameters
+ *       </button>
+ *       {isError && <p>Error: {(error as Error).message}</p>}
+ *       {isSuccess && data && (
+ *         <div>
+ *           <p>Call Gas Limit: {data.callGasLimit.toString()}</p>
+ *           <p>Verification Gas Limit: {data.verificationGasLimit.toString()}</p>
+ *           <p>Pre-verification Gas: {data.preVerificationGas.toString()}</p>
+ *           <p>Max Fee Per Gas: {data.maxFeePerGas.toString()}</p>
+ *           <p>Max Priority Fee Per Gas: {data.maxPriorityFeePerGas.toString()}</p>
+ *         </div>
+ *       )}
+ *     </div>
+ *   );
+ * };
+ * ```
+ *
+ * @returns An object containing:
+ * - `data`: Detailed gas estimation parameters including various gas limits and fees
+ * - `error`: Any error that occurred during estimation
+ * - `isPending`: Whether the estimation is in progress
+ * - `isSuccess`: Whether the estimation was successful
+ * - `isError`: Whether an error occurred
+ * - `estimateGas`: A function to trigger gas estimation without waiting for the result
+ * - `estimateGasAsync`: A function to trigger gas estimation and wait for the result
+ */
+declare const useEstimateGas: (mutationProps?: MutationOptionsWithoutMutationFn) => UseEstimateGasReturn;
+
+export { ConnectProvider, type SendTransactionMutate, type SendTransactionMutateAsync, type SendTransactionWithSessionKeyMutate, type SendTransactionWithSessionKeyMutateAsync, type UseAddOwnerReturn, type UseAddSessionKeyReturn, type UseAddWhitelistDestinationReturn, type UseRemoveOwnerReturn, type UseRemoveWhitelistDestinationReturn, type UseRetrieveAccountAddressFromPasskeyOptions, type UseRevokeSessionKeyReturn, type VerifyMessageMutate, type VerifyMessageMutateAsync, type WriteContractMutate, type WriteContractMutateAsync, type WriteContractWithSessionKeyMutate, type WriteContractWithSessionKeyMutateAsync, useAccount, useAddOwner, useAddSessionKey, useAddWhitelistDestination, useCancelRecoveryRequest, useConnect, useCreateNewSigner, useDisconnect, useEstimateGas, useGenerateQRCodeUrl, useGetEnrichedOwners, useGetGasPrice, useGetOwners, useGetRecoveryRequest, useGetSessionFromAddress, useGetTransactionCost, useIsAddressWhitelistDestination, useIsRecoveryActive, useRemoveOwner, useRemoveWhitelistDestination, useRetrieveAccountAddressFromPasskeyId, useRetrieveAccountAddressFromPasskeys, useRevokeSessionKey, useSendTransaction, useSendTransactionWithSessionKey, useSerializeUrlWithSignerPayload, useSetUpRecovery, useSignMessage, useSwitchChain, useValidateAddDevice, useVerifyMessage, useWriteContract, useWriteContractWithSessionKey };

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { Address, Transport, Chain, Hash, Hex, Abi, ContractFunctionName, ContractFunctionArgs, Account, DeriveChain, ContractFunctionParameters, GetChainParameter, GetValue, FormattedTransactionRequest, UnionOmit, SignableMessage } from 'viem';
 import { createSafeSmartAccountParameters, ComethSmartAccountClient, SafeSmartAccount, EnrichedOwner, Session, AddSessionKeyParams, Signer, webAuthnOptions, QRCodeOptions, SetUpRecoveryModuleParams, IsRecoveryActiveParams, IsRecoveryActiveReturnType, RecoveryParamsResponse, GetRecoveryRequestParams, CancelRecoveryRequestParams } from '@cometh/connect-sdk-4337';
-import { y, z, O, aI, a3, at, aQ, aK, b } from './hydration-Bnn1iiSg.js';
+import { y, z, O, aI, a3, at, b } from './hydration-Bnn1iiSg.js';
 import React, { ReactNode } from 'react';
 import { ENTRYPOINT_ADDRESS_V07_TYPE, EntryPoint } from 'permissionless/types/entrypoint';
 import { GetAccountParameter } from 'viem/_types/types/account';
@@ -27,19 +27,6 @@ type UseBaseQueryResult<TData = unknown, TError = y> = at<TData, TError>;
 type UseQueryResult<TData = unknown, TError = y> = UseBaseQueryResult<TData, TError>;
 interface UseMutationOptions<TData = unknown, TError = y, TVariables = void, TContext = unknown> extends O<aI<TData, TError, TVariables, TContext>, '_defaulted'> {
 }
-type UseMutateFunction<TData = unknown, TError = y, TVariables = void, TContext = unknown> = (...args: Parameters<aK<TData, TError, TVariables, TContext>>) => void;
-type UseMutateAsyncFunction<TData = unknown, TError = y, TVariables = void, TContext = unknown> = aK<TData, TError, TVariables, TContext>;
-type UseBaseMutationResult<TData = unknown, TError = y, TVariables = unknown, TContext = unknown> = Override<aQ<TData, TError, TVariables, TContext>, {
-    mutate: UseMutateFunction<TData, TError, TVariables, TContext>;
-}> & {
-    mutateAsync: UseMutateAsyncFunction<TData, TError, TVariables, TContext>;
-};
-type UseMutationResult<TData = unknown, TError = y, TVariables = unknown, TContext = unknown> = UseBaseMutationResult<TData, TError, TVariables, TContext>;
-type Override<TTargetA, TTargetB> = {
-    [AKey in keyof TTargetA]: AKey extends keyof TTargetB ? TTargetB[AKey] : TTargetA[AKey];
-};
-
-declare function useMutation<TData = unknown, TError = y, TVariables = void, TContext = unknown>(options: UseMutationOptions<TData, TError, TVariables, TContext>, queryClient?: b): UseMutationResult<TData, TError, TVariables, TContext>;
 
 type NetworkParams = {
     chain?: Chain;
@@ -70,7 +57,7 @@ interface UseAccountResult {
 }
 declare const useAccount: () => UseAccountResult;
 
-type MutationOptionsWithoutMutationFn$1 = Omit<UseMutationOptions<any, any, any, any>, "mutationFn" | "mutationKey">;
+type MutationOptionsWithoutMutationFn = Omit<UseMutationOptions<any, any, any, any>, "mutationFn" | "mutationKey">;
 type Transaction = {
     to: Address;
     value: bigint;
@@ -101,7 +88,6 @@ type SendTransactionMutate = (variables: UseSendTransactionProps) => void;
  * This function returns a promise that resolves to the transaction hash.
  */
 type SendTransactionMutateAsync = (variables: UseSendTransactionProps) => Promise<Hash>;
-type MutationOptionsWithoutMutationFn = Omit<Parameters<typeof useMutation>[0], "mutationFn">;
 type UseSendTransactionReturn = QueryResultType & {
     sendTransaction: SendTransactionMutate;
     sendTransactionAsync: SendTransactionMutateAsync;
@@ -272,7 +258,7 @@ type WriteContractParameters<abi extends Abi | readonly unknown[] = Abi, functio
     /** Data to append to the end of the calldata. Useful for adding a ["domain" tag](https://opensea.notion.site/opensea/Seaport-Order-Attributions-ec2d69bf455041a5baa490941aad307f). */
     dataSuffix?: Hex;
 }> & UnionEvaluate<UnionOmit<FormattedTransactionRequest<derivedChain>, "data" | "from" | "to" | "value">>;
-declare const useWriteContract: (mutationProps?: MutationOptionsWithoutMutationFn$1) => UseWriteContractReturn;
+declare const useWriteContract: (mutationProps?: MutationOptionsWithoutMutationFn) => UseWriteContractReturn;
 
 /**
  * Props for the useSendTransactionWithSessionKey hook.
@@ -310,7 +296,7 @@ type UseSendTransactionWithSessionKeyReturn = QueryResultType & {
  *
  * @throws {Error} If no smart account is found when trying to send a transaction.
  */
-declare const useSendTransactionWithSessionKey: (mutationProps?: MutationOptionsWithoutMutationFn$1) => UseSendTransactionWithSessionKeyReturn;
+declare const useSendTransactionWithSessionKey: (mutationProps?: MutationOptionsWithoutMutationFn) => UseSendTransactionWithSessionKeyReturn;
 
 /**
  * @description A custom hook for writing to smart contracts through a smart account using a session key.
@@ -392,7 +378,7 @@ type WriteContractWithSessionKeyParameters<abi extends Abi | readonly unknown[]
     /** Data to append to the end of the calldata. Useful for adding a ["domain" tag](https://opensea.notion.site/opensea/Seaport-Order-Attributions-ec2d69bf455041a5baa490941aad307f). */
     dataSuffix?: Hex;
 }> & UnionEvaluate<UnionOmit<FormattedTransactionRequest<derivedChain>, "data" | "from" | "to" | "value">>;
-declare const useWriteContractWithSessionKey: (mutationProps?: MutationOptionsWithoutMutationFn$1) => UseWriteContractWithSessionKeyReturn;
+declare const useWriteContractWithSessionKey: (mutationProps?: MutationOptionsWithoutMutationFn) => UseWriteContractWithSessionKeyReturn;
 
 declare const useDisconnect: () => {
     disconnect: () => void;
@@ -516,7 +502,7 @@ type UseValidateAddDeviceReturn = QueryResultType & {
  *
  * @throws {Error} If no smart account is found when trying to validate adding a device.
  */
-declare const useValidateAddDevice: (mutationProps?: MutationOptionsWithoutMutationFn$1) => UseValidateAddDeviceReturn;
+declare const useValidateAddDevice: (mutationProps?: MutationOptionsWithoutMutationFn) => UseValidateAddDeviceReturn;
 
 /**
  * Props for the useVerifyMessage hook.
@@ -562,7 +548,7 @@ type UseVerifyMessageReturn = {
  *
  * @throws {Error} If no smart account is found when trying to verify a signature.
  */
-declare const useVerifyMessage: (mutationProps?: MutationOptionsWithoutMutationFn$1) => UseVerifyMessageReturn;
+declare const useVerifyMessage: (mutationProps?: MutationOptionsWithoutMutationFn) => UseVerifyMessageReturn;
 
 type GasPriceResult = {
     maxFeePerGas: bigint;
@@ -948,4 +934,226 @@ declare const useSwitchChain: () => {
     error: Error | null;
 };
 
-export { ConnectProvider, type SendTransactionMutate, type SendTransactionMutateAsync, type SendTransactionWithSessionKeyMutate, type SendTransactionWithSessionKeyMutateAsync, type UseAddOwnerReturn, type UseAddSessionKeyReturn, type UseAddWhitelistDestinationReturn, type UseRemoveOwnerReturn, type UseRemoveWhitelistDestinationReturn, type UseRetrieveAccountAddressFromPasskeyOptions, type UseRevokeSessionKeyReturn, type VerifyMessageMutate, type VerifyMessageMutateAsync, type WriteContractMutate, type WriteContractMutateAsync, type WriteContractWithSessionKeyMutate, type WriteContractWithSessionKeyMutateAsync, useAccount, useAddOwner, useAddSessionKey, useAddWhitelistDestination, useCancelRecoveryRequest, useConnect, useCreateNewSigner, useDisconnect, useGenerateQRCodeUrl, useGetEnrichedOwners, useGetGasPrice, useGetOwners, useGetRecoveryRequest, useGetSessionFromAddress, useIsAddressWhitelistDestination, useIsRecoveryActive, useRemoveOwner, useRemoveWhitelistDestination, useRetrieveAccountAddressFromPasskeyId, useRetrieveAccountAddressFromPasskeys, useRevokeSessionKey, useSendTransaction, useSendTransactionWithSessionKey, useSerializeUrlWithSignerPayload, useSetUpRecovery, useSignMessage, useSwitchChain, useValidateAddDevice, useVerifyMessage, useWriteContract, useWriteContractWithSessionKey };
+/**
+ * Props for the useGetTransactionCost hook.
+ * @property {Transaction | Transaction[]} transactions - A single transaction or an array of transactions to get cost for.
+ */
+type UseGetTransactionCostProps = {
+    transactions: Transaction | Transaction[];
+};
+/**
+ * Type for the getTransactionCost function.
+ * This function doesn't return a promise, suitable for fire-and-forget usage.
+ */
+type UseGetTransactionCostMutate = (variables: UseGetTransactionCostProps) => void;
+/**
+ * Type for the getTransactionCostAsync function.
+ * This function returns a promise that resolves to the transaction cost in wei.
+ */
+type UseGetTransactionCostMutateAsync = (variables: UseGetTransactionCostProps) => Promise<{
+    totalGasCost: bigint;
+}>;
+type UseGetTransactionCostReturn = {
+    data?: bigint;
+    error: unknown;
+    isPending: boolean;
+    isSuccess: boolean;
+    isError: boolean;
+    getTransactionCost: UseGetTransactionCostMutate;
+    getTransactionCostAsync: UseGetTransactionCostMutateAsync;
+};
+/**
+ * A custom hook for getting transaction costs.
+ *
+ * This hook provides functionality to get gas costs for transactions using the smart account client.
+ * It can handle both single transactions and batched transactions.
+ *
+ * @param mutationProps Optional mutation properties from @tanstack/react-query
+ *
+ * @example
+ * ```tsx
+ * import { useGetTransactionCost } from "@/hooks/useGetTransactionCost";
+ * import { parseEther, type Address } from "viem";
+ *
+ * export const TransactionCost = () => {
+ *   const { getTransactionCost, getTransactionCostAsync, isPending, isError, error, isSuccess, data } = useGetTransactionCost();
+ *
+ *   const handleGetCost = async () => {
+ *     try {
+ *       // Example of getting cost for a single transaction
+ *       const singleTxCost = await getTransactionCostAsync({
+ *         transactions: {
+ *           to: "0x..." as Address,
+ *           value: parseEther("0.1"),
+ *           data: "0x",
+ *         }
+ *       });
+ *       console.log("Transaction cost:", singleTxCost.totalGasCost);
+ *
+ *       // Example of getting cost for multiple transactions
+ *       const batchTxCost = await getTransactionCostAsync({
+ *         transactions: [
+ *           {
+ *             to: "0x..." as Address,
+ *             value: parseEther("0.1"),
+ *             data: "0x",
+ *           },
+ *           {
+ *             to: "0x..." as Address,
+ *             value: parseEther("0.2"),
+ *             data: "0x",
+ *           }
+ *         ]
+ *       });
+ *       console.log("Batch transaction cost:", batchTxCost.totalGasCost);
+ *     } catch (error) {
+ *       console.error("Error getting transaction cost:", error);
+ *     }
+ *   };
+ *
+ *   return (
+ *     <div>
+ *       <button onClick={handleGetCost} disabled={isPending}>
+ *         Get Transaction Cost
+ *       </button>
+ *       {isError && <p>Error: {(error as Error).message}</p>}
+ *       {isSuccess && <p>Transaction cost: {data?.toString()} wei</p>}
+ *     </div>
+ *   );
+ * };
+ * ```
+ *
+ * @returns An object containing:
+ * - `data`: The total transaction cost in wei (as bigint)
+ * - `error`: Any error that occurred during cost calculation
+ * - `isPending`: Whether the calculation is in progress
+ * - `isSuccess`: Whether the calculation was successful
+ * - `isError`: Whether an error occurred
+ * - `getTransactionCost`: A function to trigger cost calculation without waiting for the result
+ * - `getTransactionCostAsync`: A function to trigger cost calculation and wait for the result
+ */
+declare const useGetTransactionCost: (mutationProps?: MutationOptionsWithoutMutationFn) => UseGetTransactionCostReturn;
+
+/**
+ * Props for the useEstimateGas hook.
+ * @property {Transaction | Transaction[]} transactions - A single transaction or an array of transactions to estimate gas for.
+ */
+type UseEstimateGasProps = {
+    transactions: Transaction | Transaction[];
+};
+/**
+ * Gas estimation result type
+ */
+type GasEstimationResult = {
+    callGasLimit: bigint;
+    verificationGasLimit: bigint;
+    preVerificationGas: bigint;
+    maxFeePerGas: bigint;
+    maxPriorityFeePerGas: bigint;
+    paymasterVerificationGasLimit?: bigint;
+    paymasterPostOpGasLimit?: bigint;
+};
+/**
+ * Type for the estimateGas function.
+ * This function doesn't return a promise, suitable for fire-and-forget usage.
+ */
+type EstimateGasMutate = (variables: UseEstimateGasProps) => void;
+/**
+ * Type for the estimateGasAsync function.
+ * This function returns a promise that resolves to the detailed gas estimation.
+ */
+type EstimateGasMutateAsync = (variables: UseEstimateGasProps) => Promise<GasEstimationResult>;
+type UseEstimateGasReturn = {
+    data?: GasEstimationResult;
+    error: unknown;
+    isPending: boolean;
+    isSuccess: boolean;
+    isError: boolean;
+    estimateGas: EstimateGasMutate;
+    estimateGasAsync: EstimateGasMutateAsync;
+};
+/**
+ * A custom hook for estimating detailed gas parameters for transactions.
+ *
+ * This hook provides functionality to estimate various gas parameters for transactions
+ * using the smart account client. It can handle both single transactions and batched transactions.
+ *
+ * @param mutationProps Optional mutation properties from @tanstack/react-query
+ *
+ * @example
+ * ```tsx
+ * import { useEstimateGas } from "@/hooks/useEstimateGas";
+ * import { parseEther, type Address } from "viem";
+ *
+ * export const GasEstimator = () => {
+ *   const { estimateGas, estimateGasAsync, isPending, isError, error, isSuccess, data } = useEstimateGas();
+ *
+ *   const handleEstimateGas = async () => {
+ *     try {
+ *       // Example of estimating gas for a single transaction
+ *       const singleTxEstimate = await estimateGasAsync({
+ *         transactions: {
+ *           to: "0x..." as Address,
+ *           value: parseEther("0.1"),
+ *           data: "0x",
+ *         }
+ *       });
+ *       console.log("Gas limits:", {
+ *         callGas: singleTxEstimate.callGasLimit.toString(),
+ *         verificationGas: singleTxEstimate.verificationGasLimit.toString(),
+ *         preVerificationGas: singleTxEstimate.preVerificationGas.toString(),
+ *       });
+ *
+ *       // Example of estimating gas for multiple transactions
+ *       const batchTxEstimate = await estimateGasAsync({
+ *         transactions: [
+ *           {
+ *             to: "0x..." as Address,
+ *             value: parseEther("0.1"),
+ *             data: "0x",
+ *           },
+ *           {
+ *             to: "0x..." as Address,
+ *             value: parseEther("0.2"),
+ *             data: "0x",
+ *           }
+ *         ]
+ *       });
+ *       console.log("Batch transaction gas parameters:", batchTxEstimate);
+ *     } catch (error) {
+ *       console.error("Error estimating gas:", error);
+ *     }
+ *   };
+ *
+ *   return (
+ *     <div>
+ *       <button onClick={handleEstimateGas} disabled={isPending}>
+ *         Estimate Gas Parameters
+ *       </button>
+ *       {isError && <p>Error: {(error as Error).message}</p>}
+ *       {isSuccess && data && (
+ *         <div>
+ *           <p>Call Gas Limit: {data.callGasLimit.toString()}</p>
+ *           <p>Verification Gas Limit: {data.verificationGasLimit.toString()}</p>
+ *           <p>Pre-verification Gas: {data.preVerificationGas.toString()}</p>
+ *           <p>Max Fee Per Gas: {data.maxFeePerGas.toString()}</p>
+ *           <p>Max Priority Fee Per Gas: {data.maxPriorityFeePerGas.toString()}</p>
+ *         </div>
+ *       )}
+ *     </div>
+ *   );
+ * };
+ * ```
+ *
+ * @returns An object containing:
+ * - `data`: Detailed gas estimation parameters including various gas limits and fees
+ * - `error`: Any error that occurred during estimation
+ * - `isPending`: Whether the estimation is in progress
+ * - `isSuccess`: Whether the estimation was successful
+ * - `isError`: Whether an error occurred
+ * - `estimateGas`: A function to trigger gas estimation without waiting for the result
+ * - `estimateGasAsync`: A function to trigger gas estimation and wait for the result
+ */
+declare const useEstimateGas: (mutationProps?: MutationOptionsWithoutMutationFn) => UseEstimateGasReturn;
+
+export { ConnectProvider, type SendTransactionMutate, type SendTransactionMutateAsync, type SendTransactionWithSessionKeyMutate, type SendTransactionWithSessionKeyMutateAsync, type UseAddOwnerReturn, type UseAddSessionKeyReturn, type UseAddWhitelistDestinationReturn, type UseRemoveOwnerReturn, type UseRemoveWhitelistDestinationReturn, type UseRetrieveAccountAddressFromPasskeyOptions, type UseRevokeSessionKeyReturn, type VerifyMessageMutate, type VerifyMessageMutateAsync, type WriteContractMutate, type WriteContractMutateAsync, type WriteContractWithSessionKeyMutate, type WriteContractWithSessionKeyMutateAsync, useAccount, useAddOwner, useAddSessionKey, useAddWhitelistDestination, useCancelRecoveryRequest, useConnect, useCreateNewSigner, useDisconnect, useEstimateGas, useGenerateQRCodeUrl, useGetEnrichedOwners, useGetGasPrice, useGetOwners, useGetRecoveryRequest, useGetSessionFromAddress, useGetTransactionCost, useIsAddressWhitelistDestination, useIsRecoveryActive, useRemoveOwner, useRemoveWhitelistDestination, useRetrieveAccountAddressFromPasskeyId, useRetrieveAccountAddressFromPasskeys, useRevokeSessionKey, useSendTransaction, useSendTransactionWithSessionKey, useSerializeUrlWithSignerPayload, useSetUpRecovery, useSignMessage, useSwitchChain, useValidateAddDevice, useVerifyMessage, useWriteContract, useWriteContractWithSessionKey };

package/dist/index.js

@@ -2265,6 +2265,73 @@ var useSwitchChain = () => {
     error
   };
 };
+
+// src/hooks/useGetTransactionCost.ts
+var useGetTransactionCost = (mutationProps) => {
+  const { smartAccountClient, queryClient } = useSmartAccount();
+  const { mutate, mutateAsync, ...result } = useMutation(
+    {
+      mutationFn: async (variables) => {
+        if (!smartAccountClient) {
+          throw new Error("No smart account found");
+        }
+        const { transactions } = variables;
+        const userOperation = await smartAccountClient.account.buildUserOperation(
+          transactions
+        );
+        const estimateGas = await smartAccountClient.estimateGas({
+          userOperation
+        });
+        const totalGas = estimateGas.preVerificationGas + estimateGas.verificationGasLimit + estimateGas.callGasLimit;
+        return { totalGasCost: totalGas * estimateGas.maxFeePerGas };
+      },
+      ...mutationProps
+    },
+    queryClient
+  );
+  return {
+    data: result.data?.totalGasCost,
+    error: result.error,
+    isPending: result.isPending,
+    isSuccess: result.isSuccess,
+    isError: result.isError,
+    getTransactionCost: mutate,
+    getTransactionCostAsync: mutateAsync
+  };
+};
+
+// src/hooks/useEstimateGas.ts
+var useEstimateGas = (mutationProps) => {
+  const { smartAccountClient, queryClient } = useSmartAccount();
+  const { mutate, mutateAsync, ...result } = useMutation(
+    {
+      mutationFn: async (variables) => {
+        if (!smartAccountClient) {
+          throw new Error("No smart account found");
+        }
+        const { transactions } = variables;
+        const userOperation = await smartAccountClient.account.buildUserOperation(
+          transactions
+        );
+        const estimateGas = await smartAccountClient.estimateGas({
+          userOperation
+        });
+        return estimateGas;
+      },
+      ...mutationProps
+    },
+    queryClient
+  );
+  return {
+    data: result.data,
+    error: result.error,
+    isPending: result.isPending,
+    isSuccess: result.isSuccess,
+    isError: result.isError,
+    estimateGas: mutate,
+    estimateGasAsync: mutateAsync
+  };
+};
 export {
   ConnectProvider,
   useAccount,
@@ -2275,12 +2342,14 @@ export {
   useConnect,
   useCreateNewSigner,
   useDisconnect,
+  useEstimateGas,
   useGenerateQRCodeUrl,
   useGetEnrichedOwners,
   useGetGasPrice,
   useGetOwners,
   useGetRecoveryRequest,
   useGetSessionFromAddress,
+  useGetTransactionCost,
   useIsAddressWhitelistDestination,
   useIsRecoveryActive,
   useRemoveOwner,

package/package.json

@@ -7,7 +7,7 @@
       "url": "https://twitter.com/slovaye"
     }
   ],
-  "version": "0.0.11",
+  "version": "0.0.12-dev.2",
   "description": "React hooks Connect 4337",
   "repository": "https://github.com/cometh-hq/connect-sdk-4337.git",
   "keywords": [
@@ -58,7 +58,7 @@
     "typescript": "^5"
   },
   "dependencies": {
-    "@cometh/connect-sdk-4337": "^0.1.11",
+    "@cometh/connect-sdk-4337": "0.1.1-3.dev-2",
     "permissionless": "0.1.31"
   }
 }