bitcore-wallet-client/src/lib/api.ts

Client for bitcore-wallet-service

'use strict';

import async from 'async';
import Mnemonic from 'bitcore-mnemonic';
import * as CWC from 'crypto-wallet-core';
import { EventEmitter } from 'events';
import { singleton } from 'preconditions';
import querystring from 'querystring';
import sjcl from 'sjcl';
import Uuid from 'uuid';
import { BulkClient } from './bulkclient';
import { Constants, Utils } from './common';
import { Credentials } from './credentials';
import { Errors } from './errors';
import { Key } from './key';
import log from './log';
import { PayPro } from './paypro';
import { PayProV2 } from './payproV2';
import { Request } from './request';
import { Verifier } from './verifier';

const $ = singleton();

const Bitcore = CWC.BitcoreLib;
const Bitcore_ = {
  btc: CWC.BitcoreLib,
  bch: CWC.BitcoreLibCash,
  eth: CWC.BitcoreLib,
  matic: CWC.BitcoreLib,
  arb: CWC.BitcoreLib,
  base: CWC.BitcoreLib,
  op: CWC.BitcoreLib,
  xrp: CWC.BitcoreLib,
  doge: CWC.BitcoreLibDoge,
  ltc: CWC.BitcoreLibLtc,
  sol: CWC.BitcoreLib,
};

const NetworkChar = {
  livenet: 'L',
  testnet: 'T',
  regtest: 'R'
};
for (const network in NetworkChar) { // invert NetworkChar
  NetworkChar[NetworkChar[network]] = network;
}

const BASE_URL = 'http://localhost:3232/bws/api';

export class API extends EventEmitter {
  doNotVerifyPayPro: any;
  timeout: any;
  logLevel: any;
  supportStaffWalletId: any;
  request: any;
  bulkClient: any;
  credentials: any;
  notificationIncludeOwn: boolean;
  lastNotificationId: any;
  notificationsIntervalId: any;
  keyDerivationOk: boolean;
  noSign: any;
  password: any;
  bp_partner: string;
  bp_partner_version: string;

  static PayProV2 = PayProV2;
  static PayPro = PayPro;
  static Key = Key;
  static Verifier = Verifier;
  static Core = CWC;
  static Utils = Utils;
  static sjcl = sjcl;
  static errors = Errors;

  // Expose bitcore
  static Bitcore = CWC.BitcoreLib;
  static BitcoreCash = CWC.BitcoreLibCash;
  static BitcoreDoge = CWC.BitcoreLibDoge;
  static BitcoreLtc = CWC.BitcoreLibLtc;

  /**
   * ClientAPI constructor.
   * @param {Object} [opts]
   * @param {boolean} [opts.doNotVerifyPayPro]
   * @param {number} [opts.timeout] Default: 50000
   * @param {string} [opts.logLevel] Default: 'silent'
   * @param {string} [opts.supportStaffWalletId]
   * @param {string} [opts.baseUrl] Default: 'http://localhost:3232/bws/api'
   * @param {Object} [opts.request] Request library instance
   * @param {string} [opts.bp_partner] PayPro BitPay Partner
   * @param {string} [opts.bp_partner_version] PayPro BitPay Partner version
   */
  constructor(opts?) {
    super();
    opts = opts || {};

    this.doNotVerifyPayPro = opts.doNotVerifyPayPro;
    this.timeout = opts.timeout || 50000;
    this.logLevel = opts.logLevel || 'silent';
    this.supportStaffWalletId = opts.supportStaffWalletId;

    this.bp_partner = opts.bp_partner;
    this.bp_partner_version = opts.bp_partner_version;

    this.request = new Request(opts.baseUrl || BASE_URL, {
      r: opts.request,
      supportStaffWalletId: opts.supportStaffWalletId
    });

    this.bulkClient = new BulkClient(opts.baseUrl || BASE_URL, {
      r: opts.request,
      supportStaffWalletId: opts.supportStaffWalletId
    });

    log.setLevel(this.logLevel);
  }

  static privateKeyEncryptionOpts = {
    iter: 10000
  };

  initNotifications(cb) {
    log.warn('DEPRECATED: use initialize() instead.');
    this.initialize({}, cb);
  }

  initialize(opts, cb) {
    $.checkState(
      this.credentials,
      'Failed state: this.credentials at <initialize()>'
    );

    this.notificationIncludeOwn = !!opts.notificationIncludeOwn;
    this._initNotifications(opts);
    return cb();
  }

  dispose(cb) {
    this._disposeNotifications();
    this.request.logout(cb);
  }

  _fetchLatestNotifications(interval, cb) {
    cb = cb || function() { };

    var opts: any = {
      lastNotificationId: this.lastNotificationId,
      includeOwn: this.notificationIncludeOwn
    };

    if (!this.lastNotificationId) {
      opts.timeSpan = interval + 1;
    }

    this.getNotifications(opts, (err, notifications) => {
      if (err) {
        log.warn('Error receiving notifications.');
        log.debug(err);
        return cb(err);
      }
      if (notifications.length > 0) {
        this.lastNotificationId = notifications.slice(-1)[0].id;
      }

      for (const notification of notifications) {
        this.emit('notification', notification);
      }
      return cb();
    });
  }

  _initNotifications(opts) {
    opts = opts || {};

    var interval = opts.notificationIntervalSeconds || 5;
    this.notificationsIntervalId = setInterval(() => {
      this._fetchLatestNotifications(interval, err => {
        if (err) {
          if (
            err instanceof Errors.NOT_FOUND ||
            err instanceof Errors.NOT_AUTHORIZED
          ) {
            this._disposeNotifications();
          }
        }
      });
    }, interval * 1000);
  }

  _disposeNotifications() {
    if (this.notificationsIntervalId) {
      clearInterval(this.notificationsIntervalId);
      this.notificationsIntervalId = null;
    }
  }

  /**
   * Reset notification polling with new interval
   * @param {number} notificationIntervalSeconds - use 0 to pause notifications
   */
  setNotificationsInterval(notificationIntervalSeconds) {
    this._disposeNotifications();
    if (notificationIntervalSeconds > 0) {
      this._initNotifications({
        notificationIntervalSeconds
      });
    }
  }

  getRootPath() {
    return this.credentials.getRootPath();
  }

  /**
   * Encrypt a message
   * @private
   * @param {string} message
   * @param {string} encryptingKey
   */
  static _encryptMessage(message, encryptingKey) {
    if (!message) return null;
    return Utils.encryptMessage(message, encryptingKey);
  }

