chore(utxo-core): generated index.ts and moved test function

TICKET: BTC-2150

Author: christopher-fong

modules/utxo-core/src/index.ts

@@ -1,7 +1,7 @@
 export * as bip65 from './bip65';
 export * as descriptor from './descriptor';
 export * as testutil from './testutil';
+export * as paygo from './paygo';
 export * from './dustThreshold';
 export * from './Output';
 export * from './xOnlyPubkey';
-export * from './paygo/ExtractAddressPayGoAttestation';

modules/utxo-core/src/paygo/ExtractAddressPayGoAttestation.ts

@@ -1,6 +1,6 @@
 import assert from 'assert';
 
-import * as utxolib from '@bitgo/utxo-lib';
+import { varuint } from '@bitgo/utxo-lib';
 
 // The signed address will always have the following structure:
 // 0x18Bitcoin Signed Message:\n<varint_length><ENTROPY><ADDRESS><UUID>
@@ -32,7 +32,7 @@ export function extractAddressBufferFromPayGoAttestationProof(message: Buffer):
 
   // we decode the varint of the message which is uint32
   // https://en.bitcoin.it/wiki/Protocol_documentation
-  const varInt = utxolib.varuint.varuint.decode(message, offset);
+  const varInt = varuint.varuint.decode(message, offset);
   assert(varInt);
   offset += 1;
 

modules/utxo-core/src/paygo/index.ts

@@ -0,0 +1 @@
+export * from './ExtractAddressPayGoAttestation';

modules/utxo-core/src/testutil/generatePayGoAttestationProof.utils.ts

@@ -0,0 +1,43 @@
+import crypto from 'crypto';
+
+import { varuint } from '@bitgo/utxo-lib';
+/** We have a mirrored function similar to our hsm that generates our Bitcoin signed
+ * message so that we can use for testing. This creates a random entropy as well using
+ * the nilUUID structure to construct our uuid buffer and given our address we can
+ * directly encode it into our message.
+ *
+ * @param attestationPrvKey
+ * @param uuid
+ * @param address
+ * @returns
+ */
+export function generatePayGoAttestationProof(uuid: string, address: Buffer): Buffer {
+  // <0x18Bitcoin Signed Message:\n
+  const prefixByte = Buffer.from([0x18]);
+  const prefixMessage = Buffer.from('Bitcoin Signed Message:\n');
+  const prefixBuffer = Buffer.concat([prefixByte, prefixMessage]);
+
+  // <ENTROPY>
+  const entropyLength = 64;
+  const entropy = crypto.randomBytes(entropyLength);
+
+  // <UUID>
+  const uuidBuffer = Buffer.from(uuid);
+  const uuidBufferLength = uuidBuffer.length;
+
+  // <ADDRESS>
+  const addressBufferLength = address.length;
+
+  // <VARINT_LENGTH>
+  const msgLength = entropyLength + addressBufferLength + uuidBufferLength;
+  const msgLengthBuffer = varuint.varuint.encode(msgLength);
+
+  // <0x18Bitcoin Signed Message:\n<LENGTH><ENTROPY><ADDRESS><UUID>
+  const proofMessage = Buffer.concat([prefixBuffer, msgLengthBuffer, entropy, address, uuidBuffer]);
+
+  // we sign this with the priv key
+  // don't know what sign function to call. Since this is just a mirrored function don't know if we need
+  // to include this part.
+  // const signedMsg = sign(attestationPrvKey, proofMessage);
+  return proofMessage;
+}

modules/utxo-core/src/testutil/index.ts

@@ -1,3 +1,4 @@
 export * from './fixtures.utils';
 export * from './key.utils';
 export * from './toPlainObject.utils';
+export * from './generatePayGoAttestationProof.utils';

modules/utxo-core/test/paygo/ExtractAddressPayGoAttestation.ts

@@ -1,15 +1,14 @@
 import * as assert from 'assert';
 
