chore(utxo-core): fixed pr on error class and JSDocs

TICKET: BTC-2047

Author: christopher-fong

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

@@ -1,28 +1,35 @@
-export class ErrorNoPayGoProof extends Error {
+export class PayGoError extends Error {
+  constructor(message: string) {
+    super(message);
+    this.name = this.constructor.name;
+  }
+}
+
+export class ErrorNoPayGoProof extends PayGoError {
   constructor(public outputIndex: number) {
     super(`There is no paygo address proof encoded in the PSBT at output ${outputIndex}.`);
   }
 }
 
-export class ErrorMultiplePayGoProof extends Error {
+export class ErrorMultiplePayGoProof extends PayGoError {
   constructor() {
     super('There are multiple paygo address proofs encoded in the PSBT. Something went wrong.');
   }
 }
 
-export class ErrorPayGoAddressProofFailedVerification extends Error {
+export class ErrorPayGoAddressProofFailedVerification extends PayGoError {
   constructor() {
     super('Cannot verify the paygo address signature with the provided pubkey.');
   }
 }
 
-export class ErrorOutputIndexOutOfBounds extends Error {
+export class ErrorOutputIndexOutOfBounds extends PayGoError {
   constructor(public outputIndex: number) {
     super(`Output index ${outputIndex} is out of bounds for PSBT outputs.`);
   }
 }
 
-export class ErrorMultiplePayGoProofAtPsbtIndex extends Error {
+export class ErrorMultiplePayGoProofAtPsbtIndex extends PayGoError {
   constructor(public outputIndex: number) {
     super(`There are multiple PayGo addresses in the PSBT output ${outputIndex}.`);
   }

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

@@ -2,4 +2,4 @@ export * from './fixtures.utils';
 export * from './key.utils';
 export * from './toPlainObject.utils';
 export * from './generatePayGoAttestationProof.utils';
-export * from './parseVaspProof';
+export * from './trimMessagePrefix';

modules/utxo-core/src/testutil/parseVaspProof.ts renamed to modules/utxo-core/src/testutil/trimMessagePrefix.ts

@@ -2,14 +2,14 @@ import * as utxolib from '@bitgo/utxo-lib';
 
 /** We receive a proof in the form:
  * 0x18Bitcoin Signed Message:\n<varint_length><ENTROPY><ADDRESS><UUID>
- * and when verifying our message in our PayGo utils we want to only verify
- * the message portion of our proof. This helps to pare our proof in that format,
- * and returns a Buffer.
+ * and when verifying our message we want to exclude the 0x18Bitcoin Signed Message:\n<varint_length>
+ * of the proof so that we are left with the entropy address and uuid as our message.
+ * This is what we are going to be verifying.
  *
  * @param proof
  * @returns
  */
-export function parseVaspProof(proof: Buffer): Buffer {
+export function trimMessagePrefix(proof: Buffer): Buffer {
   const prefix = '\u0018Bitcoin Signed Message:\n';
   if (proof.toString().startsWith(prefix)) {
     proof = proof.slice(Buffer.from(prefix).length);

modules/utxo-core/test/paygo/psbt/payGoAddressProof.ts

@@ -13,7 +13,7 @@ import {
   verifyPayGoAddressProof,
 } from '../../../src/paygo/psbt/payGoAddressProof';
 import { generatePayGoAttestationProof } from '../../../src/testutil/generatePayGoAttestationProof.utils';
-import { parseVaspProof } from '../../../src/testutil/parseVaspProof';
+import { trimMessagePrefix } from '../../../src/testutil/trimMessagePrefix';
 import { signMessage } from '../../../src/bip32utils';
 import { NIL_UUID } from '../../../src/paygo/attestation';
 
@@ -46,7 +46,7 @@ export const addressToVerify = utxolib.address.toBase58Check(
 
 // this should be retuning a Buffer
 export const addressProofBuffer = generatePayGoAttestationProof(NIL_UUID, Buffer.from(addressToVerify));
-export const addressProofMsgBuffer = parseVaspProof(addressProofBuffer);
+export const addressProofMsgBuffer = trimMessagePrefix(addressProofBuffer);
 // We know that that the entropy is a set 64 bytes.
 export const addressProofEntropy = addressProofMsgBuffer.subarray(0, 65);