  _processTxNotes(notes) {
    if (!notes) return;

    const encryptingKey = this.credentials.sharedEncryptingKey;
    for (const note of [].concat(notes)) {
      note.encryptedBody = note.body;
      note.body = Utils.decryptMessageNoThrow(note.body, encryptingKey);
      note.encryptedEditedByName = note.editedByName;
      note.editedByName = Utils.decryptMessageNoThrow(
        note.editedByName,
        encryptingKey
      );
    }
  }

  /**
   * Decrypt text fields in transaction proposals
   * @private
   * @param {Array} txps
   */
  _processTxps(txps) {
    if (!txps) return;

    var encryptingKey = this.credentials.sharedEncryptingKey;
    for (const txp of [].concat(txps)) {
      txp.encryptedMessage = txp.message;
      txp.message =
        Utils.decryptMessageNoThrow(txp.message, encryptingKey) || null;
      txp.creatorName = Utils.decryptMessageNoThrow(
        txp.creatorName,
        encryptingKey
      );

      for (const action of txp.actions || []) {
        // CopayerName encryption is optional (not available in older wallets)
        action.copayerName = Utils.decryptMessageNoThrow(action.copayerName, encryptingKey);
        action.comment = Utils.decryptMessageNoThrow(action.comment, encryptingKey);
        // TODO get copayerName from Credentials -> copayerId to copayerName
        // action.copayerName = null;
      }
      for (const output of txp.outputs || []) {
        output.encryptedMessage = output.message;
        output.message = Utils.decryptMessageNoThrow(output.message, encryptingKey) || null;
      }
      txp.hasUnconfirmedInputs = (txp.inputs || []).some(input => input.confirmations == 0);
      this._processTxNotes(txp.note);
    }
  }

  validateKeyDerivation(opts, cb) {
    var _deviceValidated;

    opts = opts || {};

    var c = this.credentials;

    var testMessageSigning = (xpriv, xpub) => {
      var nonHardenedPath = 'm/0/0';
      var message =
        'Lorem ipsum dolor sit amet, ne amet urbanitas percipitur vim, libris disputando his ne, et facer suavitate qui. Ei quidam laoreet sea. Cu pro dico aliquip gubergren, in mundi postea usu. Ad labitur posidonium interesset duo, est et doctus molestie adipiscing.';
      var priv = xpriv.deriveChild(nonHardenedPath).privateKey;
      var signature = Utils.signMessage(message, priv);
      var pub = xpub.deriveChild(nonHardenedPath).publicKey;
      return Utils.verifyMessage(message, signature, pub);
    };

    var testHardcodedKeys = () => {
      var words =
        'abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about';
      var xpriv = Mnemonic(words).toHDPrivateKey();

      if (
        xpriv.toString() !=
        'xprv9s21ZrQH143K3GJpoapnV8SFfukcVBSfeCficPSGfubmSFDxo1kuHnLisriDvSnRRuL2Qrg5ggqHKNVpxR86QEC8w35uxmGoggxtQTPvfUu'
      )
        return false;

      xpriv = xpriv.deriveChild("m/44'/0'/0'");
      if (
        xpriv.toString() !=
        'xprv9xpXFhFpqdQK3TmytPBqXtGSwS3DLjojFhTGht8gwAAii8py5X6pxeBnQ6ehJiyJ6nDjWGJfZ95WxByFXVkDxHXrqu53WCRGypk2ttuqncb'
      )
        return false;

      var xpub = Bitcore.HDPublicKey.fromString(
        'xpub6BosfCnifzxcFwrSzQiqu2DBVTshkCXacvNsWGYJVVhhawA7d4R5WSWGFNbi8Aw6ZRc1brxMyWMzG3DSSSSoekkudhUd9yLb6qx39T9nMdj'
      );
      return testMessageSigning(xpriv, xpub);
    };

    // TODO => Key refactor to Key class.
    var testLiveKeys = () => {
      var words;
      try {
        words = c.getMnemonic();
      } catch (ex) { }

      var xpriv;
      if (words && (!c.mnemonicHasPassphrase || opts.passphrase)) {
        var m = new Mnemonic(words);
        xpriv = m.toHDPrivateKey(opts.passphrase, c.network);
      }
      if (!xpriv) {
        xpriv = new Bitcore.HDPrivateKey(c.xPrivKey);
      }
      xpriv = xpriv.deriveChild(c.getBaseAddressDerivationPath());
      var xpub = new Bitcore.HDPublicKey(c.xPubKey);

      return testMessageSigning(xpriv, xpub);
    };

    var hardcodedOk = true;
    if (!_deviceValidated && !opts.skipDeviceValidation) {
      hardcodedOk = testHardcodedKeys();
      _deviceValidated = true;
    }

    // TODO
    //  var liveOk = (c.canSign() && !c.isPrivKeyEncrypted()) ? testLiveKeys() : true;
    this.keyDerivationOk = hardcodedOk; // && liveOk;

    return cb(null, this.keyDerivationOk);
  }

  /**
   * Convert credentials to a plain object
   */
  toObj() {
    $.checkState(this.credentials, 'Failed state: this.credentials at <toObj()>');
    return this.credentials.toObj();
  }

  /**
   * Convert this to a stringified JSON
   */
  toString() {
    $.checkState(this.credentials, 'Failed state: this.credentials at <toString()>');
    $.checkArgument(!this.noSign, 'no Sign not supported');
    $.checkArgument(!this.password, 'password not supported');

    const output = JSON.stringify(this.toObj());
    return output;
  }

  fromObj(credentials) {
    $.checkArgument(credentials && typeof credentials === 'object' && !Array.isArray(credentials), 'Argument should be an object');

    try {
      credentials = Credentials.fromObj(credentials);
      this.credentials = credentials;
    } catch (ex) {
      log.warn(`Error importing wallet: ${ex}`);
      if (ex.toString().match(/Obsolete/)) {
        throw new Errors.OBSOLETE_BACKUP();
      } else {
        throw new Errors.INVALID_BACKUP();
      }
    }
    this.request.setCredentials(this.credentials);
    return this;
  }

  /**
   * Import credentials from a string
   * @param {string} credentials The serialized JSON created with #export
   */
  fromString(credentials) {
    $.checkArgument(credentials, 'Missing argument: credentials at <fromString>');
    if (typeof credentials === 'object') {
      log.warn('WARN: Please use fromObj instead of fromString when importing strings');
      return this.fromObj(credentials);
    }
    let c;
    try {
      c = JSON.parse(credentials);
    } catch (ex) {
      log.warn(`Error importing wallet: ${ex}`);
      throw new Errors.INVALID_BACKUP();
    }
    return this.fromObj(c);
  }

