@exodus/bitcoin-api 2.29.0 → 2.29.2

package/CHANGELOG.md

@@ -3,6 +3,21 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.29.2](https://github.com/ExodusMovement/assets/compare/@exodus/bitcoin-api@2.29.1...@exodus/bitcoin-api@2.29.2) (2024-11-19)
+
+
+### Bug Fixes
+
+
+* fix: bitcoin use utxo.derivationPath path to resolve purpose (#4541)
+
+
+
+## [2.29.1](https://github.com/ExodusMovement/assets/compare/@exodus/bitcoin-api@2.29.0...@exodus/bitcoin-api@2.29.1) (2024-11-13)
+
+**Note:** Update exports in fee module of package @exodus/bitcoin-api
+
+
 ## [2.29.0](https://github.com/ExodusMovement/assets/compare/@exodus/bitcoin-api@2.28.0...@exodus/bitcoin-api@2.29.0) (2024-11-10)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/bitcoin-api",
-  "version": "2.29.0",
+  "version": "2.29.2",
   "description": "Exodus bitcoin-api",
   "type": "module",
   "main": "src/index.js",
@@ -28,7 +28,7 @@
     "@exodus/bitcoin-lib": "^2.4.2",
     "@exodus/bitcoinjs": "^1.1.0",
     "@exodus/crypto": "^1.0.0-rc.13",
-    "@exodus/currency": "^5.0.2",
+    "@exodus/currency": "^6.0.1",
     "@exodus/key-identifier": "^1.3.0",
     "@exodus/models": "^12.0.1",
     "@exodus/simple-retry": "^0.0.6",
@@ -56,5 +56,5 @@
     "type": "git",
     "url": "git+https://github.com/ExodusMovement/assets.git"
   },
-  "gitHead": "500277d2c77cd37f7d7a93eceec09e5b8c49f253"
+  "gitHead": "ebe9c86c8ecb6e6810613402e27ee62e8c308753"
 }

package/src/fee/fee-estimator.js

@@ -79,49 +79,17 @@ export const getSizeFactory = ({ defaultOutputType, addressApi }) => {
       4 + // n_locktime
       varuint.encodingLength(inputs.length) + // inputs_len
       // input[]
-      inputs.reduce((t, script) => {
-        if (script === null) script = '76a914000000000000000000000000000000000000000088ac' // P2PKH
-        assert(isHex(script), 'script must be hex string')
-
-        const scriptType = scriptClassifier.classifyScriptHex({ assetName, script })
-
-        const supportedTypes = supportedInputTypes[assetName] || supportedInputTypes.default
-        assert(
-          supportedTypes.includes(scriptType),
-          `Only ${supportedTypes.join(', ')} inputs supported right now`
-        )
-
-        const scriptSigLengths = compressed
-          ? scriptSigCompressedLengths
-          : scriptSigUncompressedLengths
-        const scriptSigLength = scriptSigLengths[scriptType]
-        return t + 32 + 4 + varuint.encodingLength(scriptSigLength) + scriptSigLength + 4
-      }, 0) +
+      inputs.reduce(
+        (t, script) => t + getInputSize({ script, scriptClassifier, assetName, compressed }),
+        0
+      ) +
       varuint.encodingLength(outputs.length) + // outputs_len
       // output[]
-      outputs.reduce((t, output) => {
-        // if (output === null) output = get(asset, 'address.versions.bech32') ? 'P2WSH' : 'P2PKH'
-
-        if (output === null) output = defaultOutputType
-
-        let scriptType = scriptClassify.types[output]
-        const supportedTypes = supportedOutputTypes[assetName] || supportedOutputTypes.default
-
-        if (!supportedTypes.includes(scriptType)) {
-          scriptType = scriptClassifier.classifyAddress({
-            assetName,
-            address: output,
-          })
-        }
-
-        assert(
-          supportedTypes.includes(scriptType),
-          `Only ${supportedTypes.join(', ')} outputs supported right now`
-        )
-
-        const scriptPubKeyLength = scriptPubKeyLengths[scriptType]
-        return t + 8 + varuint.encodingLength(scriptPubKeyLength) + scriptPubKeyLength
-      }, 0)
+      outputs.reduce(
+        (t, output) =>
+          t + getOutputSize({ output, scriptClassifier, assetName, defaultOutputType }),
+        0
+      )
 
     const witnessSize =
       1 + // marker
@@ -169,4 +137,45 @@ const getFeeEstimatorFactory = ({ defaultOutputType, addressApi }) => {
   return createDefaultFeeEstimator(getSize)
 }
 
+export const getInputSize = ({ script, scriptClassifier, assetName, compressed }) => {
+  if (script === null) script = '76a914000000000000000000000000000000000000000088ac' // P2PKH
+  assert(isHex(script), 'script must be hex string')
+
+  const scriptType = scriptClassifier.classifyScriptHex({ assetName, script })
+
+  const supportedTypes = supportedInputTypes[assetName] || supportedInputTypes.default
+  assert(
+    supportedTypes.includes(scriptType),
+    `Only ${supportedTypes.join(', ')} inputs supported right now`
+  )
+
+  const scriptSigLengths = compressed ? scriptSigCompressedLengths : scriptSigUncompressedLengths
+  const scriptSigLength = scriptSigLengths[scriptType]
+  return 32 + 4 + varuint.encodingLength(scriptSigLength) + scriptSigLength + 4
+}
+
+export const getOutputSize = ({ output, scriptClassifier, assetName, defaultOutputType }) => {
+  // if (output === null) output = get(asset, 'address.versions.bech32') ? 'P2WSH' : 'P2PKH'
+
+  if (output === null) output = defaultOutputType
+
+  let scriptType = scriptClassify.types[output]
+  const supportedTypes = supportedOutputTypes[assetName] || supportedOutputTypes.default
+
+  if (!supportedTypes.includes(scriptType)) {
+    scriptType = scriptClassifier.classifyAddress({
+      assetName,
+      address: output,
+    })
+  }
+
+  assert(
+    supportedTypes.includes(scriptType),
+    `Only ${supportedTypes.join(', ')} outputs supported right now`
+  )
+
+  const scriptPubKeyLength = scriptPubKeyLengths[scriptType]
+  return 8 + varuint.encodingLength(scriptPubKeyLength) + scriptPubKeyLength
+}
+
 export default getFeeEstimatorFactory

package/src/fee/index.js

@@ -1,2 +1,9 @@
 export * from './get-fee-resolver.js'
-export { default as getFeeEstimatorFactory } from './fee-estimator.js'
+export {
+  default as getFeeEstimatorFactory,
+  getInputSize,
+  getOutputSize,
+  getSizeFactory,
+} from './fee-estimator.js'
+export { default as createDefaultFeeEstimator } from './fee-utils.js'
+export { scriptClassifierFactory } from './script-classifier.js'

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

@@ -545,6 +545,7 @@ export class BitcoinMonitorScanner {
           script: vout.scriptPubKey.hex,
           value: val,
           rbfEnabled: txItem.rbf,
+          derivationPath: address.meta.keyIdentifier?.derivationPath,
           ...(txItem.vin.length === 0 ? { isCoinbase: true } : undefined),
         }
 

package/src/tx-send/dogecoin.js

@@ -8,6 +8,7 @@ export function createInputs(utxos) {
     value: utxo.value.toBaseBufferLE(8),
     script: utxo.script,
     sequence: getTxSequence(),
+    derivationPath: utxo.derivationPath,
   }))
 }
 

