bitcoinjs-lib/test/hdnode.js

294 lines
8.5 KiB
JavaScript

/* global describe, it */
/* eslint-disable no-new */
var assert = require('assert')
var networks = require('../src/networks')
var BigInteger = require('bigi')
var ECKey = require('../src/eckey')
var ECPubKey = require('../src/ecpubkey')
var HDNode = require('../src/hdnode')
var ecurve = require('ecurve')
var curve = ecurve.getCurveByName('secp256k1')
var fixtures = require('./fixtures/hdnode.json')
describe('HDNode', function () {
describe('Constructor', function () {
var d = BigInteger.ONE
var Q = curve.G.multiply(d)
var chainCode = new Buffer(32)
chainCode.fill(1)
it('calculates the publicKey from a BigInteger', function () {
var hd = new HDNode(d, chainCode)
assert(hd.pubKey.Q.equals(Q))
})
it('allows initialization directly from an ECKey', function () {
var ek = new ECKey(d)
var hd = new HDNode(ek, chainCode)
assert.equal(hd.privKey, ek)
})
it('allows initialization directly from an ECPubKey', function () {
var ek = new ECPubKey(Q)
var hd = new HDNode(ek, chainCode)
assert.equal(hd.pubKey, ek)
})
it('throws if ECKey is not compressed', function () {
var ek = new ECKey(d, false)
assert.throws(function () {
new HDNode(ek, chainCode)
}, /ECKey must be compressed/)
})
it('throws if ECPubKey is not compressed', function () {
var ek = new ECPubKey(Q, false)
assert.throws(function () {
new HDNode(ek, chainCode)
}, /ECPubKey must be compressed/)
})
it('only uses compressed points', function () {
var hd = new HDNode(Q, chainCode)
var hdP = new HDNode(d, chainCode)
assert.strictEqual(hd.pubKey.compressed, true)
assert.strictEqual(hdP.pubKey.compressed, true)
})
it('has a default depth/index of 0', function () {
var hd = new HDNode(Q, chainCode)
assert.strictEqual(hd.depth, 0)
assert.strictEqual(hd.index, 0)
})
it('defaults to the bitcoin network', function () {
var hd = new HDNode(Q, chainCode)
assert.equal(hd.network, networks.bitcoin)
})
it('supports alternative networks', function () {
var hd = new HDNode(Q, chainCode, networks.testnet)
assert.equal(hd.network, networks.testnet)
})
it('throws when an invalid length chain code is given', function () {
assert.throws(function () {
new HDNode(d, chainCode.slice(0, 20), networks.testnet)
}, /Expected chainCode length of 32, got 20/)
})
it('throws when an unknown network is given', function () {
assert.throws(function () {
new HDNode(d, chainCode, {})
}, /Unknown BIP32 constants for network/)
})
})
describe('fromSeed*', function () {
fixtures.valid.forEach(function (f) {
it('calculates privKey and chainCode for ' + f.master.fingerprint, function () {
var network = networks[f.network]
var hd = HDNode.fromSeedHex(f.master.seed, network)
assert.equal(hd.privKey.toWIF(network), f.master.wif)
assert.equal(hd.chainCode.toString('hex'), f.master.chainCode)
})
})
it('throws on low entropy seed', function () {
assert.throws(function () {
HDNode.fromSeedHex('ffffffffff')
}, /Seed should be at least 128 bits/)
})
it('throws on too high entropy seed', function () {
assert.throws(function () {
HDNode.fromSeedHex('ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff')
}, /Seed should be at most 512 bits/)
})
})
describe('toBase58', function () {
fixtures.valid.forEach(function (f) {
it('exports ' + f.master.base58 + ' (public) correctly', function () {
var network = networks[f.network]
var hd = HDNode.fromSeedHex(f.master.seed, network).neutered()
assert.equal(hd.toBase58(), f.master.base58)
})
})
fixtures.valid.forEach(function (f) {
it('exports ' + f.master.base58Priv + ' (private) correctly', function () {
var network = networks[f.network]
var hd = HDNode.fromSeedHex(f.master.seed, network)
assert.equal(hd.toBase58(), f.master.base58Priv)
})
})
})
describe('fromBase58', function () {
fixtures.valid.forEach(function (f) {
it('imports ' + f.master.base58 + ' (public) correctly', function () {
var network = networks[f.network]
var hd = HDNode.fromBase58(f.master.base58)
assert.equal(hd.toBase58(), f.master.base58)
assert.equal(hd.network, network)
})
})
fixtures.valid.forEach(function (f) {
it('imports ' + f.master.base58Priv + ' (private) correctly', function () {
var network = networks[f.network]
var hd = HDNode.fromBase58(f.master.base58Priv, network)
assert.equal(hd.toBase58(), f.master.base58Priv)
assert.equal(hd.network, network)
})
})
fixtures.invalid.fromBase58.forEach(function (f) {
it('throws on ' + f.string, function () {
assert.throws(function () {
var network = networks[f.network]
HDNode.fromBase58(f.string, network)
}, new RegExp(f.exception))
})
})
})
describe('getIdentifier', function () {
var f = fixtures.valid[0]
it('returns the identifier for ' + f.master.fingerprint, function () {
var hd = HDNode.fromBase58(f.master.base58)
assert.equal(hd.getIdentifier().toString('hex'), f.master.identifier)
})
})
describe('getFingerprint', function () {
var f = fixtures.valid[0]
it('returns the fingerprint for ' + f.master.fingerprint, function () {
var hd = HDNode.fromBase58(f.master.base58)
assert.equal(hd.getFingerprint().toString('hex'), f.master.fingerprint)
})
})
describe('getAddress', function () {
fixtures.valid.forEach(function (f) {
it('returns ' + f.master.address + ' for ' + f.master.fingerprint, function () {
var hd = HDNode.fromBase58(f.master.base58)
assert.equal(hd.getAddress().toString(), f.master.address)
})
})
})
describe('neutered', function () {
var f = fixtures.valid[0]
it('strips all private information', function () {
var hd = HDNode.fromBase58(f.master.base58)
var hdn = hd.neutered()
assert.equal(hdn.privKey, undefined)
assert.equal(hdn.pubKey.toHex(), hd.pubKey.toHex())
assert.equal(hdn.chainCode, hd.chainCode)
assert.equal(hdn.depth, hd.depth)
assert.equal(hdn.index, hd.index)
})
})
describe('derive', function () {
function verifyVector (hd, network, v, depth) {
assert.equal(hd.privKey.toWIF(network), v.wif)
assert.equal(hd.pubKey.toHex(), v.pubKey)
assert.equal(hd.chainCode.toString('hex'), v.chainCode)
assert.equal(hd.depth, depth || 0)
if (v.hardened) {
assert.equal(hd.index, v.m + HDNode.HIGHEST_BIT)
} else {
assert.equal(hd.index, v.m)
}
}
fixtures.valid.forEach(function (f) {
var network = networks[f.network]
var hd = HDNode.fromSeedHex(f.master.seed, network)
// FIXME: test data is only testing Private -> private for now
f.children.forEach(function (c, i) {
it(c.description + ' from ' + f.master.fingerprint, function () {
if (c.hardened) {
hd = hd.deriveHardened(c.m)
} else {
hd = hd.derive(c.m)
}
verifyVector(hd, network, c, i + 1)
})
})
})
it('works for Private -> public (neutered)', function () {
var f = fixtures.valid[1]
var c = f.children[0]
var master = HDNode.fromBase58(f.master.base58Priv)
var child = master.derive(c.m).neutered()
assert.equal(child.toBase58(), c.base58)
})
it('works for Private -> public (neutered, hardened)', function () {
var f = fixtures.valid[0]
var c = f.children[0]
var master = HDNode.fromBase58(f.master.base58Priv)
var child = master.deriveHardened(c.m).neutered()
assert.equal(child.toBase58(), c.base58)
})
it('works for Public -> public', function () {
var f = fixtures.valid[1]
var c = f.children[0]
var master = HDNode.fromBase58(f.master.base58)
var child = master.derive(c.m)
assert.equal(child.toBase58(), c.base58)
})
it('throws on Public -> public (hardened)', function () {
var f = fixtures.valid[0]
var c = f.children[0]
var master = HDNode.fromBase58(f.master.base58)
assert.throws(function () {
master.deriveHardened(c.m)
}, /Could not derive hardened child key/)
})
})
})