README: update to 5.0.0 API

README.md

@@ -13,16 +13,16 @@ A set of utilities for working with BIP32.
 ``` javascript
 var bip32utils = require('bip32-utils')
 var bitcoin = require('bitcoinjs-lib')
-var Helloblock = require('cb-helloblock')
+var Blockchain = require('cb-blockr')
 
 // ...
 
-var blockchain = new Helloblock('testnet')
+var blockchain = new Blockchain('testnet')
 var hdNode = bitcoin.HDNode.fromSeedHex(seedHex)
-var iterator = bip32utils.AddressIterator(hdNode)
+var chain = bip32utils.Chain(hdNode)
 var GAP_LIMIT = 20
 
-bip32utils.discovery(iterator, GAP_LIMIT, function(addresses, callback) {
+bip32utils.discovery(chain, GAP_LIMIT, function(addresses, callback) {
   blockchain.addresses.summary(addresses, function(err, results) {
     if (err) return callback(err)
 
@@ -41,10 +41,10 @@ bip32utils.discovery(iterator, GAP_LIMIT, function(addresses, callback) {
 
   // throw away ALL unused addresses AFTER the last unused address
   var unused = checked - used
-  for (var i = 1; i < unused; ++i) iterator.pop()
+  for (var i = 1; i < unused; ++i) chain.pop()
 
-  // remember used !== total, iterator may have started at a k-index > 0
-  console.log('Total number of addresses (after prune): ', iterator.addresses.length)
+  // remember used !== total, chain may have started at a k-index > 0
+  console.log('Total number of addresses (after prune): ', chain.addresses.length)
 })
 ```
 
@@ -61,26 +61,26 @@ var external = hdNode.derive(0)
 var internal = hdNode.derive(1)
 var account = new bip32utils.Account(external.neutered(), internal.neutered())
 
-console.log(account.getAddress())
+console.log(account.getExternalAddress())
 // => 1QEj2WQD9vxTzsGEvnmLpvzeLVrpzyKkGt
 
-account.nextAddress()
+account.nextExternalAddress()
 
-console.log(account.getAddress())
+console.log(account.getExternalAddress())
 // => 1DAi282VN7Ack9o5BqWYkiEsS8Vgx1rLn
 
-console.log(account.getChangeAddress())
+console.log(account.getInternalAddress())
 // => 1CXKM323V3kkrHmZQYPUTftGh9VrAWuAYX
 
-console.log(account.getNodes(account.addresses).join(' '))
+console.log(account.getChildren(account.addresses).join(' '))
 // => xpub6A5Fz4JZg4kd8pLTTaMBKsvVgzRBrvai6ChoxWNTtYQ3UDVG1VyAWQqi6SNqkpsfsx9F8pRqwtKUbU4j4gqpuN2gpgQs4DiJxsJQvTjdzfA ...
 
-console.log(account.getNodes(account.addresses, internal, external).join(' '))
+console.log(account.getChildren(account.addresses, internal, external).join(' '))
 // => xprv9vodQPEygdPGUWeKUVNd6M2N533PvEYP21tYxznauyhrYBBCmdKxRJzmnsTsSNqfTJPrDF98GbLCm6xRnjceZ238Qkf5GQGHk79CrFqtG4d ...
 ```
 
 
-BIP32 Address iteration
+BIP32 Chains
 
 ``` javascript
 var bitcoin = require('bitcoinjs-lib')
@@ -89,16 +89,16 @@ var bip32utils = require('bip32-utils')
 // ...
 
 var hdNode = bitcoin.HDNode.fromSeedHex(seedHex)
-var iter = new bip32utils.AddressIterator(hdNode)
+var chain = new bip32utils.Chain(hdNode)
 
-for (var k = 0; k < 10; ++k) iter.next()
+for (var k = 0; k < 10; ++k) chain.next()
 
-var address = iter.get()
+var address = chain.get()
 
-console.log(iter.indexOf(address))
+console.log(chain.indexOf(address))
 // => 9
 
-console.log(iter.pop())
+console.log(chain.pop())
 // => address
 ```