rename BIP32 -> HierarchicalKey, deprecate BIP32

Sounds better.

bitcore.js

@@ -35,7 +35,11 @@ requireWhenAccessed('EncodedData', './util/EncodedData');
 requireWhenAccessed('VersionedData', './util/VersionedData');
 requireWhenAccessed('BinaryParser', './util/BinaryParser');
 requireWhenAccessed('Address', './lib/Address');
-requireWhenAccessed('BIP32', './lib/BIP32');
+requireWhenAccessed('HierarchicalKey', './lib/HierarchicalKey');
+Object.defineProperty(module.exports, 'BIP32', {get: function() {
+  console.log('BIP32 is deprecated. Use bitcore.HierarchicalKey instead.');
+  return require('./lib/HierarchicalKey');
+}});
 requireWhenAccessed('Point', './lib/Point');
 requireWhenAccessed('Opcode', './lib/Opcode');
 requireWhenAccessed('Script', './lib/Script');

browser/build.js

@@ -26,7 +26,7 @@ var modules = [
   'lib/Address',
   'lib/Armory',
   'lib/Base58',
-  'lib/BIP32',
+  'lib/HierarchicalKey',
   'lib/Block',
   'lib/Bloom',
   'lib/Connection',

examples/HierarchicalKey.js

@@ -0,0 +1,83 @@
+var run = function() {
+  bitcore = typeof (bitcore) === 'undefined' ? require('../bitcore') : bitcore;
+  var HierarchicalKey = bitcore.HierarchicalKey;
+  var Address = bitcore.Address;
+  var networks = bitcore.networks;
+  var coinUtil = bitcore.util;
+  var crypto = require('crypto');
+
+  console.log('HierarchicalKey: Hierarchical Deterministic Wallets (BIP32)');
+  console.log('https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki\n');
+  console.log('1) Make new hkey from randomly generated new seed');
+
+  var randomBytes = crypto.randomBytes(256);
+  var hkey = HierarchicalKey.seed(randomBytes);
+  console.log('master extended private key: ' + hkey.extendedPrivateKeyString());
+  console.log('master extended public key: ' + hkey.extendedPublicKeyString());
+  console.log('m/0/3/5 extended private key: ' + hkey.derive('m/0/3/5').extendedPrivateKeyString());
+  console.log('m/0/3/5 extended public key: ' + hkey.derive('m/0/3/5').extendedPublicKeyString());
+  console.log();
+
+  console.log('2) Make new hkey from known seed');
+  var knownBytes = coinUtil.sha256('do not use this password as a brain wallet');
+  var hkey = HierarchicalKey.seed(knownBytes);
+  console.log('master extended private key: ' + hkey.extendedPrivateKeyString());
+  console.log('master extended public key: ' + hkey.extendedPublicKeyString());
+  console.log('m/0/3/5 extended private key: ' + hkey.derive('m/0/3/5').extendedPrivateKeyString());
+  console.log('m/0/3/5 extended public key: ' + hkey.derive('m/0/3/5').extendedPublicKeyString());
+  console.log();
+
+  console.log('3) Make new hkey from known master private key');
+  var knownMasterPrivateKey = 'xprv9s21ZrQH143K2LvayFZWVVTomiDKheKWvnupDB8fmjKwxkKG47uvzmFa3vCXoy9fxPJhRYsU19apVfexvMeLpJQuF2XtX1zRF3eao9GqqaQ';
+  var hkey = new HierarchicalKey(knownMasterPrivateKey);
+  console.log('master extended private key: ' + hkey.extendedPrivateKeyString());
+  console.log('master extended public key: ' + hkey.extendedPublicKeyString());
+  console.log('m/0/3/5 extended private key: ' + hkey.derive('m/0/3/5').extendedPrivateKeyString());
+  console.log('m/0/3/5 extended public key: ' + hkey.derive('m/0/3/5').extendedPublicKeyString());
+  console.log();
+
+  console.log('4) Make new hkey from known master public key');
+  var knownMasterPublicKey = 'xpub661MyMwAqRbcGpiFufipqsKKBG1NHNwfJKishAEFNqJ6ryLcKeKyFNEZces7gMWd4XGg4uUhXy8DS64o1oPGUECVHeLq957Txjwagxt475H';
+  var hkey = new HierarchicalKey(knownMasterPublicKey);
+  console.log('master extended private key: cannot derive');
+  console.log('master extended public key: ' + hkey.extendedPublicKeyString());
+  console.log('m/0/3/5 extended private key: cannot derive');
+  console.log('m/0/3/5 extended public key: ' + hkey.derive('m/0/3/5').extendedPublicKeyString());
+  console.log();
+
+  console.log('5) Make new hkey from known derived public key');
+  var knownPublicKey = 'xpub6CZei1p2zk68UwkcBDqzRonLHJWAiPZZ58sMgHJAn9fmpmnPayVEAvAs3XvTSUMZ1J8dNaxnv4wnt7YpRKr6BsqeWbW8msqeuuhiSzsQEC3';
+  var hkey = new HierarchicalKey(knownPublicKey);
+  console.log('master extended private key: cannot derive');
+  console.log('master extended public key: ' + hkey.extendedPublicKeyString());
+  console.log('m/0/3/5 extended private key: cannot derive');
+  console.log('m/0/3/5 extended public key: ' + hkey.derive('m/0/3/5').extendedPublicKeyString());
+  console.log();
+
+  console.log('6) Make a bunch of new addresses from known public key');
+  var knownPublicKey = 'xpub6CZei1p2zk68UwkcBDqzRonLHJWAiPZZ58sMgHJAn9fmpmnPayVEAvAs3XvTSUMZ1J8dNaxnv4wnt7YpRKr6BsqeWbW8msqeuuhiSzsQEC3';
+  var hkey = new HierarchicalKey(knownPublicKey);
+  console.log('m/0 address: ' + new Address(networks['livenet'].addressVersion, hkey.derive('m/0').eckey.public).toString());
+  //console.log('m/1 extended public key: ' + hkey.derive('m/1').extendedPublicKeyString());
+  console.log('m/1 address: ' + new Address(networks['livenet'].addressVersion, hkey.derive('m/1').eckey.public).toString());
+  //console.log('m/2 extended public key: ' + hkey.derive('m/2').extendedPublicKeyString());
+  console.log('m/2 address: ' + new Address(networks['livenet'].addressVersion, hkey.derive('m/2').eckey.public).toString());
+  //console.log('m/3 extended public key: ' + hkey.derive('m/3').extendedPublicKeyString());
+  console.log('m/3 address: ' + new Address(networks['livenet'].addressVersion, hkey.derive('m/3').eckey.public).toString());
+  console.log('...');
+  //console.log('m/100 extended public key: ' + hkey.derive('m/100').extendedPublicKeyString());
+  console.log('m/100 address: ' + new Address(networks['livenet'].addressVersion, hkey.derive('m/100').eckey.public).toString());
+  console.log();
+
+};
+
+
+// This is just for browser & mocha compatibility
+if (typeof module !== 'undefined') {
+  module.exports.run = run;
+  if (require.main === module) {
+    run();
+  }
+} else {
+  run();
+}