@exodus/bitcoin-api 2.24.0 → 2.26.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.26.0](https://github.com/ExodusMovement/assets/compare/@exodus/bitcoin-api@2.25.0...@exodus/bitcoin-api@2.26.0) (2024-09-30)
+
+
+### Features
+
+* **bitcoin-api:** switch to exodus/crypto for secp256k1 ([#4042](https://github.com/ExodusMovement/assets/issues/4042)) ([e462faf](https://github.com/ExodusMovement/assets/commit/e462faf83d430f9c5c109cc2f49edf5a1dcbd856))
+
+
+### Bug Fixes
+
+* add new balance properties ([#4018](https://github.com/ExodusMovement/assets/issues/4018)) ([7aec845](https://github.com/ExodusMovement/assets/commit/7aec8453be559211fa5ec75ec18c89f7823f3382))
+
+
+
+## [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)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/bitcoin-api",
-  "version": "2.24.0",
+  "version": "2.26.0",
   "description": "Exodus bitcoin-api",
   "type": "module",
   "main": "src/index.js",
@@ -26,7 +26,8 @@
     "@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/bitcoinjs": "^1.1.0",
+    "@exodus/crypto": "^1.0.0-rc.12",
     "@exodus/currency": "^5.0.2",
     "@exodus/key-identifier": "^1.1.1",
     "@exodus/models": "^12.0.1",
@@ -36,13 +37,10 @@
     "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",
-    "secp256k1": "^3.0.1",
     "socket.io-client": "^2.1.1",
     "url-join": "^4.0.0",
     "varuint-bitcoin": "^1.1.0",
@@ -61,5 +59,5 @@
     "type": "git",
     "url": "git+https://github.com/ExodusMovement/assets.git"
   },
-  "gitHead": "ba34f68e632d17fdd80cc50358792f449e92180a"
+  "gitHead": "77b6f56d7d574270a6418492b1094ab527d63ceb"
 }

package/src/balances.js

@@ -25,7 +25,11 @@ export const getBalancesFactory = ({ feeData, getSpendableBalance, ordinalsEnabl
       const totalBalance = asset.currency.defaultUnit(
         parsedBalances.reduce((sum, item) => sum.add(item), asset.currency.ZERO)
       )
-      return { balance: totalBalance }
+      return {
+        total: totalBalance,
+        // legacy
+        balance: totalBalance,
+      }
     }
 
     const utxos = getUtxos({ asset, accountState })
@@ -36,6 +40,12 @@ export const getBalancesFactory = ({ feeData, getSpendableBalance, ordinalsEnabl
       txSet: txLog,
       feeData,
     })
-    return { balance, spendableBalance }
+    return {
+      total: balance,
+      spendable: spendableBalance,
+      // legacy
+      balance,
+      spendableBalance,
+    }
   }
 }

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,13 +1,11 @@
-import * as defaultBitcoinjsLib from '@exodus/bitcoinjs-lib'
+import * as defaultBitcoinjsLib from '@exodus/bitcoinjs'
+import * as secp256k1 from '@exodus/crypto/secp256k1'
 import * as bech32 from 'bech32'
 import bs58check from 'bs58check'
 import lodash from 'lodash'
 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
@@ -46,7 +44,7 @@ export const createBtcLikeKeys = ({
     encodePublicFromWIFCustom ||
     ((privateKeyWIF) => {
       const { privateKey, compressed } = wif.decode(privateKeyWIF, coinInfo.versions.private)
-      const publicKey = ecc.pointFromScalar(privateKey, compressed)
+      const publicKey = secp256k1.privateKeyToPublicKey({ privateKey, compressed })
       return encodePublicPurpose44(publicKey)
     })
   const encodePublicBech32 =
@@ -67,7 +65,7 @@ export const createBtcLikeKeys = ({
           // NOTE: No password support here
           const { versions } = coinInfo
           const { privateKey, compressed } = wif.decode(privateKeyWIF, versions.private)
-          const publicKey = ecc.pointFromScalar(privateKey, compressed)
+          const publicKey = secp256k1.privateKeyToPublicKey({ privateKey, compressed })
           return encodePublicBech32(publicKey)
         }
       : undefined
@@ -75,7 +73,11 @@ export const createBtcLikeKeys = ({
   const encodeNestedP2WPKH =
     encodeNestedP2WPKHCustom || bitcoinjsLib
       ? (publicKey) => {
-          const pubkey = secp256k1.publicKeyConvert(publicKey, true)
+          const pubkey = secp256k1.publicKeyConvert({
+            publicKey,
+            compressed: true,
+            format: 'buffer',
+          })
           const witnessProgram = bitcoinjsLib.payments.p2wpkh({
             pubkey,
           }).output
@@ -93,7 +95,8 @@ export const createBtcLikeKeys = ({
     (useBip86
       ? (publicKey) => {
           const network = coinInfo.toBitcoinJS()
-          return bitcoinjsLib.payments.p2tr({ internalPubkey: toXOnly(publicKey), network }).address
+          const xOnly = secp256k1.publicKeyToX({ publicKey, format: 'buffer' })
+          return bitcoinjsLib.payments.p2tr({ internalPubkey: xOnly, network }).address
         }
       : undefined)
 

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 { ECPair } from '@exodus/bitcoinjs'
+import { tiny_secp256k1_compat as ecc } from '@exodus/crypto/secp256k1'
+
 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,12 @@ 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 { tiny_secp256k1_compat as ecc } from '@exodus/crypto/secp256k1'
+export const eccFactory = () => ecc
+export const getECPair = () => ECPair
+export const toXOnly = (publicKey) => publicKey.slice(1, 33)

package/src/move-funds.js

@@ -1,6 +1,6 @@
+import { privateKeyToPublicKey, publicKeyConvert } from '@exodus/crypto/secp256k1'
 import { Address, UtxoCollection } from '@exodus/models'
 import assert from 'minimalistic-assert'
-import secp256k1 from 'secp256k1'
 import wif from 'wif'
 
 import { createInputs, createOutput, getNonWitnessTxs } from './tx-send/index.js'
@@ -20,7 +20,8 @@ const wifToPublicKey = ({ coinInfo, privateKeyWIF }) => {
   const { versions } = coinInfo
 
   const { privateKey, compressed } = wif.decode(privateKeyWIF, versions.private)
-  return { compressed, publicKey: secp256k1.publicKeyCreate(privateKey, compressed) }
+  const publicKey = privateKeyToPublicKey({ privateKey, compressed, format: 'buffer' })
+  return { compressed, publicKey }
 }
 
 export const getAddressesFromPrivateKeyFactory = ({ purposes, keys, coinInfo }) => {
@@ -35,9 +36,12 @@ export const getAddressesFromPrivateKeyFactory = ({ purposes, keys, coinInfo })
 
     const { publicKey, compressed } = wifToPublicKey({ coinInfo, privateKeyWIF: privateKey })
     const addresses = purposes.map((purpose) =>
-      keys.encodePublic(purpose === 49 ? secp256k1.publicKeyConvert(publicKey, true) : publicKey, {
-        purpose,
-      })
+      keys.encodePublic(
+        purpose === 49
+          ? publicKeyConvert({ publicKey, compressed: true, format: 'buffer' })
+          : publicKey,
+        { purpose }
+      )
     )
     return { addresses, compressed }
   }

package/src/multisig-address.js

@@ -1,7 +1,7 @@
-import * as defaultBitcoinjsLib from '@exodus/bitcoinjs-lib'
+import * as defaultBitcoinjsLib from '@exodus/bitcoinjs'
+import { publicKeyIsValid, publicKeyToX } from '@exodus/crypto/secp256k1'
 
-import { ecc as defaultEcc } from './bitcoinjs-lib/ecc/index.js'
-import { toXOnly } from './bitcoinjs-lib/ecc-utils.js'
+const toXOnly = (publicKey) => publicKeyToX({ publicKey, format: 'buffer' })
 
 // 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(
@@ -16,11 +16,7 @@ const LEAF_VERSION_TAPSCRIPT = 192
 const MAX_PUBKEYS = 20
 
 export const createEncodeMultisigContract =
-  ({
-    bitcoinjsLib = defaultBitcoinjsLib,
-    network = bitcoinjsLib.Network.bitcoin,
-    ecc = defaultEcc,
-  }) =>
+  ({ bitcoinjsLib = defaultBitcoinjsLib, network = bitcoinjsLib.Network.bitcoin, ecc }) =>
   (
     publicKeys,
     {
@@ -29,9 +25,12 @@ export const createEncodeMultisigContract =
       internalPubkey = DUMMY_TAPROOT_PUBKEY,
     } = Object.create(null)
   ) => {
+    const isPointCompressed = (publicKey) =>
+      ecc ? ecc.isPointCompressed(publicKey) : publicKeyIsValid({ publicKey, compressed: true })
+
     if (
       !Array.isArray(publicKeys) ||
-      publicKeys.some((k) => !Buffer.isBuffer(k) || !ecc.isPointCompressed(k))
+      publicKeys.some((k) => !Buffer.isBuffer(k) || !isPointCompressed(k))
     ) {
       throw new Error('publicKeys must be an Array of Buffers representing compressed public keys')
     }

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,13 +1,9 @@
-import { getOwnProperty } from '@exodus/basic-utils'
+import { getOwnProperty, memoize } from '@exodus/basic-utils'
+import { ECPair } from '@exodus/bitcoinjs'
+import { privateKeyToPublicKey } from '@exodus/crypto/secp256k1'
 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,
@@ -18,7 +14,7 @@ export const createGetKeyWithMetadata = ({
   coinInfo,
   getKeyIdentifier,
 }) =>
-  lodash.memoize((address) => {
+  memoize((address) => {
     const purpose = resolvePurpose(address)
     const networkInfo = coinInfo.toBitcoinJS()
 
@@ -37,7 +33,7 @@ function getPrivateKeyFromMap(privateKeysAddressMap, networkInfo, purpose, addre
   const privateKey = getOwnProperty(privateKeysAddressMap, address, 'string')
   assert(privateKey, `there is no private key for address ${address}`)
   const key = ECPair.fromWIF(privateKey, networkInfo)
-  const publicKey = secp256k1.publicKeyCreate(key.privateKey, true)
+  const publicKey = privateKeyToPublicKey({ privateKey: key.privateKey, format: 'buffer' })
   return { key, purpose, publicKey }
 }
 

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 { bip371, payments, Transaction } from '@exodus/bitcoinjs'
+import { publicKeyToX } from '@exodus/crypto/secp256k1'
 
-import { toXOnly } from '../bitcoinjs-lib/ecc-utils.js'
 import { createGetKeyWithMetadata } from './create-get-key-and-purpose.js'
 import { toAsyncBufferSigner, toAsyncSigner } from './taproot.js'
 
@@ -53,7 +52,7 @@ export function createSignWithWallet({
         if (isTaprootKeySpend && !Buffer.isBuffer(input.tapInternalKey)) {
           // tapInternalKey is metadata for signing and not part of the hash to sign.
           // so modifying it here is fine.
-          psbt.updateInput(index, { tapInternalKey: toXOnly(publicKey) })
+          psbt.updateInput(index, { tapInternalKey: publicKeyToX({ publicKey, format: 'buffer' }) })
         }
       } else if (purpose === 49 && !skipFinalize) {
         // If spending from a P2SH address, we assume the address is P2SH wrapping

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/taproot.js

@@ -1,12 +1,9 @@
-import { crypto } from '@exodus/bitcoinjs-lib'
+import { crypto, ECPair } from '@exodus/bitcoinjs'
+import { tiny_secp256k1_compat as ecc } from '@exodus/crypto/secp256k1'
 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,
-}