  toClone() {
    $.checkState(this.credentials, 'Failed state: this.credentials at <toClone()>');
    const clone = new API(Object.assign({}, this, { request: this.request.r, baseUrl: this.request.baseUrl }));
    clone.fromObj(this.toObj());
    return clone;
  }

  static clone(api: API) {
    const clone = new API(Object.assign({}, api, { request: api.request.r, baseUrl: api.request.baseUrl }));
    if (api.credentials) {
      clone.fromObj(api.toObj());
    }
    return clone;
  }

  decryptBIP38PrivateKey(encryptedPrivateKeyBase58, passphrase, progressCallback, cb) {
    var Bip38 = require('bip38');
    var bip38 = new Bip38();

    var privateKeyWif;
    try {
      privateKeyWif = bip38.decrypt(encryptedPrivateKeyBase58, passphrase, progressCallback);
    } catch (ex) {
      return cb(new Error('Could not decrypt BIP38 private key' + ex));
    }

    var privateKey = new Bitcore.PrivateKey(privateKeyWif);
    var address = privateKey.publicKey.toAddress().toString();
    var addrBuff = Buffer.from(address, 'ascii');
    var actualChecksum = Bitcore.crypto.Hash.sha256sha256(addrBuff)
      .toString('hex')
      .substring(0, 8);
    var expectedChecksum = Bitcore.encoding.Base58Check.decode(
      encryptedPrivateKeyBase58
    )
      .toString('hex')
      .substring(6, 14);

    if (actualChecksum != expectedChecksum)
      return cb(new Error('Incorrect passphrase'));

    return cb(null, privateKeyWif);
  }

  getBalanceFromPrivateKey(privateKey, chain, cb) {
    if (typeof chain === 'function') {
      cb = chain;
      chain = 'btc';
    }
    var B = Bitcore_[chain];

    var privateKey = new B.PrivateKey(privateKey);
    var address = privateKey.publicKey.toAddress().toString(true);

    this.getUtxos(
      {
        addresses: address
      },
      (err, utxos) => {
        if (err) return cb(err);
        return cb(null, (utxos || []).reduce((sum, u) => sum += u.satoshis, 0));
      }
    );
  }

  buildTxFromPrivateKey(privateKey, destinationAddress, opts, cb) {
    opts = opts || {};

    var chain = opts.chain?.toLowerCase() || Utils.getChain(opts.coin); // getChain -> backwards compatibility
    var signingMethod = opts.signingMethod || 'ecdsa';

    if (!Constants.CHAINS.includes(chain))
      return cb(new Error('Invalid chain'));

    if (Constants.EVM_CHAINS.includes(chain))
      return cb(new Error('EVM based chains not supported for this action'));

    var B = Bitcore_[chain];
    var privateKey = B.PrivateKey(privateKey);
    var address = privateKey.publicKey.toAddress().toString(true);

    async.waterfall(
      [
        next => {
          this.getUtxos(
            {
              addresses: address
            },
            (err, utxos) => {
              return next(err, utxos);
            }
          );
        },
        (utxos, next) => {
          if (!Array.isArray(utxos) || utxos.length == 0)
            return next(new Error('No utxos found'));

          const fee = opts.fee || 10000;
          const utxoSum = (utxos || []).reduce((sum, u) => sum += u.satoshis, 0);
          const amount = utxoSum - fee;
          if (amount <= 0) return next(new Errors.INSUFFICIENT_FUNDS());

          try {
            const toAddress = B.Address.fromString(destinationAddress);
            const tx = new B.Transaction()
              .from(utxos)
              .to(toAddress, amount)
              .fee(fee)
              .sign(privateKey, undefined, signingMethod);

            // Make sure the tx can be serialized
            tx.serialize();
            return next(null, tx);
          } catch (ex) {
            log.error('Could not build transaction from private key', ex);
            return next(new Errors.COULD_NOT_BUILD_TRANSACTION());
          }
        }
      ],
      cb
    );
  }

  /**
   * Open a wallet and try to complete the public key ring.
   * @param {function} cb Callback function in the standard form (err, wallet)
   * @returns {API} Returns instance of API wallet
   */
  openWallet(opts, cb) {
    if (typeof opts === 'function') {
      cb = opts;
    }
    opts = opts || {};

    $.checkState(this.credentials, 'Failed state: this.credentials at <openWallet()>');
    if (this.credentials.isComplete() && this.credentials.hasWalletInfo())
      return cb(null, true);

    const qs = [];
    qs.push('includeExtendedInfo=1');
    qs.push('serverMessageArray=1');

    this.request.get('/v3/wallets/?' + qs.join('&'), (err, ret) => {
      if (err) return cb(err);
      var wallet = ret.wallet;

      this._processStatus(ret);

      if (!this.credentials.hasWalletInfo()) {
        const me = (wallet.copayers || []).find(c => c.id === this.credentials.copayerId);
        if (!me) return cb(new Error('Copayer not in wallet'));

        try {
          this.credentials.addWalletInfo(
            wallet.id,
            wallet.name,
            wallet.m,
            wallet.n,
            me.name,
            opts
          );
        } catch (e) {
          if (e.message) {
            log.info('Trying credentials...', e.message);
          }
          if (e.message && e.message.match(/Bad\snr/)) {
            return cb(new Errors.WALLET_DOES_NOT_EXIST());
          }
          throw e;
        }
      }
      if (wallet.status != 'complete') return cb(null, ret);

      if (this.credentials.walletPrivKey) {
        if (!Verifier.checkCopayers(this.credentials, wallet.copayers)) {
          return cb(new Errors.SERVER_COMPROMISED());
        }
      } else {
        // this should only happen in AIR-GAPPED flows
        log.warn('Could not verify copayers key (missing wallet Private Key)');
      }

      this.credentials.addPublicKeyRing(
        this._extractPublicKeyRing(wallet.copayers)
      );
      this.emit('walletCompleted', wallet);

      return cb(null, ret);
    });
  }

  static _buildSecret(walletId, walletPrivKey, chain, network) {
    if (typeof walletPrivKey === 'string') {
      walletPrivKey = Bitcore.PrivateKey.fromString(walletPrivKey);
    }
    var widHex = Buffer.from(walletId.replace(/-/g, ''), 'hex');
    var widBase58 = new Bitcore.encoding.Base58(widHex).toString();
    const networkChar = NetworkChar[network] || 'L';
    return (
      widBase58.padEnd(22, '0') +
      walletPrivKey.toWIF() +
      networkChar +
      chain
    );
  }

