[BTC] Tx crafting

package.json

@@ -31,6 +31,7 @@
     "bech32": "^2.0.0",
     "bignumber.js": "^9.1.2",
     "bitcoinjs-lib": "^6.1.6",
+    "coinselect": "^3.1.13",
     "cosmjs-types": "^0.9.0",
     "hi-base32": "^0.5.1",
     "js-sha512": "^0.8.0",
@@ -56,5 +57,10 @@
     "ts-node": "^10.4.0",
     "tsconfig-paths": "^4.2.0",
     "typescript": "^5"
+  },
+  "pnpm": {
+    "patchedDependencies": {
+      "coinselect@3.1.13": "patches/coinselect@3.1.13.patch"
+    }
   }
 }

patches/coinselect@3.1.13.patch

@@ -0,0 +1,43 @@
+diff --git a/index.d.ts b/index.d.ts
+new file mode 100644
+index 0000000..20cc98a
+--- /dev/null
++++ b/index.d.ts
+@@ -0,0 +1,25 @@
++export interface UTXO {
++  txid: string | Buffer;
++  vout: number;
++  value: number;
++  nonWitnessUtxo?: Buffer;
++  witnessUtxo?: {
++    script: Buffer;
++    value: number;
++  };
++}
++export interface Target {
++  address?: string;
++  value: number;
++}
++export interface SelectedUTXO {
++  inputs?: UTXO[];
++  outputs?: Target[];
++  fee: number;
++}
++
++export default function coinSelect(
++  utxos: UTXO[],
++  outputs: Target[],
++  feeRate: number
++): SelectedUTXO;
+diff --git a/package.json b/package.json
+index 6cdef00..337bf4f 100644
+--- a/package.json
++++ b/package.json
+@@ -31,6 +31,7 @@
+     "utils.js"
+   ],
+   "main": "index.js",
++  "types": "index.d.ts",
+   "repository": {
+     "type": "git",
+     "url": "https://github.com/bitcoinjs/coinselect.git"

src/app/api/schemaCommon.ts

@@ -62,7 +62,7 @@ const positiveBigintSchema = z
   .or(toNumber)
   .transform((data) => BigInt(data))
   .openapi({
-    type: "string"
+    type: "string",
   });
 
 const recipientSchema = z.object({
@@ -204,7 +204,7 @@ const transactionDataSchema = z
           case ChainFeature.TRANSACTIONS_TO_MANY:
             return [TransactionMode.TRANSFER_TO_MANY];
           default:
-            return []; // filter out features that don't concern transac
+            return []; // filter out features that don't concern transactions
         }
       });
       // idea of how we could have generic errors for features, for all chains
