fcoin/lib/bcoin/wallet.js

/*!
 * wallet.js - wallet object for bcoin
 * Copyright (c) 2014-2015, Fedor Indutny (MIT License)
 * Copyright (c) 2014-2016, Christopher Jeffrey (MIT License).
 * https://github.com/indutny/bcoin
 */

var bcoin = require('./env');
var EventEmitter = require('events').EventEmitter;
var utils = require('./utils');
var assert = utils.assert;
var constants = bcoin.protocol.constants;
var BufferReader = require('./reader');
var BufferWriter = require('./writer');

/**
 * HD BIP-44/45 wallet
 * @exports Wallet
 * @constructor
 * @param {Object} options
 * @param {WalletDB} options.db
 * present, no coins will be available.
 * @param {(HDPrivateKey|HDPublicKey)?} options.master - Master HD key. If not
 * present, it will be generated.
 * @param {Boolean?} options.witness - Whether to use witness programs.
 * @param {Number?} options.accountIndex - The BIP44 account index (default=0).
 * @param {Number?} options.receiveDepth - The index of the _next_ receiving
 * address.
 * @param {Number?} options.changeDepth - The index of the _next_ change
 * address.
 * @param {Number?} options.lookahead - Amount of lookahead addresses
 * (default=5).
 * @param {String?} options.type - Type of wallet (pubkeyhash, multisig)
 * (default=pubkeyhash).
 * @param {Boolean?} options.compressed - Whether to use compressed
 * public keys (default=true).
 * @param {Number?} options.m - `m` value for multisig.
 * @param {Number?} options.n - `n` value for multisig.
 * @param {String?} options.id - Wallet ID (used for storage)
 * (default=account key "address").
 */

function Wallet(options) {
  var i, key;

  if (!(this instanceof Wallet))
    return new Wallet(options);

  EventEmitter.call(this);

  if (!options)
    options = {};

  options = utils.merge({}, options);

  this.options = options;
  this.network = bcoin.network.get(options.network);
  this.db = options.db;

  if (!this.db)
    this.db = new bcoin.walletdb({ name: 'wtmp', db: 'memory' });

  if (!options.master)
    options.master = bcoin.hd.fromMnemonic(null, this.network);

  if (!bcoin.hd.isHD(options.master) && !MasterKey.isMasterKey(options.master))
    options.master = bcoin.hd.fromAny(options.master, this.network);

  if (!MasterKey.isMasterKey(options.master))
    options.master = MasterKey.fromKey(options.master);

  this.id = options.id || null;
  this.master = options.master || null;
  this.witness = options.witness || false;
  this.loaded = false;
  this.loading = false;

  this.accountKey = options.accountKey || null;
  this.accountIndex = options.accountIndex || 0;
  this.receiveDepth = options.receiveDepth || 1;
  this.changeDepth = options.changeDepth || 1;
  this.receiveAddress = null;
  this.changeAddress = null;

  this.lookahead = options.lookahead != null ? options.lookahead : 5;
  this.initialized = options.initialized || false;

  this.type = options.type || 'pubkeyhash';
  this.compressed = options.compressed !== false;
  this.keys = [];
  this.m = options.m || 1;
  this.n = options.n || 1;

  this.cache = new bcoin.lru(20, 1);

  if (this.n > 1)
    this.type = 'multisig';

  assert(this.type === 'pubkeyhash' || this.type === 'multisig',
    '`type` must be multisig or pubkeyhash.');

  if (this.m < 1 || this.m > this.n)
    throw new Error('m ranges between 1 and n');

  if (!this.accountKey) {
    assert(this.master.key);
    key = this.master.key.deriveAccount44(this.accountIndex);
    this.accountKey = key.hdPublicKey;
  }

  if (!this.id)
    this.id = this.getID();

  if (options.passphrase)
    this.master.encrypt(options.passphrase);

  // Non-alphanumeric IDs will break leveldb sorting.
  assert(/^[a-zA-Z0-9]+$/.test(this.id), 'Wallet IDs must be alphanumeric.');

  this.pushKey(this.accountKey);

  if (options.keys) {
    for (i = 0; i < options.keys.length; i++)
      this.pushKey(options.keys[i]);
  }
}

utils.inherits(Wallet, EventEmitter);

/**
 * Open the wallet, register with the database.
 * @param {Function} callback
 */

Wallet.prototype.open = function open(callback) {
  var self = this;

  callback = utils.ensure(callback);

  if (this.loaded)
    return utils.nextTick(callback);

  if (this.loading)
    return this.once('open', callback);

  this.loading = true;

  try {
    this.db.register(this);
  } catch (e) {
    this.emit('error', err);
    return callback(err);
  }

  this.init(function(err) {
    if (err) {
      self.emit('error', err);
      return callback(err);
    }

    self.loading = false;
    self.loaded = true;
    self.emit('open');

    return callback();
  });
};

/**
 * Close the wallet, unregister with the database.
 * @method
 * @param {Function} callback
 */

Wallet.prototype.close =
Wallet.prototype.destroy = function destroy(callback) {
  callback = utils.ensure(callback);

  if (!this.loaded)
    return utils.nextTick(callback);

  assert(!this.loading);

  try {
    this.db.unregister(this);
  } catch (e) {
    this.emit('error', err);
    return callback(err);
  }

  this.loaded = false;

  return utils.nextTick(callback);
};

/**
 * Attempt to intialize the wallet (generating
 * the first addresses along with the lookahead
 * addresses). Called automatically from the
 * walletdb and open().
 * @param {Function} callback
 */

