@teleportdao/bitcoin 1.9.0 → 2.0.0

package/src/type.ts

@@ -1,48 +1,74 @@
-export type Transaction = {
-  txId: string
-  version: number
-  locktime: number
-  blockNumber: number
-  blockHash: string
-  merkleProof?: {
-    intermediateNodes: string
-    transactionIndex: number
-  }
-  vout: {
-    address?: string
-    script: string
-    value: number
-  }[]
-  vin: {
-    txId: string
-    index: number
-    address?: string
-    script?: string
-    value?: number
-  }[]
-  address: string
-  addressScript: string
-}
-
-export type BitcoinConnectionInfo = {
-  api: {
-    token?: string
-    // provider: "BlockStream" | "MempoolSpace"
-    provider: any
-  }
-  rpc?: {
-    enabled?: boolean
-    url: string
-    headers?: {
-      [key: string]: string
-    }
-    auth?: {
-      username: string
-      password: string
-    }
-  }
-  utxo?: {
-    token?: string
-    provider: "BlockStream" | "NowNodes" | "MempoolSpace" | "Unisat"
-  }
-}
+export type Transaction = {
+  txId: string
+  version: number
+  locktime: number
+  blockNumber: number
+  blockHash: string
+  merkleProof?: {
+    intermediateNodes: string
+    transactionIndex: number
+  }
+  vout: {
+    address?: string
+    script: string
+    value: number
+  }[]
+  vin: {
+    txId: string
+    index: number
+    address?: string
+    script?: string
+    value?: number
+  }[]
+  address: string
+  addressScript: string
+}
+
+export type UtxoConnectionInfo = {
+  token?: string
+  provider: "BlockStream" | "MempoolSpace" | "NowNodes" | "Unisat" | "TeleportDao"
+}
+
+export type BTCTokenConnectionInfo = {
+  token?: string
+  provider: "Unisat" | "TeleportDao"
+}
+
+export type APIConnectionInfo = {
+  provider: "BlockStream" | "MempoolSpace"
+}
+
+export type RPCConnectionInfo = {
+  url: string
+  headers?: {
+    [key: string]: string
+  }
+  auth?: {
+    username: string
+    password: string
+  }
+}
+
+export type BitcoinWalletConnectionInfo = {
+  utxo?: UtxoConnectionInfo
+  // rpc used for getRawTransaction in transaction builder if set (optional)
+  rpc?: RPCConnectionInfo
+}
+export type BitcoinWalletInterfaceConnectionInfo = {
+  api?: APIConnectionInfo
+  // if utxo is not provided, it will use the same provider as the api
+  // rpc used for getRawTransaction in transaction builder if set (optional)
+  utxo?: UtxoConnectionInfo
+}
+
+export type BitcoinInterfaceConnectionInfo = BitcoinWalletInterfaceConnectionInfo & {
+  rpc?: RPCConnectionInfo
+}
+
+export type BitcoinNodeConnectionInfo = BitcoinWalletInterfaceConnectionInfo & {
+  rpc: RPCConnectionInfo
+}
+
+export type BitcoinTokenNodeConnectionInfo = BitcoinNodeConnectionInfo & {
+  // btcToken: BTCTokenConnectionInfo
+}

package/src/utils/networks.ts

