Caravan Health Package

.changeset/eighty-planets-help.md

@@ -0,0 +1,14 @@
+---
+"@caravan/bitcoin": minor
+"@caravan/clients": minor
+---
+
+@caravan/client 
+We are exposing a new method `getAddressTransactions` which will fetch all the transaction for a given address and format it as per needs. To facilitate the change, we had moved the interfaces in the new file `types.ts`.
+
+Another change was about getting the block fee-rate percentile history from mempool as a client.
+
+@caravan/bitcoin
+The new function that has the capability to detect the address type (i.e P2SH, P2PKH, P2WSH or P2TR) was added.
+
+Overall, The changes were to support the new library within caravan called @caravan/health.

packages/caravan-bitcoin/src/addresses.test.ts

@@ -1,17 +1,18 @@
-import { validateAddress } from "./addresses";
+import { validateAddress, getAddressType } from "./addresses";
 import * as multisig from "./multisig";
 import { Network } from "./networks";
 
 const P2PKH = "P2PKH";
 const P2TR = "P2TR";
+const P2WSH = "P2WSH";
 
 const ADDRESSES = {};
 ADDRESSES[Network.MAINNET] = {};
 ADDRESSES[Network.MAINNET][P2PKH] = ["1BgGZ9tcN4rm9KBzDn7KprQz87SZ26SAMH"];
 ADDRESSES[Network.MAINNET][(multisig as any).P2SH] = [
   "3LRW7jeCvQCRdPF8S3yUCfRAx4eqXFmdcr",
 ];
 ADDRESSES[Network.MAINNET][(multisig as any).P2WSH] = [
   "bc1qw508d6qejxtdg4y5r3zarvary0c5xw7kv8f3t4",
   "bc1qng72v5ceptk07htel0wcv6k27fkg6tmmd8887jr2l2yz5a5lnawqqeceya",
 ];
@@ -21,10 +22,10 @@
 
 ADDRESSES[Network.TESTNET] = {};
 ADDRESSES[Network.TESTNET][P2PKH] = ["mrCDrCybB6J1vRfbwM5hemdJz73FwDBC8r"];
 ADDRESSES[Network.TESTNET][(multisig as any).P2SH] = [
   "2NByiBUaEXrhmqAsg7BbLpcQSAQs1EDwt5w",
 ];
 ADDRESSES[Network.TESTNET][(multisig as any).P2WSH] = [
   "tb1qrp33g0q5c5txsp9arysrx4k6zdkfs4nce4xj0gdcccefvpysxf3q0sl5k7",
 ];
 ADDRESSES[Network.TESTNET][P2TR] = [
@@ -32,10 +33,10 @@
 ];
 ADDRESSES[Network.REGTEST] = {};
 ADDRESSES[Network.REGTEST][P2PKH] = ["msX7BWX7xnyqGMxHRCqWoogcvQ93PQtWWR"];
 ADDRESSES[Network.REGTEST][(multisig as any).P2SH] = [
   "2NByiBUaEXrhmqAsg7BbLpcQSAQs1EDwt5w",
 ];
 ADDRESSES[Network.REGTEST][(multisig as any).P2WSH] = [
   "bcrt1q5qlrrl9lq2mktevfdlxl6upxqluadr74x3znhc",
 ];
 ADDRESSES[Network.REGTEST][P2TR] = [
@@ -44,8 +45,8 @@
 
 const ADDRESS_TYPES = [
   P2PKH,
   (multisig as any).P2SH,
   (multisig as any).P2WSH,
   P2TR,
 ];
 
@@ -104,4 +105,54 @@
       });
     });
   });