@@ -220,15 +220,6 @@ const transactionDataSchema = z
   // async validation of addresses
   .superRefine(async (data, ctx) => {
     if (data.mode === TransactionMode.TRANSFER_TO_MANY) {
-      if (data.chainId != ChainId.BITCOIN && data.chainId != ChainId.BITCOIN_TESTNET) {
-        ctx.addIssue({
-          code: z.ZodIssueCode.custom,
-          message: `TransferToMany is not supported for ${data.chainId}`,
-          fatal: true,
-        });
-        return z.NEVER;
-      }
-
       const validSender = await getService(data.chainId).validateAddress(data.sender);
       if (!validSender) {
         ctx.addIssue({

src/app/api/transaction/txSchemaCommon.ts

@@ -1,6 +1,5 @@
 import { z } from "zod";
 import { transactionDataSchema } from "../schemaCommon";
-import { SchemaObject } from "node_modules/zod-openapi/lib-types/openapi3-ts/dist/oas31";
 
 const newTransactionSchema = z
   .object({

src/app/families/bitcoin/backend/explorer.ts

@@ -8,7 +8,7 @@ const queryParams = new URLSearchParams({
   key: BLOCKCHAIR_API_KEY,
 });
 
-export async function fetchXpubBalances(chainId: ChainId, xpub: Xpub) {
+export async function fetchXpubData(chainId: ChainId, xpub: Xpub) {
   const explorerURL = CHAINS[chainId].backends.explorerURL;
 
   const url = `/dashboards/xpub/${xpub}?${queryParams.toString()}`;
@@ -45,8 +45,8 @@ export async function fetchAddressesBalances(chainId: ChainId, addresses: string
   return result.data;
 }
 
-export async function pushTransaction(chaindId: ChainId, signedTransaction: string): Promise<string> {
-  const explorerURL = CHAINS[chaindId].backends.explorerURL;
+export async function pushTransaction(chainId: ChainId, signedTransaction: string): Promise<string> {
+  const explorerURL = CHAINS[chainId].backends.explorerURL;
 
   queryParams.set("data", signedTransaction);
   const url = `/push/transaction?${queryParams.toString()}`;
@@ -64,4 +64,75 @@ export async function pushTransaction(chaindId: ChainId, signedTransaction: stri
   return responseBody.data.transaction_hash;
 }
 
+export async function fetchFeePerByte(chainId: ChainId): Promise<number> {
+  const explorerURL = CHAINS[chainId].backends.explorerURL;
+
+  const url = `/stats?${queryParams.toString()}`;
+
+  const response = await fetch(explorerURL + url);
+
+  // TODO: add zod validation
+  const responseBody = await response.json();
+
+  if (responseBody.context.code !== 200) {
+    throw new Error(`fetchNetworkInformations - received invalid response: ${responseBody.context.error}`);
+  }
+
+  return responseBody.data.suggested_transaction_fee_per_byte_sat;
+}
+
+export async function fetchTxMetadata(
+  chainId: ChainId,
+  txHash: string
+): Promise<{
+  [key: string]: {
+    has_witness: boolean;
+    outputs: [
+      {
+        index: number;
+        script_hex: string;
+        // ... other fields are not used for now
+      }
+    ];
+    // ... other fields are not used for now
+  };
+}> {
+  const explorerURL = CHAINS[chainId].backends.explorerURL;
+  const url = `/dashboards/transaction/${txHash}?${queryParams.toString()}`;
+
+  const response = await fetch(explorerURL + url);
+
+  const responseBody = await response.json();
+
+  if (responseBody.context.code !== 200) {
+    throw new Error(`fetchRawTxMetadata - received invalid response: ${responseBody.context.error}`);
+  }
+
+  return responseBody.data;
+}
+
+export async function fetchRawTxMetadata(
+  chainId: ChainId,
+  txHash: string
+): Promise<{
+  [key: string]: {
+    // key is tx_hash
+    raw_transaction: string;
+    /// ... other fields are not used for now
+  };
+}> {
+  const explorerURL = CHAINS[chainId].backends.explorerURL;
+  const url = `/raw/transaction/${txHash}?${queryParams.toString()}`;
+
+  const response = await fetch(explorerURL + url);
+
+  const responseBody = await response.json();
+
+  if (responseBody.context.code !== 200) {
+    throw new Error(`fetchRawTxMetadata - received invalid response: ${responseBody.context.error}`);
+  }
+
+  return responseBody.data;
+}
+
 export function fetchAccountAddresses(pubKey: string) {}

src/app/families/bitcoin/backend/types.ts

@@ -1,13 +1,27 @@
+import { UTXO } from "coinselect";
 import z from "zod";
 
 // Blockchair responses SUB-MODELS
-const UtxosSchema = z.object({
-  block_id: z.number(),
-  transaction_hash: z.string(),
-  index: z.number(),
-  value: z.number(),
-  address: z.string(),
-});
+const UtxosSchema = z
+  .object({
+    block_id: z.number(),
+    transaction_hash: z.string(),
+    index: z.number(),
+    value: z.number(),
+    address: z.string(),
+  })
+  .transform((data) => {
+    return {
+      /**
+       * add fields for compatibility with coinselect @see {@link UTXO}
+       */
+      txid: data.transaction_hash,
+      vout: data.index,
+      ...data,
+    };
+  });
+
+export type UtxoWithMetadata = z.infer<typeof UtxosSchema>;
 
 const AddressSchema = z.object({
   type: z.string(),
@@ -69,17 +83,21 @@ export const requestContextSchema = z.object({
   rows: z.number().optional(),
   market_price_usd: z.number().optional(),
   total_rows: z.number().optional(),
-  api: z.object({
-    version: z.string(),
-    last_major_update: z.string().optional(),
-    next_major_update: z.string().optional(),
-    documentation: z.string().optional(),
-    notice: z.string().optional(),
-  }).optional(),
-  cache: z.object({
-    live: z.boolean(),
-    until: z.string().optional(),
-  }).optional(),
+  api: z
+    .object({
+      version: z.string(),
+      last_major_update: z.string().optional(),
+      next_major_update: z.string().optional(),
+      documentation: z.string().optional(),
+      notice: z.string().optional(),
+    })
+    .optional(),
+  cache: z
+    .object({
+      live: z.boolean(),
+      until: z.string().optional(),
+    })
+    .optional(),
   request_cost: z.number(),
 });
 
@@ -185,7 +203,8 @@ export const requestContextSchema = z.object({
 }
  */
 export const XpubDashboardData = z.record(
-  z.string(), z.object({
+  z.string(),
+  z.object({
     xpub: z.object({
       address_count: z.number(),
       balance: z.number().pipe(z.coerce.bigint()),
@@ -203,9 +222,12 @@ export const XpubDashboardData = z.record(
       transaction_count: z.number(),
     }),
     addresses: z.record(
-      z.string(), AddressSchema.and(z.object({
-        path: z.string(),
-      }))
+      z.string(),
+      AddressSchema.and(
+        z.object({
+          path: z.string(),
+        })
+      )
     ),
     transactions: z.array(z.string()),
     utxo: UtxosSchema.array(),
@@ -219,7 +241,7 @@ export const XpubDashboardResponse = z.object({
     z.object({
       checked: z.array(z.string()),
     })
-  )
+  ),
 });
 
 export const AddressesDashboardResponse = z.object({
@@ -230,13 +252,13 @@ export const AddressesDashboardResponse = z.object({
       received_usd: true,
       spent_usd: true,
     }),
-    addresses: z.record(
-      z.string(), AddressSchema
-    ),
+    addresses: z.record(z.string(), AddressSchema),
     transactions: z.array(z.string()),
-    utxo: UtxosSchema.and(z.object({
-      address: z.string(),
-    })).array(),
+    utxo: UtxosSchema.and(
+      z.object({
+        address: z.string(),
+      })
+    ).array(),
   }),
-  context: requestContextSchema
+  context: requestContextSchema,
 });