Merge pull request #5155 from BitGo/BTC-1632

fix: validate addresses created matches the requested format

Author: lcovar

modules/abstract-utxo/src/abstractUtxoCoin.ts

@@ -29,6 +29,7 @@ import {
   AddressTypeChainMismatchError,
   BaseCoin,
   BitGoBase,
+  CreateAddressFormat,
   decryptKeychainPrivateKey,
   ExtraPrebuildParamsOptions,
   HalfSignedUtxoTransaction,
@@ -251,6 +252,7 @@ export interface GenerateAddressOptions {
 }
 
 export interface GenerateFixedScriptAddressOptions extends GenerateAddressOptions {
+  format?: CreateAddressFormat;
   keychains: {
     pub: string;
     aspKeyId?: string;
@@ -1092,6 +1094,7 @@ export abstract class AbstractUtxoCoin extends BaseCoin {
     }
 
     const expectedAddress = this.generateAddress({
+      format: params.format,
       addressType: addressType as ScriptType2Of3,
       keychains,
       threshold: 2,
@@ -1220,7 +1223,7 @@ export abstract class AbstractUtxoCoin extends BaseCoin {
     );
 
     return {
-      address,
+      address: this.canonicalAddress(address, params.format),
       chain: derivationChain,
       index: derivationIndex,
       coin: this.getChain(),

modules/sdk-core/src/bitgo/baseCoin/iBaseCoin.ts

@@ -8,7 +8,7 @@ import { IPendingApprovals } from '../pendingApproval';
 import { InitiateRecoveryOptions } from '../recovery';
 import { EcdsaMPCv2Utils, EcdsaUtils } from '../utils/tss/ecdsa';
 import EddsaUtils, { PrebuildTransactionWithIntentOptions, TxRequest } from '../utils/tss/eddsa';
-import { CustomSigningFunction, IWallet, IWallets, Wallet, WalletData } from '../wallet';
+import { CreateAddressFormat, CustomSigningFunction, IWallet, IWallets, Wallet, WalletData } from '../wallet';
 
 import { IWebhooks } from '../webhook/iWebhooks';
 import { TransactionType } from '../../account-lib';
@@ -105,6 +105,7 @@ export interface IBlsKeyPair extends KeyPair {
 }
 
 export interface VerifyAddressOptions {
+  format?: CreateAddressFormat;
   address: string;
   addressType?: string;
   keychains?: {

modules/sdk-core/src/bitgo/wallet/iWallet.ts

@@ -437,14 +437,16 @@ export interface ForwarderBalanceOptions {
   maximumBalance?: number;
 }
 
+export type CreateAddressFormat = 'base58' | 'cashaddr';
+
 export interface CreateAddressOptions {
   chain?: number;
   gasPrice?: number | string;
   count?: number;
   label?: string;
   lowPriority?: boolean;
   forwarderVersion?: number;
-  format?: 'base58' | 'cashaddr';
+  format?: CreateAddressFormat;
   baseAddress?: string;
   allowSkipVerifyAddress?: boolean;
   derivedAddress?: string;

modules/sdk-core/src/bitgo/wallet/wallet.ts

@@ -1267,6 +1267,7 @@ export class Wallet implements IWallet {
 
       newAddress.keychains = keychains;
       newAddress.baseAddress = baseAddress ?? _.get(this._wallet, 'coinSpecific.baseAddress');
+      newAddress.format = addressParams.format;
 
       const verificationData: VerifyAddressOptions = _.merge({}, newAddress, { rootAddress });