  static parseSecret(secret) {
    $.checkArgument(secret);

    var split = (str, indexes) => {
      var parts = [];
      indexes.push(str.length);
      var i = 0;
      while (i < indexes.length) {
        parts.push(str.substring(i == 0 ? 0 : indexes[i - 1], indexes[i]));
        i++;
      }
      return parts;
    };

    try {
      var secretSplit = split(secret, [22, 74, 75]);
      var widBase58 = secretSplit[0].replace(/0/g, '');
      var widHex = Bitcore.encoding.Base58.decode(widBase58).toString('hex');
      var walletId = split(widHex, [8, 12, 16, 20]).join('-');

      const walletPrivKey = Bitcore.PrivateKey.fromString(secretSplit[1]);
      const network = NetworkChar[secretSplit[2]] || 'livenet';
      const coin = secretSplit[3] || 'btc';

      return {
        walletId,
        walletPrivKey,
        coin,
        network
      };
    } catch (ex) {
      throw new Error('Invalid secret');
    }
  }

  static getRawTx(txp) {
    var t = Utils.buildTx(txp);
    return t.uncheckedSerialize();
  }

  _getCurrentSignatures(txp) {
    var acceptedActions = (txp.actions || []).filter(a => a.type === 'accept');

    return acceptedActions.map(x => ({
      signatures: x.signatures,
      xpub: x.xpub
    }));
  }

  _addSignaturesToBitcoreTxBitcoin(txp, t, signatures, xpub) {
    $.checkState(
      txp.coin,
      'Failed state: txp.coin undefined at _addSignaturesToBitcoreTxBitcoin'
    );
    $.checkState(
      txp.signingMethod,
      'Failed state: txp.signingMethod undefined at _addSignaturesToBitcoreTxBitcoin'
    );

    var chain = txp.chain?.toLowerCase() || Utils.getChain(txp.coin); // getChain -> backwards compatibility
    const bitcore = Bitcore_[chain];
    if (signatures.length != txp.inputs.length)
      throw new Error('Number of signatures does not match number of inputs');

    let i = 0;
    const x = new bitcore.HDPublicKey(xpub);

    for (const signatureHex of signatures) {
      try {
        const signature = bitcore.crypto.Signature.fromString(signatureHex);
        const pub = x.deriveChild(txp.inputPaths[i]).publicKey;
        const s = {
          inputIndex: i,
          signature,
          sigtype:
            // tslint:disable-next-line:no-bitwise
            bitcore.crypto.Signature.SIGHASH_ALL |
            bitcore.crypto.Signature.SIGHASH_FORKID,
          publicKey: pub
        };
        t.inputs[i].addSignature(t, s, txp.signingMethod);
        i++;
      } catch (e) { }
    }

    if (i != txp.inputs.length) throw new Error('Wrong signatures');
  }

  _addSignaturesToBitcoreTx(txp, t, signatures, xpub) {
    const { chain, network } = txp;
    switch (chain.toLowerCase()) {
      case 'xrp':
      case 'eth':
      case 'matic':
      case 'arb':
      case 'base':
      case 'op':
      case 'sol':
        const unsignedTxs = t.uncheckedSerialize();
        const signedTxs = [];
        for (let index = 0; index < signatures.length; index++) {
          const signed = CWC.Transactions.applySignature({
            chain: chain.toUpperCase(),
            tx: unsignedTxs[index],
            signature: signatures[index]
          });
          signedTxs.push(signed);

          // bitcore users id for txid...
          t.id = CWC.Transactions.getHash({
            tx: signed,
            chain: chain.toUpperCase(),
            network
          });
        }
        t.uncheckedSerialize = () => signedTxs;
        t.serialize = () => signedTxs;
        break;
      default:
        return this._addSignaturesToBitcoreTxBitcoin(txp, t, signatures, xpub);
    }
  }

  _applyAllSignatures(txp, t) {
    $.checkState(
      txp.status == 'accepted',
      'Failed state: txp.status at _applyAllSignatures'
    );

    var sigs = this._getCurrentSignatures(txp);
    for (const x of sigs) {
      this._addSignaturesToBitcoreTx(txp, t, x.signatures, x.xpub);
    }
  }

  /**
   * Join a multisig wallet
   * @private
   * @param {string} walletId
   * @param {string} walletPrivKey
   * @param {string} xPubKey
   * @param {string} requestPubKey
   * @param {string} copayerName
   * @param {Object} [opts]
   * @param {string} [opts.customData]
   * @param {string} [opts.coin]
   * @param {string} [opts.hardwareSourcePublicKey]
   * @param {string} [opts.clientDerivedPublicKey]
   * @param {function} cb Callback function in the standard form (err, wallet)
   * @returns {API} Returns instance of API wallet
   */
  _doJoinWallet(
    walletId,
    walletPrivKey,
    xPubKey,
    requestPubKey,
    copayerName,
    opts,
    cb
  ) {
    $.shouldBeFunction(cb);

    opts = opts || {};

    // Adds encrypted walletPrivateKey to CustomData
    opts.customData = opts.customData || {};
    opts.customData.walletPrivKey = walletPrivKey.toString();
    const encCustomData = Utils.encryptMessage(JSON.stringify(opts.customData), this.credentials.personalEncryptingKey);
    const encCopayerName = Utils.encryptMessage(copayerName, this.credentials.sharedEncryptingKey);

    const args: any = {
      walletId,
      coin: opts.coin,
      chain: opts.chain,
      name: encCopayerName,
      xPubKey,
      requestPubKey,
      customData: encCustomData,
      hardwareSourcePublicKey: opts.hardwareSourcePublicKey,
      clientDerivedPublicKey: opts.clientDerivedPublicKey
    };
    if (opts.dryRun) args.dryRun = true;

    if ([true, false].includes(opts.supportBIP44AndP2PKH))
      args.supportBIP44AndP2PKH = opts.supportBIP44AndP2PKH;

    const hash = Utils.getCopayerHash(
      args.name,
      args.xPubKey,
      args.requestPubKey
    );
    args.copayerSignature = Utils.signMessage(hash, walletPrivKey);

    const url = '/v2/wallets/' + walletId + '/copayers';
    this.request.post(url, args, (err, body) => {
      if (err) return cb(err);
      this._processWallet(body.wallet);
      return cb(null, body.wallet);
    });
  }