+
+  describe("getAddressType", () => {
+    it("correctly identifies P2SH addresses", () => {
+      ADDRESSES[Network.MAINNET][P2PKH].forEach((address) => {
+        expect(getAddressType(address, Network.MAINNET)).toBe(P2PKH);
+      });
+      ADDRESSES[Network.TESTNET][P2PKH].forEach((address) => {
+        expect(getAddressType(address, Network.TESTNET)).toBe("P2PKH");
+      });
+      ADDRESSES[Network.REGTEST][P2PKH].forEach((address) => {
+        expect(getAddressType(address, Network.REGTEST)).toBe(P2PKH);
+      });
+    });
+
+    it("correctly identifies P2WSH addresses", () => {
+      ADDRESSES[Network.MAINNET][(multisig as any).P2WSH].forEach((address) => {
+        expect(getAddressType(address, Network.MAINNET)).toBe(P2WSH);
+      });
+      ADDRESSES[Network.TESTNET][(multisig as any).P2WSH].forEach((address) => {
+        expect(getAddressType(address, Network.TESTNET)).toBe(P2WSH);
+      });
+      ADDRESSES[Network.REGTEST][(multisig as any).P2WSH].forEach((address) => {
+        expect(getAddressType(address, Network.REGTEST)).toBe(P2WSH);
+      });
+    });
+
+    it("correctly identifies P2TR addresses", () => {
+      ADDRESSES[Network.MAINNET][P2TR].forEach((address) => {
+        expect(getAddressType(address, Network.MAINNET)).toBe(P2TR);
+      });
+      ADDRESSES[Network.TESTNET][P2TR].forEach((address) => {
+        expect(getAddressType(address, Network.TESTNET)).toBe(P2TR);
+      });
+      ADDRESSES[Network.REGTEST][P2TR].forEach((address) => {
+        expect(getAddressType(address, Network.REGTEST)).toBe(P2TR);
+      });
+    });
+
+    it("returns UNKNOWN for unrecognized addresses", () => {
+      expect(getAddressType("unknownaddress1", Network.MAINNET)).toBe(
+        "UNKNOWN",
+      );
+      expect(getAddressType("unknownaddress2", Network.TESTNET)).toBe(
+        "UNKNOWN",
+      );
+      expect(getAddressType("unknownaddress3", Network.REGTEST)).toBe(
+        "UNKNOWN",
+      );
+    });
+  });
 });

packages/caravan-bitcoin/src/addresses.ts

@@ -8,6 +8,7 @@ import {
 } from "bitcoin-address-validation";
 
 import { Network } from "./networks";
+import { MultisigAddressType } from "./types";
 
 const MAINNET_ADDRESS_MAGIC_BYTE_PATTERN = "^(bc1|[13])";
 const TESTNET_ADDRESS_MAGIC_BYTE_PATTERN = "^(tb1|bcrt1|[mn2])";
@@ -60,3 +61,31 @@ export function validateAddress(address: string, network: Network) {
 
   return valid ? "" : "Address is invalid.";
 }
+
+export function getAddressType(
+  address: string,
+  network: Network,
+): MultisigAddressType {
+  if (validateAddress(address, network) !== "") {
+    return "UNKNOWN";
+  }
+  const bech32Regex = /^(bc1|tb1|bcrt1)/;
+  const p2pkhRegex = /^(1|m|n)/;
+  const p2shRegex = /^(3|2)/;
+
+  if (address.match(bech32Regex)) {
+    if (
+      address.startsWith("bc1p") ||
+      address.startsWith("tb1p") ||
+      address.startsWith("bcrt1p")
+    ) {
+      return "P2TR";
+    }
+    return "P2WSH";
+  } else if (address.match(p2pkhRegex)) {
+    return "P2PKH";
+  } else if (address.match(p2shRegex)) {
+    return "P2SH";
+  }
+  return "UNKNOWN";
+}

packages/caravan-bitcoin/src/types/addresses.ts

@@ -2,4 +2,4 @@
 // address type.
 // We should be able to replace this with use of the MULTISIG_ADDRESS_TYPES
 // enum when that file (./multisig.js) gets converted to typescript
-export type MultisigAddressType = "P2SH" | "P2WSH" | "P2SH-P2WSH" | "P2TR";
+export type MultisigAddressType = "P2SH" | "P2WSH" | "P2SH-P2WSH" | "P2TR" | "P2PKH" | "UNKNOWN";

packages/caravan-clients/src/bitcoind.js

@@ -143,3 +143,17 @@ export function bitcoindImportMulti({ url, auth, addresses, label, rescan }) {
   }
   return callBitcoind(...params);
 }
+
+export async function bitcoindRawTxData(txid){
+  try{
+    return await callBitcoind(
+      this.bitcoindParams.url,
+      this.bitcoindParams.auth,
+      "decoderawtransaction",
+      [txid],
+    );
+  }
+  catch(e){
+    return e;
+  }
+}