Merge pull request #7209 from BitGo/BTC-2668.use-secp256k1-instead-of-utxolib

feat(utxo-lib): standardize secp256k1 cryptography implementation

Author: OttoAllmendinger

modules/abstract-utxo/package.json

@@ -42,6 +42,7 @@
     ]
   },
   "dependencies": {
+    "@bitgo/secp256k1": "^1.5.0",
     "@bitgo/blockapis": "^1.12.0",
     "@bitgo/sdk-api": "^1.70.1",
     "@bitgo/sdk-core": "^36.12.0",

modules/abstract-utxo/src/abstractUtxoCoin.ts

@@ -3,7 +3,8 @@ import { randomBytes } from 'crypto';
 
 import _ from 'lodash';
 import * as utxolib from '@bitgo/utxo-lib';
-import { bip32, bitgo, getMainnet, isMainnet, isTestnet } from '@bitgo/utxo-lib';
+import { bip32 } from '@bitgo/secp256k1';
+import { bitgo, getMainnet, isMainnet, isTestnet } from '@bitgo/utxo-lib';
 import {
   AddressCoinSpecific,
   AddressTypeChainMismatchError,
@@ -46,7 +47,6 @@ import {
   Wallet,
   isValidPrv,
   isValidXprv,
-  bitcoin,
 } from '@bitgo/sdk-core';
 
 import {
@@ -1160,7 +1160,7 @@ export abstract class AbstractUtxoCoin extends BaseCoin {
       throw new Error('invalid private key');
     }
     if (publicKey) {
-      const genPubKey = bitcoin.HDNode.fromBase58(prv).neutered().toBase58();
+      const genPubKey = bip32.fromBase58(prv).neutered().toBase58();
       if (genPubKey !== publicKey) {
         throw new Error('public key does not match private key');
       }

modules/abstract-utxo/src/descriptor/builder/parse.ts

@@ -1,5 +1,4 @@
-import { BIP32Interface } from '@bitgo/utxo-lib';
-import * as utxolib from '@bitgo/utxo-lib';
+import { BIP32Interface, bip32 } from '@bitgo/secp256k1';
 import { Descriptor } from '@bitgo/wasm-miniscript';
 
 import { DescriptorBuilder, getDescriptorFromBuilder } from './builder';
@@ -55,7 +54,7 @@ function parseMulti(node: unknown): {
   });
   return {
     threshold,
-    keys: keyWithPath.map((k) => utxolib.bip32.fromBase58(k.xpub)),
+    keys: keyWithPath.map((k) => bip32.fromBase58(k.xpub)),
     path: paths[0],
   };
 }

modules/abstract-utxo/src/descriptor/createWallet/createDescriptorWallet.ts

@@ -1,5 +1,5 @@
 import { BitGoAPI } from '@bitgo/sdk-api';
-import * as utxolib from '@bitgo/utxo-lib';
+import { bip32 } from '@bitgo/secp256k1';
 import { Wallet } from '@bitgo/sdk-core';
 
 import { AbstractUtxoCoin } from '../../abstractUtxoCoin';
@@ -56,12 +56,12 @@ export async function createDescriptorWalletWithWalletPassphrase(
   if (!userKeychain.prv) {
     throw new Error('Missing private key');
   }
-  const userKey = utxolib.bip32.fromBase58(userKeychain.prv);
+  const userKey = bip32.fromBase58(userKeychain.prv);
   const cosigners = [backupKeychain, bitgoKeychain].map((keychain) => {
     if (!keychain.pub) {
       throw new Error('Missing public key');
     }
-    return utxolib.bip32.fromBase58(keychain.pub);
+    return bip32.fromBase58(keychain.pub);
   });
   return createDescriptorWallet(bitgo, coin, {
     ...params,

modules/abstract-utxo/src/keychains.ts

@@ -1,7 +1,7 @@
 import assert from 'assert';
 
 import * as t from 'io-ts';
-import * as utxolib from '@bitgo/utxo-lib';
+import { BIP32Interface, bip32 } from '@bitgo/secp256k1';
 import { IRequestTracer, IWallet, KeyIndices, promiseProps, Triple } from '@bitgo/sdk-core';
 
 import { AbstractUtxoCoin } from './abstractUtxoCoin';
@@ -48,12 +48,12 @@ export function toKeychainTriple(keychains: UtxoNamedKeychains): Triple<UtxoKeyc
 
 export function toBip32Triple(
   keychains: UtxoNamedKeychains | Triple<{ pub: string }> | Triple<string>
-): Triple<utxolib.BIP32Interface> {
+): Triple<BIP32Interface> {
   if (Array.isArray(keychains)) {
     return keychains.map((keychain: { pub: string } | string) => {
       const v = typeof keychain === 'string' ? keychain : keychain.pub;
-      return utxolib.bip32.fromBase58(v);
-    }) as Triple<utxolib.BIP32Interface>;
+      return bip32.fromBase58(v);
+    }) as Triple<BIP32Interface>;
   }
 
   return toBip32Triple(toKeychainTriple(keychains));

modules/abstract-utxo/src/offlineVault/OfflineVaultHalfSigned.ts

@@ -1,5 +1,5 @@
+import { BIP32Interface, bip32 } from '@bitgo/secp256k1';
 import * as utxolib from '@bitgo/utxo-lib';
-import { BIP32Interface } from '@bitgo/utxo-lib';
 import { BaseCoin } from '@bitgo/sdk-core';
 
 import { getNetworkFromChain } from '../names';
@@ -23,7 +23,7 @@ export function createHalfSigned(
 ): OfflineVaultHalfSigned {
   const network = getNetworkFromChain(coin);
   if (typeof prv === 'string') {
-    prv = utxolib.bip32.fromBase58(prv);
+    prv = bip32.fromBase58(prv);
   }
   prv = BaseCoin.deriveKeyWithSeedBip32(prv, derivationId).key;
   if (!OfflineVaultSignable.is(tx)) {

modules/abstract-utxo/src/offlineVault/OfflineVaultSignable.ts

@@ -1,4 +1,4 @@
-import * as utxolib from '@bitgo/utxo-lib';
+import { BIP32Interface, bip32 } from '@bitgo/secp256k1';
 import { Triple } from '@bitgo/sdk-core';
 import * as t from 'io-ts';
 
@@ -28,8 +28,8 @@ export type OfflineVaultUnsigned = t.TypeOf<typeof OfflineVaultSignable>;
 
 type WithXpub = { xpub: string };
 type NamedKeys = { user: WithXpub; backup: WithXpub; bitgo: WithXpub };
-export function toKeyTriple(xpubs: NamedKeys): Triple<utxolib.BIP32Interface> {
+export function toKeyTriple(xpubs: NamedKeys): Triple<BIP32Interface> {
   return [xpubs.user.xpub, xpubs.backup.xpub, xpubs.bitgo.xpub].map((xpub) =>
-    utxolib.bip32.fromBase58(xpub)
-  ) as Triple<utxolib.BIP32Interface>;
+    bip32.fromBase58(xpub)
+  ) as Triple<BIP32Interface>;
 }

modules/abstract-utxo/src/recovery/crossChainRecovery.ts

@@ -1,5 +1,5 @@
 import * as utxolib from '@bitgo/utxo-lib';
-import { bip32, BIP32Interface } from '@bitgo/utxo-lib';
+import { BIP32Interface, bip32 } from '@bitgo/secp256k1';
 import { Dimensions } from '@bitgo/unspents';
 import { BitGoBase, IWallet, Keychain, Triple, Wallet } from '@bitgo/sdk-core';
 import { decrypt } from '@bitgo/sdk-api';

modules/abstract-utxo/src/transaction/fixedScript/explainTransaction.ts

@@ -1,6 +1,7 @@
 import * as utxolib from '@bitgo/utxo-lib';
 import { bip322 } from '@bitgo/utxo-core';
-import { bip32, BIP32Interface, bitgo } from '@bitgo/utxo-lib';
+import { BIP32Interface, bip32 } from '@bitgo/secp256k1';
+import { bitgo } from '@bitgo/utxo-lib';
 import { Triple } from '@bitgo/sdk-core';
 import * as utxocore from '@bitgo/utxo-core';
 
@@ -302,7 +303,7 @@ export function explainPsbt<TNumber extends number | bigint, Tx extends bitgo.Ut
       utxocore.paygo.verifyPayGoAddressProof(
         psbt,
         payGoVerificationInfo.outputIndex,
-        utxolib.bip32.fromBase58(payGoVerificationInfo.verificationPubkey, utxolib.networks.bitcoin).publicKey
+        bip32.fromBase58(payGoVerificationInfo.verificationPubkey, utxolib.networks.bitcoin).publicKey
       );
     } catch (e) {
       if (strict) {

modules/abstract-utxo/src/transaction/fixedScript/signTransaction.ts

@@ -1,7 +1,8 @@
 import assert from 'assert';
 
 import _ from 'lodash';
-import { bip32, BIP32Interface, bitgo } from '@bitgo/utxo-lib';
+import { BIP32Interface, bip32 } from '@bitgo/secp256k1';
+import { bitgo } from '@bitgo/utxo-lib';
 import * as utxolib from '@bitgo/utxo-lib';
 import { isTriple, Triple } from '@bitgo/sdk-core';