chore(utxo-lib): changed deprecated comments and param type

TICKET: BTC-2183

Author: christopher-fong

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

@@ -1,4 +1,4 @@
-import { KeyValue } from 'bip174/src/lib/interfaces';
+import { PsbtInput, PsbtOutput } from 'bip174/src/lib/interfaces';
 import { decodeProprietaryKey, encodeProprietaryKey, ProprietaryKey } from 'bip174/src/lib/proprietaryKeyVal';
 import { UtxoPsbt } from './UtxoPsbt';
 
@@ -22,12 +22,8 @@ export interface ProprietaryKeyValue {
   value: Buffer;
 }
 
-export interface WithUnknownKeyValues {
-  unknownKeyVals?: KeyValue[];
-}
-
 export function getProprietaryKeyValuesFromUnknownKeyValues(
-  psbtField: WithUnknownKeyValues,
+  psbtField: PsbtInput | PsbtOutput,
   keySearch?: ProprietaryKeySearch
 ): ProprietaryKeyValue[] {
   if (!psbtField.unknownKeyVals?.length) {
@@ -52,7 +48,7 @@ export function getProprietaryKeyValuesFromUnknownKeyValues(
 }
 
 export function deleteProprietaryKeyValuesFromUnknownKeyValues(
-  psbtField: WithUnknownKeyValues,
+  psbtField: PsbtInput | PsbtOutput,
   keysToDelete?: ProprietaryKeySearch
 ): void {
   if (!psbtField.unknownKeyVals?.length) {
@@ -74,9 +70,9 @@ export function deleteProprietaryKeyValuesFromUnknownKeyValues(
   });
 }
 
-export function updateProprietaryKeyValuesToUnknownKeyValues(
+export function updateProprietaryKeyValuesFromUnknownKeyValues(
   keyValueData: ProprietaryKeyValue,
-  psbtField: WithUnknownKeyValues
+  psbtField: PsbtInput | PsbtOutput
 ): void {
   if (!psbtField.unknownKeyVals?.length) {
     return;
@@ -91,7 +87,7 @@ export function updateProprietaryKeyValuesToUnknownKeyValues(
   psbtField.unknownKeyVals[ukvIndex] = { key, value };
 }
 
-export function addProprietaryKeyValuesToUnknownKeyValues(
+export function addProprietaryKeyValuesFromUnknownKeyValues(
   psbt: UtxoPsbt,
   entry: string,
   index: number,

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

@@ -1075,7 +1075,7 @@ export class UtxoPsbt<Tx extends UtxoTransaction<bigint> = UtxoTransaction<bigin
   }
 
   /**
-   * @deprecated Please use the new method addProprietaryKeyVals(type, index, keyValueData)
+   * @deprecated Please use the new method addProprietaryKeyVals(psbt, entry, index, keyValueData)
    *
    * Adds proprietary key value pair to PSBT input.
    * Default identifierEncoding is utf-8 for identifier.
@@ -1088,7 +1088,8 @@ export class UtxoPsbt<Tx extends UtxoTransaction<bigint> = UtxoTransaction<bigin
   }
 
   /**
-   * @deprecated Please use the new method addOrUpdateProprietaryKeyVal(type, index, keyValueData)
+   * @deprecated Please use the new method addProprietaryKeyValuesToUnknownKeyValues(psbt, entry, index, keyValueData)
+   *  or updateProprietaryKeyValuesToUnknownKeyValues(keyValueData)
    *
    * Adds or updates (if exists) proprietary key value pair to PSBT input.
    * Default identifierEncoding is utf-8 for identifier.
@@ -1112,7 +1113,7 @@ export class UtxoPsbt<Tx extends UtxoTransaction<bigint> = UtxoTransaction<bigin
   }
 
   /**
-   * @deprecated Please use getProprietaryKeyValues(type, index, keySearch). The new method
+   * @deprecated Please use getProprietaryKeyValuesFromUnknownKeyValues(psbtField, keySearch). The new method
    * allows for the retrieval of either input or output proprietary key values.
    *
    * To search any data from proprietary key value against keydata in the inputs.

modules/utxo-lib/test/bitgo/psbt/ProprietaryKeyVals.ts

@@ -4,10 +4,10 @@ import { bip32, BIP32Interface, networks, testutil } from '../../../src';
 import { RootWalletKeys, PSBT_PROPRIETARY_IDENTIFIER } from '../../../src/bitgo';
 import { checkForInput, checkForOutput } from 'bip174/src/lib/utils';
 import {
-  addProprietaryKeyValuesToUnknownKeyValues,
+  addProprietaryKeyValuesFromUnknownKeyValues,
   deleteProprietaryKeyValuesFromUnknownKeyValues,
   getProprietaryKeyValuesFromUnknownKeyValues,
-  updateProprietaryKeyValuesToUnknownKeyValues,
+  updateProprietaryKeyValuesFromUnknownKeyValues,
 } from '../../../src/bitgo/ProprietaryKeyValUtils';
 
 const network = networks.bitcoin;
@@ -36,7 +36,7 @@ describe('Proprietary key value helper functions', () => {
       keydata: dummyTapOutputKey,
     };
     const input = checkForInput(psbt.data.inputs, 0);
-    addProprietaryKeyValuesToUnknownKeyValues(psbt, 'input', 0, { key, value: dummyTapInternalKey });
+    addProprietaryKeyValuesFromUnknownKeyValues(psbt, 'input', 0, { key, value: dummyTapInternalKey });
     const keyVal = getProprietaryKeyValuesFromUnknownKeyValues(input);
     assert.strictEqual(keyVal[0].key.identifier, 'DUMMY');
   });
@@ -49,7 +49,7 @@ describe('Proprietary key value helper functions', () => {
       keydata: dummyTapOutputKey,
     };
     const output = checkForOutput(psbt.data.outputs, 0);
-    addProprietaryKeyValuesToUnknownKeyValues(psbt, 'output', 0, { key, value: dummyTapInternalKey });
+    addProprietaryKeyValuesFromUnknownKeyValues(psbt, 'output', 0, { key, value: dummyTapInternalKey });
     const keyVal = getProprietaryKeyValuesFromUnknownKeyValues(output);
     assert.strictEqual(keyVal[0].key.identifier, 'DUMMY');
   });
@@ -62,8 +62,8 @@ describe('Proprietary key value helper functions', () => {
       keydata: dummyTapOutputKey,
     };
     const input = checkForInput(psbt.data.inputs, 0);
-    addProprietaryKeyValuesToUnknownKeyValues(psbt, 'input', 0, { key, value: dummyTapInternalKey });
-    updateProprietaryKeyValuesToUnknownKeyValues({ key, value: invalidTapOutputKey }, input);
+    addProprietaryKeyValuesFromUnknownKeyValues(psbt, 'input', 0, { key, value: dummyTapInternalKey });
+    updateProprietaryKeyValuesFromUnknownKeyValues({ key, value: invalidTapOutputKey }, input);
     const keyVal = getProprietaryKeyValuesFromUnknownKeyValues(input);
     assert.strictEqual(keyVal[0].value, invalidTapOutputKey);
   });
@@ -76,8 +76,8 @@ describe('Proprietary key value helper functions', () => {
       keydata: dummyTapOutputKey,
     };
     const output = checkForOutput(psbt.data.outputs, 0);
-    addProprietaryKeyValuesToUnknownKeyValues(psbt, 'output', 0, { key, value: dummyTapInternalKey });
-    updateProprietaryKeyValuesToUnknownKeyValues({ key, value: invalidTapOutputKey }, output);
+    addProprietaryKeyValuesFromUnknownKeyValues(psbt, 'output', 0, { key, value: dummyTapInternalKey });
+    updateProprietaryKeyValuesFromUnknownKeyValues({ key, value: invalidTapOutputKey }, output);
     const keyVal = getProprietaryKeyValuesFromUnknownKeyValues(output);
     assert.strictEqual(keyVal[0].value, invalidTapOutputKey);
   });
@@ -90,7 +90,7 @@ describe('Proprietary key value helper functions', () => {
       keydata: dummyTapOutputKey,
     };
     const input = checkForInput(psbt.data.inputs, 0);
-    addProprietaryKeyValuesToUnknownKeyValues(psbt, 'input', 0, { key, value: dummyTapInternalKey });
+    addProprietaryKeyValuesFromUnknownKeyValues(psbt, 'input', 0, { key, value: dummyTapInternalKey });
     deleteProprietaryKeyValuesFromUnknownKeyValues(input, { identifier: PSBT_PROPRIETARY_IDENTIFIER });
     const keyVal = getProprietaryKeyValuesFromUnknownKeyValues(input);
     assert.strictEqual(keyVal[0].key.identifier, 'DUMMY');
@@ -109,8 +109,8 @@ describe('Proprietary key value helper functions', () => {
       keydata: dummyTapOutputKey,
     };
     const output = checkForOutput(psbt.data.outputs, 0);
-    addProprietaryKeyValuesToUnknownKeyValues(psbt, 'output', 0, { key, value: dummyTapInternalKey });
-    addProprietaryKeyValuesToUnknownKeyValues(psbt, 'output', 0, { key: key2, value: dummyTapInternalKey });
+    addProprietaryKeyValuesFromUnknownKeyValues(psbt, 'output', 0, { key, value: dummyTapInternalKey });
+    addProprietaryKeyValuesFromUnknownKeyValues(psbt, 'output', 0, { key: key2, value: dummyTapInternalKey });
     deleteProprietaryKeyValuesFromUnknownKeyValues(output, { identifier: 'DUMMY' });
     const keyVal = getProprietaryKeyValuesFromUnknownKeyValues(output);
     assert.strictEqual(keyVal[0].key.identifier, 'OTHER_DUMMY');