  /**
   * Checks if wallet is complete
   * @returns {boolean}
   */
  isComplete() {
    return this.credentials && this.credentials.isComplete();
  }

  _extractPublicKeyRing(copayers) {
    return (copayers || []).map(copayer => ({
      xPubKey: copayer.xPubKey,
      requestPubKey: copayer.requestPubKey,
      copayerName: copayer.name
    }));
  }

  /**
   * Get current fee levels for the specified network
   * @param {string} chain 'btc' (default) or 'bch'
   * @param {string} network 'livenet' (default) or 'testnet'
   * @param {function} cb Callback function in the standard form (err, levels)
   * @returns {object} An object with fee level information
   */
  getFeeLevels(chain, network, cb) {
    $.checkArgument(chain || Constants.CHAINS.includes(chain));
    $.checkArgument(network || ['livenet', 'testnet'].includes(network));

    this.request.get(
      '/v2/feelevels/?coin=' +
      (chain || 'btc') +
      '&network=' +
      (network || 'livenet'),
      (err, result) => {
        if (err) return cb(err);
        return cb(err, result);
      }
    );
  }

  clearCache(opts, cb) {
    if (typeof opts === 'function') {
      cb = opts;
      opts = {};
    }
    const qs = Object.entries(opts || {}).map(([key, value]) => `${key}=${value}`).join('&');
    this.request.post('/v1/clearcache/' + (qs ? '?' + qs : ''), {}, (err, res) => {
      return cb(err, res);
    });
  }

  /**
   * Get service version
   * @param {function} cb Callback function in the standard form (err, version)
   */
  getVersion(cb) {
    this.request.get('/v1/version/', cb);
  }

  _checkKeyDerivation() {
    var isInvalid = this.keyDerivationOk === false;
    if (isInvalid) {
      log.error('Key derivation for this device is not working as expected');
    }
    return !isInvalid;
  }

  /**
   * Create a wallet
   * @param {string} walletName
   * @param {string} copayerName
   * @param {number} m
   * @param {number} n
   * @param {Object} [opts] (optional: advanced options)
   * @param {string} [opts.coin] The coin for this wallet (btc, bch). Default: btc
   * @param {string} [opts.chain] The chain for this wallet (btc, bch). Default: btc
   * @param {string} [opts.network] Default: livenet
   * @param {boolean} [opts.singleAddress] The wallet will only ever have one address. Default: false
   * @param {string} [opts.walletPrivKey] Set a walletPrivKey (instead of random)
   * @param {string} [opts.id] Set an id for wallet (instead of server given)
   * @param {boolean} [opts.useNativeSegwit] Set addressType to P2WPKH, P2WSH, or P2TR (segwitVersion = 1)
   * @param {number} [opts.segwitVersion] 0 (default) = P2WPKH, P2WSH; 1 = P2TR
   * @param {function} cb Callback function in the standard form (err, joinSecret)
   * @return {null|string} Returns null for a single-sig wallet, or the join secret for a multi-sig wallet
   */
  createWallet(walletName, copayerName, m, n, opts, cb) {
    if (!this._checkKeyDerivation())
      return cb(new Error('Cannot create new wallet'));

    if (opts) $.shouldBeObject(opts);
    opts = opts || {};

    var coin = opts.coin || 'btc';
    var chain = opts.chain?.toLowerCase() || coin;

    // checking in chains for simplicity
    if (!Constants.CHAINS.includes(chain))
      return cb(new Error('Invalid chain'));

    var network = opts.network || 'livenet';
    if (!['testnet', 'livenet', 'regtest'].includes(network))
      return cb(new Error('Invalid network: ' + network));

    if (!this.credentials) {
      return cb(new Error('Import credentials first with setCredentials()'));
    }

    if (coin != this.credentials.coin) {
      return cb(new Error('Existing keys were created for a different coin'));
    }

    if (network != this.credentials.network) {
      return cb(new Error('Existing keys were created for a different network'));
    }

    var walletPrivKey = opts.walletPrivKey || new Bitcore.PrivateKey();

    var c = this.credentials;
    c.addWalletPrivateKey(walletPrivKey.toString());
    var encWalletName = Utils.encryptMessage(walletName, c.sharedEncryptingKey);

    var args = {
      name: encWalletName,
      m,
      n,
      pubKey: new Bitcore.PrivateKey(walletPrivKey).toPublicKey().toString(),
      chain,
      coin,
      network,
      singleAddress: !!opts.singleAddress,
      id: opts.id,
      usePurpose48: n > 1,
      useNativeSegwit: !!opts.useNativeSegwit,
      segwitVersion: opts.segwitVersion,
      hardwareSourcePublicKey: c.hardwareSourcePublicKey,
      clientDerivedPublicKey: c.clientDerivedPublicKey
    };
    this.request.post('/v2/wallets/', args, (err, res) => {
      if (err) return cb(err);

      var walletId = res.walletId;
      c.addWalletInfo(walletId, walletName, m, n, copayerName, {
        useNativeSegwit: opts.useNativeSegwit,
        segwitVersion: opts.segwitVersion
      });
      var secret = API._buildSecret(
        c.walletId,
        c.walletPrivKey,
        c.coin,
        c.network
      );

      this._doJoinWallet(
        walletId,
        walletPrivKey,
        c.xPubKey,
        c.requestPubKey,
        copayerName,
        {
          coin,
          chain,
          hardwareSourcePublicKey: c.hardwareSourcePublicKey,
          clientDerivedPublicKey: c.clientDerivedPublicKey
        },
        (err, wallet) => {
          if (err) return cb(err);
          return cb(null, n > 1 ? secret : null);
        }
      );
    });
  }

