chore(utxo-core): renamed files and moved helper to own file

TICKET: BTC-2047

chore(utxo-core): updated index.ts

TICKET: BTC-2047

chore(utxo-core): added asserts for address in attestation

TICKET: BTC-2047

chore(utxo-core): naming convention

TICKET: BTC-2047

Author: christopher-fong

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

@@ -0,0 +1,19 @@
+import assert from 'assert';
+
+import * as utxolib from '@bitgo/utxo-lib';
+export const NIL_UUID = '00000000-0000-0000-0000-000000000000';
+
+/** This function reconstructs the proof <ENTROPY><ADDRESS><UUID>
+ * given the address and entropy.
+ *
+ * @param address
+ * @param entropy
+ * @returns
+ */
+export function createPayGoAttestationBuffer(address: string, entropy: Buffer, network: utxolib.Network): Buffer {
+  assert(address.length > 0);
+  const isValidAddress = utxolib.address.toOutputScript(address, network);
+  assert(isValidAddress, `Address ${address} is not a valid address.`);
+  const addressBuffer = Buffer.from(address);
+  return Buffer.concat([entropy, addressBuffer, Buffer.from(NIL_UUID)]);
+}

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

@@ -1 +1 @@
-export * from './PayGoUtils';
+export * from './payGoAddressProof';

modules/utxo-core/src/paygo/psbt/PayGoUtils.ts renamed to modules/utxo-core/src/paygo/psbt/payGoAddressProof.ts

@@ -2,6 +2,7 @@ import * as utxolib from '@bitgo/utxo-lib';
 import { checkForOutput } from 'bip174/src/lib/utils';
 
 import { verifyMessage } from '../../bip32utils';
+import { createPayGoAttestationBuffer } from '../attestation';
 
 import {
   ErrorMultiplePayGoProof,
@@ -11,8 +12,6 @@ import {
   ErrorPayGoAddressProofFailedVerification,
 } from './Errors';
 
-const NILLUUID = '00000000-0000-0000-0000-000000000000';
-
 /** This function adds the entropy and signature into the PSBT output unknown key vals.
  * We store the entropy so that we reconstruct the message <ENTROPY><ADDRESS><UUID>
  * to later verify.
@@ -75,7 +74,7 @@ export function verifyPayGoAddressProof(
   const addressFromOutput = utxolib.address.fromOutputScript(output.script, psbt.network);
 
   // We construct our message <ENTROPY><ADDRESS><UUID>
-  const message = createPayGoAttestationBuffer(addressFromOutput, entropy);
+  const message = createPayGoAttestationBuffer(addressFromOutput, entropy, psbt.network);
 
   if (!verifyMessage(message.toString(), verificationPubkey, signature, utxolib.networks.bitcoin)) {
     throw new ErrorPayGoAddressProofFailedVerification();
@@ -109,15 +108,3 @@ export function getPayGoAddressProofOutputIndex(psbt: utxolib.bitgo.UtxoPsbt): n
 export function psbtOutputIncludesPaygoAddressProof(psbt: utxolib.bitgo.UtxoPsbt): boolean {
   return getPayGoAddressProofOutputIndex(psbt) !== undefined;
 }
-
-/** This function reconstructs the proof <ENTROPY><ADDRESS><UUID>
- * given the address and entropy.
- *
- * @param address
- * @param entropy
- * @returns
- */
-export function createPayGoAttestationBuffer(address: string, entropy: Buffer): Buffer {
-  const addressBuffer = Buffer.from(address);
-  return Buffer.concat([entropy, addressBuffer, Buffer.from(NILLUUID)]);
-}

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

@@ -0,0 +1,24 @@
+import assert from 'assert';
+
+import { createPayGoAttestationBuffer } from '../../src/paygo/attestation';
+import { generatePayGoAttestationProof } from '../../src/testutil';
+
+import { addressProofEntropy, addressProofMsgBuffer, addressToVerify, network } from './psbt/payGoAddressProof';
+
+describe('createPayGoAttestationBuffer', () => {
+  it('should create a PayGo Attestation proof matching with original proof', () => {
+    const payGoAttestationProof = createPayGoAttestationBuffer(addressToVerify, addressProofEntropy, network);
+    assert.strictEqual(payGoAttestationProof.toString(), addressProofMsgBuffer.toString());
+    assert(Buffer.compare(payGoAttestationProof, addressProofMsgBuffer) === 0);
+  });
+
+  it('should create a PayGo Attestation proof that does not match with different uuid', () => {
+    const addressProofBufferDiffUuid = generatePayGoAttestationProof(
+      '00000000-0000-0000-0000-000000000001',
+      Buffer.from(addressToVerify)
+    );
+    const payGoAttestationProof = createPayGoAttestationBuffer(addressToVerify, addressProofEntropy, network);
+    assert.notStrictEqual(payGoAttestationProof.toString(), addressProofBufferDiffUuid.toString());
+    assert(Buffer.compare(payGoAttestationProof, addressProofBufferDiffUuid) !== 0);
+  });
+});

modules/utxo-core/test/paygo/psbt/PayGoUtils.ts renamed to modules/utxo-core/test/paygo/psbt/payGoAddressProof.ts

@@ -8,17 +8,17 @@ import { checkForOutput } from 'bip174/src/lib/utils';
 
 import {
   addPayGoAddressProof,
-  createPayGoAttestationBuffer,
   getPayGoAddressProofOutputIndex,
   psbtOutputIncludesPaygoAddressProof,
   verifyPayGoAddressProof,
-} from '../../../src/paygo/psbt/PayGoUtils';
+} from '../../../src/paygo/psbt/payGoAddressProof';
 import { generatePayGoAttestationProof } from '../../../src/testutil/generatePayGoAttestationProof.utils';
 import { parseVaspProof } from '../../../src/testutil/parseVaspProof';
 import { signMessage } from '../../../src/bip32utils';
