bch.ts

import { BitGoBase } from '@bitgo/sdk-core';
import { address as wasmAddress } from '@bitgo/wasm-utxo';

import { AbstractUtxoCoin } from '../../abstractUtxoCoin.js';
import { UtxoCoinName } from '../../names.js';
import { isScriptRecipient } from '../../transaction/index.js';

export class Bch extends AbstractUtxoCoin {
  readonly name: UtxoCoinName = 'bch';

  protected constructor(bitgo: BitGoBase) {
    super(bitgo);
  }

  static createInstance(bitgo: BitGoBase): Bch {
    return new Bch(bitgo);
  }

  /**
   * Canonicalize a Bitcoin Cash address for a specific version
   *
   * Starting on January 14th, 2018 Bitcoin Cash's bitcoin-abc node switched over to using cashaddr
   * encoding for all of their addresses in order to distinguish them from Bitcoin Core's.
   * https://www.bitcoinabc.org/cashaddr. We're sticking with the old base58 format because
   * migrating over to the new format will be laborious, and we want to see how the space evolves
   *
   * @param address may or may not be prefixed with the network, example bitcoincash:pppkt7q2axpsm2cajyjtu6x8fsh6ywauzgxmsru962 or pppkt7q2axpsm2cajyjtu6x8fsh6ywauzgxmsru962
   * @param version the version of the desired address, 'base58' or 'cashaddr', defaulting to 'base58'
   * @returns {*} address string
   */
  canonicalAddress(address: string, version: unknown = 'base58'): string {
    if (isScriptRecipient(address)) {
      return address;
    }

    if (version === 'base58') {
      const script = wasmAddress.toOutputScriptWithCoin(address, this.name);
      return wasmAddress.fromOutputScriptWithCoin(script, this.name, 'default');
    }

    if (version === 'cashaddr') {
      const script = wasmAddress.toOutputScriptWithCoin(address, this.name);
      return wasmAddress.fromOutputScriptWithCoin(script, this.name, 'cashaddr');
    }

    throw new Error(`invalid version ${version}`);
  }
}