Wallet.prototype.init = function init(callback) {
  var self = this;
  var addresses = [];
  var i;

  // Waiting for more keys.
  if (this.keys.length !== this.n) {
    assert(!this.initialized);
    return this.db.open(function(err) {
      if (err)
        return callback(err);
      self.save(callback);
    });
  }

  if (this.initialized) {
    this.receiveAddress = this.deriveReceive(this.receiveDepth - 1);
    this.changeAddress = this.deriveChange(this.changeDepth - 1);
    return this.db.open(callback);
  }

  this.initialized = true;

  for (i = 0; i < this.receiveDepth - 1; i++)
    addresses.push(this.deriveReceive(i));

  for (i = 0; i < this.changeDepth - 1; i++)
    addresses.push(this.deriveChange(i));

  for (i = this.receiveDepth; i < this.receiveDepth + this.lookahead; i++)
    addresses.push(this.deriveReceive(i));

  for (i = this.changeDepth; i < this.changeDepth + this.lookahead; i++)
    addresses.push(this.deriveChange(i));

  this.receiveAddress = this.deriveReceive(this.receiveDepth - 1);
  this.changeAddress = this.deriveChange(this.changeDepth - 1);

  addresses.push(this.receiveAddress);
  addresses.push(this.changeAddress);

  return this.db.open(function(err) {
    if (err)
      return callback(err);
    return self.saveAddress(addresses, function(err) {
      if (err)
        return callback(err);
      return self.save(callback);
    });
  });
};

/**
 * Add a public account key to the wallet (multisig).
 * Does not update the database.
 * @param {HDPublicKey} key - Account (bip44)
 * key (can be in base58 form).
 * @throws Error on non-hdkey/non-accountkey.
 */

Wallet.prototype.pushKey = function pushKey(key) {
  var result = false;
  var index = -1;
  var i;

  assert(key, 'Key required.');

  if (Array.isArray(key)) {
    for (i = 0; i < key.length; i++) {
      if (this.pushKey(key[i]))
        result = true;
    }
    return result;
  }

  if (key instanceof bcoin.wallet)
    key = key.accountKey;

  if (bcoin.hd.isExtended(key))
    key = bcoin.hd.fromBase58(key);

  if (key.hdPublicKey)
    key = key.hdPublicKey;

  if (!bcoin.hd.isHD(key))
    throw new Error('Must add HD keys to wallet.');

  if (!key.isAccount44())
    throw new Error('Must add HD account keys to BIP44 wallet.');

  for (i = 0; i < this.keys.length; i++) {
    if (this.keys[i].equal(key)) {
      index = i;
      break;
    }
  }

  if (index !== -1)
    return false;

  if (this.keys.length === this.n)
    throw new Error('Cannot add more keys.');

  this.keys.push(key);

  return true;
};

/**
 * Remove a public account key to the wallet (multisig).
 * Does not update the database.
 * @param {HDPublicKey} key - Account (bip44)
 * key (can be in base58 form).
 * @throws Error on non-hdkey/non-accountkey.
 */

Wallet.prototype.spliceKey = function spliceKey(key) {
  var result = false;
  var index = -1;
  var i;

  if (Array.isArray(key)) {
    for (i = 0; i < key.length; i++) {
      if (this.spliceKey(key[i]))
        result = true;
    }
    return result;
  }

  assert(key, 'Key required.');

  if (key instanceof bcoin.wallet)
    key = key.accountKey;

  if (bcoin.hd.isExtended(key))
    key = bcoin.hd.fromBase58(key);

  if (key.hdPublicKey)
    key = key.hdPublicKey;

  if (!bcoin.hd.isHD(key))
    throw new Error('Must add HD keys to wallet.');

  if (!key.isAccount44())
    throw new Error('Must add HD account keys to BIP44 wallet.');

  for (i = 0; i < this.keys.length; i++) {
    if (this.keys[i].equal(key)) {
      index = i;
      break;
    }
  }

  if (index === -1)
    return false;

  if (this.keys.length === this.n)
    throw new Error('Cannot remove key.');

  this.keys.splice(index, 1);

  return true;
};

/**
 * Add a public account key to the wallet (multisig).
 * Saves the key in the wallet database.
 * @param {HDPublicKey} key
 * @param {Function} callback
 */

Wallet.prototype.addKey = function addKey(key, callback) {
  var result = false;

  try {
    result = this.pushKey(key);
  } catch (e) {
    return callback(e);
  }

  if (!result)
    return callback(null, result);

  this.init(function(err) {
    if (err)
      return callback(err);

    return callback(null, result);
  });
};

/**
 * Remove a public account key from the wallet (multisig).
 * Remove the key from the wallet database.
 * @param {HDPublicKey} key
 * @param {Function} callback
 */

Wallet.prototype.removeKey = function removeKey(key, callback) {
  var result = false;

  try {
    result = this.spliceKey(key);
  } catch (e) {
    return callback(e);
  }

  if (!result)
    return callback(null, result);

  this.save(function(err) {
    if (err)
      return callback(err);

    return callback(null, result);
  });
};

/**
 * Get the wallet ID which is either the passed in `id`
 * option, or the account/purpose key converted to an
 * address with a prefix of `0x03be04` (`WLT`).
 * @returns {Base58String}
 */

Wallet.prototype.getID = function getID() {
  var publicKey = this.accountKey.publicKey;
  var p;

  p = new BufferWriter();
  p.writeU8(0x03);
  p.writeU8(0xbe);
  p.writeU8(0x04);
  p.writeBytes(utils.ripesha(publicKey));
  p.writeChecksum();

  return utils.toBase58(p.render());
};

/**
 * Create a new receiving address (increments receiveDepth).
 * @returns {KeyRing}
 */

Wallet.prototype.createReceive = function createReceive(callback) {
  return this.createAddress(false, callback);
};

/**
 * Create a new change address (increments receiveDepth).
 * @returns {KeyRing}
 */

Wallet.prototype.createChange = function createChange(callback) {
  return this.createAddress(true, callback);
};

/**
 * Create a new address (increments depth).
 * @param {Boolean} change
 * @returns {KeyRing}
 */

