Merge pull request #5019 from BitGo/BTC-1553-false-invalid-bch-cashaddr

BTC-1553: fix isValidAddress returning false for valid cashaddr bch addresses

Author: davidkaplanbitgo

modules/abstract-utxo/src/abstractUtxoCoin.ts

@@ -415,10 +415,19 @@ export abstract class AbstractUtxoCoin extends BaseCoin {
       throw new Error('deprecated');
     }
 
-    const formats = param && param.anyFormat ? undefined : ['default' as const];
+    // By default, allow all address formats.
+    // At the time of writing, the only additional address format is bch cashaddr.
+    const anyFormat = (param as { anyFormat: boolean } | undefined)?.anyFormat ?? true;
     try {
-      const script = utxolib.addressFormat.toOutputScriptTryFormats(address, this.network, formats);
-      return address === utxolib.address.fromOutputScript(script, this.network);
+      // Find out if the address is valid for any format. Tries all supported formats by default.
+      // Throws if address cannot be decoded with any format.
+      const [format, script] = utxolib.addressFormat.toOutputScriptAndFormat(address, this.network);
+      // unless anyFormat is set, only 'default' is allowed.
+      if (!anyFormat && format !== 'default') {
+        return false;
+      }
+      // make sure that address is in normal representation for given format.
+      return address === utxolib.addressFormat.fromOutputScriptWithFormat(script, format, this.network);
     } catch (e) {
       return false;
     }

modules/bitgo/test/v2/unit/wallet.ts

@@ -242,6 +242,18 @@ describe('V2 Wallet:', function () {
     });
   });
 
+  it('should verify bch cashaddr format as valid', async function () {
+    const coin = bitgo.coin('tbch');
+    const valid = coin.isValidAddress('bchtest:pzfkxv532t0q5zchck2mhmmf2y02cdejyssq5qrz7a');
+    valid.should.be.True();
+  });
+
+  it('should verify bch legacy format as valid', async function () {
+    const coin = bitgo.coin('tbch');
+    const valid = coin.isValidAddress('2N6gY9r9iuXQQzZiSyngWJeoUuL5mC1x4Ac');
+    valid.should.be.True();
+  });
+
   describe('TETH Wallet Addresses', function () {
     let ethWallet;