@@ -1,33 +1,33 @@
-import * as bitcoinLib from "bitcoinjs-lib"
-
-const networks: {
-  [key: string]: bitcoinLib.Network
-} = {
-  bitcoin: bitcoinLib.networks.bitcoin,
-  bitcoin_testnet: bitcoinLib.networks.testnet,
-
-  litecoin: {
-    messagePrefix: "\x19Litecoin Signed Message:\n",
-    bech32: "ltc",
-    bip32: {
-      public: 0x0488b21e,
-      private: 0x0488ade4,
-    },
-    pubKeyHash: 0x30,
-    scriptHash: 0x32,
-    wif: 0xb0,
-  },
-  litecoin_testnet: {
-    messagePrefix: "\x18Litecoin Signed Message:\n",
-    bech32: "tltc",
-    bip32: {
-      public: 0x043587cf,
-      private: 0x04358394,
-    },
-    pubKeyHash: 0x6f,
-    scriptHash: 0x3a, // old 0xc4 -> 2  deprecated
-    wif: 0xef,
-  },
-}
-
-export default networks
+import * as bitcoinLib from "bitcoinjs-lib"
+
+const networks: {
+  [key: string]: bitcoinLib.Network
+} = {
+  bitcoin: bitcoinLib.networks.bitcoin,
+  bitcoin_testnet: bitcoinLib.networks.testnet,
+
+  litecoin: {
+    messagePrefix: "\x19Litecoin Signed Message:\n",
+    bech32: "ltc",
+    bip32: {
+      public: 0x0488b21e,
+      private: 0x0488ade4,
+    },
+    pubKeyHash: 0x30,
+    scriptHash: 0x32,
+    wif: 0xb0,
+  },
+  litecoin_testnet: {
+    messagePrefix: "\x18Litecoin Signed Message:\n",
+    bech32: "tltc",
+    bip32: {
+      public: 0x043587cf,
+      private: 0x04358394,
+    },
+    pubKeyHash: 0x6f,
+    scriptHash: 0x3a, // old 0xc4 -> 2  deprecated
+    wif: 0xef,
+  },
+}
+
+export default networks

package/src/utils/tools.ts

