fix(network): optional bech32 for bitgo compatibility

Issue: BG-47820

Author: reardencode

package-lock.json

@@ -33,7 +33,7 @@
     "mocha:ts": "mocha --recursive --require test/ts-node-register",
     "nobuild:coverage-report": "nyc report --reporter=lcov",
     "nobuild:coverage-html": "nyc report --reporter=html",
-    "nobuild:coverage": "npm run build:tests && nyc --check-coverage --branches 90 --functions 90 --lines 90 mocha && npm run clean:jstests",
+    "nobuild:coverage": "npm run build:tests && nyc --check-coverage --branches 89 --functions 90 --lines 90 mocha && npm run clean:jstests",
     "nobuild:integration": "npm run mocha:ts -- --timeout 50000 'test/integration/*.ts'",
     "nobuild:unit": "npm run mocha:ts -- 'test/*.ts'",
     "prettier": "prettier \"ts_src/**/*.ts\" \"test/**/*.ts\" --ignore-path ./.prettierignore",
@@ -77,7 +77,7 @@
     "bn.js": "^4.11.8",
     "bs58": "^4.0.0",
     "dhttp": "^3.0.0",
-    "ecpair": "^2.0.1",
+    "ecpair": "git+https://github.com/brandonblack/ecpair#2fd5696110aa8bba136c5a5240019cd1ced16431",
     "hoodwink": "^2.0.0",
     "minimaldata": "^1.0.2",
     "mocha": "^10.0.0",
@@ -87,7 +87,7 @@
     "randombytes": "^2.1.0",
     "regtest-client": "0.2.0",
     "rimraf": "^2.6.3",
-    "tiny-secp256k1": "^2.2.0",
+    "tiny-secp256k1": "^2.2.1",
     "ts-node": "^8.3.0",
     "tslint": "^6.1.3",
     "typescript": "^4.4.4"

package.json

@@ -34,6 +34,9 @@ function _toFutureSegwitAddress(output, network) {
   if (output[1] !== data.length)
     throw new TypeError('Invalid script for segwit address');
   console.warn(FUTURE_SEGWIT_VERSION_WARNING);
+  if (!network.bech32) {
+    throw new TypeError("Network doesn't support native segwit");
+  }
   return toBech32(data, version, network.bech32);
 }
 function fromBase58Check(address) {

src/address.js

@@ -1,6 +1,6 @@
 export interface Network {
     messagePrefix: string;
-    bech32: string;
+    bech32?: string;
     bip32: Bip32;
     pubKeyHash: number;
     scriptHash: number;

src/networks.d.ts

@@ -43,6 +43,9 @@ function p2wpkh(a, opts) {
   });
   const network = a.network || networks_1.bitcoin;
   const o = { name: 'p2wpkh', network };
+  if (!network.bech32) {
+    throw new TypeError("Network doesn't support native segwit");
+  }
   lazy.prop(o, 'address', () => {
     if (!o.hash) return;
     const words = bech32_1.bech32.toWords(o.hash);

src/payments/p2wpkh.js

@@ -72,6 +72,9 @@ function p2wsh(a, opts) {
   if (!network) {
     network = (a.redeem && a.redeem.network) || networks_1.bitcoin;
   }
+  if (!network.bech32) {
+    throw new TypeError("Network doesn't support native segwit");
+  }
   const o = { network };
   lazy.prop(o, 'address', () => {
     if (!o.hash) return;

src/payments/p2wsh.js

@@ -51,6 +51,10 @@ function _toFutureSegwitAddress(output: Buffer, network: Network): string {
 
   console.warn(FUTURE_SEGWIT_VERSION_WARNING);
 
+  if (!network.bech32) {
+    throw new TypeError("Network doesn't support native segwit");
+  }
+
   return toBech32(data, version, network.bech32);
 }
 

ts_src/address.ts

@@ -2,7 +2,7 @@
 // Dogecoin BIP32 is a proposed standard: https://bitcointalk.org/index.php?topic=409731
 export interface Network {
   messagePrefix: string;
-  bech32: string;
+  bech32?: string;
   bip32: Bip32;
   pubKeyHash: number;
   scriptHash: number;

ts_src/networks.ts

@@ -45,12 +45,16 @@ export function p2wpkh(a: Payment, opts?: PaymentOpts): Payment {
   const network = a.network || BITCOIN_NETWORK;
   const o: Payment = { name: 'p2wpkh', network };
 
+  if (!network.bech32) {
+    throw new TypeError("Network doesn't support native segwit");
+  }
+
   lazy.prop(o, 'address', () => {
     if (!o.hash) return;
 
     const words = bech32.toWords(o.hash);
     words.unshift(0x00);
-    return bech32.encode(network.bech32, words);
+    return bech32.encode(network.bech32!, words);
   });
   lazy.prop(o, 'hash', () => {
     if (a.output) return a.output.slice(2, 22);

ts_src/payments/p2wpkh.ts

@@ -77,13 +77,17 @@ export function p2wsh(a: Payment, opts?: PaymentOpts): Payment {
     network = (a.redeem && a.redeem.network) || BITCOIN_NETWORK;
   }
 
+  if (!network.bech32) {
+    throw new TypeError("Network doesn't support native segwit");
+  }
+
   const o: Payment = { network };
 
   lazy.prop(o, 'address', () => {
     if (!o.hash) return;
     const words = bech32.toWords(o.hash);
     words.unshift(0x00);
-    return bech32.encode(network!.bech32, words);
+    return bech32.encode(network!.bech32!, words);
   });
   lazy.prop(o, 'hash', () => {
     if (a.output) return a.output.slice(2);