-import * as utxolib from '@bitgo/utxo-lib';
-
-import { extractAddressBufferFromPayGoAttestationProof } from '../../src/paygo/ExtractAddressPayGoAttestation';
+import { extractAddressBufferFromPayGoAttestationProof } from '../../src/paygo';
+import { generatePayGoAttestationProof } from '../../src/testutil';
 
 const addressFromPubKeyBase58 = 'bitgoAddressToExtract';
 const bufferAddressPubKeyB58 = Buffer.from(addressFromPubKeyBase58);
 
 describe('extractAddressBufferFromPayGoAttestationProof', () => {
   it('should extractAddressBufferFromPayGoAttestationProof properly', () => {
-    const paygoAttestationProof = utxolib.testutil.generatePayGoAttestationProof(
+    const paygoAttestationProof = generatePayGoAttestationProof(
       '00000000-0000-0000-0000-000000000000',
       bufferAddressPubKeyB58
     );
@@ -18,7 +17,7 @@ describe('extractAddressBufferFromPayGoAttestationProof', () => {
   });
 
   it('should extract the paygo address paygo attestation proof given a non nilUUID', () => {
-    const paygoAttestationProof = utxolib.testutil.generatePayGoAttestationProof(
+    const paygoAttestationProof = generatePayGoAttestationProof(
       '12345678-1234-4567-6890-231928472123',
       bufferAddressPubKeyB58
     );
@@ -27,7 +26,7 @@ describe('extractAddressBufferFromPayGoAttestationProof', () => {
   });
 
   it('should not extract the correct address given a uuid of wrong format', () => {
-    const paygoAttestationProof = utxolib.testutil.generatePayGoAttestationProof(
+    const paygoAttestationProof = generatePayGoAttestationProof(
       '000000000000000-000000-0000000-000000-0000000000000000',
       bufferAddressPubKeyB58
     );

modules/utxo-lib/src/bitgo/ExtractAddressPayGoAttestation.ts

@@ -1,6 +1,4 @@
 import * as assert from 'assert';
-import { varuint } from 'bitcoinjs-lib/src/bufferutils';
-import * as crypto from 'crypto';
 
 import {
   createOutputScriptP2shP2pk,
@@ -285,44 +283,3 @@ export function verifyFullySignedSignatures(
     }
   });
 }
-
-/** We have a mirrored function similar to our hsm that generates our Bitcoin signed
- * message so that we can use for testing. This creates a random entropy as well using
- * the nilUUID structure to construct our uuid buffer and given our address we can
- * directly encode it into our message.
- *
- * @param attestationPrvKey
- * @param uuid
- * @param address
- * @returns
- */
-export function generatePayGoAttestationProof(uuid: string, address: Buffer): Buffer {
-  // <0x18Bitcoin Signed Message:\n
-  const prefixByte = Buffer.from([0x18]);
-  const prefixMessage = Buffer.from('Bitcoin Signed Message:\n');
-  const prefixBuffer = Buffer.concat([prefixByte, prefixMessage]);
-
-  // <ENTROPY>
-  const entropyLength = 64;
-  const entropy = crypto.randomBytes(entropyLength);
-
-  // <UUID>
-  const uuidBuffer = Buffer.from(uuid);
-  const uuidBufferLength = uuidBuffer.length;
-
-  // <ADDRESS>
-  const addressBufferLength = address.length;
-
-  // <VARINT_LENGTH>
-  const msgLength = entropyLength + addressBufferLength + uuidBufferLength;
-  const msgLengthBuffer = varuint.encode(msgLength);
-
-  // <0x18Bitcoin Signed Message:\n<LENGTH><ENTROPY><ADDRESS><UUID>
-  const proofMessage = Buffer.concat([prefixBuffer, msgLengthBuffer, entropy, address, uuidBuffer]);
-
-  // we sign this with the priv key
-  // don't know what sign function to call. Since this is just a mirrored function don't know if we need
-  // to include this part.
-  // const signedMsg = sign(attestationPrvKey, proofMessage);
-  return proofMessage;
-}