+import { NIL_UUID } from '../../../src/paygo/attestation';
 
 // To construct our PSBTs
-const network = utxolib.networks.bitcoin;
+export const network = utxolib.networks.bitcoin;
 const keys = [1, 2, 3].map((v) => utxolib.bip32.fromSeed(Buffer.alloc(16, `test/2/${v}`), network));
 const rootWalletKeys = new utxolib.bitgo.RootWalletKeys([keys[0], keys[1], keys[2]]);
 
@@ -34,34 +34,31 @@ const psbtOutputs = utxolib.testutil.outputScriptTypes.map((scriptType) => ({
 
 // wallet pub and priv key for tbtc
 const dummyPub1 = rootWalletKeys.deriveForChainAndIndex(50, 200);
-const attestationPubKey = dummyPub1.user.publicKey;
-const attestationPrvKey = dummyPub1.user.privateKey!;
-
-// UUID structure
-const nillUUID = '00000000-0000-0000-0000-000000000000';
+export const attestationPubKey = dummyPub1.user.publicKey;
+export const attestationPrvKey = dummyPub1.user.privateKey!;
 
 // our xpub converted to base58 address
-const addressToVerify = utxolib.address.toBase58Check(
+export const addressToVerify = utxolib.address.toBase58Check(
   utxolib.crypto.hash160(Buffer.from(dummyPub1.backup.publicKey)),
   utxolib.networks.bitcoin.pubKeyHash,
   utxolib.networks.bitcoin
 );
 
 // this should be retuning a Buffer
-const addressProofBuffer = generatePayGoAttestationProof(nillUUID, Buffer.from(addressToVerify));
-const addressProofMsgBuffer = parseVaspProof(addressProofBuffer);
+export const addressProofBuffer = generatePayGoAttestationProof(NIL_UUID, Buffer.from(addressToVerify));
+export const addressProofMsgBuffer = parseVaspProof(addressProofBuffer);
 // We know that that the entropy is a set 64 bytes.
-const addressProofEntropy = addressProofMsgBuffer.subarray(0, 65);
+export const addressProofEntropy = addressProofMsgBuffer.subarray(0, 65);
 
 // signature with the given msg addressProofBuffer
-const sig = signMessage(addressProofMsgBuffer.toString(), attestationPrvKey!, network);
+export const sig = signMessage(addressProofMsgBuffer.toString(), attestationPrvKey!, network);
 
 function getTestPsbt() {
   return utxolib.testutil.constructPsbt(psbtInputs, psbtOutputs, network, rootWalletKeys, 'unsigned');
 }
 
 describe('addPaygoAddressProof and verifyPaygoAddressProof', () => {
-  function getPaygoProprietaryKey(proprietaryKeyVals: KeyValue[]) {
+  function getPayGoProprietaryKey(proprietaryKeyVals: KeyValue[]) {
     return proprietaryKeyVals
       .map(({ key, value }) => {
         return { key: decodeProprietaryKey(key), value };
@@ -88,7 +85,7 @@ describe('addPaygoAddressProof and verifyPaygoAddressProof', () => {
     addPayGoAddressProof(psbt, outputIndex, sig, addressProofEntropy);
     addPayGoAddressProof(psbt, outputIndex, Buffer.from('signature2'), crypto.randomBytes(64));
     const output = checkForOutput(psbt.data.outputs, outputIndex);
-    const proofInPsbt = getPaygoProprietaryKey(output.unknownKeyVals!);
+    const proofInPsbt = getPayGoProprietaryKey(output.unknownKeyVals!);
     assert(proofInPsbt.length !== 0);
     assert(proofInPsbt.length > 1);
     assert.throws(
@@ -134,21 +131,3 @@ describe('getPaygoAddressProofIndex', () => {
     );
   });
 });
-
-describe('createPayGoAttestationBuffer', () => {
-  it('should create a PayGo Attestation proof matching with original proof', () => {
-    const payGoAttestationProof = createPayGoAttestationBuffer(addressToVerify, addressProofEntropy);
-    assert.strictEqual(payGoAttestationProof.toString(), addressProofMsgBuffer.toString());
-    assert(Buffer.compare(payGoAttestationProof, addressProofMsgBuffer) === 0);
-  });
-
-  it('should create a PayGo Attestation proof that does not match with different uuid', () => {
-    const addressProofBufferDiffUuid = generatePayGoAttestationProof(
-      '00000000-0000-0000-0000-000000000001',
-      Buffer.from(addressToVerify)
-    );
-    const payGoAttestationProof = createPayGoAttestationBuffer(addressToVerify, addressProofEntropy);
-    assert.notStrictEqual(payGoAttestationProof.toString(), addressProofBufferDiffUuid.toString());
-    assert(Buffer.compare(payGoAttestationProof, addressProofBufferDiffUuid) !== 0);
-  });
-});