Wallet.prototype.createAddress = function createAddress(change, callback) {
  var self = this;
  var addresses = [];
  var address;

  if (typeof change === 'function') {
    callback = change;
    change = null;
  }

  if (change) {
    address = this.deriveChange(this.changeDepth);
    addresses.push(address);
    addresses.push(this.deriveChange(this.changeDepth + this.lookahead));
    this.changeDepth++;
    this.changeAddress = address;
  } else {
    address = this.deriveReceive(this.receiveDepth);
    addresses.push(address);
    addresses.push(this.deriveReceive(this.receiveDepth + this.lookahead));
    this.receiveDepth++;
    this.receiveAddress = address;
  }

  this.saveAddress(addresses, function(err) {
    if (err)
      return callback(err);

    self.save(function(err) {
      if (err)
        return callback(err);
      return callback(null, address);
    });
  });
};

/**
 * Derive a receiving address at `index`. Do not increment depth.
 * @param {Number} index
 * @returns {KeyRing}
 */

Wallet.prototype.deriveReceive = function deriveReceive(index) {
  return this.deriveAddress(false, index);
};

/**
 * Derive a change address at `index`. Do not increment depth.
 * @param {Number} index
 * @returns {KeyRing}
 */

Wallet.prototype.deriveChange = function deriveChange(index) {
  return this.deriveAddress(true, index);
};

/**
 * Derive an address at `index`. Do not increment depth.
 * @param {Boolean} change - Whether the address on the change branch.
 * @param {Number} index
 * @returns {KeyRing}
 */

Wallet.prototype.deriveAddress = function deriveAddress(change, index) {
  var self = this;
  var i, key, options;

  assert(this.initialized);

  change = +change;

  key = this.accountKey.derive(change).derive(index);

  options = {
    network: this.network,
    key: key.publicKey,
    account: this.accountIndex,
    change: change,
    index: index,
    type: this.type,
    witness: this.witness,
    m: this.m,
    n: this.n,
    keys: []
  };

  for (i = 0; i < this.keys.length; i++) {
    key = this.keys[i];
    key = key.derive(change).derive(index);
    options.keys.push(key.publicKey);
  }

  return new bcoin.keyring(options);
};

/**
 * Save the wallet to the database. Necessary
 * when address depth and keys change.
 * @param {Function} callback
 */

Wallet.prototype.save = function save(callback) {
  this.db.save(this, callback);
};

/**
 * Save addresses to path map.
 * @param {KeyRing[]} address
 * @param {Function} callback
 */

Wallet.prototype.saveAddress = function saveAddress(address, callback) {
  this.db.saveAddress(this.id, address, callback);
};

/**
 * Test whether the wallet possesses an address.
 * @param {Base58Address} address
 * @returns {Boolean}
 */

Wallet.prototype.hasAddress = function hasAddress(address, callback) {
  this.db.hasAddress(this.id, address, callback);
};

/**
 * Set receiving depth (depth is the index of the _next_ address).
 * Allocate all addresses up to depth. Note that this also allocates
 * new lookahead addresses.
 * @param {Number} depth
 * @returns {Boolean} True if new addresses were allocated.
 */

Wallet.prototype.setReceiveDepth = function setReceiveDepth(depth, callback) {
  var self = this;
  var addresses = [];
  var i;

  if (!(depth > this.receiveDepth))
    return callback(null, false);

  for (i = this.receiveDepth; i < depth; i++) {
    this.receiveAddress = this.deriveReceive(i);
    addresses.push(this.receiveAddress);
  }

  for (i = this.receiveDepth + this.lookahead; i < depth + this.lookahead; i++)
    addresses.push(this.deriveReceive(i));

  this.receiveDepth = depth;

  this.saveAddress(addresses, function(err) {
    if (err)
      return callback(err);

    self.save(function(err) {
      if (err)
        return callback(err);

      return callback(null, true);
    });
  });
};

/**
 * Set change depth (depth is the index of the _next_ address).
 * Allocate all addresses up to depth. Note that this also allocates
 * new lookahead addresses.
 * @param {Number} depth
 * @returns {Boolean} True if new addresses were allocated.
 */

Wallet.prototype.setChangeDepth = function setChangeDepth(depth, callback) {
  var self = this;
  var addresses = [];
  var i;

  if (!(depth > this.changeDepth))
    return callback(null, false);

  for (i = this.changeDepth; i < depth; i++) {
    this.changeAddress = this.deriveChange(i);
    addresses.push(this.changeAddress);
  }

  for (i = this.changeDepth + this.lookahead; i < depth + this.lookahead; i++)
    addresses.push(this.deriveChange(i));

  this.changeDepth = depth;

  this.saveAddress(addresses, function(err) {
    if (err)
      return callback(err);
    self.save(function(err) {
      if (err)
        return callback(err);
      return callback(null, true);
    });
  });
};

/**
 * Fill a transaction with inputs, estimate
 * transaction size, calculate fee, and add a change output.
 * @see MTX#selectCoins
 * @see MTX#fill
 * @param {MTX} tx - _Must_ be a mutable transaction.
 * @param {Object?} options
 * @param {String?} options.selection - Coin selection priority. Can
 * be `age`, `random`, or `all`. (default=age).
 * @param {Boolean} options.round - Whether to round to the nearest
 * kilobyte for fee calculation.
 * See {@link TX#getMinFee} vs. {@link TX#getRoundFee}.
 * @param {Rate} options.rate - Rate used for fee calculation.
 * @param {Boolean} options.confirmed - Select only confirmed coins.
 * @param {Boolean} options.free - Do not apply a fee if the
 * transaction priority is high enough to be considered free.
 * @param {Amount?} options.fee - Use a hard fee rather than calculating one.
 * @param {Number|Boolean} options.subtractFee - Whether to subtract the
 * fee from existing outputs rather than adding more inputs.
 */