  /**
   * Join an existent wallet
   * @param {string} secret
   * @param {string} copayerName
   * @param {Object} [opts]
   * @param {string} [opts.coin] The expected coin for this wallet (btc, bch). Default: btc
   * @param {boolean} [opts.dryRun] Simulate wallet join. Default: false
   * @param {function} cb Callback function in the standard form (err, wallet)
   * @returns {API} Returns instance of API wallet
   */
  joinWallet(secret, copayerName, opts, cb) {
    if (!cb) {
      cb = opts;
      opts = {};
      log.warn('DEPRECATED WARN: joinWallet should receive 4 parameters.');
    }

    if (!this._checkKeyDerivation()) return cb(new Error('Cannot join wallet'));

    opts = opts || {};

    var coin = opts.coin || 'btc';
    var chain = opts.chain || coin;

    if (!Constants.CHAINS.includes(chain))
      return cb(new Error('Invalid chain'));

    try {
      var secretData = API.parseSecret(secret);
    } catch (ex) {
      return cb(ex);
    }

    if (!this.credentials) {
      return cb(new Error('Import credentials first with setCredentials()'));
    }

    this.credentials.addWalletPrivateKey(secretData.walletPrivKey.toString());
    this._doJoinWallet(
      secretData.walletId,
      secretData.walletPrivKey,
      this.credentials.xPubKey,
      this.credentials.requestPubKey,
      copayerName,
      {
        coin,
        chain,
        dryRun: !!opts.dryRun
      },
      (err, wallet) => {
        if (err) return cb(err);
        if (!opts.dryRun) {
          this.credentials.addWalletInfo(
            wallet.id,
            wallet.name,
            wallet.m,
            wallet.n,
            copayerName,
            {
              useNativeSegwit: Utils.isNativeSegwit(wallet.addressType),
              segwitVersion: Utils.getSegwitVersion(wallet.addressType),
              allowOverwrite: true
            }
          );
        }
        return cb(null, wallet);
      }
    );
  }

  /**
   * Recreates a wallet, given credentials (with wallet id)
   * @param {function} cb Callback function in the standard form (err)
   * @returns {undefined} No return value
   */
  recreateWallet(cb) {
    $.checkState(this.credentials, 'Failed state: this.credentials at <recreateWallet()>');
    $.checkState(this.credentials.isComplete());
    $.checkState(this.credentials.walletPrivKey);

    // First: Try to get the wallet with current credentials
    this.getStatus({ includeExtendedInfo: true }, err => {
      if (!err) {
        // No error? -> Wallet is ready.
        log.info('Wallet is already created');
        return cb();
      }

      var c = this.credentials;
      var walletPrivKey = Bitcore.PrivateKey.fromString(c.walletPrivKey);
      var walletId = c.walletId;
      var useNativeSegwit = Utils.isNativeSegwit(c.addressType);
      var segwitVersion = Utils.getSegwitVersion(c.addressType);
      var supportBIP44AndP2PKH = c.derivationStrategy != Constants.DERIVATION_STRATEGIES.BIP45;
      var encWalletName = Utils.encryptMessage(
        c.walletName || 'recovered wallet',
        c.sharedEncryptingKey
      );

      var args = {
        name: encWalletName,
        m: c.m,
        n: c.n,
        pubKey: walletPrivKey.toPublicKey().toString(),
        coin: c.coin,
        chain: c.chain,
        network: c.network,
        id: walletId,
        usePurpose48: c.n > 1,
        useNativeSegwit,
        segwitVersion
      };

      if (!!supportBIP44AndP2PKH) {
        args['supportBIP44AndP2PKH'] = supportBIP44AndP2PKH;
      }

      this.request.post('/v2/wallets/', args, (err, body) => {
        if (err) {
          // return all errors. Can't call addAccess.
          log.info('openWallet error' + err);
          return cb(new Errors.WALLET_DOES_NOT_EXIST());
        }

        if (!walletId) {
          walletId = body.walletId;
        }

        var i = 1;
        var opts = {
          coin: c.coin,
          chain: c.chain
        };
        if (!!supportBIP44AndP2PKH)
          opts['supportBIP44AndP2PKH'] = supportBIP44AndP2PKH;

        async.each(
          this.credentials.publicKeyRing,
          (item, next) => {
            var name = item.copayerName || 'copayer ' + i++;
            this._doJoinWallet(
              walletId,
              walletPrivKey,
              item.xPubKey,
              item.requestPubKey,
              name,
              opts,
              err => {
                // Ignore error if copayer is already in wallet
                if (err instanceof Errors.COPAYER_IN_WALLET)
                  return next();
                return next(err);
              }
            );
          },
          cb
        );
      });
    });
  }

  _processWallet(wallet) {
    var encryptingKey = this.credentials.sharedEncryptingKey;

    var name = Utils.decryptMessageNoThrow(wallet.name, encryptingKey);
    if (name != wallet.name) {
      wallet.encryptedName = wallet.name;
    }
    wallet.name = name;
    for (const copayer of wallet.copayers || []) {
      var name = Utils.decryptMessageNoThrow(copayer.name, encryptingKey);
      if (name != copayer.name) {
        copayer.encryptedName = copayer.name;
      }
      copayer.name = name;
      for (const access of copayer.requestPubKeys || []) {
        if (!access.name) continue;

        var name = Utils.decryptMessageNoThrow(access.name, encryptingKey);
        if (name != access.name) {
          access.encryptedName = access.name;
        }
        access.name = name;
      }
    }
  }

  _processStatus(status) {
    var processCustomData = data => {
      const copayers = data.wallet.copayers;
      if (!copayers) return;

      const me = copayers.find(c => c.id === this.credentials.copayerId);
      if (!me || !me.customData) return;

      var customData;
      try {
        customData = JSON.parse(
          Utils.decryptMessage(
            me.customData,
            this.credentials.personalEncryptingKey
          )
        );
      } catch (e) {
        log.warn('Could not decrypt customData:', me.customData);
      }
      if (!customData) return;

      // Add it to result
      data.customData = customData;

      // Update walletPrivateKey
      if (!this.credentials.walletPrivKey && customData.walletPrivKey)
        this.credentials.addWalletPrivateKey(customData.walletPrivKey);
    };

    processCustomData(status);
    this._processWallet(status.wallet);
    this._processTxps(status.pendingTxps);
  }

  /**
   * Get latest notifications
   * @param {Object} [opts]
   * @param {string} [opts.lastNotificationId] The ID of the last received notification
   * @param {string} [opts.timeSpan] A time window on which to look for notifications (in seconds)
   * @param {string} [opts.includeOwn] Do not ignore notifications generated by the current copayer. Default: false
   * @param {function} cb Callback function in the standard form (err, notifications)
   * @returns {Array<any>} Returns an array of notifications
   */
  getNotifications(opts, cb) {
    $.checkState(this.credentials, 'Failed state: this.credentials at <getNotifications()>');

    opts = opts || {};

    var url = '/v1/notifications/';
    if (opts.lastNotificationId) {
      url += '?notificationId=' + opts.lastNotificationId;
    } else if (opts.timeSpan) {
      url += '?timeSpan=' + opts.timeSpan;
    }

    this.request.getWithLogin(url, (err, result) => {
      if (err) return cb(err);
      result = result || [];
      const notifications = opts.includeOwn ? result : result.filter(notification => notification.creatorId != this.credentials.copayerId);
      return cb(null, notifications);
    });
  }

