@teleportdao/bitcoin 1.8.9 → 2.0.0

package/src/transaction-builder/bitcoin-transaction-builder.ts

@@ -1,44 +1,26 @@
 import * as bitcoin from "bitcoinjs-lib"
 import { BaseTransactionBuilder } from "./transaction-builder"
+import { BitcoinInterfaceWallet } from "../bitcoin-interface-wallet"
 import { BitcoinInterface } from "../bitcoin-interface"
-import { BitcoinConnectionInfo } from "../type"
+import { BitcoinInterfaceConnectionInfo } from "../type"
 
 export class BitcoinTransactionBuilder extends BaseTransactionBuilder {
-  btcInterface: BitcoinInterface
+  btcInterface: BitcoinInterfaceWallet
   constructor(
-    connectionInfo: BitcoinConnectionInfo,
     networkName: string,
     network = bitcoin.networks.bitcoin,
+    connectionInfo?: BitcoinInterfaceConnectionInfo,
   ) {
     super({
       network,
       testnet: networkName?.includes("_testnet"),
       dustLimit: 1000,
     })
-    this.btcInterface = new BitcoinInterface(connectionInfo, networkName)
-  }
-
-  async _getUtxo(userAddress: string) {
-    let utxos = await this.btcInterface.getUtxo(userAddress)
-    return utxos.map((tx) => ({
-      hash: tx.txId as string,
-      value: +tx.value,
-      index: +tx.index,
-    }))
-  }
-
-  async _getFeeRate(speed: "normal" | "slow" | "fast" = "normal") {
-    return this.btcInterface.getFeeRate(speed)
+    this.btcInterface = new BitcoinInterface(networkName, connectionInfo)
   }
 
+  // eslint-disable-next-line no-underscore-dangle
   async _getTransactionHex(transactionId: string): Promise<string> {
     return this.btcInterface.getRawTransaction(transactionId)
   }
-
-  async sendTx(txHex: string): Promise<string> {
-    let txId = await (
-      this.btcInterface.rpcProvider || this.btcInterface.apiProvider
-    ).sendRawTransaction(txHex)
-    return txId
-  }
 }

package/src/transaction-builder/ordinal-transaction-builder.ts

@@ -1,8 +1,8 @@
-import { ExtendedUtxo, Target } from "./transaction-builder"
 import * as bitcoin from "bitcoinjs-lib"
 import { LEAF_VERSION_TAPSCRIPT } from "bitcoinjs-lib/src/payments/bip341"
 import { BitcoinTransactionBuilder } from "./bitcoin-transaction-builder"
 import { getOrdinalScript, toXOnly } from "../helper/ordinal-helper"
+import { ExtendedUtxo, Target } from "./transaction-builder"
 
 export class OrdinalTransactionBuilder extends BitcoinTransactionBuilder {
   async createNftPsbt({
@@ -133,15 +133,7 @@ export class OrdinalTransactionBuilder extends BitcoinTransactionBuilder {
         },
       ],
       fee: inscribeDeposit.value - ordinalAmount,
+      possibleTxId: this.getUnsignedPsbtTxId(psbt.toBase64()),
     }
   }
-
-  //  use with caution. just segwit address
-  getUnsignedPsbtTxId(unsignedPsbt: string): string {
-    //  use with caution
-    let psbt = bitcoin.Psbt.fromBase64(unsignedPsbt, {
-      network: this.network,
-    })
-    return (psbt as any).__CACHE.__TX.getId()
-  }
 }

package/src/transaction-builder/transaction-builder.ts

@@ -161,13 +161,6 @@ export class BaseTransactionBuilder {
     this.dustLimit = dustLimit || 1 * 2 * componentBytes.bytePerInput.p2pkh
   }
 
-  // eslint-disable-next-line no-unused-vars, class-methods-use-this
-  async _getUtxo(userAddress: string): Promise<Utxo[]> {
-    // The child has implemented this method.
-    throw new Error("Do not call abstract method directly")
-    // return utxo
-  }
-
   // eslint-disable-next-line no-unused-vars, class-methods-use-this
   async _getTransactionHex(transactionId: string): Promise<string> {
     // The child has implemented this method.
@@ -202,18 +195,6 @@ export class BaseTransactionBuilder {
     }
   }
 
