fix: improve fee estimate (#105)

packages/sats-wagmi/package.json

@@ -48,7 +48,7 @@
   },
   "dependencies": {
     "@bitcoin-js/tiny-secp256k1-asmjs": "^2.2.3",
-    "@gobob/bob-sdk": "^2.3.3",
+    "@gobob/bob-sdk": "^2.3.7",
     "@metamask/providers": "^12.0.0",
     "@scure/base": "^1.1.6",
     "@scure/btc-signer": "^1.3.1",

packages/sats-wagmi/src/constants/fee-estimate.ts

@@ -0,0 +1,3 @@
+// Confirmation target for fee estimation in Bitcoin blocks
+
+export const CONFIRMATION_TARGET = 6;

packages/sats-wagmi/src/constants/index.ts

@@ -1 +1,2 @@
 export * from './local-storage';
+export * from './fee-estimate';

packages/sats-wagmi/src/hooks/index.ts

@@ -1,10 +1,11 @@
-export * from './useConnect';
 export * from './useAccount';
-export * from './useDisconnect';
 export * from './useBalance';
-export * from './useFeeRate';
+export * from './useConnect';
+export * from './useDisconnect';
 export * from './useFeeEstimate';
+export * from './useFeeRate';
+export * from './useSendGatewayTransaction';
 export * from './useSendTransaction';
 export * from './useSignMessage';
-export * from './useSendGatewayTransaction';
+export * from './useUtxos';
 export * from './useWaitForTransactionReceipt';

packages/sats-wagmi/src/hooks/useFeeEstimate.tsx

@@ -3,30 +3,49 @@
 import { estimateTxFee } from '@gobob/bob-sdk';
 import { UndefinedInitialDataOptions, useQuery } from '@tanstack/react-query';
 
+import { CONFIRMATION_TARGET } from '../constants';
 import { INTERVAL } from '../utils';
 import { useSatsWagmi } from '../provider';
 
 import { useFeeRate } from './useFeeRate';
+import { useAccount } from './useAccount';
 
 type UseFeeEstimateProps = {
-  query?: Omit<UndefinedInitialDataOptions<bigint, Error, bigint, (string | undefined)[]>, 'queryKey' | 'queryFn'>;
+  query?: Omit<
+    UndefinedInitialDataOptions<bigint, Error, bigint, (string | number | undefined)[]>,
+    'queryKey' | 'queryFn'
+  >;
+  amount?: number;
+  opReturnData?: string;
+  confirmationTarget?: number;
 };
 
-const useFeeEstimate = ({ query }: UseFeeEstimateProps = {}) => {
-  const { data: feeRate } = useFeeRate();
+const useFeeEstimate = ({
+  amount,
+  opReturnData,
+  confirmationTarget = CONFIRMATION_TARGET,
+  query
+}: UseFeeEstimateProps = {}) => {
+  const { address, publicKey } = useAccount();
+  const { data: feeRate } = useFeeRate({ confirmationTarget });
   const { network } = useSatsWagmi();
 
+  const enabled = Boolean(feeRate && address && (query?.enabled !== undefined ? query.enabled : true));
+
   return useQuery({
-    queryKey: ['sats-fee-estimate', network, feeRate?.toString()],
+    queryKey: ['sats-fee-estimate', amount, address, opReturnData, network, feeRate?.toString(), confirmationTarget],
     queryFn: async () => {
-      const feeEstimate = estimateTxFee(Number(feeRate));
+      if (!address || !feeRate || !publicKey) {
+        throw new Error('Failed to estimate fee');
+      }
 
-      return BigInt(feeEstimate);
+      return estimateTxFee(address, amount, publicKey, opReturnData, Number(feeRate), confirmationTarget);
     },
     refetchOnWindowFocus: false,
     refetchOnMount: false,
     refetchInterval: INTERVAL.MINUTE,
-    ...query
+    ...query,
+    enabled
   });
 };
 

packages/sats-wagmi/src/hooks/useFeeRate.tsx

@@ -3,26 +3,24 @@
 import { EsploraClient } from '@gobob/bob-sdk';
 import { UndefinedInitialDataOptions, useQuery } from '@tanstack/react-query';
 
+import { CONFIRMATION_TARGET } from '../constants';
 import { INTERVAL } from '../utils';
 import { useSatsWagmi } from '../provider';
 
-// Confirmation target for fee estimation in Bitcoin blocks
-export const CONFIRMATION_TARGET = 3;
-
 type UseFeeRateProps = {
-  confirmations?: number;
-  query?: Omit<UndefinedInitialDataOptions<bigint, Error, bigint, string[]>, 'queryKey' | 'queryFn'>;
+  confirmationTarget?: number;
+  query?: Omit<UndefinedInitialDataOptions<bigint, Error, bigint, (string | number)[]>, 'queryKey' | 'queryFn'>;
 };
 
-const useFeeRate = ({ query, confirmations = CONFIRMATION_TARGET }: UseFeeRateProps = {}) => {
+const useFeeRate = ({ query, confirmationTarget = CONFIRMATION_TARGET }: UseFeeRateProps = {}) => {
   const { network } = useSatsWagmi();
 
   return useQuery({
-    queryKey: ['sats-fee-rate', network],
+    queryKey: ['sats-fee-rate', confirmationTarget, network],
     queryFn: async () => {
       const esploraClient = new EsploraClient(network);
 
-      const feeRate = await esploraClient.getFeeEstimate(confirmations);
+      const feeRate = await esploraClient.getFeeEstimate(confirmationTarget);
 
       return BigInt(Math.ceil(feeRate));
     },

packages/sats-wagmi/src/hooks/useUtxos.tsx

@@ -0,0 +1,42 @@
+'use client';
+
+import { UndefinedInitialDataOptions, useQuery } from '@tanstack/react-query';
+import { EsploraClient, UTXO } from '@gobob/bob-sdk';
+
+import { INTERVAL } from '../utils';
+import { useSatsWagmi } from '../provider';
+
+import { useAccount } from './useAccount';
+
+type UseUTXOSProps = {
+  query?: Omit<
+    UndefinedInitialDataOptions<UTXO[], Error, UTXO[], (string | number | undefined)[]>,
+    'queryKey' | 'queryFn'
+  >;
+  confirmed?: boolean;
+};
+
+const useUtxos = ({ query, confirmed }: UseUTXOSProps = {}) => {
+  const { address } = useAccount();
+  const { network } = useSatsWagmi();
+
+  return useQuery({
+    queryKey: ['sats-utxos', confirmed ? 'confirmed' : 'all', address, network],
+    queryFn: async () => {
+      if (!address) {
+        throw new Error('Failed to get utxos');
+      }
+      const esploraClient = new EsploraClient(network);
+
+      return esploraClient.getAddressUtxos(address, confirmed);
+    },
+    refetchOnWindowFocus: false,
+    refetchOnMount: false,
+    refetchInterval: INTERVAL.SECONDS_30,
+    ...query,
+    enabled: Boolean(address && (query?.enabled !== undefined ? query.enabled : true))
+  });
+};
+
+export { useUtxos };
+export type { UseUTXOSProps };