@exodus/bitcoin-api 2.31.1 → 2.33.0

package/CHANGELOG.md

@@ -3,6 +3,26 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.33.0](https://github.com/ExodusMovement/assets/compare/@exodus/bitcoin-api@2.32.0...@exodus/bitcoin-api@2.33.0) (2025-06-30)
+
+
+### Features
+
+
+* feat: enable zcash buffer signer (#5732)
+
+
+
+## [2.32.0](https://github.com/ExodusMovement/assets/compare/@exodus/bitcoin-api@2.31.1...@exodus/bitcoin-api@2.32.0) (2025-04-01)
+
+
+### Features
+
+
+* feat(bitcoin): allow message signing with external signer (#5365)
+
+
+
 ## [2.31.1](https://github.com/ExodusMovement/assets/compare/@exodus/bitcoin-api@2.31.0...@exodus/bitcoin-api@2.31.1) (2025-03-19)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/bitcoin-api",
-  "version": "2.31.1",
+  "version": "2.33.0",
   "description": "Bitcoin transaction and fee monitors, RPC with the blockchain node, other networking code.",
   "type": "module",
   "main": "src/index.js",
@@ -23,7 +23,7 @@
     "@exodus/asset-lib": "^5.0.0",
     "@exodus/basic-utils": "^3.0.1",
     "@exodus/bip32": "^3.3.0",
-    "@exodus/bip322-js": "^2.0.0",
+    "@exodus/bip322-js": "^2.1.0",
     "@exodus/bip44-constants": "^195.0.0",
     "@exodus/bitcoin-lib": "^2.4.3",
     "@exodus/bitcoinjs": "^1.1.0",
@@ -34,7 +34,7 @@
     "@exodus/simple-retry": "^0.0.6",
     "bech32": "^1.1.3",
     "bip32-path": "^0.4.2",
-    "bs58check": "^2.1.2",
+    "bs58check": "^3.0.1",
     "delay": "^4.0.1",
     "lodash": "^4.17.21",
     "minimalistic-assert": "^1.0.1",
@@ -56,5 +56,5 @@
     "type": "git",
     "url": "git+https://github.com/ExodusMovement/assets.git"
   },
-  "gitHead": "f1b6ccb198231db1fb6c9c51a0173967ec4efd1f"
+  "gitHead": "b680523e8d9e053a441e4ce863c83ada389b7a73"
 }

package/src/index.js

@@ -23,7 +23,8 @@ export * from './move-funds.js'
 export { createEncodeMultisigContract } from './multisig-address.js'
 export { toAsyncSigner } from './tx-sign/taproot.js'
 export * from './ordinals-utils.js'
-export { signMessage } from './sign-message.js'
+export { signMessage, signMessageWithSigner } from './sign-message.js'
+export { writePsbtBlockHeight, readPsbtBlockHeight } from './psbt-proprietary-types.js'
 
 // TODO: remove these, kept for compat
 export { scriptClassify } from '@exodus/bitcoinjs'

package/src/psbt-proprietary-types.js

@@ -0,0 +1,53 @@
+/*
+ * Set of utilities to add proprietary use types to PSBT
+ * see https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki#proprietary-use-type
+ */
+
+import assert from 'minimalistic-assert'
+import varuint from 'varuint-bitcoin'
+
+const IDENTIFIER = 'exodus'
+const PROP_TYPE_MARKER = 0xfc
+
+export const SubType = Object.freeze({
+  BlockHeight: 0x01,
+})
+
+const buildPropKey = (subType) => {
+  const idBuf = Buffer.from(IDENTIFIER, 'utf8')
+  const parts = [
+    Buffer.from([PROP_TYPE_MARKER]),
+    varuint.encode(idBuf.length),
+    idBuf,
+    varuint.encode(subType),
+  ]
+  return Buffer.concat(parts)
+}
+
+const u32LE = (n) => {
+  const b = Buffer.allocUnsafe(4)
+  b.writeUInt32LE(n >>> 0, 0)
+  return b
+}
+
+const findProprietaryVal = (unknownArr, subType) => {
+  if (!unknownArr) return
+
+  const prefix = buildPropKey(subType)
+
+  return unknownArr.find((kv) => kv.key.equals(prefix))
+}
+
+export const writePsbtBlockHeight = (psbt, height) => {
+  assert(
+    Number.isInteger(height) && height >= 0 && height <= 4_294_967_295,
+    'blockHeight must be a positive number between 0 and 4294967295'
+  )
+
+  psbt.addUnknownKeyValToGlobal({ key: buildPropKey(SubType.BlockHeight), value: u32LE(height) })
+}
+
+export const readPsbtBlockHeight = (psbt) => {
+  const kv = findProprietaryVal(psbt.data.globalMap.unknownKeyVals, SubType.BlockHeight)
+  return kv ? kv.value.readUInt32LE(0) : undefined
+}

package/src/sign-message.js

@@ -9,3 +9,13 @@ export const signMessage = async ({ privateKey, message: _message }) => {
 
   return Buffer.isBuffer(signedMessage) ? signedMessage : Buffer.from(signedMessage, 'base64')
 }
+
+export const signMessageWithSigner = async ({ signer, message: { bip322Message, ...rest } }) => {
+  assert(bip322Message, `expected bip322Message`)
+  assert(Object.keys(rest).length === 0, `unexpected message properties`)
+
+  const { address, message } = bip322Message
+  const signedMessage = await Signer.signAsync(signer, address, message)
+
+  return Buffer.isBuffer(signedMessage) ? signedMessage : Buffer.from(signedMessage, 'base64')
+}

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

@@ -39,7 +39,18 @@ export const createGetKeyWithMetadata = ({
 function getPrivateKeyFromMap(privateKeysAddressMap, networkInfo, purpose, address) {
   const privateWif = getOwnProperty(privateKeysAddressMap, address, 'string')
   assert(privateWif, `there is no private key for address ${address}`)
-  const { privateKey, compressed } = ECPair.fromWIF(privateWif, networkInfo)
+
+  // ECPair.fromWIF() rejects network objects whose pubKeyHash/scriptHash are wider than one byte (UInt8).
+  // so we skip the network argument in that case and let the library infer it from the WIF prefix.
+  const useNet =
+    networkInfo && networkInfo.pubKeyHash <= 0xff && networkInfo.scriptHash <= 0xff
+      ? networkInfo
+      : undefined
+
+  const { privateKey, compressed } = useNet
+    ? ECPair.fromWIF(privateWif, useNet)
+    : ECPair.fromWIF(privateWif)
+
   const publicKey = privateKeyToPublicKey({ privateKey, compressed, format: 'buffer' })
   return { privateKey, publicKey, purpose }
 }

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

@@ -1,6 +1,8 @@
 import { Psbt as DefaultPsbt, Transaction as DefaultTransaction } from '@exodus/bitcoinjs'
 import assert from 'minimalistic-assert'
 
+import { writePsbtBlockHeight } from '../psbt-proprietary-types.js'
+
 const _MAXIMUM_FEE_RATES = {
   qtumignition: 25_000,
   ravencoin: 1_000_000,
@@ -40,6 +42,7 @@ export function createPrepareForSigning({
 
     // Create PSBT based on internal Exodus data structure
     const psbt = createPsbtFromTxData({
+      assetName,
       ...unsignedTx.txData,
       ...unsignedTx.txMeta,
       resolvePurpose,
@@ -68,6 +71,7 @@ function createPsbtFromTxData({
   assetName,
   Psbt,
   Transaction,
+  blockHeight,
 }) {
   // use harcoded max fee rates for specific assets
   // if undefined, will be set to default value by PSBT (2500)
@@ -75,6 +79,11 @@ function createPsbtFromTxData({
 
   const psbt = new Psbt({ maximumFeeRate, network: networkInfo })
 
+  // If present, add blockHeight as a proprietary field
+  if (blockHeight) {
+    writePsbtBlockHeight(psbt, blockHeight)
+  }
+
   // Fill tx
   for (const { txId, vout, address, value, script, sequence, tapLeafScript } of inputs) {
     // TODO: don't use the purpose as intermediate variable
@@ -83,9 +92,15 @@ function createPsbtFromTxData({
 
     const isSegwitAddress = purpose === 84
     const isTaprootAddress = purpose === 86
+    const isZcashAsset = assetName === 'zcash'
 
     const txIn = { hash: txId, index: vout, sequence }
 
+    if (isZcashAsset) {
+      txIn.script = script
+      txIn.value = value
+    }
+
     if (isTaprootAddress && tapLeafScript) {
       txIn.tapLeafScript = tapLeafScript
     }
@@ -97,12 +112,9 @@ function createPsbtFromTxData({
 
     const rawTx = (rawTxs || []).find((t) => t.txId === txId)
 
-    // Non-taproot outputs require the full transaction
-    assert(
-      isTaprootAddress || !!rawTx?.rawData,
-      `Non-taproot outputs require the full previous transaction.`
-    )
-    if (!isTaprootAddress) {
+    if (!isTaprootAddress && !isZcashAsset) {
+      assert(!!rawTx?.rawData, `Non-taproot outputs require the full previous transaction.`)
+
       const rawTxBuffer = Buffer.from(rawTx.rawData, 'hex')
       if (canParseTx(Transaction, rawTxBuffer)) {
         txIn.nonWitnessUtxo = rawTxBuffer

package/src/tx-sign/taproot.js

@@ -47,6 +47,19 @@ export function toAsyncSigner({ privateKey, publicKey, isTaprootKeySpend }) {
         extraEntropy: defaultEntropy.getSchnorrEntropy(), // mockable with jest.spyOn
         format: 'buffer',
       }),
+    signEncoded: async ({ data, enc = 'sig' }) => {
+      assert(
+        ['der', 'sig'].includes(enc),
+        'signBuffer: invalid encoding type. Expected "der" or "sig".'
+      )
+      return secp256k1.ecdsaSignHash({
+        hash: data,
+        der: enc === 'der',
+        privateKey,
+        extraEntropy: null,
+        format: 'buffer',
+      })
+    },
     publicKey,
     privateKey,
   }
@@ -79,6 +92,9 @@ export async function toAsyncBufferSigner({ signer, keyId, isTaprootKeySpend })
         extraEntropy: defaultEntropy.getSchnorrEntropy(),
       })
     },
+    signEncoded: async ({ data, enc = 'sig' }) => {
+      return signer.sign({ data, keyId, enc, signatureType: 'ecdsa' })
+    },
     publicKey,
   }
 }