Wallet.prototype.fill = function fill(tx, options, callback) {
  var self = this;

  if (typeof options === 'function') {
    callback = options;
    options = null;
  }

  if (!options)
    options = {};

  if (!this.initialized)
    return callback(new Error('Cannot use uninitialized wallet.'));

  this.getCoins(function(err, coins) {
    if (err)
      return callback(err);

    try {
      tx.fill(coins, {
        selection: options.selection || 'age',
        round: options.round,
        confirmed: options.confirmed,
        free: options.free,
        fee: options.fee,
        subtractFee: options.subtractFee,
        changeAddress: self.changeAddress.getAddress(),
        height: self.network.height,
        rate: options.rate != null
          ? options.rate
          : self.network.getRate(),
        wallet: self,
        m: self.m,
        n: self.n
      });
    } catch (e) {
      return callback(e);
    }

    return callback();
  });
};

/**
 * Fill transaction with coins (accesses db).
 * @param {TX} tx
 * @param {Function} callback - Returns [Error, {@link TX}].
 */

Wallet.prototype.fillCoins = function fillCoins(tx, callback) {
  return this.db.fillHistory(this.id, tx, callback);
};

/**
 * Get a coin from the wallet (accesses db).
 * @param {Hash} hash
 * @param {Number} index
 * @param {Function} callback - Returns [Error, {@link Coin}].
 */

Wallet.prototype.getCoin = function getCoin(hash, index, callback) {
  return this.db.getCoin(hash, index, callback);
};

/**
 * Get a transaction from the wallet (accesses db).
 * @param {Hash} hash
 * @param {Function} callback - Returns [Error, {@link TX}].
 */

Wallet.prototype.getTX = function getTX(hash, callback) {
  return this.db.getTX(hash, callback);
};

/**
 * Build a transaction, fill it with outputs and inputs,
 * sort the members according to BIP69, set locktime,
 * and sign it (accesses db).
 * @param {Object} options - See {@link Wallet#fill options}.
 * @param {Object[]} outputs - See {@link Script.createOutputScript}.
 * @param {Function} callback - Returns [Error, {@link MTX}].
 */

Wallet.prototype.createTX = function createTX(options, outputs, callback) {
  var self = this;
  var height = 0xffffffff;
  var tx, i;

  if (typeof outputs === 'function') {
    callback = outputs;
    outputs = null;
  }

  if (!outputs) {
    outputs = options;
    options = {};
  }

  if (!Array.isArray(outputs))
    outputs = [outputs];

  if (options.height >= 0)
    height = options.height;

  // Create mutable tx
  tx = bcoin.mtx();

  // Add the outputs
  for (i = 0; i < outputs.length; i++) {
    try {
      tx.addOutput(outputs[i]);
    } catch (e) {
      callback = utils.asyncify(callback);
      return callback(e);
    }
  }

  // Fill the inputs with unspents
  this.fill(tx, options, function(err) {
    if (err)
      return callback(err);

    // Sort members a la BIP69
    tx.sortMembers();

    // Set the locktime to target value or
    // `height - whatever` to avoid fee sniping.
    // if (options.locktime != null)
    //   tx.setLocktime(options.locktime);
    // else
    //   tx.avoidFeeSniping(options.height);

    if (!tx.isSane())
      return callback(new Error('CheckTransaction failed.'));

    if (!tx.checkInputs(height))
      return callback(new Error('CheckInputs failed.'));

    self.scriptInputs(tx, function(err, total) {
      if (err)
        return callback(err);

      if (total === 0)
        return callback(new Error('scriptInputs failed.'));

      return callback(null, tx);
    });
  });
};

/**
 * Derive necessary addresses for signing a transaction.
 * @param {TX|Input} tx
 * @param {Number?} index - Input index.
 * @returns {KeyRing[]}
 */

Wallet.prototype.deriveInputs = function deriveInputs(tx, callback) {
  var self = this;
  var addresses = [];
  var i;

  this.getInputPaths(tx, function(err, paths) {
    if (err)
      return callback(err);

    for (i = 0; i < paths.length; i++) {
      path = paths[i];
      addresses.push(self.deriveAddress(path.change, path.index));
    }

    return callback(null, addresses);
  });
};

/**
 * Get path by address.
 * @param {Base58Address} address - Base58 address.
 */

Wallet.prototype.getPath = function getPath(address, callback) {
  this.db.getPath(this.id, address, callback);
};

/**
 * Map input addresses to paths.
 * @param {TX|Input} tx
 * @param {Number?} index
 * @returns {String[]}
 */

Wallet.prototype.getInputPaths = function getInputPaths(tx, callback) {
  var self = this;
  var paths = [];
  var i, input, address, path;

  if (tx instanceof bcoin.input) {
    if (!tx.coin)
      return callback(new Error('Not all coins available.'));

    return this.getPath(tx.coin.getHash(), function(err, path) {
      if (err)
        return callback(err);

      if (path)
        paths.push(path);

      return callback(null, paths);
    });
  }

  utils.forEachSerial(tx.inputs, function(input, next, i) {
    if (!input.coin)
      return next(new Error('Not all coins available.'));

    self.getPath(input.coin.getHash(), function(err, path) {
      if (err)
        return next(err);

      if (!path)
        return next();

      paths.push(path);

      return next();
    });
  }, function(err) {
    if (err)
      return callback(err);
    return callback(null, utils.uniq(paths));
  });
};

/**
 * Map output addresses to paths.
 * @param {TX|Output}
 * @param {Number?} index
 * @returns {String[]}
 */

Wallet.prototype.getOutputPaths = function getOutputPaths(tx, callback) {
  var self = this;
  var paths = [];
  var i, input, address, path;

  if (tx instanceof bcoin.output) {
    return this.getPath(tx.getHash(), function(err, path) {
      if (err)
        return callback(err);
      if (path)
        paths.push(path);
      return callback(null, paths);
    });
  }

  utils.forEachSerial(tx.outputs, function(output, next, i) {
    self.getPath(output.getHash(), function(err, path) {
      if (err)
        return next(err);

      if (!path)
        return next();

      paths.push(path);

      return next();
    });
  }, function(err) {
    if (err)
      return next(err);
    return callback(null, utils.uniq(paths));
  });
};

