Merge pull request #17 from BitGo/BTC-2652.harden-output-script-creation

feat(wasm-utxo): improve address handling and network validation

Author: OttoAllmendinger

packages/wasm-utxo/js/address.ts

@@ -1,6 +1,10 @@
 import { AddressNamespace } from "./wasm/wasm_utxo";
 import type { CoinName } from "./coinName";
 
+/**
+ * Most coins only have one unambiguous address format (base58check and bech32/bech32m)
+ * For Bitcoin Cash and eCash, we can select between base58check and cashaddr.
+ */
 export type AddressFormat = "default" | "cashaddr";
 
 export function toOutputScriptWithCoin(address: string, coin: CoinName): Uint8Array {

packages/wasm-utxo/js/fixedScriptWallet.ts

@@ -1,6 +1,7 @@
 import { FixedScriptWalletNamespace } from "./wasm/wasm_utxo";
 import type { UtxolibNetwork, UtxolibRootWalletKeys } from "./utxolibCompat";
 import { Triple } from "./triple";
+import { AddressFormat } from "./address";
 
 export type WalletKeys =
   /** Just an xpub triple, will assume default derivation prefixes  */
@@ -11,19 +12,33 @@ export type WalletKeys =
 /**
  * Create the output script for a given wallet keys and chain and index
  */
-export function outputScript(keys: WalletKeys, chain: number, index: number): Uint8Array {
-  return FixedScriptWalletNamespace.output_script(keys, chain, index);
+export function outputScript(
+  keys: WalletKeys,
+  chain: number,
+  index: number,
+  network: UtxolibNetwork,
+): Uint8Array {
+  return FixedScriptWalletNamespace.output_script(keys, chain, index, network);
 }
 
 /**
  * Create the address for a given wallet keys and chain and index and network.
  * Wrapper for outputScript that also encodes the script to an address.
+ * @param keys - The wallet keys to use.
+ * @param chain - The chain to use.
+ * @param index - The index to use.
+ * @param network - The network to use.
+ * @param addressFormat - The address format to use.
+ *   Only relevant for Bitcoin Cash and eCash networks, where:
+ *   - "default" means base58check,
+ *   - "cashaddr" means cashaddr.
  */
 export function address(
   keys: WalletKeys,
   chain: number,
   index: number,
   network: UtxolibNetwork,
+  addressFormat?: AddressFormat,
 ): string {
-  return FixedScriptWalletNamespace.address(keys, chain, index, network);
+  return FixedScriptWalletNamespace.address(keys, chain, index, network, addressFormat);
 }