@exodus/bitcoin-api 2.0.0 → 2.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/bitcoin-api",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Exodus bitcoin-api",
   "main": "src/index.js",
   "files": [
@@ -40,5 +40,5 @@
     "@exodus/bip-schnorr": "0.6.6-fork-1",
     "@noble/secp256k1": "~1.5.3"
   },
-  "gitHead": "53103ac1ac2c6fd96111869a13893b6c13bbcb3a"
+  "gitHead": "667523b6a37cb6d9755082df52c812a86cda594d"
 }

package/src/bitcoinjs-lib/ecc/index.native.js

@@ -1,6 +1,3 @@
-export const eccFactory = (useSchnorrEcc) => {
-  if (useSchnorrEcc) {
-    return require('./mobile-schnorr').mobileSchnorrEcc
-  }
-  return require('./mobile').mobileEcc
-}
+import { mobileEcc } from './mobile'
+
+export const eccFactory = () => mobileEcc

package/src/bitcoinjs-lib/ecc/mobile.js

@@ -3,27 +3,37 @@ import secp256k1 from '@exodus/secp256k1'
 // TODO: temp import until '@noble/secp256k1' can be used
 import { isPoint } from 'tiny-secp256k1'
 import { common, toPubKey } from './common'
+import schnorr from '@exodus/bip-schnorr'
 
 /**
  * Wrapper around `secp256k1` in order to follow the bitcoinjs-lib `TinySecp256k1Interface`
- * Schnorr signatures are offered by @noble/secp256k1
+ * Schnorr signatures are offered by @exodus/bip-schnorr
+ *
  */