/**
 * Get the maximum address depth based on a transactions outputs.
 * @param {TX} tx
 * @returns {Object} { changeDepth: Number, receiveDepth: Number }
 */

Wallet.prototype.getOutputDepth = function getOutputDepth(tx, callback) {
  var self = this;
  var depth = { changeDepth: -1, receiveDepth: -1 };
  var i, path;

  this.getOutputPaths(tx, function(err, paths) {
    if (err)
      return callback(err);

    for (i = 0; i < paths.length; i++) {
      path = paths[i];
      if (path.change) {
        if (path.index > depth.changeDepth)
          depth.changeDepth = path.index;
      } else {
        if (path.index > depth.receiveDepth)
          depth.receiveDepth = path.index;
      }
    }

    depth.changeDepth++;
    depth.receiveDepth++;

    return callback(null, depth);
  });
};

/**
 * Sync address depths based on a transaction's outputs.
 * This is used for deriving new addresses when
 * a confirmed transaction is seen.
 * @param {TX} tx
 * @returns {Boolean} Whether new addresses were allocated.
 */

Wallet.prototype.syncOutputDepth = function syncOutputDepth(tx, callback) {
  var self = this;
  var result = false;

  this.getOutputDepth(tx, function(err, depth) {
    if (err)
      return callback(err);

    self.setChangeDepth(depth.changeDepth + 1, function(err, res) {
      if (err)
        return callback(err);

      if (res)
        result = true;

      self.setReceiveDepth(depth.receiveDepth + 1, function(err, res) {
        if (err)
          return callback(err);

        if (res)
          result = true;

        return callback(null, result);
      });
    });
  });
};

/**
 * Get a redeem script or witness script by hash.
 * @param {Hash} hash - Can be a ripemd160 or a sha256.
 * @returns {Script}
 */

Wallet.prototype.getRedeem = function getRedeem(hash, callback) {
  var self = this;
  var address;

  if (typeof hash === 'string')
    hash = new Buffer(hash, 'hex');

  this.getPath(hash.toString('hex'), function(err, path) {
    if (err)
      return callback(err);

    if (!path)
      return callback();

    address = self.deriveAddress(path);

    if (address.program && hash.length === 20) {
      if (utils.equal(hash, address.programHash))
        return callback(null, address.program);
    }

    return callback(null, address.script);
  });
};

/**
 * Zap stale TXs from wallet (accesses db).
 * @param {Number} now - Current time (unix time).
 * @param {Number} age - Age threshold (unix time, default=72 hours).
 * @param {Function} callback - Returns [Error].
 */

Wallet.prototype.zap = function zap(now, age, callback) {
  return this.db.zap(this.id, now, age, callback);
};

/**
 * Scan for addresses.
 * @param {Function} getByAddress - Must be a callback which accepts
 * a callback and returns transactions by address.
 * @param {Function} callback - Returns [Boolean, TX[]].
 */

Wallet.prototype.scan = function scan(getByAddress, callback) {
  var self = this;
  var result = false;

  return this._scan(getByAddress, function(err, depth, txs) {
    if (err)
      return callback(err);

    self.setChangeDepth(depth.changeDepth + 1, function(err, res) {
      if (err)
        return callback(err);

      if (res)
        result = true;

      self.setReceiveDepth(depth.receiveDepth + 1, function(err, res) {
        if (err)
          return callback(err);

        if (res)
          result = true;

        return callback(null, result, txs);
      });
    });
  });
};

Wallet.prototype._scan = function _scan(getByAddress, callback) {
  var self = this;
  var depth = { changeDepth: 0, receiveDepth: 0 };
  var all = [];

  assert(this.initialized);

  (function chainCheck(change) {
    var addressIndex = 0;
    var total = 0;
    var gap = 0;

    (function next() {
      var address = self.deriveAddress(change, addressIndex++);

      getByAddress(address.getAddress(), function(err, txs) {
        var result;

        if (err)
          return callback(err);

        if (txs) {
          if (typeof txs === 'boolean')
            result = txs;
          else if (typeof txs === 'number')
            result = txs > 0;
          else if (Array.isArray(txs))
            result = txs.length > 0;
          else
            result = false;

          if (Array.isArray(txs) && (txs[0] instanceof bcoin.tx))
            all = all.concat(txs);
        }

        if (result) {
          total++;
          gap = 0;
          return next();
        }

        if (++gap < 20)
          return next();

        assert(depth.receiveDepth === 0 || change === true);

        if (change === false)
          depth.receiveDepth = addressIndex - gap;
        else
          depth.changeDepth = addressIndex - gap;

        if (change === false)
          return chainCheck(true);

        return callback(null, depth, all);
      });
    })();
  })(false);
};

/**
 * Build input scripts templates for a transaction (does not
 * sign, only creates signature slots). Only builds scripts
 * for inputs that are redeemable by this wallet.
 * @param {MTX} tx
 * @param {Number?} index - Index of input. If not present,
 * it will attempt to sign all redeemable inputs.
 * @returns {Number} Total number of scripts built.
 */

Wallet.prototype.scriptInputs = function scriptInputs(tx, callback) {
  var self = this;
  var total = 0;
  var i;

  this.deriveInputs(tx, function(err, addresses) {
    if (err)
      return callback(err);

    for (i = 0; i < addresses.length; i++)
      total += addresses[i].scriptInputs(tx);

    return callback(null, total);
  });
};

/**
 * Build input scripts and sign inputs for a transaction. Only attempts
 * to build/sign inputs that are redeemable by this wallet.
 * @param {MTX} tx
 * @param {Number?} index - Index of input. If not present,
 * it will attempt to build and sign all redeemable inputs.
 * @param {SighashType?} type
 * @returns {Number} Total number of inputs scripts built and signed.
 */

