bitcore-lib-terracoin
Version:
A pure and powerful JavaScript Terracoin library.
373 lines (324 loc) • 19.1 kB
JavaScript
;
// Relax some linter options:
// * quote marks so "m/0'/1/2'/" doesn't need to be scaped
// * too many tests, maxstatements -> 100
// * store test vectors at the end, latedef: false
// * should call is never defined
/* jshint quotmark: false */
/* jshint latedef: false */
/* jshint maxstatements: 100 */
/* jshint unused: false */
var _ = require('lodash');
var should = require('chai').should();
var expect = require('chai').expect;
var sinon = require('sinon');
var bitcore = require('..');
var Networks = bitcore.Networks;
var HDPrivateKey = bitcore.HDPrivateKey;
var HDPublicKey = bitcore.HDPublicKey;
describe('HDKeys building with static methods', function() {
var classes = [HDPublicKey, HDPrivateKey];
var clazz, index;
_.each(classes, function(clazz) {
var expectStaticMethodFail = function(staticMethod, argument, message) {
expect(clazz[staticMethod].bind(null, argument)).to.throw(message);
};
it(clazz.name + ' fromJSON checks that a valid JSON is provided', function() {
var errorMessage = 'Invalid Argument: No valid argument was provided';
var method = 'fromObject';
expectStaticMethodFail(method, undefined, errorMessage);
expectStaticMethodFail(method, null, errorMessage);
expectStaticMethodFail(method, 'invalid JSON', errorMessage);
expectStaticMethodFail(method, '{\'singlequotes\': true}', errorMessage);
});
it(clazz.name + ' fromString checks that a string is provided', function() {
var errorMessage = 'No valid string was provided';
var method = 'fromString';
expectStaticMethodFail(method, undefined, errorMessage);
expectStaticMethodFail(method, null, errorMessage);
expectStaticMethodFail(method, {}, errorMessage);
});
it(clazz.name + ' fromObject checks that an object is provided', function() {
var errorMessage = 'No valid argument was provided';
var method = 'fromObject';
expectStaticMethodFail(method, undefined, errorMessage);
expectStaticMethodFail(method, null, errorMessage);
expectStaticMethodFail(method, '', errorMessage);
});
});
});
describe('BIP32 compliance', function() {
it('should initialize test vector 1 from the extended public key', function() {
new HDPublicKey(vector1_m_public).xpubkey.should.equal(vector1_m_public);
});
it('should initialize test vector 1 from the extended private key', function() {
new HDPrivateKey(vector1_m_private).xprivkey.should.equal(vector1_m_private);
});
it('can initialize a public key from an extended private key', function() {
new HDPublicKey(vector1_m_private).xpubkey.should.equal(vector1_m_public);
});
it('toString should be equal to the `xpubkey` member', function() {
var privateKey = new HDPrivateKey(vector1_m_private);
privateKey.toString().should.equal(privateKey.xprivkey);
});
it('toString should be equal to the `xpubkey` member', function() {
var publicKey = new HDPublicKey(vector1_m_public);
publicKey.toString().should.equal(publicKey.xpubkey);
});
it('should get the extended public key from the extended private key for test vector 1', function() {
HDPrivateKey(vector1_m_private).xpubkey.should.equal(vector1_m_public);
});
it("should get m/0' ext. private key from test vector 1", function() {
var privateKey = new HDPrivateKey(vector1_m_private).derive("m/0'");
privateKey.xprivkey.should.equal(vector1_m0h_private);
});
it("should get m/0' ext. public key from test vector 1", function() {
HDPrivateKey(vector1_m_private).derive("m/0'")
.xpubkey.should.equal(vector1_m0h_public);
});
it("should get m/0'/1 ext. private key from test vector 1", function() {
HDPrivateKey(vector1_m_private).derive("m/0'/1")
.xprivkey.should.equal(vector1_m0h1_private);
});
it("should get m/0'/1 ext. public key from test vector 1", function() {
HDPrivateKey(vector1_m_private).derive("m/0'/1")
.xpubkey.should.equal(vector1_m0h1_public);
});
it("should get m/0'/1 ext. public key from m/0' public key from test vector 1", function() {
var derivedPublic = HDPrivateKey(vector1_m_private).derive("m/0'").hdPublicKey.derive("m/1");
derivedPublic.xpubkey.should.equal(vector1_m0h1_public);
});
it("should get m/0'/1/2' ext. private key from test vector 1", function() {
var privateKey = new HDPrivateKey(vector1_m_private);
var derived = privateKey.derive("m/0'/1/2'");
derived.xprivkey.should.equal(vector1_m0h12h_private);
});
it("should get m/0'/1/2' ext. public key from test vector 1", function() {
HDPrivateKey(vector1_m_private).derive("m/0'/1/2'")
.xpubkey.should.equal(vector1_m0h12h_public);
});
it("should get m/0'/1/2'/2 ext. private key from test vector 1", function() {
HDPrivateKey(vector1_m_private).derive("m/0'/1/2'/2")
.xprivkey.should.equal(vector1_m0h12h2_private);
});
it("should get m/0'/1/2'/2 ext. public key from m/0'/1/2' public key from test vector 1", function() {
var derived = HDPrivateKey(vector1_m_private).derive("m/0'/1/2'").hdPublicKey;
derived.derive("m/2").xpubkey.should.equal(vector1_m0h12h2_public);
});
it("should get m/0'/1/2h/2 ext. public key from test vector 1", function() {
HDPrivateKey(vector1_m_private).derive("m/0'/1/2'/2")
.xpubkey.should.equal(vector1_m0h12h2_public);
});
it("should get m/0'/1/2h/2/1000000000 ext. private key from test vector 1", function() {
HDPrivateKey(vector1_m_private).derive("m/0'/1/2'/2/1000000000")
.xprivkey.should.equal(vector1_m0h12h21000000000_private);
});
it("should get m/0'/1/2h/2/1000000000 ext. public key from test vector 1", function() {
HDPrivateKey(vector1_m_private).derive("m/0'/1/2'/2/1000000000")
.xpubkey.should.equal(vector1_m0h12h21000000000_public);
});
it("should get m/0'/1/2'/2/1000000000 ext. public key from m/0'/1/2'/2 public key from test vector 1", function() {
var derived = HDPrivateKey(vector1_m_private).derive("m/0'/1/2'/2").hdPublicKey;
derived.derive("m/1000000000").xpubkey.should.equal(vector1_m0h12h21000000000_public);
});
it('should initialize test vector 2 from the extended public key', function() {
HDPublicKey(vector2_m_public).xpubkey.should.equal(vector2_m_public);
});
it('should initialize test vector 2 from the extended private key', function() {
HDPrivateKey(vector2_m_private).xprivkey.should.equal(vector2_m_private);
});
it('should get the extended public key from the extended private key for test vector 2', function() {
HDPrivateKey(vector2_m_private).xpubkey.should.equal(vector2_m_public);
});
it("should get m/0 ext. private key from test vector 2", function() {
HDPrivateKey(vector2_m_private).derive(0).xprivkey.should.equal(vector2_m0_private);
});
it("should get m/0 ext. public key from test vector 2", function() {
HDPrivateKey(vector2_m_private).derive(0).xpubkey.should.equal(vector2_m0_public);
});
it("should get m/0 ext. public key from m public key from test vector 2", function() {
HDPrivateKey(vector2_m_private).hdPublicKey.derive(0).xpubkey.should.equal(vector2_m0_public);
});
it("should get m/0/2147483647h ext. private key from test vector 2", function() {
HDPrivateKey(vector2_m_private).derive("m/0/2147483647'")
.xprivkey.should.equal(vector2_m02147483647h_private);
});
it("should get m/0/2147483647h ext. public key from test vector 2", function() {
HDPrivateKey(vector2_m_private).derive("m/0/2147483647'")
.xpubkey.should.equal(vector2_m02147483647h_public);
});
it("should get m/0/2147483647h/1 ext. private key from test vector 2", function() {
HDPrivateKey(vector2_m_private).derive("m/0/2147483647'/1")
.xprivkey.should.equal(vector2_m02147483647h1_private);
});
it("should get m/0/2147483647h/1 ext. public key from test vector 2", function() {
HDPrivateKey(vector2_m_private).derive("m/0/2147483647'/1")
.xpubkey.should.equal(vector2_m02147483647h1_public);
});
it("should get m/0/2147483647h/1 ext. public key from m/0/2147483647h public key from test vector 2", function() {
var derived = HDPrivateKey(vector2_m_private).derive("m/0/2147483647'").hdPublicKey;
derived.derive(1).xpubkey.should.equal(vector2_m02147483647h1_public);
});
it("should get m/0/2147483647h/1/2147483646h ext. private key from test vector 2", function() {
HDPrivateKey(vector2_m_private).derive("m/0/2147483647'/1/2147483646'")
.xprivkey.should.equal(vector2_m02147483647h12147483646h_private);
});
it("should get m/0/2147483647h/1/2147483646h ext. public key from test vector 2", function() {
HDPrivateKey(vector2_m_private).derive("m/0/2147483647'/1/2147483646'")
.xpubkey.should.equal(vector2_m02147483647h12147483646h_public);
});
it("should get m/0/2147483647h/1/2147483646h/2 ext. private key from test vector 2", function() {
HDPrivateKey(vector2_m_private).derive("m/0/2147483647'/1/2147483646'/2")
.xprivkey.should.equal(vector2_m02147483647h12147483646h2_private);
});
it("should get m/0/2147483647h/1/2147483646h/2 ext. public key from test vector 2", function() {
HDPrivateKey(vector2_m_private).derive("m/0/2147483647'/1/2147483646'/2")
.xpubkey.should.equal(vector2_m02147483647h12147483646h2_public);
});
it("should get m/0/2147483647h/1/2147483646h/2 ext. public key from m/0/2147483647h/2147483646h public key from test vector 2", function() {
var derivedPublic = HDPrivateKey(vector2_m_private)
.derive("m/0/2147483647'/1/2147483646'").hdPublicKey;
derivedPublic.derive("m/2")
.xpubkey.should.equal(vector2_m02147483647h12147483646h2_public);
});
it('should use full 32 bytes for private key data that is hashed (as per bip32)', function() {
// https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki
var privateKeyBuffer = new Buffer('00000055378cf5fafb56c711c674143f9b0ee82ab0ba2924f19b64f5ae7cdbfd', 'hex');
var chainCodeBuffer = new Buffer('9c8a5c863e5941f3d99453e6ba66b328bb17cf0b8dec89ed4fc5ace397a1c089', 'hex');
var key = HDPrivateKey.fromObject({
network: 'testnet',
depth: 0,
parentFingerPrint: 0,
childIndex: 0,
privateKey: privateKeyBuffer,
chainCode: chainCodeBuffer
});
var derived = key.deriveChild("m/44'/0'/0'/0/0'");
derived.privateKey.toString().should.equal('3348069561d2a0fb925e74bf198762acc47dce7db27372257d2d959a9e6f8aeb');
});
it('should NOT use full 32 bytes for private key data that is hashed with nonCompliant flag', function() {
// This is to test that the previously implemented non-compliant to BIP32
var privateKeyBuffer = new Buffer('00000055378cf5fafb56c711c674143f9b0ee82ab0ba2924f19b64f5ae7cdbfd', 'hex');
var chainCodeBuffer = new Buffer('9c8a5c863e5941f3d99453e6ba66b328bb17cf0b8dec89ed4fc5ace397a1c089', 'hex');
var key = HDPrivateKey.fromObject({
network: 'testnet',
depth: 0,
parentFingerPrint: 0,
childIndex: 0,
privateKey: privateKeyBuffer,
chainCode: chainCodeBuffer
});
var derived = key.deriveNonCompliantChild("m/44'/0'/0'/0/0'");
derived.privateKey.toString().should.equal('4811a079bab267bfdca855b3bddff20231ff7044e648514fa099158472df2836');
});
it('should NOT use full 32 bytes for private key data that is hashed with the nonCompliant derive method', function() {
// This is to test that the previously implemented non-compliant to BIP32
var privateKeyBuffer = new Buffer('00000055378cf5fafb56c711c674143f9b0ee82ab0ba2924f19b64f5ae7cdbfd', 'hex');
var chainCodeBuffer = new Buffer('9c8a5c863e5941f3d99453e6ba66b328bb17cf0b8dec89ed4fc5ace397a1c089', 'hex');
var key = HDPrivateKey.fromObject({
network: 'testnet',
depth: 0,
parentFingerPrint: 0,
childIndex: 0,
privateKey: privateKeyBuffer,
chainCode: chainCodeBuffer
});
var derived = key.derive("m/44'/0'/0'/0/0'");
derived.privateKey.toString().should.equal('4811a079bab267bfdca855b3bddff20231ff7044e648514fa099158472df2836');
});
describe('edge cases', function() {
var sandbox = sinon.sandbox.create();
afterEach(function() {
sandbox.restore();
});
it('will handle edge case that derived private key is invalid', function() {
var invalid = new Buffer('0000000000000000000000000000000000000000000000000000000000000000', 'hex');
var privateKeyBuffer = new Buffer('5f72914c48581fc7ddeb944a9616389200a9560177d24f458258e5b04527bcd1', 'hex');
var chainCodeBuffer = new Buffer('39816057bba9d952fe87fe998b7fd4d690a1bb58c2ff69141469e4d1dffb4b91', 'hex');
var unstubbed = bitcore.crypto.BN.prototype.toBuffer;
var count = 0;
var stub = sandbox.stub(bitcore.crypto.BN.prototype, 'toBuffer', function(args) {
// On the fourth call to the function give back an invalid private key
// otherwise use the normal behavior.
count++;
if (count === 4) {
return invalid;
}
var ret = unstubbed.apply(this, arguments);
return ret;
});
sandbox.spy(bitcore.PrivateKey, 'isValid');
var key = HDPrivateKey.fromObject({
network: 'testnet',
depth: 0,
parentFingerPrint: 0,
childIndex: 0,
privateKey: privateKeyBuffer,
chainCode: chainCodeBuffer
});
var derived = key.derive("m/44'");
derived.privateKey.toString().should.equal('b15bce3608d607ee3a49069197732c656bca942ee59f3e29b4d56914c1de6825');
bitcore.PrivateKey.isValid.callCount.should.equal(2);
});
it('will handle edge case that a derive public key is invalid', function() {
var publicKeyBuffer = new Buffer('029e58b241790284ef56502667b15157b3fc58c567f044ddc35653860f9455d099', 'hex');
var chainCodeBuffer = new Buffer('39816057bba9d952fe87fe998b7fd4d690a1bb58c2ff69141469e4d1dffb4b91', 'hex');
var key = new HDPublicKey({
network: 'testnet',
depth: 0,
parentFingerPrint: 0,
childIndex: 0,
chainCode: chainCodeBuffer,
publicKey: publicKeyBuffer
});
var unstubbed = bitcore.PublicKey.fromPoint;
bitcore.PublicKey.fromPoint = function() {
bitcore.PublicKey.fromPoint = unstubbed;
throw new Error('Point cannot be equal to Infinity');
};
sandbox.spy(key, '_deriveWithNumber');
var derived = key.derive("m/44");
key._deriveWithNumber.callCount.should.equal(2);
key.publicKey.toString().should.equal('029e58b241790284ef56502667b15157b3fc58c567f044ddc35653860f9455d099');
});
});
describe('seed', function() {
it('should initialize a new BIP32 correctly from test vector 1 seed', function() {
var seededKey = HDPrivateKey.fromSeed(vector1_master, Networks.livenet);
seededKey.xprivkey.should.equal(vector1_m_private);
seededKey.xpubkey.should.equal(vector1_m_public);
});
it('should initialize a new BIP32 correctly from test vector 2 seed', function() {
var seededKey = HDPrivateKey.fromSeed(vector2_master, Networks.livenet);
seededKey.xprivkey.should.equal(vector2_m_private);
seededKey.xpubkey.should.equal(vector2_m_public);
});
});
});
//test vectors: https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki
var vector1_master = '000102030405060708090a0b0c0d0e0f';
var vector1_m_public = 'xpub661MyMwAqRbcGxrvrFF3K5Qgv7EAvnaQt6PSG2rjgHkHc1cvGFLiNVye6P73Xm9jhj73z36x1DubuSGfHMC78xTbJndGmDzgopqMdScqejv';
var vector1_m_private = 'xprv9s21ZrQH143K4UnTkDi2wwTxN5PgXKrZWsTqTeT87xDJjDHmii2TphfAF81fLmYZ8QcFCGDJDeC65jLtXeUzDFcdyrss3KCK5FaM1GkuZNg';
var vector1_m0h_public = 'xpub69UUnoYGv6YSxRQXQUDY5F7vmRUx9i3xfq99hVTXn2RBA47pRg9qw8BWRfJUXCvY8axhQ2PZtUQqBHWvz2xJY68iucXko1mWsqRLXYDQnP1';
var vector1_m0h_private = 'xprv9vV8PJ1P5iz9jwL4JSgXi7BCDPeTkFL7JcDYu73vDgtCHFnft8qbPKs2aMs3FsBNkTaUbpmCPX4Zeffi7apY4fsgoXdeWyqp887MRx9gNSF';
var vector1_m0h1_public = 'xpub69u5rXAWmUDhYyDoUf6yjHHocvmA9PwTDfE5LrSTMdizj6mLBDmhZz6MV4C8a2mfQFbfYZvASRPsbapR54A2LzTRhNZvbSBQLHBMDni4dgn';
var vector1_m0h1_private = 'xprv9vujT1dcw6fQLV9LNdZyN9M54tvfjwDbrSJUYU2qoJC1rJSBdgTT2BmsdjvtuR3LWY29PNXFVMAduzv6TfxhvT5UVU2C4b62tzrspLXn8Mn';
var vector1_m0h12h_public = 'xpub6CMow9Y2e3aggLmkXiYZp61ocGMNoszVkyMRPfXB2ZoHtdgRMK6RV7hL43MEBUU9QX1sCmNCRNhqCY3as8q21MAngyM5sJLsbnsZV11fyEy';
var vector1_m0h12h_private = 'xprv9yNTXe18og2PTrhHRh1ZSx554EWtQRGePkRpbH7ZUEGK1qMGomnAwKNrCmaeeqHt4HB8xgRbEwskya9vqgSW8mtpv7q4xUReHQtcS3mFYTV';
var vector1_m0h12h2_public = 'xpub6EU1GDGNBBcpJNxgaHUBcgBzMEpRyJLCRyKfR1PyTsjZgdY4sVJJdb8kYzMrNNWSqsEK3rNcjgvGVjvXtSmK3s26bFTQ5qRZWWUNrMyjFca';
var vector1_m0h12h2_private = 'xprvA1UerhjULp4X5ttDUFwBFYFFoCywZqcM4kQ4cczMuYCaoqCvKwz45npGhijxDsek9AQ8taDz1FGrA71g4L4hBVxNFpEcYCf5kqpnXHqGANz';
var vector1_m0h12h21000000000_public = 'xpub6Gn8AdPJnw8ufpgryp5MRJTAiBZE5bM7GGHcXr5wzofr8ehTEz45VqPAn5uH9Pq9ww7VKkFcQt7SpzCDkr6hrnrG84fm33yvR4GYJ8w8Dm6';
var vector1_m0h12h21000000000_private = 'xprvA3nmm7rQxZacTLcPsnYM4AWSA9ijg8dFu3N1jTgLSU8sFrNJhSjpx34gvqFuLgJ8K88tVWF6jC4dcL3SETPHkHr3jn72TiizDTNqb6VS3i5';
var vector2_master = 'fffcf9f6f3f0edeae7e4e1dedbd8d5d2cfccc9c6c3c0bdbab7b4b1aeaba8a5a29f9c999693908d8a8784817e7b7875726f6c696663605d5a5754514e4b484542';
var vector2_m_public = 'xpub661MyMwAqRbcGHR8x3rokSLDrkCuqDj1fiqQBjQZvmDAEMpBb6oN95DSvzAoP5cBvQq4DoDicJL2djspA4mqutQrEiUmvpRiHnGXthpnfyY';
var vector2_m_private = 'xprv9s21ZrQH143K3oLfr2KoPJPVJiNRRm1AJVuoPLzxNRgBMZV33ZV7bGty5gjbkr5QMudCMAzM25xjQZDjmH9qA4buSgs76qy5UXuyxfPytvi';
var vector2_m0_public = 'xpub69BfP63rcCauJ5qZLR1qqRi6g63yoD4Le4ZxQEv4MH8Ra4TEng3A7h6Wk2tr9Kf2Fg1QEMmKt6dLeTtL1y5LWmCWttHSmLHUPU4s4Ssp4i1';
var vector2_m0_private = 'xprv9vCJyaWxmq2c5bm6EPUqUHmN84DVPkLVGqeMbrWSnwbShG86F8iuZtn2tiUzpy263WCC4XTCxdQWxzfmmEqNEUWhHWeVsAQXoTFdUmGLC66';
var vector2_m02147483647h_public = 'xpub6ABNrfFq6WaW6MvHS374Kb2oNFqcxFBGpumY4UmfBjRWwRq2h6TxzKaQQeP3kqMwkJ8hDv1UVcQeMFwW8yKsQWCAVkwUcQs6UFdcwAXxmPQ';
var vector2_m02147483647h_private = 'xprv9wC2T9iwG92CssqpL1a3xT64pE18YnTRTgqwG6N3dPtY4dVt9Z9iSXFvZN5AfPjjDbHFknrqxYCB1EyHW3xrDsYNGYeG1kQ8G2MX7BsAsD5';
var vector2_m02147483647h1_public = 'xpub6BiG5b9RDEgwZroGXkpraMZzPpTMeLNwCZkfJ3LXPJXFDVifs5CHoYh6ikZR6Ns9mdrrBXrJQrpm1fynyzVpbPg7rocv4V4mpmdm7NBrAoq';
var vector2_m02147483647h1_private = 'xprv9xiug5cXNs8eMNioRjHrDDdFqncsEsf5qLq4VevupxzGLhPXKXt3FkNcsTb1iFxjg1MQTHofzm9tqAW1EMVjyeYGJq6jyV2gaYQZGcHZ29i';
var vector2_m02147483647h12147483646h_public = 'xpub6Dfc3mURg3BhE2XvmewwvCgbkSrxrb2esXyuzfdxv1rFMDS7wAqDdYuPYpS1kw71KbfBtPxSukJNaiHZxfDGXJDN1JMmqVKGViDQY8VSG2x';
var vector2_m02147483647h12147483646h_private = 'xprv9zgFeFwXqfdQ1YTTfdQwZ4jsCR2UT8JoWK4KCHEMMgKGUR6yPdWy5kauhZRr6EfWNy3VoQnpQ5fLT623qgTJLjiMkGYQnr3f7ZAZMstXiCN';
var vector2_m02147483647h12147483646h2_public = 'xpub6GYy5XRtwnSHd7VpZKkRbeGBPb4kpJ9U66wtAGd7oa6BVCeBTCKyfzzkTPJSKEHowkVjNdxYVtSRMenxXBYuvdGkx8z9GVtiGs8qqAfBARn';
var vector2_m02147483647h12147483646h2_private = 'xprvA3Zcg1u17QszQdRMTJDREWKSqZEGQqRcit2HMtDWFEZCcQK2uf1j8CgGc7Xchb9pWCenJHDF9wNZzDBpcDkN4rQWVZiWgtRxd2koRgpKMqu';