refactor(evm): btc bridge api update

apps/evm/.env.example

@@ -10,3 +10,9 @@ VITE_FEATURE_FLAG_BTC_ONRAMP=disabled
 VITE_INDEXER_BRIDGE_URL=""
 VITE_SENTRY_URL=""
 VITE_SENTRY_AUTH_TOKEN=""
+
+
+/* MAINNET */
+VITE_ONRAMP_API_URL="https://onramp-api-mainnet.gobob.xyz"
+VITE_BTC_API_URL="https://btc-mainnet.gobob.xyz"
+VITE_L1_CHAIN_NAME="ethereum"

apps/evm/package.json

@@ -15,6 +15,7 @@
   "dependencies": {
     "@eth-optimism/sdk": "^3.1.6",
     "@ethersproject/providers": "^5.7.2",
+    "@gobob/bob-sdk": "1.3.0",
     "@gobob/chains": "workspace:^",
     "@gobob/connect-ui": "workspace:^",
     "@gobob/currency": "workspace:^",

apps/evm/src/lib/bob-sdk/gateway.ts

@@ -0,0 +1,5 @@
+import { GatewayApiClient } from '@gobob/bob-sdk';
+
+const gatewayClient = new GatewayApiClient('/onramp-api');
+
+export { gatewayClient };

apps/evm/src/lib/bob-sdk/index.ts

@@ -0,0 +1 @@
+export * from './gateway';

apps/evm/src/lib/react-query/keys.ts

@@ -43,8 +43,7 @@ export const bridgeKeys = {
   proveTransaction: (address: Address | undefined, hash: Address) => [address, hash, 'prove'],
   relayTransaction: (address: Address | undefined, hash: Address) => [address, hash, 'relay'],
   btc: (address: Address | undefined, btcAddress: string | undefined) => ['btc', address, btcAddress],
-  btcTotalLiquidity: () => ['btc-total-liquidity'],
-  btcQuote: (address: Address | undefined, btcAddress: string | undefined, atomicAmount: number | undefined) => [
+  btcQuote: (address: Address | undefined, btcAddress: string | undefined, atomicAmount?: number | 'max') => [
     ...bridgeKeys.btc(address, btcAddress),
     atomicAmount,
     'quote'

apps/evm/src/pages/Bridge/components/BridgeForm/BtcBridgeForm.tsx

@@ -28,10 +28,10 @@ import {
   bridgeSchema
 } from '../../../../lib/form/bridge';
 import { isFormDisabled } from '../../../../lib/form/utils';
-import { onRampApiClient } from '../../../../utils';
 import { useGetTransactions } from '../../hooks';
 import { OnRampData } from '../../types';
 import { bridgeKeys } from '../../../../lib/react-query';
+import { gatewayClient } from '../../../../lib/bob-sdk';
 
 type BtcBridgeFormProps = {
   type: 'deposit' | 'withdraw';
@@ -41,7 +41,7 @@ type BtcBridgeFormProps = {
   onFailOnRamp: () => void;
 };
 
-const MIN_DEPOSIT_AMOUNT = 40000;
+const MIN_DEPOSIT_AMOUNT = 4000;
 
 const gasEstimatePlaceholder = CurrencyAmount.fromRawAmount(BITCOIN, 0n);
 
@@ -87,18 +87,18 @@ const BtcBridgeForm = ({
     toast.error(e.message);
   }, []);
 
-  const { data: availableLiquidity, isLoading: isLoadingLiquidity } = useQuery({
+  const { data: availableLiquidity, isLoading: isLoadingMaxQuote } = useQuery({
     enabled: Boolean(btcToken),
-    queryKey: bridgeKeys.btcTotalLiquidity(),
+    queryKey: bridgeKeys.btcQuote(evmAddress, btcAddress, 'max'),
     refetchInterval: INTERVAL.MINUTE,
     refetchOnMount: false,
     refetchOnWindowFocus: false,
     queryFn: async () => {
       if (!currencyAmount || !btcToken) return;
 
-      const total = await onRampApiClient.getTotalLiquidity(btcToken.raw.address);
+      const maxQuoteData = await gatewayClient.getQuote(btcToken.raw.address);
 
-      return CurrencyAmount.fromRawAmount(BITCOIN, total);
+      return CurrencyAmount.fromRawAmount(BITCOIN, maxQuoteData.satoshis);
     }
   });
 
@@ -133,7 +133,7 @@ const BtcBridgeForm = ({
 
       const atomicAmount = currencyAmount.numerator.toString();
 
-      const { fee, onramp_address, bitcoin_address, gratuity } = await onRampApiClient.getQuote(
+      const { fee, onramp_address, bitcoin_address, gratuity } = await gatewayClient.getQuote(
         btcToken.raw.address,
         atomicAmount
       );
@@ -185,12 +185,12 @@ const BtcBridgeForm = ({
 
       const atomicAmount = Number(currencyAmount.numerator);
 
-      const orderId = await onRampApiClient.createOrder(onrampAddress, evmAddress, atomicAmount);
+      const orderId = await gatewayClient.createOrder(onrampAddress, evmAddress, atomicAmount);
 
       const tx = await connector.createTxWithOpReturn(bitcoinAddress, atomicAmount, evmAddress);
 
       // NOTE: relayer should broadcast the tx
-      await onRampApiClient.updateOrder(orderId, tx.toHex());
+      await gatewayClient.updateOrder(orderId, tx.toHex());
 
       return { ...data, txid: tx.getId() };
     },
@@ -220,7 +220,7 @@ const BtcBridgeForm = ({
 
     if (type === 'deposit') {
       return depositMutation.mutate({
-        onrampAddress: quoteData.onrampAddress,
+        onrampAddress: quoteData.onrampAddress as Address,
         bitcoinAddress: quoteData.bitcoinAddress,
         evmAddress: (data[BRIDGE_RECIPIENT] as Address) || evmAddress,
         currencyAmount
@@ -267,7 +267,10 @@ const BtcBridgeForm = ({
 
   const params: BridgeFormValidationParams = {
     [BRIDGE_AMOUNT]: {
-      minAmount: currencyAmount && new Big(MIN_DEPOSIT_AMOUNT / 10 ** currencyAmount?.currency.decimals),
+      minAmount:
+        currencyAmount && MIN_DEPOSIT_AMOUNT
+          ? new Big(MIN_DEPOSIT_AMOUNT / 10 ** currencyAmount?.currency.decimals)
+          : undefined,
       maxAmount: new Big(balanceAmount.toExact())
     },
     [BRIDGE_RECIPIENT]: !!isSmartAccount
@@ -289,7 +292,7 @@ const BtcBridgeForm = ({
   const isTapRootAddress = btcAddressType === BtcAddressType.p2tr;
 
   const isDisabled =
-    isSubmitDisabled || !quoteData || isQuoteError || isTapRootAddress || isLoadingLiquidity || !hasLiquidity;
+    isSubmitDisabled || !quoteData || isQuoteError || isTapRootAddress || isLoadingMaxQuote || !hasLiquidity;
 
   const isLoading = !isSubmitDisabled && (depositMutation.isPending || isFetchingQuote);
 
@@ -361,7 +364,7 @@ const BtcBridgeForm = ({
           </P>
         </Alert>
       )}
-      {!hasLiquidity && !isLoadingLiquidity && (
+      {!hasLiquidity && !isLoadingMaxQuote && (
         <Alert status='warning'>
           <P size='s'>There is currently no available liquidity to onramp BTC into {btcToken?.currency.symbol}.</P>
         </Alert>

apps/evm/src/pages/Bridge/hooks/useGetOnRampTransactions.ts

@@ -6,9 +6,10 @@ import { Address, isAddressEqual } from 'viem';
 
 import { L2_CHAIN } from '../../../constants';
 import { FeatureFlags, TokenData, useFeatureFlag, useTokens } from '../../../hooks';
-import { electrsClient, onRampApiClient } from '../../../utils';
+import { electrsClient } from '../../../utils';
 import { OnRampDepositSteps } from '../constants';
 import { TransactionType } from '../types';
+import { gatewayClient } from '../../../lib/bob-sdk';
 
 type OnRampTransaction = {
   status: OnRampDepositSteps;
@@ -21,12 +22,12 @@ type OnRampTransaction = {
 };
 
 const getOnRampTransactions = async (address: Address, l2Tokens: TokenData[]): Promise<OnRampTransaction[]> => {
-  const [orders, latestBlock] = await Promise.all([onRampApiClient.getOrders(address), electrsClient.getLatestBlock()]);
+  const [orders, latestBlock] = await Promise.all([gatewayClient.getOrders(address), electrsClient.getLatestBlock()]);
 
   return (
     await Promise.all(
       orders.map(async (order): Promise<OnRampTransaction | undefined> => {
-        const token = l2Tokens.find((token) => isAddressEqual(token.raw.address, order.token_address));
+        const token = l2Tokens.find((token) => isAddressEqual(token.raw.address, order.token_address as Address));
 
         if (!token) return undefined;
 

apps/evm/src/utils/index.ts

@@ -1,4 +1,3 @@
 export * from './api-client';
 export * from './electrs-client';
-export * from './onramp-api-client';
 export * from './math';

packages/sats-wagmi/package.json

@@ -45,7 +45,7 @@
   },
   "dependencies": {
     "@bitcoin-js/tiny-secp256k1-asmjs": "^2.2.3",
-    "@gobob/bob-sdk": "^1.2.0",
+    "@gobob/bob-sdk": "^1.3.0",
     "@gobob/react-query": "workspace:^",
     "@gobob/types": "workspace:^",
     "@gobob/utils": "workspace:^",

packages/sats-wagmi/src/connectors/base.ts

@@ -1,4 +1,4 @@
-import { DefaultElectrsClient, RemoteSigner } from '@gobob/bob-sdk';
+import { DefaultEsploraClient, RemoteSigner } from '@gobob/bob-sdk';
 import { Network as LibNetwork, Psbt, Transaction, networks } from 'bitcoinjs-lib';
 import * as bitcoin from 'bitcoinjs-lib';
 import retry from 'async-retry';
@@ -126,7 +126,7 @@ abstract class SatsConnector {
 
     // const network = await this.getNetwork();
 
-    // const electrsClient = new DefaultElectrsClient(this.network as string);
+    // const electrsClient = new DefaultEsploraClient(this.network as string);
 
     // const utxos = await electrsClient.getAddressUtxos(this.ordinalsAddress);
 
@@ -176,7 +176,7 @@ abstract class SatsConnector {
   }
 
   async getTransaction(txId: string): Promise<Transaction> {
-    const electrsClient = new DefaultElectrsClient(this.network as string);
+    const electrsClient = new DefaultEsploraClient(this.network as string);
 
     return retry(
       async (bail) => {
@@ -205,7 +205,7 @@ abstract class SatsConnector {
     //   throw new Error('Something went wrong while connecting');
     // }
 
-    // const electrsClient = new DefaultElectrsClient(this.network as string);
+    // const electrsClient = new DefaultEsploraClient(this.network as string);
 
     // let inscription;
 

packages/sats-wagmi/src/connectors/mm-snap.ts

@@ -174,7 +174,7 @@ class MMSnapConnector extends SatsConnector {
   //     throw new Error('Public key missing');
   //   }
 
-  //   const electrsClient = new DefaultElectrsClient(this.network as string);
+  //   const electrsClient = new DefaultEsploraClient(this.network as string);
 
   //   const libNetwork = await this.getNetwork();
   //   const network = this.network.toString();
@@ -271,7 +271,7 @@ class MMSnapConnector extends SatsConnector {
   // const libNetwork = await this.getNetwork();
   // const senderAddress = bitcoin.payments.p2wpkh({ pubkey, network: libNetwork }).address!;
 
-  // const electrsClient = new DefaultElectrsClient(this.network as string);
+  // const electrsClient = new DefaultEsploraClient(this.network as string);
 
   // const utxos = await electrsClient.getAddressUtxos(senderAddress);
   // const inscriptionUtxo = await findUtxoForInscriptionId(electrsClient, utxos, inscriptionId);

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

@@ -1,4 +1,4 @@
-import { DefaultElectrsClient } from '@gobob/bob-sdk';
+import { DefaultEsploraClient } from '@gobob/bob-sdk';
 import { CONFIRMATION_TARGET } from '@gobob/utils';
 import { INTERVAL, UndefinedInitialDataOptions, useQuery } from '@gobob/react-query';
 
@@ -15,7 +15,7 @@ const useFeeRate = ({ query, confirmations = CONFIRMATION_TARGET }: UseFeeRatePr
   return useQuery({
     queryKey: ['sats-fee-rate', network],
     queryFn: async () => {
-      const electrsClient = new DefaultElectrsClient(network);
+      const electrsClient = new DefaultEsploraClient(network);
 
       const feeRate = await electrsClient.getFeeEstimate(confirmations);
 

packages/utils/package.json

@@ -36,7 +36,7 @@
     "vitest": "^1.5.2"
   },
   "dependencies": {
-    "@gobob/bob-sdk": "^1.2.0",
+    "@gobob/bob-sdk": "^1.3.0",
     "@scure/base": "^1.1.6",
     "@scure/btc-signer": "^1.3.1",
     "bitcoin-address-validation": "^2.2.3",

packages/utils/src/inscription.ts

@@ -1,4 +1,4 @@
-import { ElectrsClient } from '@gobob/bob-sdk';
+import { EsploraClient } from '@gobob/bob-sdk';
 import * as bitcoin from 'bitcoinjs-lib';
 import { InscriptionId } from '@gobob/bob-sdk/dist/ordinal-api';
 
@@ -92,8 +92,8 @@ export function parseInscriptions(tx: bitcoin.Transaction) {
   return inscriptions;
 }
 
-export async function getTxInscriptions(electrsClient: ElectrsClient, txid: string) {
-  const txHex = await electrsClient.getTransactionHex(txid);
+export async function getTxInscriptions(esploraClient: EsploraClient, txid: string) {
+  const txHex = await esploraClient.getTransactionHex(txid);
   const tx = bitcoin.Transaction.fromHex(txHex);
 
   return parseInscriptions(tx);
@@ -116,9 +116,9 @@ export function createImageInscription(image: Buffer) {
   return { contentType, content: image };
 }
 
-export async function getInscriptionFromId(electrsClient: ElectrsClient, inscriptionId: string) {
+export async function getInscriptionFromId(esploraClient: EsploraClient, inscriptionId: string) {
   const { txid, index } = InscriptionId.fromString(inscriptionId);
-  const inscriptions = await getTxInscriptions(electrsClient, txid);
+  const inscriptions = await getTxInscriptions(esploraClient, txid);
 
   return inscriptions[index];
 }