anders/Wallet
1
0
Fork 0
Code Issues Projects Releases Packages Wiki Activity

change Wallet to PublicKeyRing

Browse source
This commit is contained in:
Matias Alejo Garcia 2014-04-04 15:57:28 -03:00
commit d33cf4a751
3 changed files with 184 additions and 294 deletions
Download patch file Download diff file Expand all files Collapse all files

142
js/models/wallet.js → js/models/PublicKeyRing.js
View file

@ -26,48 +26,47 @@ var PUBLIC_BRANCH = 'm/0/';
var CHANGE_BRANCH = 'm/1/'; var CHANGE_BRANCH = 'm/1/';
function Wallet(opts) { function PublicKeyRing(opts) {
opts = opts || {}; opts = opts || {};
this.network = opts.network === 'livenet' ? this.network = opts.network === 'livenet' ?
bitcore.networks.livenet : bitcore.networks.testnet; bitcore.networks.livenet : bitcore.networks.testnet;
this.requiredCosigners = opts.requiredCosigners || 3; this.requiredCopayers = opts.requiredCopayers || 3;
this.totalCosigners = opts.totalCosigners || 5; this.totalCopayers = opts.totalCopayers || 5;
this.id = opts.id || Wallet.getRandomId(); this.id = opts.id || PublicKeyRing.getRandomId();
this.dirty = 1; this.dirty = 1;
this.cosignersWallets = []; this.copayersWallets = [];
this.bip32 = new BIP32(opts.bytes || this.network.name); this.bip32 = new BIP32(opts.bytes || this.network.name);
this.changeAddressIndex=0; this.changeAddressIndex=0;
this.addressIndex=0; this.addressIndex=0;
} }
Wallet.getRandomId = function () { PublicKeyRing.getRandomId = function () {
return buffertools.toHex(coinUtil.generateNonce()); return buffertools.toHex(coinUtil.generateNonce());
}; };
Wallet.decrypt = function (passphrase, encPayload) { PublicKeyRing.decrypt = function (passphrase, encPayload) {
log('[wallet.js.35] TODO READ: passphrase IGNORED'); log('[wallet.js.35] TODO READ: passphrase IGNORED');
return encPayload; return encPayload;
}; };
Wallet.encrypt = function (passphrase, payload) { PublicKeyRing.encrypt = function (passphrase, payload) {
log('[wallet.js.92] TODO: passphrase IGNORED'); log('[wallet.js.92] TODO: passphrase IGNORED');
return payload; return payload;
}; };
Wallet.read = function (id, passphrase) { PublicKeyRing.read = function (id, passphrase) {
var encPayload = storage.read(id); var encPayload = storage.read(id);
if (!encPayload) if (!encPayload)
throw new Error('Could not find wallet data'); throw new Error('Could not find wallet data');
var data; var data;
try { try {
data = JSON.parse( Wallet.decrypt( passphrase, encPayload )); data = JSON.parse( PublicKeyRing.decrypt( passphrase, encPayload ));
} catch (e) { } catch (e) {
throw new Error('error in storage: '+ e.toString()); throw new Error('error in storage: '+ e.toString());
return; return;
@ -80,12 +79,12 @@ Wallet.read = function (id, passphrase) {
bitcore.networks.livenet : bitcore.networks.testnet bitcore.networks.livenet : bitcore.networks.testnet
}; };
var w = new Wallet(config); var w = new PublicKeyRing(config);
w.requiredCosigners = data.neededCosigners; w.requiredCopayers = data.neededCopayers;
w.totalCosigners = data.totalCosigners; w.totalCopayers = data.totalCopayers;
w.cosignersWallets = data.cosignersExtPubKeys.map( function (pk) { w.copayersWallets = data.copayersExtPubKeys.map( function (pk) {
return new Wallet({bytes:pk, network: w.network.name}); return new PublicKeyRing({bytes:pk, network: w.network.name});
}); });
w.dirty = 0; w.dirty = 0;
@ -93,57 +92,47 @@ Wallet.read = function (id, passphrase) {
return w; return w;
}; };
Wallet.prototype.serialize = function () { PublicKeyRing.prototype.serialize = function () {
return JSON.stringify({ return JSON.stringify({
id: this.id, id: this.id,
network: this.network.name, network: this.network.name,
requiredCosigners: this.neededCosigners, requiredCopayers: this.neededCopayers,
totalCosigners: this.totalCosigners, totalCopayers: this.totalCopayers,
cosignersExtPubKeys: this.cosignersWallets.map( function (b) { copayersExtPubKeys: this.copayersWallets.map( function (b) {
return b.getMasterExtendedPubKey(); return b.getMasterExtendedPubKey();
}), }),
priv: this.getMasterExtendedPrivKey(),
}); });
}; };
Wallet.prototype.store = function (passphrase) { PublicKeyRing.prototype.store = function (passphrase) {
if (!this.id) if (!this.id)
throw new Error('wallet has no id'); throw new Error('wallet has no id');
storage.save(this.id, Wallet.encrypt(passphrase,this.serialize())); storage.save(this.id, PublicKeyRing.encrypt(passphrase,this.serialize()));
this.dirty = 0; this.dirty = 0;
return true; return true;
}; };
Wallet.prototype.registeredCosigners = function () { PublicKeyRing.prototype.registeredCopayers = function () {
if (! this.cosignersWallets) return 1; if (! this.copayersWallets) return 1;
// 1 is self. // 1 is self.
return 1 + this.cosignersWallets.length; return 1 + this.copayersWallets.length;
}; };
Wallet.prototype.getMasterExtendedPrivKey = function () { PublicKeyRing.prototype.getMasterExtendedPubKey = function () {
return this.bip32.extendedPublicKeyString();
if (!this.bip32)
throw new Error('no priv key defined on the wallet');
return this.bip32.extended_private_key_string();
}; };
Wallet.prototype.getMasterExtendedPubKey = function () { PublicKeyRing.prototype.haveAllRequiredPubKeys = function () {
return this.bip32.extended_public_key_string(); return this.registeredCopayers() === this.totalCopayers;
}; };
PublicKeyRing.prototype._checkKeys = function() {
Wallet.prototype.haveAllRequiredPubKeys = function () {
return this.registeredCosigners() === this.totalCosigners;
};
Wallet.prototype._checkKeys = function() {
if (!this.haveAllRequiredPubKeys()) if (!this.haveAllRequiredPubKeys())
throw new Error('dont have required keys yet'); throw new Error('dont have required keys yet');
@ -151,26 +140,26 @@ Wallet.prototype._checkKeys = function() {
// should receive an array also? // should receive an array also?
Wallet.prototype.addCosignerExtendedPubKey = function (newEpk) { PublicKeyRing.prototype.addCopayerExtendedPubKey = function (newEpk) {
if (this.haveAllRequiredPubKeys()) if (this.haveAllRequiredPubKeys())
throw new Error('already have all required key:' + this.totalCosigners); throw new Error('already have all required key:' + this.totalCopayers);
if (this.getMasterExtendedPubKey() === newEpk) if (this.getMasterExtendedPubKey() === newEpk)
throw new Error('already have that key (self key)'); throw new Error('already have that key (self key)');
this.cosignersWallets.forEach(function(b){ this.copayersWallets.forEach(function(b){
if (b.getMasterExtendedPubKey() === newEpk) if (b.getMasterExtendedPubKey() === newEpk)
throw new Error('already have that key'); throw new Error('already have that key');
}); });
this.cosignersWallets.push(new Wallet({bytes:newEpk, network: this.network.name } )); this.copayersWallets.push(new PublicKeyRing({bytes:newEpk, network: this.network.name } ));
this.dirty = 1; this.dirty = 1;
}; };
Wallet.prototype.getPubKey = function (index,isChange) { PublicKeyRing.prototype.getPubKey = function (index,isChange) {
var path = (isChange ? CHANGE_BRANCH : PUBLIC_BRANCH) + index; var path = (isChange ? CHANGE_BRANCH : PUBLIC_BRANCH) + index;
var bip32 = this.bip32.derive(path); var bip32 = this.bip32.derive(path);
@ -178,49 +167,19 @@ Wallet.prototype.getPubKey = function (index,isChange) {
return pub; return pub;
}; };
PublicKeyRing.prototype.getCopayersPubKeys = function (index, isChange) {
Wallet.prototype.getCosignersPubKeys = function (index, isChange) {
this._checkKeys(); this._checkKeys();
var pubKeys = []; var pubKeys = [];
var l = this.cosignersWallets.length; var l = this.copayersWallets.length;
for(var i=0; i<l; i++) { for(var i=0; i<l; i++) {
pubKeys[i] = this.cosignersWallets[i].getPubKey(index, isChange); pubKeys[i] = this.copayersWallets[i].getPubKey(index, isChange);
} }
return pubKeys; return pubKeys;
}; };
PublicKeyRing.prototype.getAddress = function (index, isChange) {
Wallet.prototype.getCosignersSortedPubKeys = function(index, isChange) {
var self = this;
var pubKeys = self.getCosignersPubKeys(index, isChange);
//sort lexicographically, i.e. as strings, i.e. alphabetically
// From https://github.com/ryanxcharles/treasure/blob/master/treasure.js
return pubKeys.sort(function(buf1, buf2) {
var len = buf1.length > buf1.length ? buf1.length : buf2.length;
for (var i = 0; i <= len; i++) {
if (buf1[i] === undefined)
return -1; //shorter strings come first
if (buf2[i] === undefined)
return 1;
if (buf1[i] < buf2[i])
return -1;
if (buf1[i] > buf2[i])
return 1;
else
continue;
}
return 0;
});
};
Wallet.prototype.getAddress = function (index, isChange) {
if ( (isChange && index > this.changeAddressIndex) if ( (isChange && index > this.changeAddressIndex)
|| (!isChange && index > this.addressIndex)) { || (!isChange && index > this.addressIndex)) {
@ -228,10 +187,9 @@ Wallet.prototype.getAddress = function (index, isChange) {
throw new Error('index out of bound'); throw new Error('index out of bound');
} }
var pubKeys = this.getCosignersSortedPubKeys(index, isChange); var pubKeys = this.getCopayersPubKeys();
var version = this.network.addressScript; var version = this.network.addressScript;
var script = Script.createMultisig(this.requiredCosigners, pubKeys); var script = Script.createMultisig(this.requiredCopayers, pubKeys);
var buf = script.buffer; var buf = script.buffer;
var hash = coinUtil.sha256ripe160(buf); var hash = coinUtil.sha256ripe160(buf);
var addr = new Address(version, hash); var addr = new Address(version, hash);
@ -239,11 +197,11 @@ Wallet.prototype.getAddress = function (index, isChange) {
return addrStr; return addrStr;
}; };
Wallet.prototype.createAddress = function(isChange) { //generate a new address, update index.
PublicKeyRing.prototype.generateAddress = function(isChange) {
var ret = var ret =
this.getAddress(isChange ? this.changeAddressIndex : this.addressIndex, isChange); this.getAddress(isChange ? this.changeAddressIndex : this.addressIndex, isChange);
if (isChange) if (isChange)
this.addressIndex++; this.addressIndex++;
else else
@ -253,7 +211,7 @@ Wallet.prototype.createAddress = function(isChange) {
}; };
Wallet.prototype.getAddresses = function() { PublicKeyRing.prototype.getAddresses = function() {
var ret = []; var ret = [];
for (var i=0; i<this.changeAddressIndex; i++) { for (var i=0; i<this.changeAddressIndex; i++) {
@ -266,16 +224,4 @@ Wallet.prototype.getAddresses = function() {
return ret; return ret;
}; };
Wallet.prototype.createTx = function(utxos,outs, changeAddress) { module.exports = require('soop')(PublicKeyRing);
var opts = {
remainderAddress: changeAddress || this.createAddress(1),
};
return Transaction.create(utxos, outs, opts);
};
// Input: Bitcore's Transaction, sign with ownPK
// return partially signed or fully signed tx
Wallet.prototype.signTx = function (tx) {
};
module.exports = require('soop')(Wallet);

140
test/test.publickeyring.js Normal file
View file

@ -0,0 +1,140 @@
'use strict';
var chai = chai || require('chai');
var should = chai.should();
var bitcore = bitcore || require('../node_modules/bitcore');
var Address = bitcore.Address;
var buffertools = bitcore.buffertools;
var copay = copay || {};
var fakeStorage = require('./FakeStorage');
var PublicKeyRing = copay.PublicKeyRing || require('soop').load('../js/models/PublicKeyRing', {Storage: fakeStorage});
var aMasterPubKey = 'tprv8ZgxMBicQKsPdSVTiWXEqCCzqRaRr9EAQdn5UVMpT9UHX67Dh1FmzEMbavPumpAicsUm2XvC6NTdcWB89yN5DUWx5HQ7z3KByUg7Ht74VRZ';
var config = {
network:'livenet',
};
var createW = function (network, bytes) {
var config = {
network: network || 'livenet',
};
if (bytes) config.bytes = bytes;
var w = new PublicKeyRing(config);
should.exist(w);
var copayers = [];
for(var i=0; i<4; i++) {
delete config['bytes'];
var c = new PublicKeyRing(config);
w.haveAllRequiredPubKeys().should.equal(false);
w.addCopayerExtendedPubKey(c.getMasterExtendedPubKey());
copayers.push(c);
}
return {w:w, copayers: copayers};
};
describe('PublicKeyRing model', function() {
it('should create an instance (livenet)', function () {
var w = new PublicKeyRing({
network: config.network
});
should.exist(w);
w.network.name.should.equal('livenet');
});
it('should create an instance (testnet)', function () {
var w2 = new PublicKeyRing();
should.exist(w2);
w2.network.name.should.equal('testnet');
});
it('should create an master pub key', function () {
var w2 = new PublicKeyRing(config);
should.exist(w2);
should.exist(w2.getMasterExtendedPubKey());
});
it('should fail to generate shared pub keys wo extended key', function () {
var w2 = new PublicKeyRing(config);
should.exist(w2);
w2.registeredCopayers().should.equal(1);
w2.haveAllRequiredPubKeys().should.equal(false);
w2.getAddress.bind(false).should.throw();
});
it('should add and check when adding shared pub keys', function () {
var k = createW();
var w = k.w;
var copayers = k.copayers;
w.haveAllRequiredPubKeys().should.equal(true);
w.addCopayerExtendedPubKey.bind(w.getMasterExtendedPubKey()).should.throw();
w.addCopayerExtendedPubKey.bind(copayers[0].getMasterExtendedPubKey()).should.throw();
w.addCopayerExtendedPubKey.bind((new PublicKeyRing(config)).getMasterExtendedPubKey()).should.throw();
});
it('show be able to store and retrieve', function () {
var k = createW();
var w = k.w;
var copayers = k.copayers;
w.store().should.equal(true);
var ID = w.id;
delete w['id'];
w.store.bind().should.throw();
var w2 = PublicKeyRing.read(ID);
w2.haveAllRequiredPubKeys().should.equal(true);
w2.addCopayerExtendedPubKey.bind(w.getMasterExtendedPubKey()).should.throw();
w2.addCopayerExtendedPubKey.bind(copayers[0].getMasterExtendedPubKey()).should.throw();
w2.addCopayerExtendedPubKey.bind((new PublicKeyRing(config)).getMasterExtendedPubKey()).should.throw();
});
it('should generate some p2sh addresses', function () {
var k = createW();
var w = k.w;
for(var isChange=0; isChange<2; isChange++) {
for(var i=0; i<5; i++) {
var addr = w.generateAddress(isChange);
var a = new Address(addr);
a.isValid().should.equal(true);
a.isScript().should.equal(true);
a.network().name.should.equal('livenet');
}
}
});
it('should return PublicKeyRing addresses', function () {
var k = createW();
var w = k.w;
var a = w.getAddresses();
a.length.should.equal(0);
for(var isChange=0; isChange<2; isChange++)
for(var i=0; i<6; i++)
w.generateAddress(isChange);
var as = w.getAddresses();
as.length.should.equal(12);
for(var i in as) {
var a = new Address(as[i]);
a.isValid().should.equal(true);
}
});
});

196
test/test.wallet.js
View file

@ -1,196 +0,0 @@
'use strict';
var chai = chai || require('chai');
var should = chai.should();
var bitcore = bitcore || require('../node_modules/bitcore');
var Address = bitcore.Address;
var buffertools = bitcore.buffertools;
var cosign = cosign || {};
var fakeStorage = require('./FakeStorage');
var Wallet = cosign.Wallet || require('soop').load('../js/models/Wallet', {Storage: fakeStorage});
var aMasterPrivKey = 'tprv8ZgxMBicQKsPdSVTiWXEqCCzqRaRr9EAQdn5UVMpT9UHX67Dh1FmzEMbavPumpAicsUm2XvC6NTdcWB89yN5DUWx5HQ7z3KByUg7Ht74VRZ';
var config = {
network:'livenet',
};
var createW = function (network, bytes) {
var config = {
network: network || 'livenet',
};
if (bytes) config.bytes = bytes;
var w = new Wallet(config);
should.exist(w);
var cosigners = [];
for(var i=0; i<4; i++) {
delete config['bytes'];
var c = new Wallet(config);
w.haveAllRequiredPubKeys().should.equal(false);
w.addCosignerExtendedPubKey(c.getMasterExtendedPubKey());
cosigners.push(c);
}
return {w:w, cosigners: cosigners};
};
describe('Wallet model', function() {
it('should create an instance (livenet)', function () {
var w = new Wallet({
network: config.network
});
should.exist(w);
w.network.name.should.equal('livenet');
});
it('should create an instance (testnet)', function () {
var w2 = new Wallet();
should.exist(w2);
w2.network.name.should.equal('testnet');
});
it('should throw master priv key', function () {
var w2 = new Wallet(config);
should.exist(w2);
w2.getMasterExtendedPrivKey.bind().should.throw();
});
it('should create an master priv key', function () {
var w2 = new Wallet(config);
should.exist(w2);
should.exist(w2.getMasterExtendedPrivKey());
});
it('should create an master pub key', function () {
var w2 = new Wallet(config);
should.exist(w2);
should.exist(w2.getMasterExtendedPubKey());
});
it('should fail to generate shared pub keys wo extended key', function () {
var w2 = new Wallet(config);
should.exist(w2);
w2.registeredCosigners().should.equal(1);
w2.haveAllRequiredPubKeys().should.equal(false);
w2.getAddress.bind(false).should.throw();
});
it('should add and check when adding shared pub keys', function () {
var k = createW();
var w = k.w;
var cosigners = k.cosigners;
w.haveAllRequiredPubKeys().should.equal(true);
w.addCosignerExtendedPubKey.bind(w.getMasterExtendedPubKey()).should.throw();
w.addCosignerExtendedPubKey.bind(cosigners[0].getMasterExtendedPubKey()).should.throw();
w.addCosignerExtendedPubKey.bind((new Wallet(config)).getMasterExtendedPubKey()).should.throw();
});
it('show be able to store and retrieve', function () {
var k = createW();
var w = k.w;
var cosigners = k.cosigners;
w.store().should.equal(true);
var ID = w.id;
delete w['id'];
w.store.bind().should.throw();
var w2 = Wallet.read(ID);
w2.haveAllRequiredPubKeys().should.equal(true);
w2.addCosignerExtendedPubKey.bind(w.getMasterExtendedPubKey()).should.throw();
w2.addCosignerExtendedPubKey.bind(cosigners[0].getMasterExtendedPubKey()).should.throw();
w2.addCosignerExtendedPubKey.bind((new Wallet(config)).getMasterExtendedPubKey()).should.throw();
});
it('should create some p2sh addresses', function () {
var k = createW();
var w = k.w;
for(var isChange=0; isChange<2; isChange++) {
for(var i=0; i<5; i++) {
var addr = w.createAddress(isChange);
var a = new Address(addr);
a.isValid().should.equal(true);
a.isScript().should.equal(true);
a.network().name.should.equal('livenet');
}
}
});
it('should return wallet addresses', function () {
var k = createW();
var w = k.w;
var a = w.getAddresses();
a.length.should.equal(0);
for(var isChange=0; isChange<2; isChange++)
for(var i=0; i<6; i++)
w.createAddress(isChange);
var as = w.getAddresses();
as.length.should.equal(12);
for(var i in as) {
var a = new Address(as[i]);
a.isValid().should.equal(true);
}
});
it('should create a TX', function () {
var k = createW('testnet', aMasterPrivKey);
var w = k.w;
var as=[], j=0;
for(var isChange=0; isChange<2; isChange++)
for(var i=0; i<6; i++)
as[j++] = w.createAddress(isChange);
var utxos = [
{
address: as[0],
txid: "2ac165fa7a3a2b535d106a0041c7568d03b531e58aeccdd3199d7289ab12cfc1",
scriptPubKey: "76a9146ce4e1163eb18939b1440c42844d5f0261c0338288ac",
vout: 1,
amount: 1,
confirmations: 3
},
{
address: as[1],
txid: "2ac165fa7a3a2b535d106a0041c7568d03b531e58aeccdd3199d7289ab12cfc1",
scriptPubKey: "76a9146ce4e1163eb18939b1440c42844d5f0261c0338288ac",
vout: 1,
amount: 1.01,
confirmations: 7
},
];
var outs=[{
address: 'mfwSGKeLEGdd1YwsZ1TkoEeKNk8TTWqXLC',
amount: 1.5,
}];
var ret = w.createTx(utxos, outs, '2Mu1GwdF9X1LLxXNxtfNChi5ngBMJxi2csv');
var tx=ret.tx;
should.exist(tx);
tx.ins.length.should.equal(2);
tx.outs.length.should.equal(2);
buffertools.toHex(tx.serialize()).should.equal('0100000002c1cf12ab89729d19d3cdec8ae531b5038d56c741006a105d532b3a7afa65c12a0100000000ffffffffc1cf12ab89729d19d3cdec8ae531b5038d56c741006a105d532b3a7afa65c12a0100000000ffffffff0280d1f008000000001976a91404a154d56e5455dc87f15e293b8872f31d03a12c88acb00b0a030000000017a914134ce4e4ea92b6cb0008803cafe25f197ff1dcb98700000000');
});
});