Wallet/js/models/Identity.js

'use strict';
var preconditions = require('preconditions').singleton();

var TxProposals = require('./TxProposals');
var PublicKeyRing = require('./PublicKeyRing');
var PrivateKey = require('./PrivateKey');
var Wallet = require('./Wallet');
var _ = require('underscore');
var log = require('../log');
var PluginManager = require('./PluginManager');
var Async = module.exports.Async = require('./Async');
var Insight = module.exports.Insight = require('./Insight');
var preconditions = require('preconditions').singleton();
var Storage = module.exports.Storage = require('./Storage');

/**
 * @desc
 * Identity - stores the state for a wallet in creation
 *
 * @param {Object} config - configuration for this wallet
 *
 * @TODO: Don't pass a class for these three components
 *        -- send a factory or instance, the 'new' call considered harmful for refactoring
 *        -- arguable, since all of them is called with an object as argument.
 *        -- Still, could it be hard to refactor? (for example, what if we want to fail hard if a network call gets interrupted?)
 * @param {Storage} config.Storage - the class to instantiate to store the wallet (StorageLocalEncrypted by default)
 * @param {Object} config.storage - the configuration to be sent to the Storage constructor
 * @param {Network} config.Network - the class to instantiate to make network requests to copayers (the Async module by default)
 * @param {Object} config.network - the configurations to be sent to the Network and Blockchain constructors
 * @param {Blockchain} config.Blockchain - the class to instantiate to get information about the blockchain (Insight by default)
 * @TODO: Investigate what parameters go inside this object
 * @param {Object} config.wallet - default configuration for the wallet
 * @TODO: put `version` inside of the config object
 * @param {string} version - the version of copay for which this wallet was generated (for example, 0.4.7)
 * @constructor
 */

function Identity(config, version, pluginManager) {
  var self = this;
  preconditions.checkArgument(config);
  preconditions.checkArgument(config.network);

  this.Storage = config.Storage || Storage;
  this.Network = config.Network || Async;
  this.Blockchain = config.Blockchain || Insight;

  var storageOpts = {};

  if (pluginManager) {
    storageOpts = {
      storage: pluginManager.get('STORAGE')
    };
  }

  this.storage = new this.Storage(storageOpts);

  this.networks = {
    'livenet': new this.Network(config.network.livenet),
    'testnet': new this.Network(config.network.testnet),
  };
  this.blockchains = {
    'livenet': new this.Blockchain(config.network.livenet),
    'testnet': new this.Blockchain(config.network.testnet),
  };

  this.walletDefaults = config.wallet || {};
  this.version = version;
};


/**
 * @desc obtain network name from serialized wallet
 * @param {Object} wallet object
 * @return {string} network name
 */
Identity.prototype.obtainNetworkName = function(obj) {
  return obj.networkName ||
    obj.opts.networkName ||
    obj.publicKeyRing.networkName ||
    obj.privateKey.networkName;
};

/**
 * @desc Deserialize an object to a Wallet
 * @param {Object} wallet object
 * @param {string[]} skipFields - fields to skip when importing
 * @return {Wallet}
 */
Identity.prototype.fromObj = function(inObj, skipFields) {
  var networkName = this.obtainNetworkName(inObj);
  preconditions.checkState(networkName);
  preconditions.checkArgument(inObj);

  var obj = JSON.parse(JSON.stringify(inObj));

  // not stored options
  obj.opts = obj.opts || {};
  obj.opts.reconnectDelay = this.walletDefaults.reconnectDelay;

  skipFields = skipFields || [];
  skipFields.forEach(function(k) {
    if (obj[k]) {
      delete obj[k];
    } else
      throw new Error('unknown field:' + k);
  });

  var w = Wallet.fromObj(obj, this.storage, this.networks[networkName], this.blockchains[networkName]);
  if (!w) return false;
  this._checkVersion(w.version);
  return w;
};

/**
 * @desc Imports a wallet from an encrypted base64 object
 * @param {string} base64 - the base64 encoded object
 * @param {string} passphrase - passphrase to decrypt it
 * @param {string[]} skipFields - fields to ignore when importing
 * @return {Wallet}
 */
