@teleportdao/bitcoin 1.7.2 → 1.7.6

package/src/helper/teleswap-helper.ts

@@ -16,13 +16,13 @@ export type WrapOpReturn = {
   chainId: number
   appId: number
   recipientAddress: string
-  percentageFee: number
+  thirdPartyId: number
+  networkFee: string
   speed: boolean
   //
   outputToken?: string
   outputAmount?: string
-  deadline?: string
-  isFixedToken?: boolean
+  bridgePercentageFee?: number
 }
 
 export type UnwrapInfo = {
@@ -41,29 +41,32 @@ export type UnwrapInfo = {
 }
 
 export type WrapOpReturnWithType = WrapOpReturn & {
-  requestType: "wrap" | "wrapAndSwap"
+  requestType: "Wrap" | "WrapAndSwap"
 }
 
+// hex length -> 1 byte = 2
 const wrapOpReturnLength = {
-  chainId: 2,
-  appId: 4,
-  percentageFee: 4,
-  outputAmount: 56,
-  deadline: 8,
+  chainId: 4,
+  appId: 2,
+  thirdPartyId: 2,
+  networkFee: 6,
+  bridgePercentageFee: 6,
+  outputAmount: 28,
 }
 
 export function generateWrapOpReturn({
   chainId,
   appId,
   recipientAddress, // 20 bytes
-  percentageFee, // 2 bytes in percent %
+  networkFee, // 2 bytes in percent %
+  thirdPartyId = 0,
   speed = false, // 1 byte
   isExchange = false,
   outputToken, // 20 bytes
   outputAmount, // 28 bytes
-  deadline, // 4 bytes
-  isFixedToken = false, // 1 byte
-}: WrapOpReturn & {
+  bridgePercentageFee = 0,
+}: Omit<WrapOpReturn, "thirdPartyId"> & {
+  thirdPartyId?: number
   isExchange?: boolean
 }) {
   let data = ""
@@ -73,18 +76,20 @@ export function generateWrapOpReturn({
   if (BigNumber(appId).toString(16).length > wrapOpReturnLength.appId) {
     throw new Error("invalid appId")
   }
-  if (BigNumber(percentageFee).toString(16).length > wrapOpReturnLength.percentageFee) {
+  if (BigNumber(networkFee).toString(16).length > wrapOpReturnLength.networkFee) {
     throw new Error("invalid percentageFee")
   }
-  data += BigNumber(chainId).toString(16).padStart(2, "0")
-  data += BigNumber(appId).toString(16).padStart(4, "0")
+  if (BigNumber(thirdPartyId).toString(16).length > wrapOpReturnLength.thirdPartyId) {
+    throw new Error("invalid percentageFee")
+  }
+  data += BigNumber(chainId).toString(16).padStart(wrapOpReturnLength.chainId, "0")
+  data += BigNumber(appId).toString(16).padStart(wrapOpReturnLength.appId, "0")
   data += recipientAddress.replace("0x", "").toLowerCase().padStart(40, "0")
-  data += BigNumber((percentageFee * 100).toFixed(0))
-    .toString(16)
-    .padStart(4, "0")
+  data += BigNumber(networkFee).toString(16).padStart(wrapOpReturnLength.networkFee, "0")
   data += speed ? "01" : "00"
+  data += BigNumber(thirdPartyId).toString(16).padStart(wrapOpReturnLength.thirdPartyId, "0")
   if (!isExchange) {
-    if (data.length !== 26 * 2) throw new Error("invalid data length")
+    if (data.length !== 28 * 2) throw new Error("invalid data length")
     return data
   }
   if (!outputToken) {
@@ -96,15 +101,22 @@ export function generateWrapOpReturn({
   ) {
     throw new Error("invalid outputAmount")
   }
-  if (!deadline || BigNumber(deadline).toString(16).length > wrapOpReturnLength.deadline) {
-    throw new Error("invalid deadline")
+  if (
+    (bridgePercentageFee || 0) > 100 ||
+    BigNumber(bridgePercentageFee || 0)
+      .multipliedBy(1e7)
+      .toString(16).length > wrapOpReturnLength.bridgePercentageFee
+  ) {
+    throw new Error("invalid percentageFee")
   }
-
   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")
+  data += BigNumber(outputAmount).toString(16).padStart(wrapOpReturnLength.outputAmount, "0")
+
+  data += BigNumber(bridgePercentageFee || 0)
+    .multipliedBy(1e7)
+    .toString(16)
+    .padStart(wrapOpReturnLength.bridgePercentageFee, "0")
+  if (data.length !== 65 * 2) throw new Error("invalid data length")
   return data
 }
 
@@ -132,21 +144,24 @@ export function getBurnTransactionInfo(address: string, vin: Vin[] = [], vouts:
     })
     return { receivers, changes, totalInputValue, lockerVin }
   }
-  return
 }
 
 //
 
-function parseWrapRequest(data: string) {
-  let parsedData: any = {}
-  parsedData.requestType = "wrap"
+export function parseWrapRequest(data: string) {
+  let parsedData: Partial<WrapOpReturnWithType> = {}
+  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.chainId = BigNumber(
+    `0x${data.slice(offset, (offset += wrapOpReturnLength.chainId))}`,
+  ).toNumber() // 1 bytes
+  parsedData.appId = BigNumber(
+    `0x${data.slice(offset, (offset += wrapOpReturnLength.appId))}`,
+  ).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.networkFee = new BigNumber(
+    `0x${data.slice(offset, (offset += wrapOpReturnLength.networkFee))}`,
+  ).toFixed(0)
   parsedData.speed = data.slice(offset, (offset += 2)) === "01" // 1 byte
   if (data.length === offset) {
     return {
@@ -155,11 +170,24 @@ function parseWrapRequest(data: string) {
     }
   }
 
-  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
+  parsedData.requestType = "WrapAndSwap"
+  parsedData.outputToken = `0x${data.slice(offset, (offset += 40))}` // 20 bytes
+  parsedData.outputAmount = new BigNumber(
+    `0x${data.slice(offset, (offset += wrapOpReturnLength.outputAmount))}`,
+  ).toFixed(0) // 28 bytes
+  parsedData.bridgePercentageFee = new BigNumber(
+    `0x${data.slice(offset, (offset += wrapOpReturnLength.bridgePercentageFee))}`,
+  )
+    .dividedBy(1e7)
+    .toNumber()
+
+  if (parsedData.bridgePercentageFee > 100) {
+    return {
+      status: false,
+      message: `invalid OP_RETURN data for requestType: 'wrap or wrapAndSwap'. invalid bridgePercentageFee`,
+      code: "INVALID_OP_RETURN",
+    }
+  }
   if (data.length === offset) {
     return {
       status: true,
@@ -169,43 +197,11 @@ function parseWrapRequest(data: string) {
 
   return {
     status: false,
-    message: `invalid OP_RETURN data for requestType: 'transfer or exchange'. invalid data length : ${data.length} - valid length : ${offset}`,
+    message: `invalid OP_RETURN data for requestType: 'wrap or wrapAndSwap'. 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
@@ -239,11 +235,7 @@ export function parseWrapRawRequest(opReturnData: string) {
   }
 }
 
-export function checkAndParseWrapRequest(
-  vouts: Vout[],
-  lockerAddress: string,
-  { minTeleporterFeeAmount = 0 } = {},
-) {
+export function checkAndParseWrapRequest(vouts: Vout[], lockerAddress: string) {
   let requestOutputIndex = vouts.findIndex((vout_) => vout_.script.startsWith("6a"))
   if (requestOutputIndex >= 0) {
     let opReturnData = vouts[requestOutputIndex]?.script || null
@@ -268,29 +260,13 @@ export function checkAndParseWrapRequest(
       }
     }
 
-    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: response.data,
+      value,
+      valueOutputIndex,
+      requestOutputIndex,
     }
-
-    return { status: response.status, data, value, valueOutputIndex }
   }
   return {
     status: false,

package/src/index.ts

@@ -1,15 +1,15 @@
-export * as bitcoinUtils from "./bitcoin-utils"
-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-interface"
-export * from "./bitcoin-interface-teleswap"
-export * from "./bitcoin-interface-ordinal"
-//
-export * from "./transaction-builder"
-export * from "./sign"
+export * as bitcoinUtils from "./bitcoin-utils"
+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-interface"
+export * from "./bitcoin-interface-teleswap"
+export * from "./bitcoin-interface-ordinal"
+//
+export * from "./transaction-builder"
+export * from "./sign"