-  async getExtendedUtxo(signerInfo: SignerInfo) {
-    let utxo = await this._getUtxo(signerInfo.address)
-    const extendedUtxo = utxo.map((input) => ({
-      ...input,
-      signerInfo,
-    }))
-    if (!extendedUtxo || extendedUtxo.length === 0) {
-      return []
-    }
-    return extendedUtxo
-  }
-
   calculateTxSize(
     inputTypes: string[],
     outputs: {
@@ -454,8 +435,7 @@ export class BaseTransactionBuilder {
     let inputs: (BitcoinJSInputInfo & {
       signerInfo: SignerInfo
     })[] = baseInputs
-    let transactionId: string | null = null
-    let transactionHex: string | null = null
+    const transactionHex: { [key: string]: string } = {}
     for (let i in inputs) {
       let { address, publicKey, derivationPath, masterFingerprint, addressType } =
         inputs[i].signerInfo
@@ -474,14 +454,10 @@ export class BaseTransactionBuilder {
         ]
       }
       if (addressType === "p2pkh") {
-        // add p2pkh data
-        if (transactionHex && transactionId === inputs[i].hash) {
-          inputs[i].nonWitnessUtxo = Buffer.from(transactionHex, "hex")
-        } else {
-          transactionHex = await this._getTransactionHex(inputs[i].hash)
-          transactionId = inputs[i].hash
-          inputs[i].nonWitnessUtxo = Buffer.from(transactionHex, "hex")
-        }
+        const txHex =
+          transactionHex[inputs[i].hash] || (await this._getTransactionHex(inputs[i].hash))
+        transactionHex[inputs[i].hash] = txHex
+        inputs[i].nonWitnessUtxo = Buffer.from(txHex, "hex")
       } else if (addressType === "p2wpkh") {
         // add p2wpkh data
         if (!addressObject.output) throw new Error("invalid signer info")
@@ -491,13 +467,10 @@ export class BaseTransactionBuilder {
         }
 
         if (inputs[i].signerInfo.includeHex) {
-          if (transactionHex && transactionId === inputs[i].hash) {
-            inputs[i].nonWitnessUtxo = Buffer.from(transactionHex, "hex")
-          } else {
-            transactionHex = await this._getTransactionHex(inputs[i].hash)
-            transactionId = inputs[i].hash
-            inputs[i].nonWitnessUtxo = Buffer.from(transactionHex, "hex")
-          }
+          const txHex =
+            transactionHex[inputs[i].hash] || (await this._getTransactionHex(inputs[i].hash))
+          transactionHex[inputs[i].hash] = txHex
+          inputs[i].nonWitnessUtxo = Buffer.from(txHex, "hex")
         }
       } else if (addressType === "p2sh-p2wpkh") {
         // add p2sh-p2wpkh data
@@ -510,13 +483,10 @@ export class BaseTransactionBuilder {
         inputs[i].redeemScript = addressObject.redeem.output
 
         if (inputs[i].signerInfo.includeHex) {
-          if (transactionHex && transactionId === inputs[i].hash) {
-            inputs[i].nonWitnessUtxo = Buffer.from(transactionHex, "hex")
-          } else {
-            transactionHex = await this._getTransactionHex(inputs[i].hash)
-            transactionId = inputs[i].hash
-            inputs[i].nonWitnessUtxo = Buffer.from(transactionHex, "hex")
-          }
+          const txHex =
+            transactionHex[inputs[i].hash] || (await this._getTransactionHex(inputs[i].hash))
+          transactionHex[inputs[i].hash] = txHex
+          inputs[i].nonWitnessUtxo = Buffer.from(txHex, "hex")
         }
       } else if (addressType === "p2tr") {
         if (!addressObject.output) throw new Error("invalid signer info")
@@ -528,13 +498,10 @@ export class BaseTransactionBuilder {
         inputs[i].tapInternalKey = addressObject.internalPubkey
 
         if (inputs[i].signerInfo.includeHex) {
-          if (transactionHex && transactionId === inputs[i].hash) {
-            inputs[i].nonWitnessUtxo = Buffer.from(transactionHex, "hex")
-          } else {
-            transactionHex = await this._getTransactionHex(inputs[i].hash)
-            transactionId = inputs[i].hash
-            inputs[i].nonWitnessUtxo = Buffer.from(transactionHex, "hex")
-          }
+          const txHex =
+            transactionHex[inputs[i].hash] || (await this._getTransactionHex(inputs[i].hash))
+          transactionHex[inputs[i].hash] = txHex
+          inputs[i].nonWitnessUtxo = Buffer.from(txHex, "hex")
         }
       }
     }
@@ -649,6 +616,13 @@ export class BaseTransactionBuilder {
     }
 
     const unsignedPsbtBaseText = newPsbt.toBase64()
+
+    const safeAddressTypeForPossibleTxId = ["p2wpkh", "p2tr"]
+    const isPossibleTxId = inputs.reduce(
+      (a, b) => a && safeAddressTypeForPossibleTxId.includes(b.signerInfo.addressType),
+      true,
+    )
+
     return {
       unsignedTransaction: unsignedPsbtBaseText,
       outputs,
@@ -660,6 +634,7 @@ export class BaseTransactionBuilder {
       })),
       fee,
       change,
+      possibleTxId: isPossibleTxId ? this.getUnsignedPsbtTxId(unsignedPsbtBaseText) : undefined,
     }
   }
 
@@ -703,4 +678,13 @@ export class BaseTransactionBuilder {
 
     return unsignedTransaction
   }
+
+  //  use with caution. just segwit address
+  getUnsignedPsbtTxId(unsignedPsbt: string): string {
+    //  use with caution
+    let psbt = bitcoin.Psbt.fromBase64(unsignedPsbt, {
+      network: this.network,
+    })
+    return (psbt as any).__CACHE.__TX.getId()
+  }
 }

package/src/type.ts

@@ -24,25 +24,51 @@ export type Transaction = {
   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
-    }
+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
   }
-  utxo?: {
-    token?: string
-    provider: "BlockStream" | "NowNodes" | "MempoolSpace" | "Unisat"
+  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
+}