Identity.prototype.fromEncryptedObj = function(base64, passphrase, skipFields) {
  this.storage.setPassphrase(passphrase);
  var walletObj = this.storage.import(base64);
  if (!walletObj) return false;
  return this.fromObj(walletObj, skipFields);
};

/**
 * @TODO: import is a reserved keyword! DONT USE IT
 * @TODO: this is essentialy the same method as {@link Identity#fromEncryptedObj}!
 * @desc Imports a wallet from an encrypted base64 object
 * @param {string} base64 - the base64 encoded object
 * @param {string} passphrase - passphrase to decrypt it
 * @param {string[]} skipFields - fields to ignore when importing
 * @return {Wallet}
 */
Identity.prototype.import = function(base64, passphrase, skipFields) {
  var self = this;
  return self.fromEncryptedObj(base64, passphrase, skipFields);
};

Identity.prototype.migrateWallet = function(walletId, passphrase, cb) {
  var self = this;

  self.storage.setPassphrase(passphrase);
  self.read_Old(walletId, null, function(err, wallet) {
    if (err) return cb(err);

    wallet.store(function(err) {
      if (err) return cb(err);

      self.storage.deleteWallet_Old(walletId, function(err) {
        if (err) return cb(err);

        self.storage.removeGlobal('nameFor::' + walletId, function() {
          return cb();
        });
      });
    });
  });

};


/**
 * @desc Retrieve a wallet from storage
 * @param {string} walletId - the wallet id
 * @param {string[]} skipFields - parameters to ignore when importing
 * @param {function} callback - {err, Wallet}
 */
Identity.prototype.read = function(walletId, skipFields, cb) {
  var self = this,
    err;
  var obj = {};

  this.storage.readWallet(walletId, function(err, ret) {
    if (err) return cb(err);

    _.each(Wallet.PERSISTED_PROPERTIES, function(p) {
      obj[p] = ret[p];
    });

    if (!_.any(_.values(obj)))
      return cb(new Error('Wallet not found'));

    var w, err;
    obj.id = walletId;
    try {
      w = self.fromObj(obj, skipFields);
    } catch (e) {
      if (e && e.message && e.message.indexOf('MISSOPTS')) {
        err = new Error('Could not read: ' + walletId);
      } else {
        err = e;
      }
      w = null;
    }
    return cb(err, w);
  });
};

Identity.prototype.read_Old = function(walletId, skipFields, cb) {
  var self = this,
    err;
  var obj = {};

  this.storage.readWallet_Old(walletId, function(err, ret) {
    if (err) return cb(err);

    _.each(Wallet.PERSISTED_PROPERTIES, function(p) {
      obj[p] = ret[p];
    });

    if (!_.any(_.values(obj)))
      return cb(new Error('Wallet not found'));

    var w, err;
    obj.id = walletId;
    try {
      w = self.fromObj(obj, skipFields);
    } catch (e) {
      if (e && e.message && e.message.indexOf('MISSOPTS')) {
        err = new Error('Could not read: ' + walletId);
      } else {
        err = e;
      }
      w = null;
    }
    return cb(err, w);
  });
};

/**
 * @desc This method instantiates a wallet. Usefull for stubbing.
 *
 * @param {opts} opts, ready for new Wallet(opts)
 *
 */


Identity.prototype._getWallet = function(opts) {
  return new Wallet(opts);
};

/**
 * @desc This method prepares options for a new Wallet
 *
 * @param {Object} opts
 * @param {string} opts.id
 * @param {PrivateKey=} opts.privateKey
 * @param {string=} opts.privateKeyHex
 * @param {number} opts.requiredCopayers
 * @param {number} opts.totalCopayers
 * @param {PublicKeyRing=} opts.publicKeyRing
 * @param {string} opts.nickname
 * @param {string} opts.passphrase
 * @TODO: Figure out what is this parameter
 * @param {?} opts.spendUnconfirmed this.walletDefaults.spendUnconfirmed ??
 * @TODO: Figure out in what unit is this reconnect delay.
 * @param {number} opts.reconnectDelay milliseconds?
 * @param {number=} opts.version
 * @param {callback} opts.version
 * @return {Wallet}
 */