  /**
   * Get status of the wallet
   * @param {Object} [opts]
   * @param {boolean} [opts.twoStep] Use 2-step balance computation for improved performance. Default: false
   * @param {boolean} [opts.includeExtendedInfo] Query extended status. Default: false
   * @param {string} [opts.tokenAddress] ERC20 Token Contract Address
   * @param {string} [opts.multisigContractAddress] MULTISIG ETH Contract Address
   * @param {function} cb Callback function in the standard form (err, status)
   * @returns {Object} Returns an object with status information
   */
  getStatus(opts, cb) {
    $.checkState(this.credentials, 'Failed state: this.credentials at <getStatus()>');

    if (!cb) {
      cb = opts;
      opts = {};
      log.warn('DEPRECATED WARN: getStatus should receive 2 parameters.');
    }

    opts = opts || {};

    const qs = [];
    qs.push('includeExtendedInfo=' + (opts.includeExtendedInfo ? '1' : '0'));
    qs.push('twoStep=' + (opts.twoStep ? '1' : '0'));
    qs.push('serverMessageArray=1');

    if (opts.tokenAddress) {
      qs.push('tokenAddress=' + opts.tokenAddress);
    }

    if (opts.multisigContractAddress) {
      qs.push('multisigContractAddress=' + opts.multisigContractAddress);
      qs.push('network=' + this.credentials.network);
    }

    this.request.get('/v3/wallets/?' + qs.join('&'), (err, result) => {
      if (err) return cb(err);
      if (result.wallet.status == 'pending') {
        var c = this.credentials;
        result.wallet.secret = API._buildSecret(
          c.walletId,
          c.walletPrivKey,
          c.coin,
          c.network
        );
      }

      this._processStatus(result);

      return cb(err, result);
    });
  }

  /**
   * Get copayer preferences
   * @param {function} cb Callback function in the standard form (err, preferences)
   * @return {Object} Returns a preferences object
   */
  getPreferences(cb) {
    $.checkState(this.credentials, 'Failed state: this.credentials at <getPreferences()>');
    $.checkArgument(cb);

    this.request.get('/v1/preferences/', (err, preferences) => {
      if (err) return cb(err);
      return cb(null, preferences);
    });
  }

  /**
   * Save copayer preferences
   * @param {Object} preferences Preferences to be saved
   * @param {function} cb Callback function in the standard form (err, preferences)
   * @return {Object} Returns saved preferences object
   */
  savePreferences(preferences, cb) {
    $.checkState(
      this.credentials,
      'Failed state: this.credentials at <savePreferences()>'
    );
    $.checkArgument(cb);

    this.request.put('/v1/preferences/', preferences, cb);
  }

  /**
   * Fetch PayPro invoice
   * @param {Object} opts
   * @param {string} opts.payProUrl PayPro request URL
   * @param {function} cb Callback function in the standard form (err, paypro)
   * @returns {{ amount, toAddress, memo }} Parsed payment protocol request
   */
  fetchPayPro(opts, cb) {
    $.checkArgument(opts).checkArgument(opts.payProUrl);

    PayPro.get(
      {
        url: opts.payProUrl,
        coin: this.credentials.coin || 'btc',
        network: this.credentials.network || 'livenet',

        // for testing
        request: this.request
      },
      (err, paypro) => {
        if (err) return cb(err);

        return cb(null, paypro);
      }
    );
  }

  /**
   * Gets list of utxos
   * @param {Object} [opts]
   * @param {Array<string>} [opts.addresses] List of addresses from where to fetch UTXOs
   * @param {function} cb Callback function in the standard form (err, utxos)
   * @returns {Array<any>} Returns an array of utxos
   */
  getUtxos(opts, cb) {
    $.checkState(this.credentials && this.credentials.isComplete(), 'Failed state: this.credentials at <getUtxos()>');
    opts = opts || {};
    let url = '/v1/utxos/';
    if (opts.addresses) {
      url +=
        '?' +
        querystring.stringify({
          addresses: [].concat(opts.addresses).join(',')
        });
    }
    this.request.get(url, cb);
  }

  /**
   * Gets list of coins
   * @param {Object} opts
   * @param {string} [opts.coin] Chain to query (DEPRECATED - use `opts.chain`)
   * @param {string} opts.chain Chain to query
   * @param {string} opts.network Network to query
   * @param {string} opts.txId Transaction ID to query
   * @param {function} cb Callback function in the standard form (err, coins) 
   * @returns {Array<any>} Returns an array of coins
   */
  getCoinsForTx(opts, cb) {
    $.checkState(this.credentials && this.credentials.isComplete(), 'Failed state: this.credentials at <getCoinsForTx()>');
    $.checkArgument(opts && (opts.coin || opts.chain) && opts.network && opts.txId, 'Missing required parameter(s)');
    opts.chain = opts.chain || opts.coin; // backwards compatibility
    let url = '/v1/txcoins/';
    url +=
      '?' +
      querystring.stringify({
        coin: opts.chain,
        network: opts.network,
        txId: opts.txId
      });
    this.request.get(url, cb);
  }

  _getCreateTxProposalArgs(opts) {
    const args = JSON.parse(JSON.stringify(opts));
    args.message = API._encryptMessage(opts.message, this.credentials.sharedEncryptingKey) || null;
    args.payProUrl = opts.payProUrl || null;
    args.isTokenSwap = opts.isTokenSwap || null;
    args.replaceTxByFee = opts.replaceTxByFee || null;
    for (const o of args.outputs) {
      o.message = API._encryptMessage(o.message, this.credentials.sharedEncryptingKey) || null;
    }
    return args;
  }

