Merge pull request #6393 from BitGo/BTC-0.bip32utils

feat(utxo-core): modernize bip32utils module

Author: christopher-fong

modules/bitgo/test/unit/bip32util.ts

@@ -55,11 +55,7 @@
     "@bitgo/utxo-lib": "^11.6.1",
     "@bitgo/wasm-miniscript": "2.0.0-beta.7",
     "bip174": "npm:@bitgo-forks/[email protected]",
-    "bitcoinjs-message": "npm:@bitgo-forks/[email protected]",
-    "lodash": "^4.17.15"
-  },
-  "devDependencies": {
-    "@types/lodash": "^4.14.151"
+    "bitcoinjs-message": "npm:@bitgo-forks/[email protected]"
   },
   "gitHead": "18e460ddf02de2dbf13c2aa243478188fb539f0c"
 }

modules/utxo-core/package.json

@@ -1,13 +1,12 @@
 import * as utxolib from '@bitgo/utxo-lib';
-import * as _ from 'lodash';
 import * as bitcoinMessage from 'bitcoinjs-message';
 import { BIP32Interface } from '@bitgo/utxo-lib';
 /**
  * bip32-aware wrapper around bitcoin-message package
  * @see {bitcoinMessage.sign}
  */
 export function signMessage(
-  message: string,
+  message: string | Buffer,
   privateKey: BIP32Interface | Buffer,
   network: { messagePrefix: string }
 ): Buffer {
@@ -17,7 +16,7 @@ export function signMessage(
       throw new Error(`must provide privateKey`);
     }
   }
-  if (!_.isObject(network) || !_.isString(network.messagePrefix)) {
+  if (network === null || typeof network !== 'object' || typeof network.messagePrefix !== 'string') {
     throw new Error(`invalid argument 'network'`);
   }
   const compressed = true;
@@ -29,15 +28,15 @@ export function signMessage(
  * @see {bitcoinMessage.verify}
  */
 export function verifyMessage(
-  message: string,
+  message: string | Buffer,
   publicKey: BIP32Interface | Buffer,
   signature: Buffer,
   network: { messagePrefix: string }
 ): boolean {
   if (!Buffer.isBuffer(publicKey)) {
     publicKey = publicKey.publicKey;
   }
-  if (!_.isObject(network) || !_.isString(network.messagePrefix)) {
+  if (network === null || typeof network !== 'object' || typeof network.messagePrefix !== 'string') {
     throw new Error(`invalid argument 'network'`);
   }
 

modules/utxo-core/src/bip32utils.ts

@@ -0,0 +1,32 @@
+import * as crypto from 'crypto';
+import * as assert from 'assert';
+
+import * as utxolib from '@bitgo/utxo-lib';
+
+import { signMessage, verifyMessage } from '../src/bip32utils';
+
+describe('bip32utils', function () {
+  function getSeedBuffers(length: number) {
+    return Array.from({ length }).map((_, i) => crypto.createHash('sha256').update(`${i}`).digest());
+  }
+  it('signMessage/verifyMessage', function () {
+    const keys = getSeedBuffers(4).map((seed) => utxolib.bip32.fromSeed(seed));
+    const messages = ['hello', 'goodbye', Buffer.from('\x01\x02\x03'), Buffer.from('')];
+    keys.forEach((key) => {
+      messages.forEach((message) => {
+        const signature = signMessage(message, key, utxolib.networks.bitcoin);
+
+        keys.forEach((otherKey) => {
+          messages.forEach((otherMessage) => {
+            const expectValid = message === otherMessage && key === otherKey;
+            assert.strictEqual(verifyMessage(otherMessage, otherKey, signature, utxolib.networks.bitcoin), expectValid);
+            assert.strictEqual(
+              verifyMessage(Buffer.from(otherMessage), otherKey, signature, utxolib.networks.bitcoin),
+              expectValid
+            );
+          });
+        });
+      });
+    });
+  });
+});