Wallet.prototype.sign = function sign(tx, options, callback) {
  var self = this;
  var total = 0;
  var i, address, key, master;

  if (Array.isArray(tx)) {
    utils.forEachSerial(tx, function(tx, next) {
      self.sign(tx, options, next);
    }, callback);
    return;
  }

  if (typeof options === 'function') {
    callback = options;
    options = {};
  }

  if (typeof options === 'string' || Buffer.isBuffer(options))
    options = { passphrase: options };

  this.deriveInputs(tx, function(err, addresses) {
    if (err)
      return callback(err);

    try {
      master = self.master.decrypt(options.passphrase);
    } catch (e) {
      return callback(null, 0);
    }

    master = master.deriveAccount44(self.accountIndex);

    for (i = 0; i < addresses.length; i++) {
      address = addresses[i];
      key = master.derive(address.change).derive(address.index);
      assert(utils.equal(key.getPublicKey(), address.key));
      total += address.sign(tx, key, options.index, options.type);
    }

    return callback(null, total);
  });
};

/**
 * Add a transaction to the wallets TX history (accesses db).
 * @param {TX} tx
 * @param {Function} callback
 */

Wallet.prototype.addTX = function addTX(tx, callback) {
  return this.db.addTX(tx, callback);
};

/**
 * Get all transactions in transaction history (accesses db).
 * @param {Function} callback - Returns [Error, {@link TX}[]].
 */

Wallet.prototype.getHistory = function getHistory(callback) {
  return this.db.getHistory(this.id, callback);
};

/**
 * Get all available coins (accesses db).
 * @param {Function} callback - Returns [Error, {@link Coin}[]].
 */

Wallet.prototype.getCoins = function getCoins(callback) {
  return this.db.getCoins(this.id, callback);
};

/**
 * Get all pending/unconfirmed transactions (accesses db).
 * @param {Function} callback - Returns [Error, {@link TX}[]].
 */

Wallet.prototype.getUnconfirmed = function getUnconfirmed(callback) {
  return this.db.getUnconfirmed(this.id, callback);
};

/**
 * Get wallet balance (accesses db).
 * @param {Function} callback - Returns [Error, {@link Balance}].
 */

Wallet.prototype.getBalance = function getBalance(callback) {
  return this.db.getBalance(this.id, callback);
};

/**
 * Get last timestamp and height this wallet was active
 * at (accesses db). Useful for resetting the chain
 * to a certain height when in SPV mode.
 * @param {Function} callback - Returns [Error, Number(ts), Number(height)].
 */

Wallet.prototype.getLastTime = function getLastTime(callback) {
  return this.db.getLastTime(this.id, callback);
};

/**
 * Get the last N transactions (accesses db).
 * @param {Number} limit
 * @param {Function} callback - Returns [Error, {@link TX}[]].
 */

Wallet.prototype.getLast = function getLast(limit, callback) {
  return this.db.getLast(this.id, limit, callback);
};

/**
 * Get a range of transactions between two timestamps (accesses db).
 * @param {Object} options
 * @param {Number} options.start
 * @param {Number} options.end
 * @param {Function} callback - Returns [Error, {@link TX}[]].
 */

Wallet.prototype.getTimeRange = function getTimeRange(options, callback) {
  return this.db.getTimeRange(this.id, options, callback);
};

/**
 * Get public key for current receiving address.
 * @param {String?} enc - `"hex"` or `null`.
 * @returns {Buffer}
 */

Wallet.prototype.getPublicKey = function getPublicKey(enc) {
  return this.receiveAddress.getPublicKey(enc);
};

/**
 * Get redeem script for current receiving address.
 * @returns {Script}
 */

Wallet.prototype.getScript = function getScript() {
  return this.receiveAddress.getScript();
};

/**
 * Get scripthash for current receiving address.
 * @param {String?} enc - `"hex"` or `null`.
 * @returns {Buffer}
 */

Wallet.prototype.getScriptHash = function getScriptHash(enc) {
  return this.receiveAddress.getScriptHash(enc);
};

/**
 * Get ripemd160 scripthash for current receiving address.
 * @param {String?} enc - `"hex"` or `null`.
 * @returns {Buffer}
 */

Wallet.prototype.getScriptHash160 = function getScriptHash160(enc) {
  return this.receiveAddress.getScriptHash160(enc);
};

/**
 * Get sha256 scripthash for current receiving address.
 * @param {String?} enc - `"hex"` or `null`.
 * @returns {Buffer}
 */

Wallet.prototype.getScriptHash256 = function getScriptHash256(enc) {
  return this.receiveAddress.getScriptHash256(enc);
};

/**
 * Get scripthash address for current receiving address.
 * @returns {Base58Address}
 */

Wallet.prototype.getScriptAddress = function getScriptAddress() {
  return this.receiveAddress.getScriptAddress();
};

/**
 * Get witness program for current receiving address.
 * @returns {Buffer}
 */

Wallet.prototype.getProgram = function getProgram() {
  return this.receiveAddress.getProgram();
};

/**
 * Get current receiving address' ripemd160 program
 * scripthash (for witness programs behind a scripthash).
 * @param {String?} enc - `"hex"` or `null`.
 * @returns {Buffer}
 */

Wallet.prototype.getProgramHash = function getProgramHash(enc) {
  return this.receiveAddress.getProgramHash(enc);
};

/**
 * Get current receiving address'
 * scripthash address for witness program.
 * @returns {Base58Address}
 */

Wallet.prototype.getProgramAddress = function getProgramAddress() {
  return this.receiveAddress.getProgramAddress();
};

/**
 * Get public key hash for current receiving address.
 * @param {String?} enc - `"hex"` or `null`.
 * @returns {Buffer}
 */

Wallet.prototype.getKeyHash = function getKeyHash(enc) {
  return this.receiveAddress.getKeyHash(enc);
};

