@exodus/bitcoin-api 2.25.0 → 2.26.0

package/CHANGELOG.md

@@ -3,6 +3,20 @@
 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)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/bitcoin-api",
-  "version": "2.25.0",
+  "version": "2.26.0",
   "description": "Exodus bitcoin-api",
   "type": "module",
   "main": "src/index.js",
@@ -26,9 +26,8 @@
     "@exodus/bip322-js": "^1.1.0",
     "@exodus/bip44-constants": "^195.0.0",
     "@exodus/bitcoin-lib": "^2.4.2",
-    "@exodus/bitcoinerlab-secp256k1": "^1.0.5-exodus.1",
     "@exodus/bitcoinjs": "^1.1.0",
-    "@exodus/crypto": "^1.0.0-rc.7",
+    "@exodus/crypto": "^1.0.0-rc.12",
     "@exodus/currency": "^5.0.2",
     "@exodus/key-identifier": "^1.1.1",
     "@exodus/models": "^12.0.1",
@@ -42,7 +41,6 @@
     "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": "823ab98b35624d4cc58dc75fa5d081e09fdc1ee6"
+  "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-keys.js

@@ -1,16 +1,14 @@
-import ecc from '@exodus/bitcoinerlab-secp256k1'
 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 { 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)])
@@ -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/index.js

@@ -1,5 +1,5 @@
-import ecc from '@exodus/bitcoinerlab-secp256k1'
 import { ECPair } from '@exodus/bitcoinjs'
+import { tiny_secp256k1_compat as ecc } from '@exodus/crypto/secp256k1'
 
 export * from './account-state.js'
 export * from './balances.js'
@@ -27,6 +27,7 @@ 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 { 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 defaultEcc from '@exodus/bitcoinerlab-secp256k1'
 import * as defaultBitcoinjsLib from '@exodus/bitcoinjs'
+import { publicKeyIsValid, publicKeyToX } from '@exodus/crypto/secp256k1'
 
-const toXOnly = defaultEcc.xOnlyPointFromPoint
+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/tx-sign/create-get-key-and-purpose.js

@@ -1,9 +1,9 @@
 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 assert from 'minimalistic-assert'
-import secp256k1 from 'secp256k1'
 
 export const createGetKeyWithMetadata = ({
   signer,
@@ -33,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,5 +1,5 @@
-import { xOnlyPointFromPoint as toXOnly } from '@exodus/bitcoinerlab-secp256k1'
 import { bip371, payments, Transaction } from '@exodus/bitcoinjs'
+import { publicKeyToX } from '@exodus/crypto/secp256k1'
 
 import { createGetKeyWithMetadata } from './create-get-key-and-purpose.js'
 import { toAsyncBufferSigner, toAsyncSigner } from './taproot.js'
@@ -52,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/taproot.js

@@ -1,5 +1,5 @@
-import ecc from '@exodus/bitcoinerlab-secp256k1'
 import { crypto, ECPair } from '@exodus/bitcoinjs'
+import { tiny_secp256k1_compat as ecc } from '@exodus/crypto/secp256k1'
 import assert from 'minimalistic-assert'
 
 import defaultEntropy from './default-entropy.cjs'