package/src/tx-send/index.js

@@ -765,6 +765,7 @@ function defaultCreateInputs(utxos, rbfEnabled) {
     script: utxo.script,
     sequence: getTxSequence(rbfEnabled),
     inscriptionId: utxo.inscriptionId,
+    derivationPath: utxo.derivationPath,
   }))
 }
 

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

@@ -14,20 +14,27 @@ export const createGetKeyWithMetadata = ({
   coinInfo,
   getKeyIdentifier,
 }) =>
-  memoize((address) => {
-    const purpose = resolvePurpose(address)
-    const networkInfo = coinInfo.toBitcoinJS()
+  memoize(
+    ({ address, derivationPath }) => {
+      const purpose = derivationPath
+        ? parseInt(derivationPath.split('/')[1].replace(/'/g, ''))
+        : resolvePurpose(address)
 
-    if (signer) {
-      return getPublicKeyFromSigner(signer, addressPathsMap, purpose, address, getKeyIdentifier)
-    }
+      assert(typeof purpose === 'number' && purpose, 'purpose must be a number')
+      const networkInfo = coinInfo.toBitcoinJS()
 
-    if (privateKeysAddressMap) {
-      return getPrivateKeyFromMap(privateKeysAddressMap, networkInfo, purpose, address)
-    }
+      if (signer) {
+        return getPublicKeyFromSigner(signer, addressPathsMap, purpose, address, getKeyIdentifier)
+      }
 
-    return getPrivateKeyFromHDKeys(hdkeys, addressPathsMap, networkInfo, purpose, address)
-  })
+      if (privateKeysAddressMap) {
+        return getPrivateKeyFromMap(privateKeysAddressMap, networkInfo, purpose, address)
+      }
+
+      return getPrivateKeyFromHDKeys(hdkeys, addressPathsMap, networkInfo, purpose, address)
+    },
+    ({ address, derivationPath }) => address + '_' + derivationPath
+  )
 
 function getPrivateKeyFromMap(privateKeysAddressMap, networkInfo, purpose, address) {
   const privateWif = getOwnProperty(privateKeysAddressMap, address, 'string')

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

@@ -34,14 +34,17 @@ export function createSignWithWallet({
       if (!inputInfo) continue
 
       const input = psbt.data.inputs[index]
-      const { address, sigHash } = inputInfo
+      const { address, sigHash, derivationPath } = inputInfo
       // The sighash value from the PSBT input itself will be used.
       // This list just represents possible sighash values the inputs can have.
       const allowedSigHashTypes =
         sigHash === undefined
           ? undefined // `SIGHASH_DEFAULT` is a default safe sig hash, always allow it.
           : [sigHash, Transaction.SIGHASH_ALL]
-      const { keyId, privateKey, publicKey, purpose } = await getKeyWithMetadata(address)
+      const { keyId, privateKey, publicKey, purpose } = await getKeyWithMetadata({
+        address,
+        derivationPath,
+      })
 
       const isTaprootInput = bip371.isTaprootInput(input)
       const isTapLeafScriptSpend = input.tapLeafScript && input.tapLeafScript.length > 0