@teleportdao/bitcoin 1.4.3 → 1.4.6

package/src/{teleport-dao-payments.js → teleport-dao-payments.ts}

@@ -1,280 +1,341 @@
-const BitcoinBase = require("./bitcoin-base")
-
-class TeleportDaoPayment extends BitcoinBase {
-  // payment
-  async payBurnRequest(receivers, feeSpeed = "normal") {
-    let extendedUtxo = await this.transactionBuilder.getExtendedUtxo({
-      address: this.currentAccount,
-      addressType: this.currentAccountType,
-      publicKey: this.publicKey.toString("hex"),
-    })
-
-    let feeRate = await this.transactionBuilder._getFeeRate(feeSpeed)
-    let unsignedTx = await this.transactionBuilder.processUnsignedTransaction({
-      extendedUtxo,
-      targets: receivers,
-      changeAddress: this.currentAccount,
-      feeRate,
-      fullAmount: false,
-    })
-    let signedPsbt = await this.signer.signPsbt(unsignedTx, this.privateKey)
-    let signedTx = this.signer.finalizePsbts([signedPsbt])
-    let txId = await this.transactionBuilder.sendTx(signedTx)
-    return txId
-  }
-
-  // send
-  async transferBitcoinToEth({
-    lockerAddress,
-    amount,
-    fullAmount = false,
-    //-----------
-    chainId,
-    appId,
-    recipientAddress, // 20 bytes
-    percentageFee, // 2 bytes in satoshi
-    speed = 0, // 1 byte
-    isExchange = false,
-    exchangeTokenAddress = "0x0000000000000000000000000000000000000000", // 20 bytes
-    outputAmount = 0, // 28 bytes
-    deadline, // 4 bytes
-    isFixedToken = false, // 1 byte
-    feeSpeed = "normal",
-  }) {
-    let extendedUtxo = await this.getExtendedUtxo({
-      address: this.currentAccount,
-      addressType: this.currentAccountType,
-      publicKey: this.publicKey.toString("hex"),
-    })
-    let unsignedTx = await this.getBitcoinToEthUnsignedPsbt({
-      changeAddress: this.currentAccount,
-      extendedUtxo,
-      lockerAddress,
-      amount,
-      fullAmount,
-      //-----------
-      chainId,
-      appId,
-      recipientAddress,
-      percentageFee,
-      speed,
-      isExchange,
-      exchangeTokenAddress,
-      outputAmount,
-      deadline,
-      isFixedToken,
-      feeSpeed,
-    })
-    let signedPsbt = await this.signer.signPsbt(unsignedTx, this.privateKey)
-    let txId = await this.sendSignedPsbt(signedPsbt)
-    return txId
-  }
-
-  // get
-  async getBitcoinToEthTargetOutputs({
-    lockerAddress,
-    amount,
-    fullAmount = false,
-    //-----------
-    chainId,
-    appId,
-    recipientAddress, // 20 bytes
-    percentageFee, // 2 bytes in satoshi
-    speed = 0, // 1 byte
-    isExchange = false,
-    exchangeTokenAddress = "0x0000000000000000000000000000000000000000", // 20 bytes
-    outputAmount = 0, // 28 bytes
-    deadline = 0, // 4 bytes
-    isFixedToken = false, // 1 byte
-  }) {
-    let dataHex = TeleportDaoPayment.getTransferOpReturnData({
-      chainId,
-      appId,
-      recipientAddress,
-      percentageFee,
-      speed,
-      isExchange,
-      exchangeTokenAddress,
-      outputAmount,
-      deadline,
-      isFixedToken,
-    })
-    let opTarget = this.transactionBuilder.getOpReturnTarget(dataHex)
-    return fullAmount
-      ? [opTarget]
-      : [
-          {
-            address: lockerAddress,
-            value: amount,
-          },
-          opTarget,
-        ]
-  }
-
-  async getBitcoinToEthUnsignedPsbt({
-    changeAddress,
-    extendedUtxo,
-    lockerAddress,
-    amount,
-    fullAmount = false,
-    //-----------
-    chainId,
-    appId,
-    recipientAddress, // 20 bytes
-    percentageFee, // 2 bytes in satoshi
-    speed = 0, // 1 byte
-    isExchange = false,
-    exchangeTokenAddress = "0x0000000000000000000000000000000000000000", // 20 bytes
-    outputAmount = 0, // 28 bytes
-    deadline = 0, // 4 bytes
-    isFixedToken = false, // 1 byte
-    feeSpeed = "normal",
-  }) {
-    let feeRate = await this.transactionBuilder._getFeeRate(feeSpeed)
-    let targets = await this.getBitcoinToEthTargetOutputs({
-      lockerAddress,
-      amount,
-      fullAmount,
-      chainId,
-      appId,
-      recipientAddress,
-      percentageFee,
-      speed,
-      isExchange,
-      exchangeTokenAddress,
-      outputAmount,
-      deadline,
-      isFixedToken,
-    })
-    let unsignedTx = await this.transactionBuilder.processUnsignedTransaction({
-      extendedUtxo,
-      targets,
-      changeAddress: fullAmount ? lockerAddress : changeAddress,
-      feeRate,
-      fullAmount,
-    })
-    return unsignedTx
-  }
-
-  // send
-  async bitcoinToEthLend({
-    lockerAddress,
-    amount,
-    //-----------
-    chainId,
-    appId,
-    recipientAddress, // 20 bytes
-    percentageFee, // 2 bytes in satoshi
-    mode = 0, // 1 byte
-    isBorrow = false,
-    tokenAddress = "0x0000000000000000000000000000000000000000", // 20 bytes
-    borrowAmount = 0, // 28 bytes
-  }) {
-    let dataHex = TeleportDaoPayment.getLendingOpReturnData({
-      chainId,
-      appId,
-      recipientAddress,
-      percentageFee,
-      mode,
-      isBorrow,
-      tokenAddress,
-      borrowAmount,
-    })
-    let opTarget = this.transactionBuilder.getOpReturnTarget(dataHex)
-
-    let extendedUtxo = await this.transactionBuilder.getExtendedUtxo({
-      address: this.currentAccount,
-      addressType: this.currentAccountType,
-      publicKey: this.publicKey.toString("hex"),
-    })
-    let unsignedTx = await this.transactionBuilder.processUnsignedTransaction({
-      extendedUtxo,
-      targets: [
-        {
-          address: lockerAddress,
-          value: amount,
-        },
-        opTarget,
-      ],
-      changeAddress: this.currentAccount,
-      feeRate: 1,
-      fullAmount: false,
-    })
-    let signedPsbt = await this.signer.signPsbt(unsignedTx, this.privateKey)
-    let signedTx = this.signer.finalizePsbts([signedPsbt])
-    let txId = await this.transactionBuilder.sendTx(signedTx)
-    return txId
-  }
-
-  static getTransferOpReturnData({
-    chainId,
-    appId,
-    recipientAddress, // 20 bytes
-    percentageFee, // 2 bytes in satoshi
-    speed = 0, // 1 byte
-    isExchange = false,
-    exchangeTokenAddress = "0x0000000000000000000000000000000000000000", // 20 bytes
-    outputAmount = 0, // 28 bytes
-    deadline, // 4 bytes
-    isFixedToken = false, // 1 byte
-  }) {
-    let chainIdHex = Number(chainId).toString(16).padStart(2, "0")
-    let appIdHex = Number(appId).toString(16).padStart(4, "0")
-    let recipientAddressHex = recipientAddress.replace("0x", "").toLowerCase().padStart(40, "0")
-    let percentageFeeHex = Number((percentageFee * 100).toFixed(0))
-      .toString(16)
-      .padStart(4, "0")
-    let speedHex = speed ? "01" : "00"
-    let dataHex = chainIdHex + appIdHex + recipientAddressHex + percentageFeeHex + speedHex
-
-    if (!isExchange) {
-      if (dataHex.length !== 26 * 2) throw new Error("invalid data length")
-      return dataHex
-    }
-
-    let exchangeTokenAddressHex = exchangeTokenAddress
-      .replace("0x", "")
-      .toLowerCase()
-      .padStart(40, "0")
-    let outputAmountHex = Number(outputAmount).toString(16).padStart(56, "0")
-    let deadlineHex = Number(deadline).toString(16).padStart(8, "0")
-    let isFixedTokenHex = isFixedToken ? "01" : "00"
-
-    dataHex = dataHex + exchangeTokenAddressHex + outputAmountHex + deadlineHex + isFixedTokenHex
-    if (dataHex.length !== 79 * 2) throw new Error("invalid data length")
-    return dataHex
-  }
-
-  static getLendingOpReturnData({
-    chainId, // 1 byte
-    appId, // 1 byte
-    recipientAddress, // 20 byte
-    percentageFee, // 2 byte
-    mode, // 1 byte
-    // ------
-    isBorrow = false,
-    tokenAddress = "0x0000000000000000000000000000000000000000", // 20 bytes
-    borrowAmount = 0, // 28 bytes
-  }) {
-    let chainIdHex = Number(chainId).toString(16).padStart(2, "0")
-    let appIdHex = Number(appId).toString(16).padStart(4, "0")
-    let recipientAddressHex = recipientAddress.replace("0x", "").toLowerCase().padStart(40, "0")
-    let percentageFeeHex = Number((percentageFee * 100).toFixed(0))
-      .toString(16)
-      .padStart(4, "0")
-    let modeHex = Number(mode).toString(16).padStart(2, "0")
-    let dataHex = chainIdHex + appIdHex + recipientAddressHex + percentageFeeHex + modeHex
-    if (!isBorrow) {
-      if (dataHex.length !== 26 * 2) throw new Error("invalid data length")
-      return dataHex
-    }
-
-    let tokenAddressHex = tokenAddress.replace("0x", "").toLowerCase().padStart(40, "0")
-    let borrowAmountHex = Number(borrowAmount).toString(16).padStart(56, "0")
-    dataHex = dataHex + tokenAddressHex + borrowAmountHex
-    if (dataHex.length !== 74 * 2) throw new Error("invalid data length")
-    return dataHex
-  }
-}
-
-module.exports = TeleportDaoPayment
+import type { ExtendedUtxo, Target } from "./transaction-builder/transaction-builder"
+import { BitcoinBase } from "./bitcoin-base"
+
+export type TransferRequest = {
+  changeAddress?: string
+  lockerAddress: string
+  amount: number
+  fullAmount?: boolean
+  //-----------
+  chainId: number
+  appId: number
+  recipientAddress: string // 20 bytes
+  percentageFee: number // 2 bytes in satoshi
+  speed?: number | boolean // 1 byte
+  isExchange?: boolean
+  exchangeTokenAddress?: string // 20 bytes
+  outputAmount?: number // 28 bytes
+  deadline?: number // 4 bytes
+  isFixedToken?: boolean // 1 byte
+  feeSpeed?: "normal" | "fast" | "slow"
+}
+export class TeleportDaoPayment extends BitcoinBase {
+  // payment
+  async payBurnRequest(receivers: Target[], feeSpeed: "normal" | "fast" | "slow" = "normal") {
+    if (!this.currentAccount || !this.currentAccountType || !this.publicKey || !this.privateKey) {
+      throw new Error("account not initialized")
+    }
+    let extendedUtxo = await this.getExtendedUtxo({
+      address: this.currentAccount,
+      addressType: this.currentAccountType,
+      publicKey: this.publicKey.toString("hex"),
+    })
+
+    let feeRate = await this.transactionBuilder._getFeeRate(feeSpeed)
+    let unsignedTx = await this.transactionBuilder.processUnsignedTransaction({
+      extendedUtxo,
+      targets: receivers,
+      changeAddress: this.currentAccount,
+      feeRate,
+      fullAmount: false,
+    })
+    let signedPsbt = await this.signer.signPsbt(unsignedTx, this.privateKey)
+    let signedTx = this.signer.finalizePsbts([signedPsbt])
+    let txId = await this.transactionBuilder.sendTx(signedTx)
+    return txId
+  }
+
+  // send
+  async transferBitcoinToEth({
+    lockerAddress,
+    amount,
+    fullAmount = false,
+    //-----------
+    chainId,
+    appId,
+    recipientAddress, // 20 bytes
+    percentageFee, // 2 bytes in satoshi
+    speed = 0, // 1 byte
+    isExchange = false,
+    exchangeTokenAddress = "0x0000000000000000000000000000000000000000", // 20 bytes
+    outputAmount = 0, // 28 bytes
+    deadline, // 4 bytes
+    isFixedToken = false, // 1 byte
+    feeSpeed = "normal",
+  }: TransferRequest) {
+    if (!this.currentAccount || !this.currentAccountType || !this.publicKey || !this.privateKey) {
+      throw new Error("account not initialized")
+    }
+    let extendedUtxo = await this.getExtendedUtxo({
+      address: this.currentAccount,
+      addressType: this.currentAccountType,
+      publicKey: this.publicKey.toString("hex"),
+    })
+    let unsignedTx = await this.getBitcoinToEthUnsignedPsbt({
+      changeAddress: this.currentAccount,
+      extendedUtxo,
+      lockerAddress,
+      amount,
+      fullAmount,
+      //-----------
+      chainId,
+      appId,
+      recipientAddress,
+      percentageFee,
+      speed,
+      isExchange,
+      exchangeTokenAddress,
+      outputAmount,
+      deadline,
+      isFixedToken,
+      feeSpeed,
+    })
+    let signedPsbt = await this.signer.signPsbt(unsignedTx, this.privateKey)
+    let txId = await this.sendSignedPsbt(signedPsbt)
+    return txId
+  }
+
+  // get
+  async getBitcoinToEthTargetOutputs({
+    lockerAddress,
+    amount,
+    fullAmount = false,
+    //-----------
+    chainId,
+    appId,
+    recipientAddress, // 20 bytes
+    percentageFee, // 2 bytes in satoshi
+    speed = 0, // 1 byte
+    isExchange = false,
+    exchangeTokenAddress = "0x0000000000000000000000000000000000000000", // 20 bytes
+    outputAmount = 0, // 28 bytes
+    deadline = 0, // 4 bytes
+    isFixedToken = false, // 1 byte
+  }: TransferRequest): Promise<Target[]> {
+    let dataHex = TeleportDaoPayment.getTransferOpReturnData({
+      chainId,
+      appId,
+      recipientAddress,
+      percentageFee,
+      speed,
+      isExchange,
+      exchangeTokenAddress,
+      outputAmount,
+      deadline,
+      isFixedToken,
+    })
+    let opTarget = this.transactionBuilder.getOpReturnTarget(dataHex)
+    return fullAmount
+      ? [opTarget]
+      : [
+          {
+            address: lockerAddress,
+            value: amount,
+          },
+          opTarget,
+        ]
+  }
+
+  async getBitcoinToEthUnsignedPsbt({
+    changeAddress,
+    extendedUtxo,
+    lockerAddress,
+    amount,
+    fullAmount = false,
+    //-----------
+    chainId,
+    appId,
+    recipientAddress, // 20 bytes
+    percentageFee, // 2 bytes in satoshi
+    speed = 0, // 1 byte
+    isExchange = false,
+    exchangeTokenAddress = "0x0000000000000000000000000000000000000000", // 20 bytes
+    outputAmount = 0, // 28 bytes
+    deadline = 0, // 4 bytes
+    isFixedToken = false, // 1 byte
+    feeSpeed = "normal",
+  }: TransferRequest & {
+    extendedUtxo: ExtendedUtxo[]
+  }) {
+    let feeRate = await this.transactionBuilder._getFeeRate(feeSpeed)
+    let targets = await this.getBitcoinToEthTargetOutputs({
+      lockerAddress,
+      amount,
+      fullAmount,
+      chainId,
+      appId,
+      recipientAddress,
+      percentageFee,
+      speed,
+      isExchange,
+      exchangeTokenAddress,
+      outputAmount,
+      deadline,
+      isFixedToken,
+    })
+    let unsignedTx = await this.transactionBuilder.processUnsignedTransaction({
+      extendedUtxo,
+      targets,
+      changeAddress: fullAmount ? lockerAddress : changeAddress,
+      feeRate,
+      fullAmount,
+    })
+    return unsignedTx
+  }
+
+  // send
+  async bitcoinToEthLend({
+    lockerAddress,
+    amount,
+    //-----------
+    chainId,
+    appId,
+    recipientAddress, // 20 bytes
+    percentageFee, // 2 bytes in satoshi
+    mode = 0, // 1 byte
+    isBorrow = false,
+    tokenAddress = "0x0000000000000000000000000000000000000000", // 20 bytes
+    borrowAmount = 0, // 28 bytes
+  }: {
+    lockerAddress: string
+    amount: number
+    chainId: number
+    appId: number
+    recipientAddress: string // 20 bytes
+    percentageFee: number // 2 bytes in satoshi
+    mode?: 0 | 1 | boolean // 1 byte
+    isBorrow?: boolean
+    tokenAddress?: string // 20 bytes
+    borrowAmount?: number // 28 bytes
+  }) {
+    if (!this.currentAccount || !this.currentAccountType || !this.publicKey || !this.privateKey) {
+      throw new Error("account not initialized")
+    }
+
+    let dataHex = TeleportDaoPayment.getLendingOpReturnData({
+      chainId,
+      appId,
+      recipientAddress,
+      percentageFee,
+      mode,
+      isBorrow,
+      tokenAddress,
+      borrowAmount,
+    })
+    let opTarget = this.transactionBuilder.getOpReturnTarget(dataHex)
+
+    let extendedUtxo = await this.transactionBuilder.getExtendedUtxo({
+      address: this.currentAccount,
+      addressType: this.currentAccountType,
+      publicKey: this.publicKey.toString("hex"),
+    })
+    let unsignedTx = await this.transactionBuilder.processUnsignedTransaction({
+      extendedUtxo,
+      targets: [
+        {
+          address: lockerAddress,
+          value: amount,
+        },
+        opTarget,
+      ],
+      changeAddress: this.currentAccount,
+      feeRate: 1,
+      fullAmount: false,
+    })
+    let signedPsbt = await this.signer.signPsbt(unsignedTx, this.privateKey)
+    let signedTx = this.signer.finalizePsbts([signedPsbt])
+    let txId = await this.transactionBuilder.sendTx(signedTx)
+    return txId
+  }
+
+  static getTransferOpReturnData({
+    chainId,
+    appId,
+    recipientAddress, // 20 bytes
+    percentageFee, // 2 bytes in satoshi
+    speed = 0, // 1 byte
+    isExchange = false,
+    exchangeTokenAddress = "0x0000000000000000000000000000000000000000", // 20 bytes
+    outputAmount = 0, // 28 bytes
+    deadline, // 4 bytes
+    isFixedToken = false, // 1 byte
+  }: {
+    chainId: number
+    appId: number
+    recipientAddress: string // 20 bytes
+    percentageFee: number // 2 bytes in satoshi
+    deadline: number // 4 bytes
+    speed?: number | boolean // 1 byte
+    isExchange?: boolean
+    exchangeTokenAddress?: string // 20 bytes
+    outputAmount?: number // 28 bytes
+    isFixedToken?: boolean // 1 byte
+  }) {
+    let chainIdHex = Number(chainId).toString(16).padStart(2, "0")
+    let appIdHex = Number(appId).toString(16).padStart(4, "0")
+    let recipientAddressHex = recipientAddress.replace("0x", "").toLowerCase().padStart(40, "0")
+    let percentageFeeHex = Number((percentageFee * 100).toFixed(0))
+      .toString(16)
+      .padStart(4, "0")
+    let speedHex = speed ? "01" : "00"
+    let dataHex = chainIdHex + appIdHex + recipientAddressHex + percentageFeeHex + speedHex
+
+    if (!isExchange) {
+      if (dataHex.length !== 26 * 2) throw new Error("invalid data length")
+      return dataHex
+    }
+
+    let exchangeTokenAddressHex = exchangeTokenAddress
+      .replace("0x", "")
+      .toLowerCase()
+      .padStart(40, "0")
+    let outputAmountHex = Number(outputAmount).toString(16).padStart(56, "0")
+    let deadlineHex = Number(deadline).toString(16).padStart(8, "0")
+    let isFixedTokenHex = isFixedToken ? "01" : "00"
+
+    dataHex = dataHex + exchangeTokenAddressHex + outputAmountHex + deadlineHex + isFixedTokenHex
+    if (dataHex.length !== 79 * 2) throw new Error("invalid data length")
+    return dataHex
+  }
+
+  static getLendingOpReturnData({
+    chainId, // 1 byte
+    appId, // 1 byte
+    recipientAddress, // 20 byte
+    percentageFee, // 2 byte
+    mode, // 1 byte
+    // ------
+    isBorrow = false,
+    tokenAddress = "0x0000000000000000000000000000000000000000", // 20 bytes
+    borrowAmount = 0, // 28 bytes
+  }: {
+    chainId: number
+    appId: number
+    recipientAddress: string // 20 bytes
+    percentageFee: number // 2 bytes in satoshi
+    mode?: 0 | 1 | boolean // 1 byte
+    isBorrow?: boolean
+    tokenAddress?: string // 20 bytes
+    borrowAmount?: number // 28 bytes
+  }) {
+    let chainIdHex = Number(chainId).toString(16).padStart(2, "0")
+    let appIdHex = Number(appId).toString(16).padStart(4, "0")
+    let recipientAddressHex = recipientAddress.replace("0x", "").toLowerCase().padStart(40, "0")
+    let percentageFeeHex = Number((percentageFee * 100).toFixed(0))
+      .toString(16)
+      .padStart(4, "0")
+    let modeHex = Number(mode).toString(16).padStart(2, "0")
+    let dataHex = chainIdHex + appIdHex + recipientAddressHex + percentageFeeHex + modeHex
+    if (!isBorrow) {
+      if (dataHex.length !== 26 * 2) throw new Error("invalid data length")
+      return dataHex
+    }
+
+    let tokenAddressHex = tokenAddress.replace("0x", "").toLowerCase().padStart(40, "0")
+    let borrowAmountHex = Number(borrowAmount).toString(16).padStart(56, "0")
+    dataHex = dataHex + tokenAddressHex + borrowAmountHex
+    if (dataHex.length !== 74 * 2) throw new Error("invalid data length")
+    return dataHex
+  }
+}
+export default TeleportDaoPayment