Identity.prototype.create = function(opts, cb) {
  preconditions.checkArgument(cb);

  opts = opts || {};
  opts.networkName = opts.networkName || 'testnet';

  log.debug('### CREATING NEW WALLET.' + (opts.id ? ' USING ID: ' + opts.id : ' NEW ID') + (opts.privateKey ? ' USING PrivateKey: ' + opts.privateKey.getId() : ' NEW PrivateKey'));

  var privOpts = {
    networkName: opts.networkName,
  };

  if (opts.privateKeyHex && opts.privateKeyHex.length > 1) {
    privOpts.extendedPrivateKeyString = opts.privateKeyHex;
  }

  opts.privateKey = opts.privateKey || new PrivateKey(privOpts);

  var requiredCopayers = opts.requiredCopayers || this.walletDefaults.requiredCopayers;
  var totalCopayers = opts.totalCopayers || this.walletDefaults.totalCopayers;
  opts.lockTimeoutMin = this.walletDefaults.idleDurationMin;

  opts.publicKeyRing = opts.publicKeyRing || new PublicKeyRing({
    networkName: opts.networkName,
    requiredCopayers: requiredCopayers,
    totalCopayers: totalCopayers,
  });
  opts.publicKeyRing.addCopayer(
    opts.privateKey.deriveBIP45Branch().extendedPublicKeyString(),
    opts.nickname
  );
  log.debug('\t### PublicKeyRing Initialized');

  opts.txProposals = opts.txProposals || new TxProposals({
    networkName: opts.networkName,
  });
  log.debug('\t### TxProposals Initialized');


  opts.storage = this.storage;
  opts.network = this.networks[opts.networkName];
  opts.blockchain = this.blockchains[opts.networkName];

  opts.spendUnconfirmed = opts.spendUnconfirmed || this.walletDefaults.spendUnconfirmed;
  opts.reconnectDelay = opts.reconnectDelay || this.walletDefaults.reconnectDelay;
  opts.requiredCopayers = requiredCopayers;
  opts.totalCopayers = totalCopayers;
  opts.version = opts.version || this.version;

  this.storage.setPassphrase(opts.passphrase);
  var w = this._getWallet(opts);
  var self = this;
  w.store(function(err) {
    if (err) return cb(err);
    self.storage.setLastOpened(w.id, function(err) {
      return cb(err, w);
    });
  });
};

/**
 * @desc Checks if a version is compatible with the current version
 * @param {string} inVersion - a version, with major, minor, and revision, period-separated (x.y.z)
 * @throws {Error} if there's a major version difference
 */
Identity.prototype._checkVersion = function(inVersion) {
  var thisV = this.version.split('.');
  var thisV0 = parseInt(thisV[0]);
  var inV = inVersion.split('.');
  var inV0 = parseInt(inV[0]);

  //We only check for major version differences
  if (thisV0 < inV0) {
    throw new Error('Major difference in software versions' +
      '. Received:' + inVersion +
      '. Current version:' + this.version +
      '. Aborting.');
  }
};

/**
 * @desc Retrieve a wallet from the storage
 * @param {string} walletId - the id of the wallet
 * @param {string} passphrase - the passphrase to decode it
 * @param {function} callback (err, {Wallet})
 * @return
 */
Identity.prototype.open = function(walletId, passphrase, cb) {
  preconditions.checkArgument(cb);
  var self = this;
  self.storage.setPassphrase(passphrase);

  self.migrateWallet(walletId, passphrase, function() {
    self.read(walletId, null, function(err, w) {
      if (err) return cb(err);

      w.store(function(err) {
        self.storage.setLastOpened(walletId, function() {
          return cb(err, w);
        });
      });
    });
  });
};

Identity.prototype.getWallets = function(cb) {
  var self = this;
  this.storage.getWallets(function(wallets) {
    wallets.forEach(function(i) {
      i.show = i.name ? ((i.name + ' <' + i.id + '>')) : i.id;
    });
    self.storage.getLastOpened(function(lastId) {
      var last = _.findWhere(wallets, {
        id: lastId
      });
      if (last)
        last.lastOpened = true;
      return cb(null, wallets);
    })
  });
};

