@exodus/bitcoin-api 2.23.0 → 2.25.0

package/CHANGELOG.md

@@ -3,6 +3,36 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.25.0](https://github.com/ExodusMovement/assets/compare/@exodus/bitcoin-api@2.24.0...@exodus/bitcoin-api@2.25.0) (2024-09-25)
+
+
+### Features
+
+* import secp256k1 impl directly in bitcoin-api ([#3980](https://github.com/ExodusMovement/assets/issues/3980)) ([5e7f014](https://github.com/ExodusMovement/assets/commit/5e7f014b957fe27e96548277c4ec6e3038045fd0))
+* move ec-pair and script-classify to bitcoinjs ([#4001](https://github.com/ExodusMovement/assets/issues/4001)) ([adb759b](https://github.com/ExodusMovement/assets/commit/adb759be5b264194f216b6a8f65d370f63555d81))
+* unfork bitcoinjs-lib ([#3968](https://github.com/ExodusMovement/assets/issues/3968)) ([287ba8f](https://github.com/ExodusMovement/assets/commit/287ba8f4e7dacb0f4eb91f31090b74a67eb78733))
+
+
+### Bug Fixes
+
+* bitcoin monitor unused addresses ([#3973](https://github.com/ExodusMovement/assets/issues/3973)) ([e133efc](https://github.com/ExodusMovement/assets/commit/e133efc5c9f472b9611e1b7b9ead78c7c366ba89))
+
+
+
+## [2.24.0](https://github.com/ExodusMovement/assets/compare/@exodus/bitcoin-api@2.23.0...@exodus/bitcoin-api@2.24.0) (2024-09-13)
+
+
+### Features
+
+* **BTC:** add multisig data to hardware wallet signing ([#3633](https://github.com/ExodusMovement/assets/issues/3633)) ([90293e9](https://github.com/ExodusMovement/assets/commit/90293e9b80799556df1c595558b1544c5a081d7b))
+
+
+### Bug Fixes
+
+* **BTC:** allow internal pubkey and sort xonly for multisig ([#3634](https://github.com/ExodusMovement/assets/issues/3634)) ([808bf65](https://github.com/ExodusMovement/assets/commit/808bf65f05576e2758bb32ad5654143577db7c38))
+
+
+
 ## [2.23.0](https://github.com/ExodusMovement/assets/compare/@exodus/bitcoin-api@2.22.1...@exodus/bitcoin-api@2.23.0) (2024-09-11)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/bitcoin-api",
-  "version": "2.23.0",
+  "version": "2.25.0",
   "description": "Exodus bitcoin-api",
   "type": "module",
   "main": "src/index.js",
@@ -26,7 +26,9 @@
     "@exodus/bip322-js": "^1.1.0",
     "@exodus/bip44-constants": "^195.0.0",
     "@exodus/bitcoin-lib": "^2.4.2",
-    "@exodus/bitcoinjs-lib": "^6.1.6",
+    "@exodus/bitcoinerlab-secp256k1": "^1.0.5-exodus.1",
+    "@exodus/bitcoinjs": "^1.1.0",
+    "@exodus/crypto": "^1.0.0-rc.7",
     "@exodus/currency": "^5.0.2",
     "@exodus/key-identifier": "^1.1.1",
     "@exodus/models": "^12.0.1",
@@ -36,9 +38,7 @@
     "bn.js": "^4.12.0",
     "bs58check": "^2.1.2",
     "coininfo": "^5.1.0",
-    "create-hash": "^1.2.0",
     "delay": "^4.0.1",
-    "ecpair": "^2.0.1",
     "lodash": "^4.17.21",
     "minimalistic-assert": "^1.0.1",
     "ms": "^2.1.1",
@@ -61,5 +61,5 @@
     "type": "git",
     "url": "git+https://github.com/ExodusMovement/assets.git"
   },
-  "gitHead": "e9a0341b6e59b226e46b0e802ea1240c55724f68"
+  "gitHead": "823ab98b35624d4cc58dc75fa5d081e09fdc1ee6"
 }

package/src/btc-like-address.js

@@ -1,4 +1,4 @@
-import * as bitcoinjsOriginal from '@exodus/bitcoinjs-lib'
+import * as bitcoinjsOriginal from '@exodus/bitcoinjs'
 import * as bech32 from 'bech32'
 import bs58check from 'bs58check'
 import lodash from 'lodash'

package/src/btc-like-keys.js

@@ -1,4 +1,5 @@
-import * as defaultBitcoinjsLib from '@exodus/bitcoinjs-lib'
+import ecc from '@exodus/bitcoinerlab-secp256k1'
+import * as defaultBitcoinjsLib from '@exodus/bitcoinjs'
 import * as bech32 from 'bech32'
 import bs58check from 'bs58check'
 import lodash from 'lodash'
@@ -6,11 +7,10 @@ import assert from 'minimalistic-assert'
 import secp256k1 from 'secp256k1'
 import wif from 'wif'
 
-import { ecc } from './bitcoinjs-lib/ecc/index.js'
-import { toXOnly } from './bitcoinjs-lib/ecc-utils.js'
 import { hash160 } from './hash-utils.js'
 
 const { identity, pickBy } = lodash
+const toXOnly = ecc.xOnlyPointFromPoint
 
 export const publicKeyToHashFactory = (p2pkh) => (publicKey) => {
   const payload = Buffer.concat([Buffer.from([p2pkh]), hash160(publicKey)])

package/src/fee/fee-estimator.js

@@ -1,8 +1,8 @@
+import { scriptClassify } from '@exodus/bitcoinjs'
 import { UtxoCollection } from '@exodus/models'
 import assert from 'minimalistic-assert'
 import * as varuint from 'varuint-bitcoin'
 
-import { scriptClassify } from '../bitcoinjs-lib/index.js'
 import createDefaultFeeEstimator, { isHex } from './fee-utils.js'
 import { scriptClassifierFactory } from './script-classifier.js'
 

package/src/fee/script-classifier.js

@@ -1,15 +1,14 @@
 import { memoizeLruCache } from '@exodus/asset-lib'
-import createHash from 'create-hash'
+import { scriptClassify } from '@exodus/bitcoinjs'
+import { hashSync } from '@exodus/crypto/hash'
 import assert from 'minimalistic-assert'
 
-import { scriptClassify } from '../bitcoinjs-lib/index.js'
-
 const { P2PKH, P2SH, P2WPKH, P2WSH, P2TR } = scriptClassify.types
 
 const cacheSize = 1000
 const maxSize = 30
 const hashStringIfTooBig = (str) =>
-  str.length > maxSize ? createHash('sha256').update(str).digest('hex').slice(0, maxSize) : str
+  str.length > maxSize ? hashSync('sha256', str, 'hex').slice(0, maxSize) : str
 
 export const scriptClassifierFactory = ({ addressApi }) => {
   assert(addressApi, 'addressApi is required')

package/src/hash-utils.js

@@ -1,14 +1,9 @@
-import createHash from 'create-hash'
+import { hashSync } from '@exodus/crypto/hash'
 
 export function hash160(buffer) {
-  const sha256Hash = sha256(buffer)
-  try {
-    return createHash('ripemd160').update(sha256Hash).digest()
-  } catch {
-    return createHash('rmd160').update(sha256Hash).digest()
-  }
+  return hashSync('hash160', buffer)
 }
 
 export function sha256(buffer) {
-  return createHash('sha256').update(buffer).digest()
+  return hashSync('sha256', buffer)
 }

package/src/index.js

@@ -1,9 +1,11 @@
+import ecc from '@exodus/bitcoinerlab-secp256k1'
+import { ECPair } from '@exodus/bitcoinjs'
+
 export * from './account-state.js'
 export * from './balances.js'
 export * from './btc-address.js'
 export * from './btc-like-address.js'
 export * from './btc-like-keys.js'
-export * from './bitcoinjs-lib/index.js'
 export { default as InsightAPIClient } from './insight-api-client/index.js'
 export { default as InsightWSClient } from './insight-api-client/ws.js'
 export { default as bip44Constants } from './constants/bip44.js'
@@ -20,6 +22,11 @@ export * from './insight-api-client/util.js'
 export * from './move-funds.js'
 export { createEncodeMultisigContract } from './multisig-address.js'
 export { toAsyncSigner } from './tx-sign/taproot.js'
-export { toXOnly } from './bitcoinjs-lib/ecc-utils.js'
 export * from './ordinals-utils.js'
 export { signMessage } from './sign-message.js'
+
+// TODO: remove these, kept for compat
+export { scriptClassify } from '@exodus/bitcoinjs'
+export { default as ecc, xOnlyPointFromPoint as toXOnly } from '@exodus/bitcoinerlab-secp256k1'
+export const eccFactory = () => ecc
+export const getECPair = () => ECPair

package/src/multisig-address.js

@@ -1,18 +1,18 @@
-import * as defaultBitcoinjsLib from '@exodus/bitcoinjs-lib'
+import defaultEcc from '@exodus/bitcoinerlab-secp256k1'
+import * as defaultBitcoinjsLib from '@exodus/bitcoinjs'
 
-import { ecc as defaultEcc } from './bitcoinjs-lib/ecc/index.js'
-import { toXOnly } from './bitcoinjs-lib/ecc-utils.js'
+const toXOnly = defaultEcc.xOnlyPointFromPoint
 
 // Key to use when key path spending is disabled https://github.com/bitcoin/bips/blob/master/bip-0341.mediawiki#constructing-and-spending-taproot-outputs
 const DUMMY_TAPROOT_PUBKEY = Buffer.from(
-  '50929b74c1a04954b78b4b6035e97a5e078a5a0f28ec96d547bfee9ace803ac0',
+  '0250929b74c1a04954b78b4b6035e97a5e078a5a0f28ec96d547bfee9ace803ac0',
   'hex'
 )
 
 // Leaf version for BIP342 is 0xc0 or 192 https://github.com/bitcoin/bips/blob/master/bip-0342.mediawiki#specification
 const LEAF_VERSION_TAPSCRIPT = 192
 
-// Limit multisig keys to 20 for now
+// Limit multisig keys to 16 for now
 const MAX_PUBKEYS = 20
 
 export const createEncodeMultisigContract =
@@ -21,7 +21,14 @@ export const createEncodeMultisigContract =
     network = bitcoinjsLib.Network.bitcoin,
     ecc = defaultEcc,
   }) =>
-  (publicKeys, { threshold = publicKeys.length, version = 0 } = Object.create(null)) => {
+  (
+    publicKeys,
+    {
+      threshold = publicKeys.length,
+      version = 0,
+      internalPubkey = DUMMY_TAPROOT_PUBKEY,
+    } = Object.create(null)
+  ) => {
     if (
       !Array.isArray(publicKeys) ||
       publicKeys.some((k) => !Buffer.isBuffer(k) || !ecc.isPointCompressed(k))
@@ -57,7 +64,7 @@ export const createEncodeMultisigContract =
     }
 
     // Sort according to BIP67 https://github.com/bitcoin/bips/blob/master/bip-0067.mediawiki
-    publicKeys.sort((a, b) => Buffer.compare(a, b))
+    publicKeys.sort((a, b) => Buffer.compare(toXOnly(a), toXOnly(b)))
 
     // Create multisig redeem script https://github.com/bitcoin/bips/blob/master/bip-0342.mediawiki#cite_note-5
     const OPS = bitcoinjsLib.script.OPS
@@ -74,7 +81,7 @@ export const createEncodeMultisigContract =
     const output = bitcoinjsLib.script.compile(chunks)
 
     return bitcoinjsLib.payments.p2tr({
-      internalPubkey: DUMMY_TAPROOT_PUBKEY,
+      internalPubkey: toXOnly(internalPubkey),
       scriptTree: { output },
       redeem: { output, redeemVersion: LEAF_VERSION_TAPSCRIPT },
       network,

package/src/parse-unsigned-tx.js

@@ -1,4 +1,4 @@
-import { Transaction as BitcoinTransactionClass } from '@exodus/bitcoinjs-lib'
+import { Transaction as BitcoinTransactionClass } from '@exodus/bitcoinjs'
 import BIPPath from 'bip32-path'
 import BN from 'bn.js'
 import lodash from 'lodash'

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

@@ -113,6 +113,7 @@ export class BitcoinMonitorScanner {
     const unusedAddressIndexes = await assetClientInterface.getUnusedAddressIndexes({
       assetName,
       walletAccount,
+      highestUnusedIndexes: true,
     })
 
     const resolvedGapLimit = await this.#getGapLimit({ assetConfig, refresh })
@@ -579,7 +580,7 @@ export class BitcoinMonitorScanner {
         txLogItem.from = from
       }
 
-      if (currentTxs.has(txLogItem.txId)) {
+      if (currentTxs.has(txLogItem.txId) && !refresh) {
         const existingItem = currentTxs.get(txLogItem.txId)
         // we only want to detect changes when it matters - when a tx confirms
         if (

package/src/tx-send/batch-tx.js

@@ -1,5 +1,5 @@
 import BIP32 from '@exodus/bip32'
-import { Psbt } from '@exodus/bitcoinjs-lib'
+import { Psbt } from '@exodus/bitcoinjs'
 import BipPath from 'bip32-path'
 import lodash from 'lodash' // mockable in tests
 import assert from 'minimalistic-assert'

package/src/tx-send/index.js

@@ -1,5 +1,5 @@
 import { getTxSequence } from '@exodus/bitcoin-lib'
-import * as defaultBitcoinjsLib from '@exodus/bitcoinjs-lib'
+import * as defaultBitcoinjsLib from '@exodus/bitcoinjs'
 import { Address, UtxoCollection } from '@exodus/models'
 import { retry } from '@exodus/simple-retry'
 import lodash from 'lodash'

package/src/tx-sign/create-get-key-and-purpose.js

@@ -1,14 +1,10 @@
-import { getOwnProperty } from '@exodus/basic-utils'
+import { getOwnProperty, memoize } from '@exodus/basic-utils'
+import { ECPair } from '@exodus/bitcoinjs'
 import KeyIdentifier from '@exodus/key-identifier'
 import BipPath from 'bip32-path'
-import lodash from 'lodash'
 import assert from 'minimalistic-assert'
 import secp256k1 from 'secp256k1'
 
-import { getECPair } from '../bitcoinjs-lib/index.js'
-
-const ECPair = getECPair()
-
 export const createGetKeyWithMetadata = ({
   signer,
   hdkeys,
@@ -18,7 +14,7 @@ export const createGetKeyWithMetadata = ({
   coinInfo,
   getKeyIdentifier,
 }) =>
-  lodash.memoize((address) => {
+  memoize((address) => {
     const purpose = resolvePurpose(address)
     const networkInfo = coinInfo.toBitcoinJS()
 

package/src/tx-sign/create-sign-with-wallet.js

@@ -1,7 +1,6 @@
-import { payments, Transaction } from '@exodus/bitcoinjs-lib'
-import * as bip371 from '@exodus/bitcoinjs-lib/src/psbt/bip371.js'
+import { xOnlyPointFromPoint as toXOnly } from '@exodus/bitcoinerlab-secp256k1'
+import { bip371, payments, Transaction } from '@exodus/bitcoinjs'
 
-import { toXOnly } from '../bitcoinjs-lib/ecc-utils.js'
 import { createGetKeyWithMetadata } from './create-get-key-and-purpose.js'
 import { toAsyncBufferSigner, toAsyncSigner } from './taproot.js'
 

package/src/tx-sign/default-prepare-for-signing.js

@@ -1,4 +1,4 @@
-import { Psbt, Transaction } from '@exodus/bitcoinjs-lib'
+import { Psbt, Transaction } from '@exodus/bitcoinjs'
 import assert from 'minimalistic-assert'
 
 const _MAXIMUM_FEE_RATES = {

package/src/tx-sign/default-sign-hardware.js

@@ -20,7 +20,7 @@ export const signHardwareFactory = ({ assetName, resolvePurpose, keys, coinInfo
     resolvePurpose,
   })
 
-  return async ({ unsignedTx, hardwareDevice, accountIndex }) => {
+  return async ({ unsignedTx, hardwareDevice, accountIndex, multisigData }) => {
     assert(unsignedTx, 'unsignedTx is required')
     assert(hardwareDevice, 'hardwareDevice is required')
     assert(Number.isInteger(accountIndex), 'accountIndex must be integer')
@@ -37,35 +37,65 @@ export const signHardwareFactory = ({ assetName, resolvePurpose, keys, coinInfo
       addressPathsMap,
       hardwareDevice,
       accountIndex,
+      multisigData,
     })
 
-    const skipFinalize = !!unsignedTx.txData.psbtBuffer
+    const skipFinalize = !!unsignedTx.txData.psbtBuffer || unsignedTx.txMeta.returnPsbt
     return extractTransaction({ psbt, skipFinalize })
   }
 }
 
 function createSignWithHardwareWallet({ assetName, resolvePurpose }) {
-  return async ({ psbt, inputsToSign, addressPathsMap, accountIndex, hardwareDevice }) => {
-    const derivationPaths = getDerivationPaths({ resolvePurpose, addressPathsMap, accountIndex })
+  return async ({
+    psbt,
+    inputsToSign,
+    addressPathsMap,
+    accountIndex,
+    hardwareDevice,
+    multisigData,
+  }) => {
+    const derivationPathsMap = getDerivationPathsMap({
+      resolvePurpose,
+      addressPathsMap,
+      accountIndex,
+    })
     const signatures = await hardwareDevice.signTransaction({
       assetName,
       signableTransaction: psbt.toBuffer(),
-      derivationPaths,
+      derivationPaths: Object.values(derivationPathsMap),
+      derivationPathsMap,
+      multisigData,
     })
 
-    applySignatures(psbt, signatures, inputsToSign)
+    if (multisigData) {
+      applyMultisigSignatures(psbt, signatures)
+    } else {
+      applySignatures(psbt, signatures, inputsToSign)
+    }
   }
 }
 
-function getDerivationPaths({ resolvePurpose, accountIndex, addressPathsMap }) {
-  const derivationPaths = []
+function getDerivationPathsMap({ resolvePurpose, accountIndex, addressPathsMap }) {
+  const derivationPathsMap = {}
   for (const [address, path] of Object.entries(addressPathsMap)) {
     const purpose = resolvePurpose(address)
     const derivationPath = `m/${purpose}'/0'/${accountIndex}'/${path.slice(2)}` // TODO: coinindex
-    derivationPaths.push(derivationPath)
+    derivationPathsMap[address] = derivationPath
   }
 
-  return derivationPaths
+  return derivationPathsMap
+}
+
+function applyMultisigSignatures(psbt, signatures) {
+  for (const signature of signatures) {
+    const input = psbt.data.inputs[signature.inputIndex]
+    if (!input.tapScriptSig) input.tapScriptSig = []
+    input.tapScriptSig.push({
+      pubkey: signature.publicKey,
+      signature: signature.signature,
+      leafHash: signature.tapleafHash,
+    })
+  }
 }
 
 export function applySignatures(psbt, signatures, inputsToSign) {

package/src/tx-sign/taproot.js

@@ -1,12 +1,9 @@
-import { crypto } from '@exodus/bitcoinjs-lib'
+import ecc from '@exodus/bitcoinerlab-secp256k1'
+import { crypto, ECPair } from '@exodus/bitcoinjs'
 import assert from 'minimalistic-assert'
 
-import { ecc } from '../bitcoinjs-lib/ecc/index.js'
-import { getECPair } from '../bitcoinjs-lib/index.js'
 import defaultEntropy from './default-entropy.cjs'
 
-const ECPair = getECPair()
-
 function tweakSigner({ signer, tweakHash, network }) {
   assert(signer, 'signer is required')
 

package/src/bitcoinjs-lib/ec-pair.js

@@ -1,10 +0,0 @@
-import { ECPairFactory } from 'ecpair'
-
-import { ecc } from './ecc/index.js'
-
-let ECPair
-
-export const getECPair = () => {
-  ECPair = ECPair || ECPairFactory(ecc)
-  return ECPair
-}

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

@@ -1,4 +0,0 @@
-import { eccLib } from '@exodus/bitcoinjs-lib'
-
-export const ecc = eccLib
-export const eccFactory = () => ecc

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

@@ -1,3 +0,0 @@
-export const toXOnly = (publicKey) => {
-  return publicKey.slice(1, 33)
-}

package/src/bitcoinjs-lib/index.js

@@ -1,3 +0,0 @@
-export * from './ecc/index.js'
-export { scriptClassify } from './script-classify/index.js'
-export * from './ec-pair.js'

package/src/bitcoinjs-lib/script-classify/index.js

@@ -1,48 +0,0 @@
-import { payments } from '@exodus/bitcoinjs-lib'
-
-function isPaymentFactory(payment) {
-  return (script, eccLib) => {
-    try {
-      payment({ output: script }, { eccLib })
-      return true
-    } catch {
-      return false
-    }
-  }
-}
-
-const isP2WPKH = isPaymentFactory(payments.p2wpkh)
-const isP2TR = isPaymentFactory(payments.p2tr)
-const isP2PKH = isPaymentFactory(payments.p2pkh)
-const isP2MS = isPaymentFactory(payments.p2ms)
-const isP2PK = isPaymentFactory(payments.p2pk)
-const isP2WSHScript = isPaymentFactory(payments.p2wsh)
-const isP2SHScript = isPaymentFactory(payments.p2sh)
-
-const types = {
-  P2WPKH: 'witnesspubkeyhash',
-  P2PKH: 'pubkeyhash',
-  P2MS: 'multisig',
-  P2PK: 'pubkey',
-  P2WSH: 'witnessscripthash',
-  P2SH: 'scripthash',
-  P2TR: 'taproot',
-  NONSTANDARD: 'nonstandard',
-}
-
-const outputFactory = () => (script) => {
-  if (isP2WPKH(script)) return types.P2WPKH
-  if (isP2TR(script)) return types.P2TR
-  if (isP2PKH(script)) return types.P2PKH
-  if (isP2MS(script)) return types.P2MS
-  if (isP2PK(script)) return types.P2PK
-  if (isP2WSHScript(script)) return types.P2WSH
-  if (isP2SHScript(script)) return types.P2SH
-
-  return types.NONSTANDARD
-}
-
-export const scriptClassify = {
-  types,
-  outputFactory,
-}