bitcoinjs-lib/test/hdnode.js

289 lines
8.2 KiB
JavaScript
Raw Normal View History

var assert = require('assert')
var networks = require('../src/networks')
2014-06-01 08:05:47 +02:00
var BigInteger = require('bigi')
2014-06-03 09:08:42 +02:00
var HDNode = require('../src/hdnode')
2014-04-16 22:18:31 +02:00
2014-06-07 08:24:27 +02:00
var ecurve = require('ecurve')
var curve = ecurve.getCurveByName('secp256k1')
2014-06-03 09:08:42 +02:00
var fixtures = require('./fixtures/hdnode.json')
2014-06-03 09:08:42 +02:00
describe('HDNode', function() {
2014-06-01 08:05:47 +02:00
describe('Constructor', function() {
var d = BigInteger.ONE
2014-06-15 17:36:05 +02:00
var Q = curve.G.multiply(d)
2014-06-01 08:05:47 +02:00
var chainCode = new Buffer(32)
chainCode.fill(1)
it('calculates the publicKey from a BigInteger', function() {
var hd = new HDNode(d, chainCode)
2014-06-01 08:05:47 +02:00
assert(hd.pubKey.Q.equals(Q))
2014-06-01 08:05:47 +02:00
})
it('only uses compressed points', function() {
2014-06-03 09:08:42 +02:00
var hd = new HDNode(Q, chainCode)
var hdP = new HDNode(d, chainCode)
2014-06-01 08:05:47 +02:00
assert.strictEqual(hd.pubKey.compressed, true)
assert.strictEqual(hdP.pubKey.compressed, true)
2014-06-01 08:05:47 +02:00
})
it('has a default depth/index of 0', function() {
2014-06-03 09:08:42 +02:00
var hd = new HDNode(Q, chainCode)
2014-06-01 08:05:47 +02:00
assert.strictEqual(hd.depth, 0)
assert.strictEqual(hd.index, 0)
})
it('defaults to the bitcoin network', function() {
2014-06-03 09:08:42 +02:00
var hd = new HDNode(Q, chainCode)
2014-06-01 08:05:47 +02:00
assert.equal(hd.network, networks.bitcoin)
})
it('supports alternative networks', function() {
2014-06-03 09:08:42 +02:00
var hd = new HDNode(Q, chainCode, networks.testnet)
2014-06-01 08:05:47 +02:00
assert.equal(hd.network, networks.testnet)
})
it('throws an exception when an unknown network is given', function() {
assert.throws(function() {
new HDNode(d, chainCode, {})
2014-06-01 08:05:47 +02:00
}, /Unknown BIP32 constants for network/)
})
})
describe('fromSeed*', function() {
fixtures.valid.forEach(function(f) {
it('calculates privKey and chainCode for ' + f.master.fingerprint, function() {
2014-06-03 09:08:42 +02:00
var hd = HDNode.fromSeedHex(f.master.seed)
2014-06-01 08:05:47 +02:00
assert.equal(hd.privKey.toWIF(), f.master.wif)
2014-06-01 08:05:47 +02:00
assert.equal(hd.chainCode.toString('hex'), f.master.chainCode)
})
})
})
2014-03-31 05:47:47 +02:00
describe('toBase58', function() {
2014-06-01 08:05:47 +02:00
fixtures.valid.forEach(function(f) {
it('exports ' + f.master.base58 + ' (public) correctly', function() {
2014-06-03 09:08:42 +02:00
var hd = HDNode.fromSeedHex(f.master.seed)
2014-06-01 08:05:47 +02:00
assert.equal(hd.toBase58(false), f.master.base58)
2014-06-01 08:05:47 +02:00
})
})
2014-06-01 08:05:47 +02:00
fixtures.valid.forEach(function(f) {
it('exports ' + f.master.base58Priv + ' (private) correctly', function() {
2014-06-03 09:08:42 +02:00
var hd = HDNode.fromSeedHex(f.master.seed)
2014-06-01 08:05:47 +02:00
assert.equal(hd.toBase58(true), f.master.base58Priv)
})
2014-03-31 05:47:47 +02:00
})
2014-06-01 08:05:47 +02:00
it('fails when there is no private key', function() {
2014-06-03 09:08:42 +02:00
var hd = HDNode.fromBase58(fixtures.valid[0].master.base58)
2014-05-31 07:24:03 +02:00
assert.throws(function() {
2014-03-31 05:47:47 +02:00
hd.toBase58(true)
2014-05-31 07:24:03 +02:00
}, /Missing private key/)
})
2014-03-31 05:47:47 +02:00
})
describe('fromBase58', function() {
2014-06-01 08:05:47 +02:00
fixtures.valid.forEach(function(f) {
it('imports ' + f.master.base58 + ' (public) correctly', function() {
2014-06-03 09:08:42 +02:00
var hd = HDNode.fromBase58(f.master.base58)
2014-06-01 08:05:47 +02:00
assert.equal(hd.toBase58(), f.master.base58)
})
})
fixtures.valid.forEach(function(f) {
it('imports ' + f.master.base58Priv + ' (private) correctly', function() {
2014-06-03 09:08:42 +02:00
var hd = HDNode.fromBase58(f.master.base58Priv)
2014-06-01 08:05:47 +02:00
assert.equal(hd.toBase58(), f.master.base58Priv)
2014-06-01 08:05:47 +02:00
})
})
fixtures.invalid.fromBase58.forEach(function(f) {
it('throws on ' + f.string, function() {
assert.throws(function() {
2014-06-03 09:08:42 +02:00
HDNode.fromBase58(f.string)
}, new RegExp(f.exception))
})
})
})
2014-06-01 08:39:07 +02:00
describe('fromBuffer/fromHex', function() {
2014-06-01 08:05:47 +02:00
fixtures.valid.forEach(function(f) {
it('imports ' + f.master.hex + ' (public) correctly', function() {
2014-06-03 09:08:42 +02:00
var hd = HDNode.fromHex(f.master.hex)
2014-06-01 08:05:47 +02:00
assert.equal(hd.toBuffer().toString('hex'), f.master.hex)
})
})
2014-06-01 08:05:47 +02:00
fixtures.valid.forEach(function(f) {
it('imports ' + f.master.hexPriv + ' (private) correctly', function() {
2014-06-03 09:08:42 +02:00
var hd = HDNode.fromHex(f.master.hexPriv)
assert.equal(hd.toBuffer().toString('hex'), f.master.hexPriv)
2014-06-01 08:05:47 +02:00
})
2014-03-31 05:47:47 +02:00
})
2014-06-01 08:05:47 +02:00
fixtures.invalid.fromBuffer.forEach(function(f) {
2014-06-04 07:30:53 +02:00
it('throws on ' + f.hex, function() {
2014-06-01 08:05:47 +02:00
assert.throws(function() {
2014-06-03 09:08:42 +02:00
HDNode.fromHex(f.hex)
2014-06-01 08:05:47 +02:00
}, new RegExp(f.exception))
2014-03-31 05:47:47 +02:00
})
})
2014-03-31 05:47:47 +02:00
})
2014-06-01 08:39:07 +02:00
describe('toBuffer/toHex', function() {
fixtures.valid.forEach(function(f) {
it('exports ' + f.master.hex + ' (public) correctly', function() {
2014-06-03 09:08:42 +02:00
var hd = HDNode.fromSeedHex(f.master.seed)
2014-06-01 08:39:07 +02:00
assert.equal(hd.toHex(false), f.master.hex)
2014-06-01 08:39:07 +02:00
})
})
fixtures.valid.forEach(function(f) {
it('exports ' + f.master.hexPriv + ' (private) correctly', function() {
2014-06-03 09:08:42 +02:00
var hd = HDNode.fromSeedHex(f.master.seed)
2014-06-01 08:39:07 +02:00
assert.equal(hd.toHex(true), f.master.hexPriv)
})
})
it('fails when there is no private key', function() {
2014-06-03 09:08:42 +02:00
var hd = HDNode.fromHex(fixtures.valid[0].master.hex)
2014-06-01 08:39:07 +02:00
assert.throws(function() {
hd.toHex(true)
}, /Missing private key/)
})
})
2014-06-01 08:05:47 +02:00
describe('getIdentifier', function() {
var f = fixtures.valid[0]
2014-06-01 08:05:47 +02:00
it('returns the identifier for ' + f.master.fingerprint, function() {
2014-06-03 09:08:42 +02:00
var hd = HDNode.fromBase58(f.master.base58)
2014-06-01 08:05:47 +02:00
assert.equal(hd.getIdentifier().toString('hex'), f.master.identifier)
})
2014-03-31 05:47:47 +02:00
})
2014-06-01 08:05:47 +02:00
describe('getFingerprint', function() {
var f = fixtures.valid[0]
2014-05-04 03:40:48 +02:00
2014-06-01 08:05:47 +02:00
it('returns the fingerprint for ' + f.master.fingerprint, function() {
2014-06-03 09:08:42 +02:00
var hd = HDNode.fromBase58(f.master.base58)
2014-06-01 08:05:47 +02:00
assert.equal(hd.getFingerprint().toString('hex'), f.master.fingerprint)
2014-05-04 03:40:48 +02:00
})
})
2014-06-01 08:05:47 +02:00
describe('getAddress', function() {
var f = fixtures.valid[0]
2014-06-03 09:22:13 +02:00
it('returns the Address (pubHash) for ' + f.master.fingerprint, function() {
2014-06-03 09:08:42 +02:00
var hd = HDNode.fromBase58(f.master.base58)
2014-06-01 08:05:47 +02:00
assert.equal(hd.getAddress().toString(), f.master.address)
})
2014-06-01 08:05:47 +02:00
it('supports alternative networks', function() {
2014-06-03 09:08:42 +02:00
var hd = HDNode.fromBase58(f.master.base58)
2014-06-01 08:05:47 +02:00
hd.network = networks.testnet
2014-06-17 13:05:18 +02:00
assert.equal(hd.getAddress().version, networks.testnet.pubKeyHash)
})
2014-06-01 08:05:47 +02:00
})
2014-06-01 08:05:47 +02:00
describe('derive', function() {
function verifyVector(hd, v, depth) {
assert.equal(hd.privKey.toWIF(), v.wif)
assert.equal(hd.pubKey.toHex(), v.pubKey)
2014-06-01 08:05:47 +02:00
assert.equal(hd.chainCode.toString('hex'), v.chainCode)
assert.equal(hd.depth, depth || 0)
if (v.hardened) {
2014-06-03 09:08:42 +02:00
assert.equal(hd.index, v.m + HDNode.HIGHEST_BIT)
2014-06-01 08:05:47 +02:00
} else {
assert.equal(hd.index, v.m)
}
}
2014-06-01 08:05:47 +02:00
fixtures.valid.forEach(function(f, j) {
2014-06-03 09:08:42 +02:00
var hd = HDNode.fromSeedHex(f.master.seed)
2014-06-03 09:22:13 +02:00
// FIXME: test data is only testing Private -> private for now
2014-06-01 08:05:47 +02:00
f.children.forEach(function(c, i) {
it(c.description + ' from ' + f.master.fingerprint, function() {
if (c.hardened) {
hd = hd.deriveHardened(c.m)
2014-06-01 08:05:47 +02:00
} else {
hd = hd.derive(c.m)
}
2014-06-01 08:05:47 +02:00
verifyVector(hd, c, i + 1)
})
})
})
2014-06-03 08:13:20 +02:00
2014-06-03 09:22:13 +02:00
it('works for Private -> public (neutered)', function() {
var f = fixtures.valid[1]
var c = f.children[0]
var parentNode = HDNode.fromBase58(f.master.base58Priv)
var child = parentNode.derive(c.m)
// FIXME: N(CKDpriv((kpar, cpar), i)), could be done better...
var childNeutered = HDNode.fromBase58(child.toBase58(false)) // neuter
assert.equal(childNeutered.toBase58(), c.base58)
})
it('works for Private -> public (neutered, hardened)', function() {
var f = fixtures.valid[0]
var c = f.children[0]
var parentNode = HDNode.fromBase58(f.master.base58Priv)
var child = parentNode.deriveHardened(c.m)
// FIXME: N(CKDpriv((kpar, cpar), i)), could be done better...
var childNeutered = HDNode.fromBase58(child.toBase58(false)) // neuter
assert.equal(childNeutered.toBase58(), c.base58)
})
it('works for Public -> public', function() {
2014-06-03 08:13:20 +02:00
var f = fixtures.valid[1]
var c = f.children[0]
2014-06-03 09:08:42 +02:00
var parentNode = HDNode.fromBase58(f.master.base58)
var child = parentNode.derive(c.m)
2014-06-03 08:13:20 +02:00
assert.equal(child.toBase58(), c.base58)
})
2014-06-03 09:22:13 +02:00
it('throws on Public -> public (hardened)', function() {
var f = fixtures.valid[0]
2014-06-03 08:13:20 +02:00
var c = f.children[0]
2014-06-03 09:08:42 +02:00
var parentNode = HDNode.fromBase58(f.master.base58)
2014-06-03 08:13:20 +02:00
assert.throws(function() {
2014-06-03 09:08:42 +02:00
parentNode.deriveHardened(c.m)
2014-06-03 08:13:20 +02:00
}, /Could not derive hardened child key/)
})
2014-03-31 05:47:47 +02:00
})
})