mirror of https://github.com/BTCPrivate/copay.git
Merge pull request #1285 from eordano/beauty/PublicKeyRing
JSDoc and beautified the code fro PublicKeyRing
This commit is contained in:
Gustavo Maximiliano Cortez
commit
42df9aa409
|
|
@ -1,14 +1,30 @@
|
|||
'use strict';
|
||||
|
||||
var preconditions = require('preconditions').instance();
|
||||
var _ = require('underscore');
|
||||
var log = require('../../log');
|
||||
var bitcore = require('bitcore');
|
||||
var HK = bitcore.HierarchicalKey;
|
||||
var Address = bitcore.Address;
|
||||
var Script = bitcore.Script;
|
||||
var PrivateKey = require('./PrivateKey');
|
||||
var HDPath = require('./HDPath');
|
||||
var HDParams = require('./HDParams');
|
||||
var Address = bitcore.Address;
|
||||
var Script = bitcore.Script;
|
||||
|
||||
/**
|
||||
* @desc
|
||||
*
|
||||
* @constructor
|
||||
* @param {Object} opts
|
||||
* @param {string} opts.walletId
|
||||
* @param {string} opts.network 'livenet' to signal the bitcoin main network, all others are testnet
|
||||
* @param {number=} opts.requiredCopayers - defaults to 3
|
||||
* @param {number=} opts.totalCopayers - defaults to 5
|
||||
* @param {Object[]=} opts.indexes - an array to be deserialized using {@link HDParams#fromList}
|
||||
* (defaults to all indexes in zero)
|
||||
* @param {Object=} opts.nicknameFor - nicknames for other copayers
|
||||
* @param {boolean[]=} opts.copayersBackup - whether other copayers have backed up their wallets
|
||||
*/
|
||||
function PublicKeyRing(opts) {
|
||||
opts = opts || {};
|
||||
|
||||
|
|
@ -29,24 +45,52 @@ function PublicKeyRing(opts) {
|
|||
this.copayerIds = [];
|
||||
this.copayersBackup = opts.copayersBackup || [];
|
||||
this.addressToPath = {};
|
||||
}
|
||||
|
||||
};
|
||||
|
||||
/**
|
||||
* @desc Returns an object with only the keys needed to rebuild a PublicKeyRing
|
||||
*
|
||||
* @TODO: Figure out if this is the correct pattern
|
||||
* This is a static method and is probably used for serialization.
|
||||
*
|
||||
* @static
|
||||
* @param {Object} data
|
||||
* @param {string} data.walletId - a string to identify a wallet
|
||||
* @param {string} data.networkName - the name of the bitcoin network
|
||||
* @param {number} data.requiredCopayers - the number of required copayers
|
||||
* @param {number} data.totalCopayers - the number of copayers in the ring
|
||||
* @param {Object[]} data.indexes - an array of objects that can be turned into
|
||||
* an array of HDParams
|
||||
* @param {Object} data.nicknameFor - a registry of nicknames for other copayers
|
||||
* @param {boolean[]} data.copayersBackup - whether copayers have backed up their wallets
|
||||
* @param {string[]} data.copayersExtPubKeys - the extended public keys of copayers
|
||||
* @returns {Object} a trimmed down version of PublicKeyRing that can be used
|
||||
* as a parameter
|
||||
*/
|
||||
PublicKeyRing.trim = function(data) {
|
||||
var opts = {};
|
||||
['walletId', 'networkName', 'requiredCopayers', 'totalCopayers','indexes','nicknameFor','copayersBackup', 'copayersExtPubKeys' ].forEach(function(k){
|
||||
opts[k] = data[k];
|
||||
['walletId', 'networkName', 'requiredCopayers', 'totalCopayers',
|
||||
'indexes','nicknameFor','copayersBackup', 'copayersExtPubKeys'
|
||||
].forEach(function(k){
|
||||
opts[k] = data[k];
|
||||
});
|
||||
|
||||
return opts;
|
||||
};
|
||||
|
||||
/**
|
||||
* @desc Deserializes a PublicKeyRing from a plain object
|
||||
*
|
||||
* If the <tt>data</tt> parameter is an instance of PublicKeyRing already,
|
||||
* it will fail, throwing an assertion error.
|
||||
*
|
||||
* @static
|
||||
* @param {object} data - a serialized version of PublicKeyRing {@see PublicKeyRing#trim}
|
||||
* @return {PublicKeyRing} - the deserialized object
|
||||
*/
|
||||
PublicKeyRing.fromObj = function(data) {
|
||||
preconditions.checkArgument(!(data instanceof PublicKeyRing), 'bad data format: Did you use .toObj()?');
|
||||
|
||||
|
||||
var opts = PublicKeyRing.trim(data);
|
||||
|
||||
|
||||
// Support old indexes schema
|
||||
if (!Array.isArray(opts.indexes)) {
|
||||
opts.indexes = HDParams.update(opts.indexes, opts.totalCopayers);
|
||||
|
|
@ -61,6 +105,12 @@ PublicKeyRing.fromObj = function(data) {
|
|||
return ret;
|
||||
};
|
||||
|
||||
/**
|
||||
* @desc Serialize this object to a plain object with all the data needed to
|
||||
* rebuild it
|
||||
*
|
||||
* @return {Object} a serialized version of a PublicKeyRing
|
||||
*/
|
||||
PublicKeyRing.prototype.toObj = function() {
|
||||
return {
|
||||
walletId: this.walletId,
|
||||
|
|
@ -73,91 +123,175 @@ PublicKeyRing.prototype.toObj = function() {
|
|||
copayersExtPubKeys: this.copayersHK.map(function(b) {
|
||||
return b.extendedPublicKeyString();
|
||||
}),
|
||||
nicknameFor: this.nicknameFor,
|
||||
nicknameFor: this.nicknameFor
|
||||
};
|
||||
};
|
||||
|
||||
PublicKeyRing.prototype.getCopayerId = function(i) {
|
||||
preconditions.checkArgument(typeof i !== 'undefined');
|
||||
return this.copayerIds[i];
|
||||
/**
|
||||
* @desc
|
||||
* Retrieve a copayer's public key as a hexadecimal encoded string
|
||||
*
|
||||
* @param {number} copayerId - the copayer id
|
||||
* @returns {string} the extended public key of the i-th copayer
|
||||
*/
|
||||
PublicKeyRing.prototype.getCopayerId = function(copayerId) {
|
||||
preconditions.checkArgument(!_.isUndefined(copayerId))
|
||||
preconditions.checkArgument(_.isNumber(copayerId));
|
||||
|
||||
return this.copayerIds[copayerId];
|
||||
};
|
||||
|
||||
/**
|
||||
* @desc
|
||||
* Get the amount of registered copayers in this PubKeyRing
|
||||
*
|
||||
* @returns {number} amount of copayers present
|
||||
*/
|
||||
PublicKeyRing.prototype.registeredCopayers = function() {
|
||||
return this.copayersHK.length;
|
||||
};
|
||||
|
||||
/**
|
||||
* @desc
|
||||
* Returns true if all the needed copayers have joined the public key ring
|
||||
*
|
||||
* @returns {boolean}
|
||||
*/
|
||||
PublicKeyRing.prototype.isComplete = function() {
|
||||
return this.remainingCopayers() == 0;
|
||||
};
|
||||
|
||||
/**
|
||||
* @desc
|
||||
* Returns the number of copayers yet to join to make the public key ring complete
|
||||
*
|
||||
* @returns {number}
|
||||
*/
|
||||
PublicKeyRing.prototype.remainingCopayers = function() {
|
||||
return this.totalCopayers - this.registeredCopayers();
|
||||
};
|
||||
|
||||
/**
|
||||
* @desc
|
||||
* Returns an array of copayer's public keys
|
||||
*
|
||||
* @returns {string[]} a list of hexadecimal strings with the public keys for
|
||||
* the copayers in this ring
|
||||
*/
|
||||
PublicKeyRing.prototype.getAllCopayerIds = function() {
|
||||
return this.copayerIds;
|
||||
};
|
||||
|
||||
PublicKeyRing.prototype.myCopayerId = function(i) {
|
||||
/**
|
||||
* @desc
|
||||
* Gets the current user's copayerId
|
||||
*
|
||||
* @returns {string} the extended public key hexadecimal-encoded
|
||||
*/
|
||||
PublicKeyRing.prototype.myCopayerId = function() {
|
||||
return this.getCopayerId(0);
|
||||
};
|
||||
|
||||
/**
|
||||
* @desc Throws an error if the public key ring isn't complete
|
||||
*/
|
||||
PublicKeyRing.prototype._checkKeys = function() {
|
||||
|
||||
if (!this.isComplete())
|
||||
throw new Error('dont have required keys yet');
|
||||
if (!this.isComplete()) throw new Error('dont have required keys yet');
|
||||
};
|
||||
|
||||
/**
|
||||
* @desc
|
||||
* Updates the internal register of the public hex string for a copayer, based
|
||||
* on the value of the hierarchical key stored in copayersHK
|
||||
*
|
||||
* @private
|
||||
* @param {number} index - the index of the copayer to update
|
||||
*/
|
||||
PublicKeyRing.prototype._updateBip = function(index) {
|
||||
var hk = this.copayersHK[index].derive(HDPath.IdBranch);
|
||||
this.copayerIds[index] = hk.eckey.public.toString('hex');
|
||||
};
|
||||
|
||||
/**
|
||||
* @desc
|
||||
* Sets a nickname for one of the copayers
|
||||
*
|
||||
* @private
|
||||
* @param {number} index - the index of the copayer to update
|
||||
* @param {string} nickname - the new nickname for that copayer
|
||||
*/
|
||||
PublicKeyRing.prototype._setNicknameForIndex = function(index, nickname) {
|
||||
this.nicknameFor[this.copayerIds[index]] = nickname;
|
||||
};
|
||||
|
||||
/**
|
||||
* @desc
|
||||
* Fetch the name of a copayer
|
||||
*
|
||||
* @param {number} index - the index of the copayer
|
||||
* @return {string} the nickname of the index-th copayer
|
||||
*/
|
||||
PublicKeyRing.prototype.nicknameForIndex = function(index) {
|
||||
return this.nicknameFor[this.copayerIds[index]];
|
||||
};
|
||||
|
||||
/**
|
||||
* @desc
|
||||
* Fetch the name of a copayer using its public key
|
||||
*
|
||||
* @param {string} copayerId - the public key ring of a copayer, hex encoded
|
||||
* @return {string} the nickname of the copayer with such pubkey
|
||||
*/
|
||||
PublicKeyRing.prototype.nicknameForCopayer = function(copayerId) {
|
||||
return this.nicknameFor[copayerId] || 'NN';
|
||||
};
|
||||
|
||||
PublicKeyRing.prototype.addCopayer = function(newEpk, nickname) {
|
||||
preconditions.checkArgument(newEpk);
|
||||
/**
|
||||
* @desc
|
||||
* Add a copayer into the public key ring.
|
||||
*
|
||||
* @param {string} newHexaExtendedPublicKey - an hex encoded string with the copayer's pubkey
|
||||
* @param {string} nickname - a nickname for this copayer
|
||||
* @return {string} the newHexaExtendedPublicKey parameter
|
||||
*/
|
||||
PublicKeyRing.prototype.addCopayer = function(newHexaExtendedPublicKey, nickname) {
|
||||
preconditions.checkArgument(newHexaExtendedPublicKey && _.isString(newHexaExtendedPublicKey));
|
||||
preconditions.checkArgument(!this.isComplete());
|
||||
preconditions.checkArgument(!nickname || _.isString(nickname));
|
||||
preconditions.checkArgument(!_.any(this.copayersHK,
|
||||
function(copayer) { return copayer.extendedPublicKeyString === newHexaExtendedPublicKey; }
|
||||
));
|
||||
|
||||
if (this.isComplete())
|
||||
throw new Error('PKR already has all required key:' + this.totalCopayers);
|
||||
var newCopayerIndex = this.copayersHK.length;
|
||||
var hierarchicalKey = new HK(newHexaExtendedPublicKey);
|
||||
|
||||
this.copayersHK.forEach(function(b) {
|
||||
if (b.extendedPublicKeyString() === newEpk)
|
||||
throw new Error('PKR already has that key');
|
||||
});
|
||||
this.copayersHK.push(hierarchicalKey);
|
||||
this._updateBip(newCopayerIndex);
|
||||
|
||||
var i = this.copayersHK.length;
|
||||
var bip = new HK(newEpk);
|
||||
this.copayersHK.push(bip);
|
||||
this._updateBip(i);
|
||||
if (nickname) {
|
||||
this._setNicknameForIndex(i, nickname);
|
||||
this._setNicknameForIndex(newCopayerIndex, nickname);
|
||||
}
|
||||
return newEpk;
|
||||
return newHexaExtendedPublicKey;
|
||||
};
|
||||
|
||||
/**
|
||||
* @desc
|
||||
* Get all the public keys for the copayers in this ring, for a given branch of Copay
|
||||
*
|
||||
* @param {number} index - the index for the shared address
|
||||
* @param {boolean} isChange - whether to derive a change address o receive address
|
||||
* @param {number} copayerIndex - the index of the copayer that requested the derivation
|
||||
* @return {Buffer[]} an array of derived public keys in hexa format
|
||||
*/
|
||||
PublicKeyRing.prototype.getPubKeys = function(index, isChange, copayerIndex) {
|
||||
this._checkKeys();
|
||||
|
||||
var path = HDPath.Branch(index, isChange, copayerIndex);
|
||||
var pubKeys = this.publicKeysCache[path];
|
||||
if (!pubKeys) {
|
||||
pubKeys = [];
|
||||
var l = this.copayersHK.length;
|
||||
for (var i = 0; i < l; i++) {
|
||||
var hk = this.copayersHK[i].derive(path);
|
||||
pubKeys[i] = hk.eckey.public;
|
||||
}
|
||||
pubKeys = _.map(this.copayersHK, function(hdKey) {
|
||||
return hdKey.derive(path).eckey.public;
|
||||
});
|
||||
this.publicKeysCache[path] = pubKeys.map(function(pk) {
|
||||
return pk.toString('hex');
|
||||
});
|
||||
|
|
@ -166,19 +300,39 @@ PublicKeyRing.prototype.getPubKeys = function(index, isChange, copayerIndex) {
|
|||
return new Buffer(s, 'hex');
|
||||
});
|
||||
}
|
||||
|
||||
|
||||
return pubKeys;
|
||||
};
|
||||
|
||||
// TODO this could be cached
|
||||
/**
|
||||
* @desc
|
||||
* Generate a new Script for a copay address generated by index, isChange, and copayerIndex
|
||||
*
|
||||
* @TODO this could be cached
|
||||
*
|
||||
* @param {number} index - the index for the shared address
|
||||
* @param {boolean} isChange - whether to derive a change address o receive address
|
||||
* @param {number} copayerIndex - the index of the copayer that requested the derivation
|
||||
* @returns {bitcore.Script}
|
||||
*/
|
||||
PublicKeyRing.prototype.getRedeemScript = function(index, isChange, copayerIndex) {
|
||||
var pubKeys = this.getPubKeys(index, isChange, copayerIndex);
|
||||
var script = Script.createMultisig(this.requiredCopayers, pubKeys);
|
||||
return script;
|
||||
};
|
||||
|
||||
// TODO this could be cached
|
||||
/**
|
||||
* @desc
|
||||
* Get the address for a multisig based on the given params.
|
||||
*
|
||||
* Caches the address to the branch in the member addressToPath
|
||||
*
|
||||
* @TODO this could be cached
|
||||
*
|
||||
* @param {number} index - the index for the shared address
|
||||
* @param {boolean} isChange - whether to derive a change address o receive address
|
||||
* @param {number} copayerIndex - the index of the copayer that requested the derivation
|
||||
* @returns {bitcore.Address}
|
||||
*/
|
||||
PublicKeyRing.prototype.getAddress = function(index, isChange, id) {
|
||||
var copayerIndex = this.getCosigner(id);
|
||||
var script = this.getRedeemScript(index, isChange, copayerIndex);
|
||||
|
|
@ -187,7 +341,17 @@ PublicKeyRing.prototype.getAddress = function(index, isChange, id) {
|
|||
return address;
|
||||
};
|
||||
|
||||
// Overloaded to receive a PubkeyString or a consigner index
|
||||
/**
|
||||
* @desc
|
||||
* Get the parameters used to derive a pubkey or a cosigner index
|
||||
*
|
||||
* Overloaded to receive a PubkeyString or a consigner index
|
||||
*
|
||||
* @TODO: Couldn't really figure out what does this do
|
||||
*
|
||||
* @param {number|string} id public key in hex format, or the copayer's index
|
||||
* @return ????
|
||||
*/
|
||||
PublicKeyRing.prototype.getHDParams = function(id) {
|
||||
var copayerIndex = this.getCosigner(id);
|
||||
var index = this.indexes.filter(function(i) {
|
||||
|
|
@ -198,20 +362,44 @@ PublicKeyRing.prototype.getHDParams = function(id) {
|
|||
return index[0];
|
||||
};
|
||||
|
||||
/**
|
||||
* @desc
|
||||
* Get the path used to derive a pubkey or a cosigner index for an address
|
||||
*
|
||||
* @param {string} address a multisig p2sh address
|
||||
* @return {HDPath}
|
||||
*/
|
||||
PublicKeyRing.prototype.pathForAddress = function(address) {
|
||||
var path = this.addressToPath[address];
|
||||
if (!path) throw new Error('Couldn\'t find path for address ' + address);
|
||||
return path;
|
||||
};
|
||||
|
||||
// TODO this could be cached
|
||||
/**
|
||||
* @desc
|
||||
* Get the hexadecimal representation of a P2SH script
|
||||
*
|
||||
* @param {number} index - index to use when generating the address
|
||||
* @param {boolean} isChange - generate a change address or a receive addres
|
||||
* @param {number|string} pubkey - index of the copayer, or his public key
|
||||
* @returns {string} hexadecimal encoded P2SH hash
|
||||
*/
|
||||
PublicKeyRing.prototype.getScriptPubKeyHex = function(index, isChange, pubkey) {
|
||||
var copayerIndex = this.getCosigner(pubkey);
|
||||
var addr = this.getAddress(index, isChange, copayerIndex);
|
||||
return Script.createP2SH(addr.payload()).getBuffer().toString('hex');
|
||||
};
|
||||
|
||||
//generate a new address, update index.
|
||||
/**
|
||||
* @desc
|
||||
* Generates a new address and updates the last index used
|
||||
*
|
||||
* @param {truthy} isChange - generate a change address if true, otherwise
|
||||
* generates a receive
|
||||
* @param {number|string} pubkey - the pubkey for the copayer that generates the
|
||||
* address (or index in the keyring)
|
||||
* @returns {bitpay.Address}
|
||||
*/
|
||||
PublicKeyRing.prototype.generateAddress = function(isChange, pubkey) {
|
||||
isChange = !!isChange;
|
||||
var HDParams = this.getHDParams(pubkey);
|
||||
|
|
@ -221,15 +409,31 @@ PublicKeyRing.prototype.generateAddress = function(isChange, pubkey) {
|
|||
return ret;
|
||||
};
|
||||
|
||||
/**
|
||||
* @desc
|
||||
* Retrieve the addresses from a getAddressInfo return object
|
||||
*
|
||||
* {@see PublicKeyRing#getAddressInfo}
|
||||
* @returns {string[]} the result of retrieving the addresses from calling
|
||||
*/
|
||||
PublicKeyRing.prototype.getAddresses = function(opts) {
|
||||
return this.getAddressesInfo(opts).map(function(info) {
|
||||
return info.address;
|
||||
});
|
||||
};
|
||||
|
||||
/**
|
||||
* @desc
|
||||
* Maps a copayer's public key to his index in the keyring
|
||||
*
|
||||
* @param {number|string|undefined} pubKey - if undefined, returns the SHARED_INDEX
|
||||
* - if a number, just return it
|
||||
* - if a string, assume is the hex encoded public key
|
||||
* @returns {number} the index of the copayer with the given pubkey
|
||||
*/
|
||||
PublicKeyRing.prototype.getCosigner = function(pubKey) {
|
||||
if (typeof pubKey == 'undefined') return HDPath.SHARED_INDEX;
|
||||
if (typeof pubKey == 'number') return pubKey;
|
||||
if (_.isUndefined(pubKey)) return HDPath.SHARED_INDEX;
|
||||
if (_.isNumber(pubKey)) return pubKey;
|
||||
|
||||
var sorted = this.copayersHK.map(function(h, i) {
|
||||
return h.eckey.public.toString('hex');
|
||||
|
|
@ -241,9 +445,17 @@ PublicKeyRing.prototype.getCosigner = function(pubKey) {
|
|||
if (index == -1) throw new Error('public key is not on the ring');
|
||||
|
||||
return index;
|
||||
}
|
||||
|
||||
};
|
||||
|
||||
/**
|
||||
* @desc
|
||||
* Gets information about addresses for a copayer
|
||||
*
|
||||
* @see PublicKeyRing#getAddressesInfoForIndex
|
||||
* @param {Object} opts
|
||||
* @param {string|number} pubkey - the pubkey or index of a copayer in the ring
|
||||
* @returns {AddressInfo[]}
|
||||
*/
|
||||
PublicKeyRing.prototype.getAddressesInfo = function(opts, pubkey) {
|
||||
var ret = [];
|
||||
var self = this;
|
||||
|
|
@ -252,53 +464,88 @@ PublicKeyRing.prototype.getAddressesInfo = function(opts, pubkey) {
|
|||
ret = ret.concat(self.getAddressesInfoForIndex(index, opts, copayerIndex));
|
||||
});
|
||||
return ret;
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* @typedef AddressInfo
|
||||
* @property {bitcore.Address} address - the address generated
|
||||
* @property {string} addressStr - the base58 encoded address
|
||||
* @property {boolean} isChange - true if it's a change address
|
||||
* @property {boolean} owned - true if it's an address generated by a copayer
|
||||
*/
|
||||
/**
|
||||
* @desc
|
||||
* Retrieves info about addresses generated by a copayer
|
||||
*
|
||||
* @param {HDParams} index - HDParams of the copayer
|
||||
* @param {Object} opts
|
||||
* @param {boolean} opts.excludeChange - don't append information about change addresses
|
||||
* @param {boolean} opts.excludeMain - don't append information about receive addresses
|
||||
* @param {string|number|undefined} copayerIndex - copayer index, pubkey, or undefined to fetch info
|
||||
* about shared addresses
|
||||
* @return {AddressInfo[]} a list of AddressInfo
|
||||
*/
|
||||
PublicKeyRing.prototype.getAddressesInfoForIndex = function(index, opts, copayerIndex) {
|
||||
opts = opts || {};
|
||||
|
||||
var isOwned = index.copayerIndex == HDPath.SHARED_INDEX || index.copayerIndex == copayerIndex;
|
||||
|
||||
var isOwned = index.copayerIndex === HDPath.SHARED_INDEX || index.copayerIndex === copayerIndex;
|
||||
var ret = [];
|
||||
if (!opts.excludeChange) {
|
||||
for (var i = 0; i < index.changeIndex; i++) {
|
||||
var a = this.getAddress(i, true, index.copayerIndex);
|
||||
ret.unshift({
|
||||
address: a,
|
||||
addressStr: a.toString(),
|
||||
isChange: true,
|
||||
owned: isOwned
|
||||
});
|
||||
}
|
||||
}
|
||||
var appendAddressInfo = function(address, isChange) {
|
||||
ret.unshift({
|
||||
address: address,
|
||||
addressStr: address.toString(),
|
||||
isChange: isChange,
|
||||
owned: isOwned
|
||||
});
|
||||
};
|
||||
|
||||
if (!opts.excludeMain) {
|
||||
for (var i = 0; i < index.receiveIndex; i++) {
|
||||
var a = this.getAddress(i, false, index.copayerIndex);
|
||||
ret.unshift({
|
||||
address: a,
|
||||
addressStr: a.toString(),
|
||||
isChange: false,
|
||||
owned: isOwned
|
||||
});
|
||||
}
|
||||
for (var i = 0; !opts.excludeChange && i < index.changeIndex; i++) {
|
||||
appendAddressInfo(this.getAddress(i, true, index.copayerIndex), true);
|
||||
}
|
||||
for (var i = 0; !opts.excludeMain && i < index.receiveIndex; i++) {
|
||||
appendAddressInfo(this.getAddress(i, false, index.copayerIndex), false);
|
||||
}
|
||||
|
||||
return ret;
|
||||
};
|
||||
|
||||
/**
|
||||
* @desc
|
||||
* Retrieve the public keys for all cosigners for a given path
|
||||
*
|
||||
* @param {string} path - the BIP32 path
|
||||
* @return {Buffer[]} the public keys, in buffer format
|
||||
*/
|
||||
PublicKeyRing.prototype.getForPath = function(path) {
|
||||
var p = HDPath.indexesForPath(path);
|
||||
var pubKeys = this.getPubKeys(p.addressIndex, p.isChange, p.copayerIndex);
|
||||
return pubKeys;
|
||||
return this.getPubKeys(p.addressIndex, p.isChange, p.copayerIndex);
|
||||
};
|
||||
|
||||
/**
|
||||
* @desc
|
||||
* Retrieve the public keys for all cosigners for multiple paths
|
||||
* @see PublicKeyRing#getForPath
|
||||
*
|
||||
* @param {string[]} paths - the BIP32 paths
|
||||
* @return {Buffer[][]} the public keys, in buffer format
|
||||
*/
|
||||
PublicKeyRing.prototype.getForPaths = function(paths) {
|
||||
preconditions.checkArgument(paths);
|
||||
preconditions.checkArgument(!_.isUndefined(paths));
|
||||
preconditions.checkArgument(_.isArray(paths));
|
||||
preconditions.checkArgument(_.all(paths, _.isString));
|
||||
|
||||
return paths.map(this.getForPath.bind(this));
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* @desc
|
||||
* Retrieve the public keys for derived addresses and the public keys for copayers
|
||||
*
|
||||
* @TODO: Should this exist? A user should just call getForPath(paths)
|
||||
*
|
||||
* @param {string[]} paths - the paths to be derived
|
||||
* @return {Object} with keys pubKeys and copayerIds
|
||||
*/
|
||||
PublicKeyRing.prototype.forPaths = function(paths) {
|
||||
return {
|
||||
pubKeys: paths.map(this.getForPath.bind(this)),
|
||||
|
|
@ -306,8 +553,13 @@ PublicKeyRing.prototype.forPaths = function(paths) {
|
|||
}
|
||||
};
|
||||
|
||||
|
||||
// returns pubkey -> copayerId.
|
||||
/**
|
||||
* @desc
|
||||
* Returns a map from a pubkey of an address to the id that generated it
|
||||
*
|
||||
* @param {string[]} pubkeys - the pubkeys to query
|
||||
* @param {string[]} paths - the paths to query
|
||||
*/
|
||||
PublicKeyRing.prototype.copayersForPubkeys = function(pubkeys, paths) {
|
||||
preconditions.checkArgument(pubkeys);
|
||||
preconditions.checkArgument(paths);
|
||||
|
|
@ -328,71 +580,87 @@ PublicKeyRing.prototype.copayersForPubkeys = function(pubkeys, paths) {
|
|||
}
|
||||
}
|
||||
|
||||
|
||||
for(var i in inKeyMap)
|
||||
throw new Error('Pubkey not identified')
|
||||
if (_.size(inKeyMap)) {
|
||||
for (var i in inKeyMap) {
|
||||
log.error('Pubkey ' + i + ' not identified');
|
||||
}
|
||||
throw new Error('Pubkeys not identified');
|
||||
}
|
||||
|
||||
return ret;
|
||||
};
|
||||
|
||||
|
||||
// TODO this could be cached
|
||||
PublicKeyRing.prototype._addScriptMap = function(map, path) {
|
||||
var p = HDPath.indexesForPath(path);
|
||||
var script = this.getRedeemScript(p.addressIndex, p.isChange, p.copayerIndex);
|
||||
map[Address.fromScript(script, this.network.name).toString()] = script.getBuffer().toString('hex');
|
||||
};
|
||||
|
||||
/**
|
||||
* @desc
|
||||
* Returns a map from address -> public key needed
|
||||
*
|
||||
* @param {HDPath[]} paths - paths to be solved
|
||||
* @returns {Object} a map from addresses to Buffer with the hex pubkeys
|
||||
*/
|
||||
PublicKeyRing.prototype.getRedeemScriptMap = function(paths) {
|
||||
var ret = {};
|
||||
for (var i = 0; i < paths.length; i++) {
|
||||
var path = paths[i];
|
||||
this._addScriptMap(ret, path);
|
||||
var p = HDPath.indexesForPath(path);
|
||||
var script = this.getRedeemScript(p.addressIndex, p.isChange, p.copayerIndex);
|
||||
ret[Address.fromScript(script, this.network.name).toString()] = script.getBuffer().toString('hex');
|
||||
}
|
||||
return ret;
|
||||
};
|
||||
|
||||
/**
|
||||
* @desc
|
||||
* Check if another PubKeyRing is similar to this one (checks network name,
|
||||
* requiredCopayers, and totalCopayers). If ignoreId is falsy, also check that
|
||||
* both walletIds match.
|
||||
*
|
||||
* @private
|
||||
* @param {PubKeyRing} inPKR - the other PubKeyRing
|
||||
* @param {boolean} ignoreId - whether to ignore checking for equal walletId
|
||||
* @throws {Error} if the wallets mismatch
|
||||
* @return true
|
||||
*/
|
||||
|
||||
PublicKeyRing.prototype._checkInPKR = function(inPKR, ignoreId) {
|
||||
|
||||
if (!ignoreId && this.walletId !== inPKR.walletId) {
|
||||
if (!ignoreId && this.walletId !== inPKR.walletId)
|
||||
throw new Error('inPKR walletId mismatch');
|
||||
}
|
||||
|
||||
if (this.network.name !== inPKR.network.name) {
|
||||
if (this.network.name !== inPKR.network.name)
|
||||
throw new Error('Network mismatch. Should be ' + this.network.name +
|
||||
' and found ' + inPKR.network.name);
|
||||
}
|
||||
|
||||
if (
|
||||
this.requiredCopayers && inPKR.requiredCopayers &&
|
||||
if (this.requiredCopayers && inPKR.requiredCopayers &&
|
||||
(this.requiredCopayers !== inPKR.requiredCopayers))
|
||||
throw new Error('inPKR requiredCopayers mismatch ' + this.requiredCopayers + '!=' + inPKR.requiredCopayers);
|
||||
throw new Error('inPKR requiredCopayers mismatch ' + this.requiredCopayers +
|
||||
'!=' + inPKR.requiredCopayers);
|
||||
|
||||
if (
|
||||
this.totalCopayers && inPKR.totalCopayers &&
|
||||
(this.totalCopayers !== inPKR.totalCopayers))
|
||||
throw new Error('inPKR totalCopayers mismatch' + this.totalCopayers + '!=' + inPKR.requiredCopayers);
|
||||
if (this.totalCopayers && inPKR.totalCopayers &&
|
||||
this.totalCopayers !== inPKR.totalCopayers)
|
||||
throw new Error('inPKR totalCopayers mismatch' + this.totalCopayers +
|
||||
'!=' + inPKR.requiredCopayers);
|
||||
|
||||
return true;
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* @desc
|
||||
* Merges the public keys of the wallet passed in as a parameter with ours.
|
||||
*
|
||||
* @param {PublicKeyRing} inPKR
|
||||
* @return {boolean} true if there where changes in our internal state
|
||||
*/
|
||||
PublicKeyRing.prototype._mergePubkeys = function(inPKR) {
|
||||
var self = this;
|
||||
|
||||
var hasChanged = false;
|
||||
var l = self.copayersHK.length;
|
||||
|
||||
if (self.isComplete())
|
||||
return;
|
||||
|
||||
inPKR.copayersHK.forEach(function(b) {
|
||||
var haveIt = false;
|
||||
var epk = b.extendedPublicKeyString();
|
||||
for (var j = 0; j < l; j++) {
|
||||
if (self.copayersHK[j].extendedPublicKeyString() === epk) {
|
||||
haveIt = true;
|
||||
break;
|
||||
}
|
||||
}
|
||||
var haveIt = _.any(self.copayersHK, function(hk) { return hk.extendedPublicKeyString() === epk; });
|
||||
|
||||
if (!haveIt) {
|
||||
if (self.isComplete()) {
|
||||
throw new Error('trying to add more pubkeys, when PKR isComplete at merge');
|
||||
|
|
@ -408,27 +676,57 @@ PublicKeyRing.prototype._mergePubkeys = function(inPKR) {
|
|||
return hasChanged;
|
||||
};
|
||||
|
||||
PublicKeyRing.prototype.setBackupReady = function(copayerId) {
|
||||
/**
|
||||
* @desc
|
||||
* Mark backup as done for us
|
||||
*
|
||||
* @TODO: REVIEW FUNCTIONALITY - it used to have a parameter that was not used at all!
|
||||
*
|
||||
* @return {boolean} true if everybody has backed up their wallet
|
||||
*/
|
||||
PublicKeyRing.prototype.setBackupReady = function() {
|
||||
if (this.isBackupReady()) return false;
|
||||
|
||||
var cid = this.myCopayerId();
|
||||
this.copayersBackup.push(cid);
|
||||
return true;
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* @desc returns true if a copayer has backed up his wallet
|
||||
* @param {string=} copayerId - the pubkey of a copayer, defaults to our own's
|
||||
* @return {boolean} if this copayer has backed up
|
||||
*/
|
||||
PublicKeyRing.prototype.isBackupReady = function(copayerId) {
|
||||
var cid = copayerId || this.myCopayerId();
|
||||
return this.copayersBackup.indexOf(cid) != -1;
|
||||
}
|
||||
};
|
||||
|
||||
PublicKeyRing.prototype.isFullyBackup = function(copayerId) {
|
||||
/**
|
||||
* @desc returns true if all copayers have backed up their wallets
|
||||
* @return {boolean}
|
||||
*/
|
||||
PublicKeyRing.prototype.isFullyBackup = function() {
|
||||
return this.remainingBackups() == 0;
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* @desc returns the amount of backups remaining
|
||||
* @return {boolean}
|
||||
*/
|
||||
PublicKeyRing.prototype.remainingBackups = function() {
|
||||
return this.totalCopayers - this.copayersBackup.length;
|
||||
};
|
||||
|
||||
/**
|
||||
* @desc
|
||||
* Merges this public key ring with another one, optionally ignoring the
|
||||
* wallet id
|
||||
*
|
||||
* @param {PublicKeyRing} inPkr
|
||||
* @param {boolean} ignoreId
|
||||
* @return {boolean} true if the internal state has changed
|
||||
*/
|
||||
PublicKeyRing.prototype.merge = function(inPKR, ignoreId) {
|
||||
this._checkInPKR(inPKR, ignoreId);
|
||||
|
||||
|
|
@ -440,6 +738,15 @@ PublicKeyRing.prototype.merge = function(inPKR, ignoreId) {
|
|||
return !!hasChanged;
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* @desc
|
||||
* Merges the indexes for addresses generated with another copy of a list of
|
||||
* HDParams
|
||||
*
|
||||
* @param {HDParams[]} indexes - indexes as received from another sources
|
||||
* @return {boolean} true if the internal state has changed
|
||||
*/
|
||||
PublicKeyRing.prototype.mergeIndexes = function(indexes) {
|
||||
var self = this;
|
||||
var hasChanged = false;
|
||||
|
|
@ -452,6 +759,11 @@ PublicKeyRing.prototype.mergeIndexes = function(indexes) {
|
|||
return !!hasChanged
|
||||
}
|
||||
|
||||
/**
|
||||
* @desc merges information about backups done by another copy of PublicKeyRing
|
||||
* @param {string[]} backups - another copy of backups
|
||||
* @return {boolean} true if the internal state has changed
|
||||
*/
|
||||
PublicKeyRing.prototype._mergeBackups = function(backups) {
|
||||
var self = this;
|
||||
var hasChanged = false;
|
||||
|
|
@ -463,7 +775,6 @@ PublicKeyRing.prototype._mergeBackups = function(backups) {
|
|||
});
|
||||
|
||||
return !!hasChanged
|
||||
}
|
||||
|
||||
};
|
||||
|
||||
module.exports = PublicKeyRing;
|
||||
|
|
|
|||
Loading…
Reference in New Issue