/**
 * Get pubkeyhash address for current receiving address.
 * @returns {Base58Address}
 */

Wallet.prototype.getKeyAddress = function getKeyAddress() {
  return this.receiveAddress.getKeyAddress();
};

/**
 * Get hash for current receiving address.
 * @param {String?} enc - `"hex"` or `null`.
 * @returns {Buffer}
 */

Wallet.prototype.getHash = function getHash(enc) {
  return this.receiveAddress.getHash(enc);
};

/**
 * Get base58 address for current receiving address.
 * @returns {Base58Address}
 */

Wallet.prototype.getAddress = function getAddress() {
  return this.receiveAddress.getAddress();
};

Wallet.prototype.__defineGetter__('publicKey', function() {
  return this.getPublicKey();
});

Wallet.prototype.__defineGetter__('script', function() {
  return this.getScript();
});

Wallet.prototype.__defineGetter__('scriptHash', function() {
  return this.getScriptHash();
});

Wallet.prototype.__defineGetter__('scriptHash160', function() {
  return this.getScriptHash160();
});

Wallet.prototype.__defineGetter__('scriptHash256', function() {
  return this.getScriptHash256();
});

Wallet.prototype.__defineGetter__('scriptAddress', function() {
  return this.getScriptAddress();
});

Wallet.prototype.__defineGetter__('program', function() {
  return this.getProgram();
});

Wallet.prototype.__defineGetter__('programHash', function() {
  return this.getProgramHash();
});

Wallet.prototype.__defineGetter__('programAddress', function() {
  return this.getProgramAddress();
});

Wallet.prototype.__defineGetter__('keyHash', function() {
  return this.getKeyHash();
});

Wallet.prototype.__defineGetter__('keyAddress', function() {
  return this.getKeyAddress();
});

Wallet.prototype.__defineGetter__('hash', function() {
  return this.getHash();
});

Wallet.prototype.__defineGetter__('address', function() {
  return this.getAddress();
});

/**
 * Convert the wallet to a more inspection-friendly object.
 * @returns {Object}
 */

Wallet.prototype.inspect = function inspect() {
  return {
    id: this.id,
    network: this.network.type,
    initialized: this.initialized,
    type: this.type,
    m: this.m,
    n: this.n,
    keyAddress: this.initialized
      ? this.keyAddress
      : null,
    scriptAddress: this.initialized
      ? this.scriptAddress
      : null,
    programAddress: this.initialized
      ? this.programAddress
      : null,
    witness: this.witness,
    accountIndex: this.accountIndex,
    receiveDepth: this.receiveDepth,
    changeDepth: this.changeDepth,
    master: this.master.toJSON(),
    accountKey: this.accountKey.xpubkey,
    keys: this.keys.map(function(key) {
      return key.xpubkey;
    })
  };
};

/**
 * Convert the wallet to an object suitable for
 * serialization. Will automatically encrypt the
 * master key based on the `passphrase` option.
 * @returns {Object}
 */

Wallet.prototype.toJSON = function toJSON() {
  return {
    v: 3,
    name: 'wallet',
    network: this.network.type,
    id: this.id,
    initialized: this.initialized,
    type: this.type,
    m: this.m,
    n: this.n,
    witness: this.witness,
    accountIndex: this.accountIndex,
    receiveDepth: this.receiveDepth,
    changeDepth: this.changeDepth,
    master: this.master.toJSON(),
    accountKey: this.accountKey.xpubkey,
    keys: this.keys.map(function(key) {
      return key.xpubkey;
    })
  };
};

/**
 * Handle a deserialized JSON wallet object.
 * @returns {Object} A "naked" wallet (a
 * plain javascript object which is suitable
 * for passing to the Wallet constructor).
 * @param {Object} json
 * @param {String?} passphrase
 * @returns {Object}
 * @throws Error on bad decrypt
 */

Wallet.parseJSON = function parseJSON(json) {
  assert.equal(json.v, 3);
  assert.equal(json.name, 'wallet');

  return {
    network: json.network,
    id: json.id,
    initialized: json.initialized,
    type: json.type,
    m: json.m,
    n: json.n,
    witness: json.witness,
    accountIndex: json.accountIndex,
    receiveDepth: json.receiveDepth,
    changeDepth: json.changeDepth,
    master: MasterKey.fromJSON(json.master),
    accountKey: bcoin.hd.fromBase58(json.accountKey),
    keys: json.keys.map(function(key) {
      return bcoin.hd.fromBase58(key);
    })
  };
};

/**
 * Serialize the wallet.
 * @returns {Buffer}
 */

Wallet.prototype.toRaw = function toRaw(writer) {
  var p = new BufferWriter(writer);
  var i;

  p.writeU32(this.network.magic);
  p.writeVarString(this.id, 'utf8');
  p.writeU8(this.initialized ? 1 : 0);
  p.writeU8(this.type === 'pubkeyhash' ? 0 : 1);
  p.writeU8(this.m);
  p.writeU8(this.n);
  p.writeU8(this.witness ? 1 : 0);
  p.writeU32(this.accountIndex);
  p.writeU32(this.receiveDepth);
  p.writeU32(this.changeDepth);
  p.writeVarBytes(this.master.toRaw());
  p.writeBytes(this.accountKey.toRaw());
  p.writeU8(this.keys.length);

  for (i = 0; i < this.keys.length; i++)
    p.writeBytes(this.keys[i].toRaw());

  if (!writer)
    p = p.render();

  return p;
};

/**
 * Parse a serialized wallet. Return a "naked"
 * wallet object, suitable for passing into
 * the wallet constructor.
 * @param {Buffer} data
 * @returns {Object}
 */

