@teleportdao/bitcoin 1.6.1 → 1.7.1

package/src/helper/teleswap-helper.ts

@@ -0,0 +1,300 @@
+import { teleswap } from "@teleportdao/configs"
+import BigNumber from "bignumber.js"
+
+type Vin = {
+  address: string
+  value: number
+}
+
+type Vout = {
+  address?: string
+  value: number
+  script: string
+}
+
+export type WrapOpReturn = {
+  chainId: number
+  appId: number
+  recipientAddress: string
+  percentageFee: number
+  speed: boolean
+  //
+  outputToken?: string
+  outputAmount?: string
+  deadline?: string
+  isFixedToken?: boolean
+}
+
+export type UnwrapInfo = {
+  receivers: (Vout & {
+    index: number
+  })[]
+  changes: (Vout & {
+    index: number
+  })[]
+  totalInputValue: number
+  lockerVin: {
+    vinIndex: number
+    address: string
+    value: number
+  }
+}
+
+export type WrapOpReturnWithType = WrapOpReturn & {
+  requestType: "wrap" | "wrapAndSwap"
+}
+
+const wrapOpReturnLength = {
+  chainId: 2,
+  appId: 4,
+  percentageFee: 4,
+  outputAmount: 56,
+  deadline: 8,
+}
+
+export function generateWrapOpReturn({
+  chainId,
+  appId,
+  recipientAddress, // 20 bytes
+  percentageFee, // 2 bytes in percent %
+  speed = false, // 1 byte
+  isExchange = false,
+  outputToken, // 20 bytes
+  outputAmount, // 28 bytes
+  deadline, // 4 bytes
+  isFixedToken = false, // 1 byte
+}: WrapOpReturn & {
+  isExchange?: boolean
+}) {
+  let data = ""
+  if (BigNumber(chainId).toString(16).length > wrapOpReturnLength.chainId) {
+    throw new Error("invalid chainId")
+  }
+  if (BigNumber(appId).toString(16).length > wrapOpReturnLength.appId) {
+    throw new Error("invalid appId")
+  }
+  if (BigNumber(percentageFee).toString(16).length > wrapOpReturnLength.percentageFee) {
+    throw new Error("invalid percentageFee")
+  }
+  data += BigNumber(chainId).toString(16).padStart(2, "0")
+  data += BigNumber(appId).toString(16).padStart(4, "0")
+  data += recipientAddress.replace("0x", "").toLowerCase().padStart(40, "0")
+  data += BigNumber((percentageFee * 100).toFixed(0))
+    .toString(16)
+    .padStart(4, "0")
+  data += speed ? "01" : "00"
+  if (!isExchange) {
+    if (data.length !== 26 * 2) throw new Error("invalid data length")
+    return data
+  }
+  if (!outputToken) {
+    throw new Error("invalid outputToken")
+  }
+  if (
+    !outputAmount ||
+    BigNumber(outputAmount).toString(16).length > wrapOpReturnLength.outputAmount
+  ) {
+    throw new Error("invalid outputAmount")
+  }
+  if (!deadline || BigNumber(deadline).toString(16).length > wrapOpReturnLength.deadline) {
+    throw new Error("invalid deadline")
+  }
+
+  data += outputToken.replace("0x", "").toLowerCase().padStart(40, "0")
+  data += BigNumber(outputAmount).toString(16).padStart(56, "0")
+  data += BigNumber(deadline).toString(16).padStart(8, "0")
+  data += isFixedToken ? "01" : "00"
+  if (data.length !== 79 * 2) throw new Error("invalid data length")
+  return data
+}
+
+export function getBurnTransactionInfo(address: string, vin: Vin[] = [], vouts: Vout[] = []) {
+  let lockerVinIndex = vin.findIndex((vi) => vi.address === address)
+  if (lockerVinIndex >= 0) {
+    let lockerVin = { ...vin[lockerVinIndex], vinIndex: lockerVinIndex }
+    let totalInputValue = vin.reduce((acc, current) => acc + current.value, 0)
+    let receivers: (Vout & {
+      index: number
+    })[] = []
+    let changes: (Vout & {
+      index: number
+    })[] = []
+    vouts.forEach((vout, i) => {
+      let voutWithIndex = {
+        ...vout,
+        index: i,
+      }
+      if (voutWithIndex.address === address) {
+        changes.push(voutWithIndex)
+      } else {
+        receivers.push(voutWithIndex)
+      }
+    })
+    return { receivers, changes, totalInputValue, lockerVin }
+  }
+  return
+}
+
+//
+
+function parseWrapRequest(data: string) {
+  let parsedData: any = {}
+  parsedData.requestType = "wrap"
+  let offset = 0
+  parsedData.chainId = BigNumber(`0x${data.slice(offset, (offset += 2))}`).toNumber() // 1 bytes
+  parsedData.appId = BigNumber(`0x${data.slice(offset, (offset += 4))}`).toNumber() // 2 bytes
+  parsedData.recipientAddress = `0x${data.slice(offset, (offset += 40))}` // 20 bytes
+  parsedData.percentageFee = BigNumber(`0x${data.slice(offset, (offset += 4))}`)
+    .dividedBy(100)
+    .toNumber() // 2 bytes
+  parsedData.speed = data.slice(offset, (offset += 2)) === "01" // 1 byte
+  if (data.length === offset) {
+    return {
+      status: true,
+      data: parsedData as WrapOpReturnWithType,
+    }
+  }
+
+  parsedData.requestType = "swapAndWrap"
+  parsedData.exchangeTokenAddress = `0x${data.slice(offset, (offset += 40))}` // 20 bytes
+  parsedData.outputAmount = new BigNumber(`0x${data.slice(offset, (offset += 56))}`).toFixed(0) // 28 bytes
+  parsedData.deadline = new BigNumber(`0x${data.slice(offset, (offset += 8))}`).toFixed(0) // 4 bytes
+  parsedData.isFixedToken = data.slice(offset, (offset += 2)) === "01" // 1 byte
+  if (data.length === offset) {
+    return {
+      status: true,
+      data: parsedData as WrapOpReturnWithType,
+    }
+  }
+
+  return {
+    status: false,
+    message: `invalid OP_RETURN data for requestType: 'transfer or exchange'. invalid data length : ${data.length} - valid length : ${offset}`,
+    code: "INVALID_OP_RETURN",
+  }
+}
+
+// function parseLendAndBorrowRequest(data: string) {
+//   let parsedData: any = {}
+//   parsedData.requestType = "lend"
+
+//   let offset = 0
+//   parsedData.chainId = BigNumber(`0x${data.slice(offset, (offset += 2))}`) // 1 bytes
+//   parsedData.appId = BigNumber(`0x${data.slice(offset, (offset += 4))}`) // 2 bytes
+//   parsedData.recipientAddress = `0x${data.slice(offset, (offset += 40))}` // 20 bytes
+//   parsedData.percentageFee = BigNumber(`0x${data.slice(offset, (offset += 4))}`) / 100 // 2 bytes
+//   parsedData.mode = BigNumber(`0x${data.slice(offset, (offset += 2))}`) // 1 byte
+//   if (data.length === offset) {
+//     return {
+//       status: true,
+//       data: parsedData,
+//     }
+//   }
+//   parsedData.requestType = "borrow"
+//   parsedData.tokenAddress = `0x${data.slice(offset, (offset += 40))}` // 20 bytes
+//   parsedData.borrowAmount = BigNumber(`0x${data.slice(offset, (offset += 56))}`) // 28 bytes
+//   if (data.length === offset) {
+//     return {
+//       status: true,
+//       data: parsedData,
+//     }
+//   }
+//   return {
+//     status: false,
+//     message: `invalid OP_RETURN data for requestType: 'lend or borrow'. invalid data length : ${data.length} - valid length : ${offset}`,
+//     code: "INVALID_OP_RETURN",
+//   }
+// }
+
+export function parseWrapRawRequest(opReturnData: string) {
+  let data = opReturnData.slice(2, 4) === "4c" ? opReturnData.slice(6) : opReturnData.slice(4)
+  let appIdHex = data.slice(2, 6) // 2 bytes
+  if (!appIdHex) {
+    return {
+      status: false,
+      message: `invalid OP_RETURN data : ${data}`,
+      code: "INVALID_APP_ID",
+    }
+  }
+
+  let appId = BigNumber(`0x${appIdHex}`).toNumber() // 2 bytes
+
+  //   get type base on appId
+  let requestType = Object.keys(teleswap.requestAppId).find(
+    (key) =>
+      appId >= teleswap.requestAppId[key as keyof typeof teleswap.requestAppId].appIdRange[0] &&
+      appId <= teleswap.requestAppId[key as keyof typeof teleswap.requestAppId].appIdRange[1],
+  )
+
+  switch (requestType) {
+    case "wrap":
+    case "wrapAndSwap":
+      return parseWrapRequest(data)
+    default:
+      return {
+        status: false,
+        message: `invalid appId : ${appId}`,
+        code: "INVALID_OP_RETURN",
+      }
+  }
+}
+
+export function checkAndParseWrapRequest(
+  vouts: Vout[],
+  lockerAddress: string,
+  { minTeleporterFeeAmount = 0 } = {},
+) {
+  let requestOutputIndex = vouts.findIndex((vout_) => vout_.script.startsWith("6a"))
+  if (requestOutputIndex >= 0) {
+    let opReturnData = vouts[requestOutputIndex]?.script || null
+    if (!opReturnData) {
+      return {
+        status: false,
+        message: "no data to validate. it should not happen",
+        code: "INVALID_OP_RETURN",
+      }
+    }
+
+    let valueOutputIndex = vouts.findIndex((vout_) => vout_.address === lockerAddress)
+    let value = valueOutputIndex >= 0 ? vouts[valueOutputIndex].value || 0 : 0
+
+    let response = parseWrapRawRequest(opReturnData)
+
+    if (!response.status || !("data" in response) || !response.data) {
+      return response as {
+        status: boolean
+        message: string
+        code: string
+      }
+    }
+
+    const data = response.data
+
+    if (+data.percentageFee > 100) {
+      return {
+        status: false,
+        message: `percentageFee greater than 100 is invalid. percentageFee: ${data.percentageFee}`,
+        code: "INVALID_FEE",
+      }
+    }
+
+    if ((data.percentageFee / 100) * +value <= minTeleporterFeeAmount) {
+      return {
+        status: false,
+        message: `fee amount is less than or equal minimum teleporter fee amount.percentageFee: ${
+          data.percentageFee
+        } - value: ${value} - feeAmount  ${((data.percentageFee / 100) * +value).toFixed(
+          8,
+        )} - minimumFee: ${minTeleporterFeeAmount}`,
+        code: "NOT_ACCEPTED_BY_TELEPORTER",
+      }
+    }
+
+    return { status: response.status, data, value, valueOutputIndex }
+  }
+  return {
+    status: false,
+    message: "transaction outputs must include an OP_RETURN",
+    code: "NO_OP_RETURN",
+  }
+}

package/src/index.ts

@@ -1,7 +1,15 @@
 export * as bitcoinUtils from "./bitcoin-utils"
-export * from "./teleport-dao-payments"
-export * from "./bitcoin-interface"
+export * from "./helper"
+export * from "./type"
+//
+export * from "./teleswap-wallet"
+export * from "./ordinal-wallet"
+export * from "./bitcoin-wallet-base"
+//
 export * from "./bitcoin-interface-utils"
-export * from "./bitcoin-base"
+export * from "./bitcoin-interface"
+export * from "./bitcoin-interface-teleswap"
+export * from "./bitcoin-interface-ordinal"
+//
 export * from "./transaction-builder"
 export * from "./sign"