/**
 * @desc Deletes this wallet. This involves removing it from the storage instance
 * @TODO: delete is a reserved javascript keyword. NEVER USE IT.
 * @param {string} walletId
 * @TODO: Why is there a callback?
 * @callback cb
 * @return {?} the result of the callback
 */
Identity.prototype.delete = function(walletId, cb) {
  var self = this;
  self.storage.deleteWallet(walletId, function(err) {
    if (err) return cb(err);
    self.storage.setLastOpened(null, function(err) {
      return cb(err);
    });
  });
};

/**
 * @desc Pass through to {@link Wallet#secret}
 */
Identity.prototype.decodeSecret = function(secret) {
  try {
    return Wallet.decodeSecret(secret);
  } catch (e) {
    return false;
  }
};

/**
 * @callback walletCreationCallback
 * @param {?} err - an error, if any, that happened during the wallet creation
 * @param {Wallet=} wallet - the wallet created
 */

/**
 * @desc Start the network functionality.
 *
 * Start up the Network instance and try to join a wallet defined by the
 * parameter <tt>secret</tt> using the parameter <tt>nickname</tt>. Encode
 * information locally using <tt>passphrase</tt>. <tt>privateHex</tt> is the
 * private extended master key. <tt>cb</tt> has two params: error and wallet.
 *
 * @param {object} opts
 * @param {string} opts.secret - the wallet secret
 * @param {string} opts.passphrase - a passphrase to use to encrypt the wallet for persistance
 * @param {string} opts.nickname - a nickname for the current user
 * @param {string} opts.privateHex - the private extended master key
 * @param {walletCreationCallback} cb - a callback
 */
Identity.prototype.joinCreateSession = function(opts, cb) {
  preconditions.checkArgument(opts);
  preconditions.checkArgument(opts.secret);
  preconditions.checkArgument(opts.passphrase);
  preconditions.checkArgument(opts.nickname);
  preconditions.checkArgument(cb);
  var self = this;
  var decodedSecret = this.decodeSecret(opts.secret);
  if (!decodedSecret || !decodedSecret.networkName || !decodedSecret.pubKey) {
    return cb('badSecret');
  }

  var privOpts = {
    networkName: decodedSecret.networkName,
  };

  if (opts.privateHex && opts.privateHex.length > 1) {
    privOpts.extendedPrivateKeyString = opts.privateHex;
  }

  //Create our PrivateK
  var privateKey = new PrivateKey(privOpts);
  log.debug('\t### PrivateKey Initialized');
  var joinOpts = {
    copayerId: privateKey.getId(),
    privkey: privateKey.getIdPriv(),
    key: privateKey.getIdKey(),
    secretNumber: decodedSecret.secretNumber,
  };

  var joinNetwork = this.networks[decodedSecret.networkName];
  joinNetwork.cleanUp();

  // This is a hack to reconize if the connection was rejected or the peer wasn't there.
  var connectedOnce = false;
  joinNetwork.on('connected', function(sender, data) {
    connectedOnce = true;
  });

  joinNetwork.on('connect_error', function() {
    return cb('connectionError');
  });

  joinNetwork.on('serverError', function() {
    return cb('joinError');
  });

  joinNetwork.start(joinOpts, function() {

    joinNetwork.greet(decodedSecret.pubKey, joinOpts.secretNumber);
    joinNetwork.on('data', function(sender, data) {
      if (data.type === 'walletId' && data.opts) {
        if (!data.networkName || data.networkName !== decodedSecret.networkName) {
          return cb('badNetwork');
        }
        data.opts.networkName = data.networkName;

        var walletOpts = _.clone(data.opts);
        walletOpts.id = data.walletId;

        walletOpts.privateKey = privateKey;
        walletOpts.nickname = opts.nickname;
        walletOpts.passphrase = opts.passphrase;

        self.create(walletOpts, function(err, w) {

          if (w) {
            w.sendWalletReady(decodedSecret.pubKey);
          } else {
            if (!err) err = 'walletFull';
            log.info(err);
          }
          return cb(err, w);
        });
      }
    });
  });
};

module.exports = Identity;