Wallet.parseRaw = function parseRaw(data) {
  var p = new BufferReader(data);
  var network = bcoin.network.fromMagic(p.readU32());
  var id = p.readVarString('utf8');
  var initialized = p.readU8() === 1;
  var type = p.readU8() === 0 ? 'pubkeyhash' : 'multisig';
  var m = p.readU8();
  var n = p.readU8();
  var witness = p.readU8() === 1;
  var accountIndex = p.readU32();
  var receiveDepth = p.readU32();
  var changeDepth = p.readU32();
  var master = MasterKey.fromRaw(p.readVarBytes());
  var accountKey = bcoin.hd.PublicKey.fromRaw(p.readBytes(82));
  var keys = new Array(p.readU8());
  var i;

  for (i = 0; i < keys.length; i++)
    keys[i] = bcoin.hd.PublicKey.fromRaw(p.readBytes(82));

  return {
    network: network.type,
    id: id,
    initialized: initialized,
    type: type,
    m: m,
    n: n,
    witness: witness,
    accountIndex: accountIndex,
    receiveDepth: receiveDepth,
    changeDepth: changeDepth,
    master: master,
    accountKey: accountKey,
    keys: keys
  };
};

/**
 * Instantiate a wallet from serialized data.
 * @param {Buffer} data
 * @returns {Wallet}
 */

Wallet.fromRaw = function fromRaw(data) {
  return new Wallet(Wallet.parseRaw(data));
};

/**
 * Instantiate a Wallet from a
 * jsonified wallet object.
 * @param {Object} json - The jsonified wallet object.
 * @returns {Wallet}
 */

Wallet.fromJSON = function fromJSON(json) {
  return new Wallet(Wallet.parseJSON(json));
};

/**
 * Test an object to see if it is a Wallet.
 * @param {Object} obj
 * @returns {Boolean}
 */

Wallet.isWallet = function isWallet(obj) {
  return obj
    && typeof obj.receiveDepth === 'number'
    && obj.deriveAddress === 'function';
};

/*
 * Master Key
 */

function MasterKey(options) {
  if (!(this instanceof MasterKey))
    return new MasterKey(options);

  this.encrypted = !!options.encrypted;
  this.xprivkey = options.xprivkey;
  this.phrase = options.phrase;
  this.passphrase = options.passphrase;
  this.key = options.key || null;
}

MasterKey.prototype.decrypt = function decrypt(passphrase) {
  var xprivkey;

  if (this.key)
    return this.key;

  if (this.encrypted) {
    assert(passphrase, 'Passphrase is required.');
    xprivkey = utils.decrypt(this.xprivkey, passphrase);
  } else {
    xprivkey = this.xprivkey;
  }

  return bcoin.hd.PrivateKey.fromRaw(xprivkey);
};

MasterKey.prototype.encrypt = function encrypt(passphrase) {
  if (this.encrypted)
    return;

  assert(passphrase, 'Passphrase is required.');

  this.key = null;
  this.encrypted = true;
  this.xprivkey = utils.encrypt(this.xprivkey, passphrase);

  if (this.phrase) {
    this.phrase = utils.encrypt(this.phrase, passphrase);
    this.passphrase = utils.encrypt(this.passphrase, passphrase);
  }
};

MasterKey.prototype.toRaw = function toRaw(writer) {
  var p = new BufferWriter(writer);

  p.writeU8(this.encrypted ? 1 : 0);

  if (this.phrase) {
    p.writeU8(1);
    p.writeVarBytes(this.phrase);
    p.writeVarBytes(this.passphrase);
  } else {
    p.writeU8(0);
  }

  p.writeBytes(this.xprivkey);

  if (!writer)
    p = p.render();

  return p;
};

MasterKey.fromRaw = function fromRaw(raw) {
  var data = {};
  var p = new BufferReader(raw);

  data.encrypted = p.readU8() === 1;

  if (p.readU8() === 1) {
    data.phrase = p.readVarBytes();
    data.passphrase = p.readVarBytes();
  }

  data.xprivkey = p.readBytes(82);

  if (!data.encrypted)
    data.key = bcoin.hd.PrivateKey.fromRaw(data.xprivkey);

  return new MasterKey(data);
};

MasterKey.fromKey = function fromKey(key) {
  var data = {};

  data.encrypted = false;

  if (key.mnemonic) {
    data.phrase = new Buffer(key.mnemonic.phrase, 'utf8');
    data.passphrase = new Buffer(key.mnemonic.passphrase, 'utf8');
  }

  data.xprivkey = key.toRaw();

  data.key = key;

  return new MasterKey(data);
};

MasterKey.prototype.toJSON = function toJSON() {
  var json = {};

  json.encrypted = this.encrypted;

  if (this.encrypted) {
    if (this.phrase) {
      json.phrase = this.phrase.toString('hex');
      json.passphrase = this.passphrase.toString('hex');
    }
    json.xprivkey = this.xprivkey.toString('hex');
  } else {
    if (this.phrase) {
      json.phrase = this.phrase.toString('utf8');
      json.passphrase = this.passphrase.toString('utf8');
    }
    json.xprivkey = utils.toBase58(this.xprivkey);
  }

  return json;
};

MasterKey.fromJSON = function fromJSON(json) {
  var data = {};

  data.encrypted = json.encrypted;

  if (json.encrypted) {
    if (json.phrase) {
      data.phrase = new Buffer(json.phrase, 'hex');
      data.passphrase = new Buffer(json.passphrase, 'hex');
    }
    data.xprivkey = new Buffer(json.xprivkey, 'hex');
  } else {
    if (json.phrase) {
      data.phrase = new Buffer(json.phrase, 'utf8');
      data.passphrase = new Buffer(json.passphrase, 'utf8');
    }
    data.xprivkey = utils.fromBase58(json.xprivkey);
  }

  if (!data.encrypted)
    data.key = bcoin.hd.PrivateKey.fromRaw(data.xprivkey);

  return new MasterKey(data);
};

MasterKey.isMasterKey = function isMasterKey(obj) {
  return obj
    && typeof obj.encrypted === 'boolean'
    && typeof obj.decrypt === 'function';
};

/*
 * Expose
 */

module.exports = Wallet;