  /**
   * Create a transaction proposal
   *
   * @param {Object} opts
   * @param {string} [opts.txProposalId] If provided it will be used as this TX proposal ID. Should be unique in the scope of the wallet
   * @param {Array} opts.outputs Array of outputs
   * @param {string} opts.outputs[].toAddress Destination address
   * @param {number} opts.outputs[].amount Amount to transfer in satoshi
   * @param {string} [opts.outputs[].message] A message to attach to this output
   * @param {string} [opts.message] A message to attach to this transaction
   * @param {number} [opts.feeLevel] Specify the fee level for this TX ('priority', 'normal', 'economy', 'superEconomy'). Default: normal
   * @param {number} [opts.feePerKb] Specify the fee per KB for this TX (in satoshi)
   * @param {string} [opts.changeAddress] Use this address as the change address for the tx. The address should belong to the wallet. In the case of singleAddress wallets, the first main address will be used
   * @param {boolean} [opts.sendMax] Send maximum amount of funds that make sense under the specified fee/feePerKb conditions. Default: false
   * @param {string} [opts.payProUrl] Paypro URL for peers to verify TX
   * @param {boolean} [opts.excludeUnconfirmedUtxos] Do not use UTXOs of unconfirmed transactions as inputs. Default: false
   * @param {boolean} [opts.dryRun] Simulate the action but do not change server state. Default: false
   * @param {Array} [opts.inputs] Inputs for this TX
   * @param {number} [opts.fee] Use a fixed fee for this TX (only when opts.inputs is specified)
   * @param {boolean} [opts.noShuffleOutputs] If set, TX outputs won't be shuffled. Default: false
   * @param {string} [opts.signingMethod] If set, force signing method (ecdsa or schnorr) otherwise use default for chain
   * @param {boolean} [opts.isTokenSwap] To specify if we are trying to make a token swap
   * @param {boolean} [opts.enableRBF] Enable BTC Replace-By-Fee
   * @param {string} [opts.multiSendContractAddress] Use this address to interact with the MultiSend contract that is used to send EVM based txp's with outputs > 1
   * @param {string} [opts.tokenAddress] Use this address to reference a token an a given chain
   * @param {boolean} [opts.replaceTxByFee] Ignore locked utxos check ( used for replacing a transaction designated as RBF)
   * @param {function} cb Callback function in the standard form (err, txp)
   * @param {string} [baseUrl] ONLY FOR TESTING
   * @returns {Object} Returns the transaction proposal
   */
  createTxProposal(opts, cb, baseUrl) {
    $.checkState(this.credentials && this.credentials.isComplete(), 'Failed state: this.credentials at <createTxProposal()>');
    $.checkState(this.credentials.sharedEncryptingKey);
    $.checkArgument(opts);

    // BCH schnorr deployment
    if (!opts.signingMethod && this.credentials.coin == 'bch') {
      opts.signingMethod = 'schnorr';
    }

    var args = this._getCreateTxProposalArgs(opts);
    baseUrl = baseUrl || '/v3/txproposals/';
    // baseUrl = baseUrl || '/v4/txproposals/'; // DISABLED 2020-04-07

    this.request.post(baseUrl, args, (err, txp) => {
      if (err) return cb(err);

      this._processTxps(txp);
      if (
        !Verifier.checkProposalCreation(
          args,
          txp,
          this.credentials.sharedEncryptingKey
        )
      ) {
        return cb(new Errors.SERVER_COMPROMISED());
      }

      return cb(null, txp);
    });
  }

  /**
   * Publish a transaction proposal
   * @param {Object} opts
   * @param {Object} opts.txp The transaction proposal object returned by the API#createTxProposal method
   * @param {function} cb Callback function in the standard form (err, null)
   * @returns {null}
   */
  publishTxProposal(opts, cb) {
    $.checkState(this.credentials && this.credentials.isComplete(), 'Failed state: this.credentials at <publishTxProposal()>');
    $.checkArgument(opts?.txp, 'No txp was given to publish');

    $.checkState(parseInt(opts.txp.version) >= 3);

    var t = Utils.buildTx(opts.txp);
    var hash = t.uncheckedSerialize();
    var args = {
      proposalSignature: Utils.signMessage(
        hash,
        this.credentials.requestPrivKey
      )
    };

    var url = '/v2/txproposals/' + opts.txp.id + '/publish/';
    this.request.post(url, args, (err, txp) => {
      if (err) return cb(err);
      this._processTxps(txp);
      return cb(null, txp);
    });
  }

  /**
   * Create a new address
   * @param {Object} [opts]
   * @param {boolean} [opts.ignoreMaxGap] Default: false
   * @param {boolean} [opts.isChange] Default: false
   * @param {function} cb Callback function in the standard form (err, address)
   * @returns {{ address, type, path }}  Returns the new address object
   */
  createAddress(opts, cb) {
    $.checkState(this.credentials && this.credentials.isComplete(), 'Failed state: this.credentials at <createAddress()>');

    if (!cb) {
      cb = opts;
      opts = {};
      log.warn('DEPRECATED WARN: createAddress should receive 2 parameters.');
    }

    if (!this._checkKeyDerivation())
      return cb(new Error('Cannot create new address for this wallet'));

    opts = opts || {};

    this.request.post('/v4/addresses/', opts, (err, address) => {
      if (err) return cb(err);

      if (!Verifier.checkAddress(this.credentials, address)) {
        return cb(new Errors.SERVER_COMPROMISED());
      }

      return cb(null, address);
    });
  }

  /**
   * Get your main addresses
   * @param {Object} [opts]
   * @param {boolean} [opts.doNotVerify] Do not verify the addresses. Default: false
   * @param {number} [opts.limit] Limit the resultset. Return all addresses by default
   * @param {boolean} [opts.reverse] Reverse the order. Default: false
   * @param {function} cb Callback function in the standard form (err, addresses)
   * @returns {{ address, type, path }} Returns an array of addresses
   */
  getMainAddresses(opts, cb) {
    $.checkState(this.credentials && this.credentials.isComplete());

    opts = opts || {};

    var args = [];
    if (opts.limit) args.push('limit=' + opts.limit);
    if (opts.reverse) args.push('reverse=1');
    var qs = '';
    if (args.length > 0) {
      qs = '?' + args.join('&');
    }
    var url = '/v1/addresses/' + qs;

    this.request.get(url, (err, addresses) => {
      if (err) return cb(err);

      if (!opts.doNotVerify) {
        const fake = (addresses || []).some(address => !Verifier.checkAddress(this.credentials, address));
        if (fake) return cb(new Errors.SERVER_COMPROMISED());
      }
      return cb(null, addresses);
    });
  }

  /**
   * Update wallet balance
   * @param {Object} [opts]
   * @param {String} [opts.coin] Defaults to current wallet chain (DEPRECATED - use opts.chain)
   * @param {String} [opts.chain] Defaults to current wallet chain
   * @param {String} [opts.tokenAddress] ERC20 token contract address
   * @param {String} [opts.multisigContractAddress] MULTISIG ETH Contract Address
   * @param {function} cb Callback function in the standard form (err, balance)
   * @returns {Object} Returns the wallet balance
   */
  getBalance(opts, cb) {
    if (!cb) {
      cb = opts;
      opts = {};
      log.warn('DEPRECATED WARN: getBalance should receive 2 parameters.');
    }

    opts = opts || {};

    $.checkState(this.credentials && this.credentials.isComplete(), 'Failed state: this.credentials at <getBalance