@@ -1,92 +1,92 @@
-import axios from "axios"
-
-function sleep(ms: number) {
-  // eslint-disable-next-line no-promise-executor-return
-  return new Promise((resolve) => setTimeout(resolve, ms))
-}
-
-async function runWithRetries<T>(
-  action: () => Promise<T>,
-  config: {
-    maxTries?: number
-    retrySleep?: number
-  } = {
-    maxTries: 2,
-    retrySleep: 1000,
-  },
-): Promise<T> {
-  const maxTries = config.maxTries ?? 2
-  const retrySleep = config.retrySleep ?? 1000
-  const trace = new Error().stack?.split("\n").slice(5).join("\n")
-
-  let lastError: any
-  for (let count = 0; count < maxTries; count += 1) {
-    try {
-      return await action()
-    } catch (error: any) {
-      error.message += `\n${trace}`
-      console.log(`Attempt ${count + 1} failed: ${error.message}`)
-      lastError = error
-      if (count < maxTries - 1) {
-        await sleep(retrySleep)
-      }
-    }
-  }
-
-  throw lastError || new Error(`Function failed after ${maxTries} retries: ${lastError?.message}`)
-}
-
-function getRandomInteger(min: number, max: number) {
-  return Math.floor(Math.random() * (max - min)) + min
-}
-
-function getAxiosInstance({
-  baseUrl,
-  timeout = 10000,
-  headers = {},
-  auth,
-}: {
-  baseUrl: string
-  timeout?: number
-  headers?: { [key: string]: string }
-  auth?: {
-    username: string
-    password: string
-  }
-}) {
-  let host = baseUrl
-  let instance
-
-  instance = axios.create({
-    baseURL: host,
-    timeout,
-    auth,
-    headers: {
-      ...headers,
-    },
-  })
-
-  // Add a response interceptor
-  instance.interceptors.response.use(
-    (response) => response,
-    (error) => {
-      // todo : fix this part
-      if (error.response) {
-        const serviceError = new Error(
-          JSON.stringify({ data: error.response.data, message: error.message }),
-        )
-        return Promise.reject(serviceError)
-      }
-
-      if (error.request) {
-        const serviceError = new Error(error.message)
-        return Promise.reject(serviceError)
-      }
-      return Promise.reject(error)
-    },
-  )
-
-  return instance
-}
-
-export { sleep, runWithRetries, getRandomInteger, getAxiosInstance }
+import axios from "axios"
+
+function sleep(ms: number) {
+  // eslint-disable-next-line no-promise-executor-return
+  return new Promise((resolve) => setTimeout(resolve, ms))
+}
+
+async function runWithRetries<T>(
+  action: () => Promise<T>,
+  config: {
+    maxTries?: number
+    retrySleep?: number
+  } = {
+    maxTries: 2,
+    retrySleep: 1000,
+  },
+): Promise<T> {
+  const maxTries = config.maxTries ?? 2
+  const retrySleep = config.retrySleep ?? 1000
+  const trace = new Error().stack?.split("\n").slice(5).join("\n")
+
+  let lastError: any
+  for (let count = 0; count < maxTries; count += 1) {
+    try {
+      return await action()
+    } catch (error: any) {
+      error.message += `\n${trace}`
+      console.log(`Attempt ${count + 1} failed: ${error.message}`)
+      lastError = error
+      if (count < maxTries - 1) {
+        await sleep(retrySleep)
+      }
+    }
+  }
+
+  throw lastError || new Error(`Function failed after ${maxTries} retries: ${lastError?.message}`)
+}
+
+function getRandomInteger(min: number, max: number) {
+  return Math.floor(Math.random() * (max - min)) + min
+}
+
+function getAxiosInstance({
+  baseUrl,
+  timeout = 10000,
+  headers = {},
+  auth,
+}: {
+  baseUrl: string
+  timeout?: number
+  headers?: { [key: string]: string }
+  auth?: {
+    username: string
+    password: string
+  }
+}) {
+  let host = baseUrl
+  let instance
+
+  instance = axios.create({
+    baseURL: host,
+    timeout,
+    auth,
+    headers: {
+      ...headers,
+    },
+  })
+
+  // Add a response interceptor
+  instance.interceptors.response.use(
+    (response) => response,
+    (error) => {
+      // todo : fix this part
+      if (error.response) {
+        const serviceError = new Error(
+          JSON.stringify({ data: error.response.data, message: error.message }),
+        )
+        return Promise.reject(serviceError)
+      }
+
+      if (error.request) {
+        const serviceError = new Error(error.message)
+        return Promise.reject(serviceError)
+      }
+      return Promise.reject(error)
+    },
+  )
+
+  return instance
+}
+
+export { sleep, runWithRetries, getRandomInteger, getAxiosInstance }

package/tsconfig.json

@@ -1,9 +1,9 @@
-{
-  "extends": "../../tsconfig.json",
-  "compilerOptions": {
-    "rootDir": "src" /* Specify the root folder within your source files. */,
-    "outDir": "dist" /* Specify an output folder for all emitted files. */
-  },
-  "include": ["src"],
-  "exclude": ["node_modules", "dist"]
-}
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "src" /* Specify the root folder within your source files. */,
+    "outDir": "dist" /* Specify an output folder for all emitted files. */
+  },
+  "include": ["src"],
+  "exclude": ["node_modules", "dist"]
+}

package/webpack.config.js

@@ -1,16 +1,16 @@
-const path = require("path")
-// const webpack = require("webpack")
-
-module.exports = {
-  mode: "production",
-  entry: "./dist/index.js",
-  output: {
-    filename: "bundle.js",
-    path: path.resolve(__dirname, "dist"),
-    libraryTarget: "umd", // Module type
-    globalObject: "this", // Fix for universal module definition
-  },
-  performance: {
-    hints: false,
-  },
-}
+const path = require("path")
+// const webpack = require("webpack")
+
+module.exports = {
+  mode: "production",
+  entry: "./dist/index.js",
+  output: {
+    filename: "bundle.js",
+    path: path.resolve(__dirname, "dist"),
+    libraryTarget: "umd", // Module type
+    globalObject: "this", // Fix for universal module definition
+  },
+  performance: {
+    hints: false,
+  },
+}