feat(utxo-bin): add support for regtest addresses

TICKET: BTC-1472

Author: OttoAllmendinger

modules/utxo-bin/src/AddressParser.ts

@@ -2,6 +2,7 @@ import * as utxolib from '@bitgo/utxo-lib';
 import * as bech32 from 'bech32';
 
 import { Parser, ParserNode } from './Parser';
+import { getNetworkList, getNetworkName } from './args';
 
 const bs58 = require('bs58');
 const bs58check = require('bs58check');
@@ -101,11 +102,11 @@ export class AddressParser extends Parser {
     return this.node(
       'converted',
       undefined,
-      utxolib.getNetworkList().flatMap((network) =>
+      getNetworkList().flatMap((network) =>
         utxolib.addressFormat.addressFormats
           .filter((f) => utxolib.addressFormat.isSupportedAddressFormat(f, network))
           .map((addressFormat) => {
-            const name = utxolib.getNetworkName(network) as string;
+            const name = getNetworkName(network);
             try {
               return this.node(
                 `${name} ${addressFormat}`,
@@ -139,7 +140,7 @@ export class AddressParser extends Parser {
   }
 
   parse(input: string): ParserNode {
-    const networks = this.params.network ? [this.params.network] : utxolib.getNetworkList();
+    const networks = this.params.network ? [this.params.network] : getNetworkList();
 
     type Match = {
       network: utxolib.Network;
@@ -168,7 +169,7 @@ export class AddressParser extends Parser {
 
       nodes.push(this.node('format', firstMatch.addressFormat));
       nodes.push(this.node('outputScript', firstMatch.buffer, this.parseOutputScript(firstMatch.buffer)));
-      nodes.push(this.node('network', matches.map((m) => utxolib.getNetworkName(m.network)).join(', ')));
+      nodes.push(this.node('network', matches.map((m) => getNetworkName(m.network)).join(', ')));
 
       if (this.params.all || this.params.convert) {
         nodes.push(this.convert(firstMatch.buffer));

modules/utxo-bin/src/args/parseNetwork.ts

@@ -1,13 +1,59 @@
 import * as utxolib from '@bitgo/utxo-lib';
+import { getMainnet } from '@bitgo/utxo-lib';
+
+export const bitcoinRegtest: utxolib.Network = {
+  ...utxolib.networks.testnet,
+  bech32: 'bcrt',
+};
 
 export function getNetworkForName(name: string): utxolib.Network {
+  if (name === 'bitcoinRegtest') {
+    return bitcoinRegtest;
+  }
   const network = utxolib.networks[name as utxolib.NetworkName];
   if (!network) {
     throw new Error(`invalid network ${name}`);
   }
   return network;
 }
 
+export function getNetworkName(network: utxolib.Network): string {
+  if (network === bitcoinRegtest) {
+    return 'bitcoinRegtest';
+  }
+  return utxolib.getNetworkName(network) as string;
+}
+
+const networkOrder = [
+  utxolib.networks.bitcoin,
+  utxolib.networks.bitcoincash,
+  utxolib.networks.bitcoingold,
+  utxolib.networks.bitcoinsv,
+  utxolib.networks.dash,
+  utxolib.networks.dogecoin,
+  utxolib.networks.ecash,
+  utxolib.networks.litecoin,
+  utxolib.networks.zcash,
+];
+
+function getNetworkOrderIndex(network: utxolib.Network): number {
+  if (network === bitcoinRegtest) {
+    network = utxolib.networks.bitcoin;
+  }
+  network = getMainnet(network);
+  const index = networkOrder.indexOf(network);
+  if (index === -1) {
+    throw new Error(`unknown network ${network}`);
+  }
+  return index;
+}
+
+export function getNetworkList(): utxolib.Network[] {
+  return [...utxolib.getNetworkList(), bitcoinRegtest].sort(
+    (a, b) => getNetworkOrderIndex(a) - getNetworkOrderIndex(b) || getNetworkName(a).localeCompare(getNetworkName(b))
+  );
+}
+
 export function getNetwork(argv: { network: string }): utxolib.Network {
   return getNetworkForName(argv.network);
 }

modules/utxo-bin/test/fixtures/formatAddress/bitcoinBitGoSignet_p2pkh_default_mziT9FmaG3XjV7tbaGYekqvBcVDvGnY3EZ.txt

@@ -11,4 +11,4 @@ address: mziT9FmaG3XjV7tbaGYekqvBcVDvGnY3EZ
 │   ├── type: pubkeyhash
 │   ├── hex: 76a914d2970bfc64117e397dc5cb7a9afe9f8b22dca1f188ac
 │   └── asm: OP_DUP OP_HASH160 d2970bfc64117e397dc5cb7a9afe9f8b22dca1f1 OP_EQUALVERIFY OP_CHECKSIG
-└── network: testnet, bitcoinPublicSignet, bitcoinTestnet4, bitcoinBitGoSignet, bitcoincashTestnet, bitcoingoldTestnet, bitcoinsvTestnet, ecashTest, litecoinTest
+└── network: bitcoinBitGoSignet, bitcoinPublicSignet, bitcoinRegtest, bitcoinTestnet4, testnet, bitcoincashTestnet, bitcoingoldTestnet, bitcoinsvTestnet, ecashTest, litecoinTest

modules/utxo-bin/test/fixtures/formatAddress/bitcoinBitGoSignet_p2shP2wsh_default_2MuQ6eusngGJY693CU1VUTADGWQtcBBk1di.txt

@@ -11,4 +11,4 @@ address: 2MuQ6eusngGJY693CU1VUTADGWQtcBBk1di
 │   ├── type: scripthash
 │   ├── hex: a914179ddf848a574c6fdb30e6e564f2c8b8fc11354587
 │   └── asm: OP_HASH160 179ddf848a574c6fdb30e6e564f2c8b8fc113545 OP_EQUAL
-└── network: testnet, bitcoinPublicSignet, bitcoinTestnet4, bitcoinBitGoSignet, bitcoincashTestnet, bitcoingoldTestnet, bitcoinsvTestnet, dogecoinTest, ecashTest
+└── network: bitcoinBitGoSignet, bitcoinPublicSignet, bitcoinRegtest, bitcoinTestnet4, testnet, bitcoincashTestnet, bitcoingoldTestnet, bitcoinsvTestnet, dogecoinTest, ecashTest

modules/utxo-bin/test/fixtures/formatAddress/bitcoinBitGoSignet_p2sh_default_2MwZgZu9ZT8uDqSkskSJSiDMeoFa4z4RtdW.txt

@@ -11,4 +11,4 @@ address: 2MwZgZu9ZT8uDqSkskSJSiDMeoFa4z4RtdW
 │   ├── type: scripthash
 │   ├── hex: a9142f5e2d8f4ee34ccd1a4130975b9fe635ff65e02b87
 │   └── asm: OP_HASH160 2f5e2d8f4ee34ccd1a4130975b9fe635ff65e02b OP_EQUAL
-└── network: testnet, bitcoinPublicSignet, bitcoinTestnet4, bitcoinBitGoSignet, bitcoincashTestnet, bitcoingoldTestnet, bitcoinsvTestnet, dogecoinTest, ecashTest
+└── network: bitcoinBitGoSignet, bitcoinPublicSignet, bitcoinRegtest, bitcoinTestnet4, testnet, bitcoincashTestnet, bitcoingoldTestnet, bitcoinsvTestnet, dogecoinTest, ecashTest

modules/utxo-bin/test/fixtures/formatAddress/bitcoinBitGoSignet_p2trMusig2_default_tb1p5xqvqger0zdpcq6s3jznfz352exhk356p9hml6c69matmggrve9s097l78.txt

@@ -9,4 +9,4 @@ address: tb1p5xqvqger0zdpcq6s3jznfz352exhk356p9hml6c69matmggrve9s097l78
 │   ├── type: taproot
 │   ├── hex: 5120a180c02323789a1c03508c85348a34564d7b469a096fbfeb1a2efabda103664b
 │   └── asm: OP_1 a180c02323789a1c03508c85348a34564d7b469a096fbfeb1a2efabda103664b
-└── network: testnet, bitcoinPublicSignet, bitcoinTestnet4, bitcoinBitGoSignet
+└── network: bitcoinBitGoSignet, bitcoinPublicSignet, bitcoinTestnet4, testnet

modules/utxo-bin/test/fixtures/formatAddress/bitcoinBitGoSignet_p2tr_default_tb1p8gv9m64s539mycj4m29wu8thy5n3y6u36xs58wq3yezrmqygwfns9l2hrf.txt

@@ -9,4 +9,4 @@ address: tb1p8gv9m64s539mycj4m29wu8thy5n3y6u36xs58wq3yezrmqygwfns9l2hrf
 │   ├── type: taproot
 │   ├── hex: 51203a185deab0a44bb26255da8aee1d772527126b91d1a143b81126443d80887267
 │   └── asm: OP_1 3a185deab0a44bb26255da8aee1d772527126b91d1a143b81126443d80887267
-└── network: testnet, bitcoinPublicSignet, bitcoinTestnet4, bitcoinBitGoSignet
+└── network: bitcoinBitGoSignet, bitcoinPublicSignet, bitcoinTestnet4, testnet

modules/utxo-bin/test/fixtures/formatAddress/bitcoinBitGoSignet_p2wkh_default_tb1q62tshlryz9lrjlw9edaf4l5l3v3deg03l64eut.txt

@@ -5,4 +5,4 @@ address: tb1q62tshlryz9lrjlw9edaf4l5l3v3deg03l64eut
 │   ├── type: witnesspubkeyhash
 │   ├── hex: 0014d2970bfc64117e397dc5cb7a9afe9f8b22dca1f1
 │   └── asm: OP_0 d2970bfc64117e397dc5cb7a9afe9f8b22dca1f1
-└── network: testnet, bitcoinPublicSignet, bitcoinTestnet4, bitcoinBitGoSignet
+└── network: bitcoinBitGoSignet, bitcoinPublicSignet, bitcoinTestnet4, testnet

modules/utxo-bin/test/fixtures/formatAddress/bitcoinBitGoSignet_p2wsh_default_tb1qeu6xmet5wqslj2w0wac0hx5gj6dupmp869cajrkt3kw6ud3kkecs62l3du.txt

@@ -9,4 +9,4 @@ address: tb1qeu6xmet5wqslj2w0wac0hx5gj6dupmp869cajrkt3kw6ud3kkecs62l3du
 │   ├── type: witnessscripthash
 │   ├── hex: 0020cf346de5747021f929cf7770fb9a88969bc0ec27d171d90ecb8d9dae3636b671
 │   └── asm: OP_0 cf346de5747021f929cf7770fb9a88969bc0ec27d171d90ecb8d9dae3636b671
-└── network: testnet, bitcoinPublicSignet, bitcoinTestnet4, bitcoinBitGoSignet
+└── network: bitcoinBitGoSignet, bitcoinPublicSignet, bitcoinTestnet4, testnet

modules/utxo-bin/test/fixtures/formatAddress/bitcoinPublicSignet_p2pkh_default_mziT9FmaG3XjV7tbaGYekqvBcVDvGnY3EZ.txt

@@ -11,4 +11,4 @@ address: mziT9FmaG3XjV7tbaGYekqvBcVDvGnY3EZ
 │   ├── type: pubkeyhash
 │   ├── hex: 76a914d2970bfc64117e397dc5cb7a9afe9f8b22dca1f188ac
 │   └── asm: OP_DUP OP_HASH160 d2970bfc64117e397dc5cb7a9afe9f8b22dca1f1 OP_EQUALVERIFY OP_CHECKSIG
-└── network: testnet, bitcoinPublicSignet, bitcoinTestnet4, bitcoinBitGoSignet, bitcoincashTestnet, bitcoingoldTestnet, bitcoinsvTestnet, ecashTest, litecoinTest
+└── network: bitcoinBitGoSignet, bitcoinPublicSignet, bitcoinRegtest, bitcoinTestnet4, testnet, bitcoincashTestnet, bitcoingoldTestnet, bitcoinsvTestnet, ecashTest, litecoinTest