feat: add confirmSend for unified send flow (#533)

Author: orestiseth

packages/snap/integration-test/blockchain-utils.ts

@@ -1,6 +1,7 @@
 /* eslint-disable import-x/no-nodejs-modules */
 import { execSync } from 'child_process';
 import process from 'process';
+
 /* eslint-enable import-x/no-nodejs-modules */
 
 /**
@@ -136,4 +137,41 @@ export class BlockchainTestUtils {
 
     await this.#waitForEsploraHeight(targetHeight);
   }
+
+  /**
+   * Get the balance of a Bitcoin address in satoshis
+   *
+   * @param address - The Bitcoin address to query
+   * @returns The balance in satoshis
+   */
+  async getBalance(address: string): Promise<bigint> {
+    try {
+      const response = await fetch(
+        `${this.#esploraBaseUrl}/address/${address}`,
+      );
+      if (!response.ok) {
+        throw new Error(`Failed to get address info: ${response.statusText}`);
+      }
+
+      const addressInfo = await response.json();
+      const funded = BigInt(addressInfo.chain_stats.funded_txo_sum ?? 0);
+      const spent = BigInt(addressInfo.chain_stats.spent_txo_sum ?? 0);
+      return funded - spent;
+    } catch (error) {
+      throw new Error(
+        `Failed to get balance for address ${address}: ${String(error)}`,
+      );
+    }
+  }
+
+  /**
+   * Get the balance of a Bitcoin address in BTC
+   *
+   * @param address - The Bitcoin address to query
+   * @returns The balance in BTC as a number
+   */
+  async getBalanceInBTC(address: string): Promise<number> {
+    const balanceSats = await this.getBalance(address);
+    return Number(balanceSats) / 100_000_000;
+  }
 }

packages/snap/integration-test/client-request.test.ts

@@ -245,4 +245,176 @@ describe('OnClientRequestHandler', () => {
       errors: [{ code: 'Invalid' }],
     });
   });
+
+  it('missing accountId for onAddressInput', async () => {
+    const response = await snap.onClientRequest({
+      method: 'onAddressInput',
+      params: {
+        value: 'tb1qrn9d5qewjqq5syc4nrjprkfq8gge0cjdaznwcn',
+      },
+    });
+
+    expect(response).toRespondWithError({
+      code: -32000,
+      message:
+        'Invalid format: At path: accountId -- Expected a string, but received: undefined',
+      stack: expect.anything(),
+    });
+  });
+
+  describe('confirmSend', () => {
+    it('creates a transaction without broadcasting', async () => {
+      const response = await snap.onClientRequest({
+        method: 'confirmSend',
+        params: {
+          fromAccountId: account.id,
+          toAddress: TEST_ADDRESS_REGTEST,
+          assetId: Caip19Asset.Regtest,
+          amount: '0.001', // 0.001 BTC
+        },
+      });
+
+      expect(response).toRespondWith({
+        type: 'send',
+        id: expect.any(String),
+        account: account.id,
+        chain: BtcScope.Regtest,
+        status: 'unconfirmed',
+        timestamp: expect.any(Number),
+        events: [
+          {
+            status: 'unconfirmed',
+            timestamp: expect.any(Number),
+          },
+        ],
+        to: [
+          {
+            address: TEST_ADDRESS_REGTEST,
+            asset: {
+              amount: '0.001', // BTC amount
+              fungible: true,
+              unit: CurrencyUnit.Regtest,
+              type: Caip19Asset.Regtest,
+            },
+          },
+        ],
+        from: [],
+        fees: [
+          {
+            type: FeeType.Priority,
+            asset: {
+              amount: expect.any(String),
+              fungible: true,
+              unit: CurrencyUnit.Regtest,
+              type: Caip19Asset.Regtest,
+            },
+          },
+        ],
+      });
+    });
+
+    it('fails with invalid account ID', async () => {
+      const response = await snap.onClientRequest({
+        method: 'confirmSend',
+        params: {
+          fromAccountId: 'not-a-uuid',
+          toAddress: TEST_ADDRESS_REGTEST,
+          assetId: Caip19Asset.Regtest,
+          amount: '0.001',
+        },
+      });
+
+      expect(response).toRespondWithError({
+        code: -32000,
+        message: expect.stringContaining('Expected a string matching'),
+        stack: expect.anything(),
+      });
+    });
+
+    it('fails with invalid address', async () => {
+      const response = await snap.onClientRequest({
+        method: 'confirmSend',
+        params: {
+          fromAccountId: account.id,
+          toAddress: 'invalid-address',
+          assetId: Caip19Asset.Regtest,
+          amount: '0.001',
+        },
+      });
+
+      expect(response).toRespondWith({
+        errors: [{ code: 'Invalid' }],
+        valid: false,
+      });
+    });
+
+    it('fails with invalid amount', async () => {
+      const response = await snap.onClientRequest({
+        method: 'confirmSend',
+        params: {
+          fromAccountId: account.id,
+          toAddress: TEST_ADDRESS_REGTEST,
+          assetId: Caip19Asset.Regtest,
+          amount: '-0.001', // negative amount
+        },
+      });
+
+      expect(response).toRespondWith({
+        errors: [{ code: 'Invalid' }],
+        valid: false,
+      });
+    });
+
+    it('fails with insufficient funds', async () => {
+      const response = await snap.onClientRequest({
+        method: 'confirmSend',
+        params: {
+          fromAccountId: account.id,
+          toAddress: TEST_ADDRESS_REGTEST,
+          assetId: Caip19Asset.Regtest,
+          amount: '1000', // 1000 BTC - more than available
+        },
+      });
+
+      expect(response).toRespondWith({
+        errors: [{ code: 'InsufficientBalance' }],
+        valid: false,
+      });
+    });
+
+    it('fails with insufficient funds to pay fees', async () => {
+      const balanceBtc = await blockchain.getBalanceInBTC(account.address);
+
+      const response = await snap.onClientRequest({
+        method: 'confirmSend',
+        params: {
+          fromAccountId: account.id,
+          toAddress: TEST_ADDRESS_REGTEST,
+          assetId: Caip19Asset.Regtest,
+          amount: balanceBtc.toString(),
+        },
+      });
+
+      expect(response).toRespondWith({
+        errors: [{ code: 'InsufficientBalanceToCoverFee' }],
+        valid: false,
+      });
+    });
+
+    it('fails with missing parameters', async () => {
+      const response = await snap.onClientRequest({
+        method: 'confirmSend',
+        params: {
+          fromAccountId: account.id,
+          // missing toAddress, assetId, amount
+        } as any,
+      });
+
+      expect(response).toRespondWithError({
+        code: -32000,
+        message: expect.stringContaining('At path:'),
+        stack: expect.anything(),
+      });
+    });
+  });
 });