+
 export const mobileEcc: TinySecp256k1Interface = {
   ...common,
 
   signAsync: async (h: Uint8Array, d: Uint8Array, extraEntropy?: Uint8Array): Uint8Array =>
     secp256k1.ecdsaSign(h, d, { data: extraEntropy }).signature,
 
-  // TODO: waiting for the '@noble/secp256k1' lib
-  // signSchnorrAsync: async (h: Uint8Array, d: Uint8Array, e?: Uint8Array): Uint8Array =>
-  //   schnorr.sign(h, d, e),
-  // verifySchnorrAsync: async (h: Uint8Array, Q: Uint8Array, signature: Uint8Array): boolean =>
-  //   schnorr.verify(signature, h, Q),
+  signSchnorr: (h: Uint8Array, d: Uint8Array, e?: Uint8Array): Uint8Array =>
+    schnorr.sign(d.toString('hex'), h, e),
+
+  signSchnorrAsync: async (h: Uint8Array, d: Uint8Array, e?: Uint8Array): Uint8Array =>
+    mobileEcc.signSchnorr(h, d, e),
+
+  verifySchnorr: (h: Uint8Array, Q: Uint8Array, signature: Uint8Array): boolean => {
+    try {
+      schnorr.verify(Q, h, signature)
+      return true
+    } catch (e) {
+      return false
+    }
+  },
 
-  // The underlying library does not expose sync functions for Schnorr sign and verify.
-  // These function are explicitly defined here as `null` for documentation purposes.
-  signSchnorr: null,
-  verifySchnorr: null,
+  verifySchnorrAsync: async (h: Uint8Array, Q: Uint8Array, signature: Uint8Array): boolean =>
+    mobileEcc.verifySchnorr(h, Q, signature),
 
   isPoint: (p: Uint8Array): boolean => {
     try {

package/src/btc-like-keys.js

@@ -6,6 +6,17 @@ import assert from 'minimalistic-assert'
 import { identity, pickBy } from 'lodash'
 import * as defaultBitcoinjsLib from '@exodus/bitcoinjs-lib'
 
+export const publicKeyToHashFactory = (p2pkh) => (publicKey) => {
+  const sha = createHash('sha256')
+    .update(publicKey)
+    .digest()
+  const pubKeyHash = createHash('rmd160')
+    .update(sha)
+    .digest()
+  const payload = Buffer.concat([Buffer.from([p2pkh]), pubKeyHash])
+  return bs58check.encode(payload)
+}
+
 export const createBtcLikeKeys = ({
   coinInfo,
   versions,
@@ -32,18 +43,7 @@ export const createBtcLikeKeys = ({
     ((privateKey, compressed = true) => {
       return wif.encode(coinInfo.versions.private, privateKey, compressed)
     })
-  const encodePublicPurpose44 =
-    encodePublicCustom ||
-    ((publicKey) => {
-      const sha = createHash('sha256')
-        .update(publicKey)
-        .digest()
-      const pubKeyHash = createHash('rmd160')
-        .update(sha)
-        .digest()
-      const payload = Buffer.concat([Buffer.from([versions.p2pkh]), pubKeyHash])
-      return bs58check.encode(payload)
-    })
+  const encodePublicPurpose44 = encodePublicCustom || publicKeyToHashFactory(versions.p2pkh)
   const encodePublicFromWIF =
     encodePublicFromWIFCustom ||
     ((privateKeyWIF) => {

package/src/fee/can-bump-tx.js

@@ -15,7 +15,6 @@ const _canBumpTx = ({
   accountState,
   feeData,
   getFeeEstimator,
-  taprootEnabled,
   allowUnconfirmedRbfEnabledUtxos,
 }) => {
   assert(asset, 'asset must be provided')
@@ -58,7 +57,6 @@ const _canBumpTx = ({
     utxos,
     feeData,
     txSet,
-    taprootEnabled,
     allowUnconfirmedRbfEnabledUtxos,
   })
   if (usableUtxos.value.isZero) return { errorMessage: 'insufficient funds' }

package/src/fee/get-fee-resolver.js

@@ -6,13 +6,11 @@ import { canBumpTx } from './can-bump-tx'
 
 export class GetFeeResolver {
   #getFeeEstimator
-  #taprootEnabled
   #allowUnconfirmedRbfEnabledUtxos
 
-  constructor({ getFeeEstimator, taprootEnabled, allowUnconfirmedRbfEnabledUtxos }) {
+  constructor({ getFeeEstimator, allowUnconfirmedRbfEnabledUtxos }) {
     assert(getFeeEstimator, 'getFeeEstimator must be provided')
     this.#getFeeEstimator = (asset, { feePerKB }) => getFeeEstimator(asset, feePerKB)
-    this.#taprootEnabled = taprootEnabled
     this.#allowUnconfirmedRbfEnabledUtxos = allowUnconfirmedRbfEnabledUtxos
   }
 
@@ -48,7 +46,6 @@ export class GetFeeResolver {
       utxos,
       feeData,
       txSet,
-      taprootEnabled: this.#taprootEnabled,
       allowUnconfirmedRbfEnabledUtxos: this.#allowUnconfirmedRbfEnabledUtxos,
     })
     return spendableUtxos.value
@@ -67,7 +64,6 @@ export class GetFeeResolver {
       utxos,
       feeData,
       txSet,
-      taprootEnabled: this.#taprootEnabled,
     })
     const replaceableTxs = findUnconfirmedSentRbfTxs(txSet)
 
@@ -97,7 +93,7 @@ export class GetFeeResolver {
       accountState,
       feeData,
       getFeeEstimator: this.#getFeeEstimator,
-      taprootEnabled: this.#taprootEnabled,
+
       allowUnconfirmedRbfEnabledUtxos: this.#allowUnconfirmedRbfEnabledUtxos,
     })
   }

package/src/tx-log/bitcoin-monitor-scanner.js

@@ -144,7 +144,17 @@ export class BitcoinMonitorScanner {
                 chainIndex,
                 addressIndex,
               })
-              .then((address) => ({ address, purpose }))
+              .then((address) => {
+                return {
+                  address: this.#asset.address.toLegacyAddress
+                    ? Address.create(
+                        this.#asset.address.toLegacyAddress(String(address)),
+                        address.meta
+                      )
+                    : address,
+                  purpose,
+                }
+              })
           )
         }
       }
@@ -365,15 +375,17 @@ export class BitcoinMonitorScanner {
         // this is an array because legacy multisig has multiple addresses
         if (!Array.isArray(vout.scriptPubKey.addresses)) return
         if (vout.scriptPubKey.addresses.length === 0) return
-        if (!addrMap[vout.scriptPubKey.addresses[0]]) {
+        const sentAddress = vout.scriptPubKey.addresses[0]
+        if (!addrMap[sentAddress]) {
           if (isSent && !txLogItem.to) {
             const val = currency.defaultUnit(vout.value)
-            txLogItem.data.sent.push({ address: vout.scriptPubKey.addresses[0], amount: val })
+            const sentDisplayAddress = asset.address.displayAddress?.(sentAddress) || sentAddress
+            txLogItem.data.sent.push({ address: sentDisplayAddress, amount: val })
           }
           return
         }
 
-        const address = addrMap[vout.scriptPubKey.addresses[0]]
+        const address = addrMap[sentAddress]
         if (isReceiveAddress(address)) {
           txLogItem.addresses.push(address)
         }
@@ -403,13 +415,11 @@ export class BitcoinMonitorScanner {
         utxos.push(output) // but save the unspent ones for state.utxos
       })
 
-      // BCH: convert to cash format
-      if (assetName === 'bcash') {
+      if (this.#asset.address.displayAddress) {
         if (txLogItem.to) {
-          txLogItem.to = asset.address.toCashAddress(txLogItem.to)
+          txLogItem.to = asset.address.displayAddress(txLogItem.to)
         }
-
-        from = from.map(asset.address.toCashAddress)
+        from = from.map(asset.address.displayAddress)
       }
 
       if (isSent) {

package/src/tx-send/index.js

@@ -84,7 +84,7 @@ export async function getNonWitnessTxs(asset, utxos, insightClient) {
 
 export const createAndBroadcastTXFactory = ({
   getFeeEstimator,
-  taprootEnabled,
+
   allowUnconfirmedRbfEnabledUtxos,
 }) => async ({ asset, walletAccount, address, amount, options }, { assetClientInterface }) => {
   const {
@@ -126,7 +126,6 @@ export const createAndBroadcastTXFactory = ({
     utxos: getUtxos({ accountState, asset }),
     feeData,
     txSet,
-    taprootEnabled,
   })
 
   let replaceableTxs = findUnconfirmedSentRbfTxs(txSet)
@@ -339,16 +338,15 @@ export const createAndBroadcastTXFactory = ({
     ? !replaceTx
     : receiveAddresses.some((receiveAddress) => String(receiveAddress) === String(address))
 
-  if (['bcash'].includes(assetName)) {
-    receiveAddress = asset.address.toCashAddress(receiveAddress)
-  }
+  const displayReceiveAddress = asset.address.displayAddress?.(receiveAddress) || receiveAddress
+
   const receivers = bumpTxId
     ? replaceTx
       ? replaceTx.data.sent
       : []
     : replaceTx
-    ? replaceTx.data.sent.concat([{ address: receiveAddress, amount }])
-    : [{ address: receiveAddress, amount }]
+    ? replaceTx.data.sent.concat([{ address: displayReceiveAddress, amount }])
+    : [{ address: displayReceiveAddress, amount }]
 
   await assetClientInterface.updateTxLogAndNotify({
     assetName,
@@ -366,7 +364,6 @@ export const createAndBroadcastTXFactory = ({
           feePerKB: ['bitcoin', 'bitcoinregtest', 'bitcointestnet'].includes(assetName)
             ? fee.div(tx.virtualSize() / 1000).toBaseNumber()
             : undefined,
-          additionalTo: bumpTxId ? undefined : [{ address: receiveAddress, amount }],
           changeAddress: changeOutput ? ourAddress : undefined,
           blockHeight,
           blocksSeen: 0,

package/src/utxos-utils.js

@@ -12,11 +12,7 @@ export function getUtxos({ accountState, asset }) {
   )
 }
 
-export const getBalancesFactory = ({
-  taprootEnabled,
-  feeData,
-  allowUnconfirmedRbfEnabledUtxos,
-}) => {
+export const getBalancesFactory = ({ feeData, allowUnconfirmedRbfEnabledUtxos }) => {
   assert(feeData, 'feeData is required')
   return ({ asset, accountState, txLog }) => {
     assert(asset, 'asset is required')
@@ -29,15 +25,13 @@ export const getBalancesFactory = ({
       utxos,
       txSet: txLog,
       feeData,
-      taprootEnabled,
+
       allowUnconfirmedRbfEnabledUtxos,
     }).value
     return { balance, spendableBalance }
   }
 }
 
-const isTaprootUtxo = ({ utxo }) => String(utxo.address).length === 62
-
 export function getConfirmedUtxos({ asset, utxos }) {
   assert(asset, 'asset is required')
   assert(utxos, 'utxos is required')
@@ -65,18 +59,12 @@ export function getConfirmedOrRfbDisabledUtxos({ asset, utxos, allowUnconfirmedR
   )
 }
 
-export function getUsableUtxos({ asset, utxos, feeData, txSet, taprootEnabled }) {
+export function getUsableUtxos({ asset, utxos, feeData, txSet }) {
   assert(asset, 'asset is required')
   assert(utxos, 'utxos is required')
   assert(feeData, 'feeData is required')
   assert(txSet, 'txSet is required')
   if (!['bitcoin', 'bitcointestnet', 'bitcoinregtest'].includes(asset.name)) return utxos
-  if (!taprootEnabled) {
-    utxos = UtxoCollection.fromArray(
-      utxos.toArray().filter((utxo) => !isTaprootUtxo({ utxo })),
-      { currency: asset.currency }
-    )
-  }
   const { fastestFee } = feeData
   const feeRate = fastestFee.toBaseNumber()
   const maxFee = feeData.maxExtraCpfpFee
@@ -101,10 +89,10 @@ export function getSpendableUtxos({
   utxos,
   feeData,
   txSet,
-  taprootEnabled,
+
   allowUnconfirmedRbfEnabledUtxos,
 }) {
-  const usableUtxos = getUsableUtxos({ asset, utxos, feeData, txSet, taprootEnabled })
+  const usableUtxos = getUsableUtxos({ asset, utxos, feeData, txSet })
   return getConfirmedOrRfbDisabledUtxos({
     asset,
     utxos: usableUtxos,

package/src/bitcoinjs-lib/ecc/mobile-schnorr.js

@@ -1,58 +0,0 @@
-import { TinySecp256k1Interface } from '@exodus/bitcoinjs-lib'
-import secp256k1 from '@exodus/secp256k1'
-// TODO: temp import until '@noble/secp256k1' can be used
-import { isPoint } from 'tiny-secp256k1'
-import { common, toPubKey } from './common'
-import schnorr from '@exodus/bip-schnorr'
-
-/**
- * Wrapper around `secp256k1` in order to follow the bitcoinjs-lib `TinySecp256k1Interface`
- * Schnorr signatures are offered by @exodus/bip-schnorr
- *
- */
-
-export const mobileSchnorrEcc: TinySecp256k1Interface = {
-  ...common,
-
-  signAsync: async (h: Uint8Array, d: Uint8Array, extraEntropy?: Uint8Array): Uint8Array =>
-    secp256k1.ecdsaSign(h, d, { data: extraEntropy }).signature,
-
-  signSchnorr: (h: Uint8Array, d: Uint8Array, e?: Uint8Array): Uint8Array =>
-    schnorr.sign(d.toString('hex'), h, e),
-
-  signSchnorrAsync: async (h: Uint8Array, d: Uint8Array, e?: Uint8Array): Uint8Array =>
-    mobileSchnorrEcc.signSchnorr(h, d, e),
-
-  verifySchnorr: (h: Uint8Array, Q: Uint8Array, signature: Uint8Array): boolean => {
-    try {
-      schnorr.verify(Q, h, signature)
-      return true
-    } catch (e) {
-      return false
-    }
-  },
-
-  verifySchnorrAsync: async (h: Uint8Array, Q: Uint8Array, signature: Uint8Array): boolean =>
-    mobileSchnorrEcc.verifySchnorr(h, Q, signature),
-
-  isPoint: (p: Uint8Array): boolean => {
-    try {
-      // temp solution secp256k1 does not actually verify the value range, only the data length
-      return isPoint(Buffer.from(p))
-    } catch (err) {
-      return false
-    }
-  },
-
-  isXOnlyPoint: (p: Uint8Array): boolean => {
-    try {
-      // temp solution secp256k1 does not actually verify the value range, only the data length
-      return isPoint(Buffer.from(toPubKey(p)))
-    } catch (err) {
-      return false
-    }
-  },
-
-  pointCompress: (p: Uint8Array, compressed?: boolean): Uint8Array =>
-    secp256k1.publicKeyConvert(p, compressed),
-}