Merge pull request #11 from sogoiii/master

fix: Adding unit test cases for sanity.

Author: quentinlesceller

.gitignore

@@ -1,2 +1,3 @@
 *.swp
 node_modules
+coverage

README.md

@@ -15,7 +15,7 @@ Examples
 ```javascript
 bcypher = require('blockcypher');
 
-var bcapi = new bcypher('btc','main','YOURTOKEN');
+var bcapi = new bcypher('btc','main',process.env.TOKEN);
 
 function printResponse(err, data) {
   if (err !== null) {

lib/bcypher.js

@@ -192,12 +192,14 @@ Blockcy.prototype.getAddrFull = function (addr, params, cb) {
 /**
  * <b>Gen Addr</b>
  * Generates a new address and associate private/public keys.
- * @param {Object}   data    Optional JSON data, which could be used for generating multisig addresses, for exampl.JSON data, which could be used for generating multisig addresses, for example.
+ * @param {Object}   					data    						Optional JSON data, which could be used for generating multisig addresses, for exampl.JSON data, which could be used for generating multisig addresses, for example.
+ * @param {Array[Strings]}    data.pubKeys    		Optional pubKeys for multi sig address
+ * @param {String}   					data.script_type    Optional script type for multi sig address
  * @callback cb
  * @memberof Blockcy
  * @method genAddr
  */
-Blockcy.prototype.genAddr = function (data, cb) {
+Blockcy.prototype.genAddr = function (data, cb) { //TODO Allow function signature genAddr(cb) as well
 	this._post('/addrs', {}, data, function (error, body) {
 		cb(error, body);
 	});
@@ -212,7 +214,7 @@ Blockcy.prototype.genAddr = function (data, cb) {
  * @memberof Blockcy
  * @method faucet
  */
-Blockcy.prototype.faucet = function (addr, value, cb) {
+Blockcy.prototype.faucet = function (addr, value, cb) { //TODO set default value if value is undefined/null. Maybe allow faucet(addr, cb).
 	this._post('/faucet', {}, { address: addr, amount: value }, function (error, body) {
 		cb(error, body);
 	});
@@ -221,12 +223,14 @@ Blockcy.prototype.faucet = function (addr, value, cb) {
 /**
  * <b>Create Wallet</b>
  * Creates a new wallet.
- * @param {Object}    data    JSON Data used to create wallet.
+ * @param {Object}    				data    					JSON Data used to create wallet.
+ * @param {String}    				data.name    			Name of wallet
+ * @param {Array[String]}     data.addresses    Array of addresses
  * @callback cb
  * @memberof Blockcy
  * @method createWallet
  */
-Blockcy.prototype.createWallet = function (data, cb) {
+Blockcy.prototype.createWallet = function (data, cb) { //TODO check if they have name and address before making request
 	this._post('/wallets', {}, data, function (error, body) {
 		cb(error, body);
 	});
@@ -235,12 +239,15 @@ Blockcy.prototype.createWallet = function (data, cb) {
 /**
  * <b>Create HD Wallet</b>
  * Creates a new HD wallet.
- * @param {Object}    data    JSON Data used to create HD wallet.
+ * @param {Object}     		 data    											JSON Data used to create HD wallet.
+ * @param {String}     		 data.name    								Name of wallet
+ * @param {String}     		 data.extended_public_key    	extended public key
+ * @param {Array[int]}     data.subchain_indexes    		subchain indexes
  * @callback cb
  * @memberof Blockcy
  * @method createHDWallet
  */
-Blockcy.prototype.createHDWallet = function (data, cb) {
+Blockcy.prototype.createHDWallet = function (data, cb) { //TODO error validation on name and extended_public_key
 	this._post('/wallets/hd', {}, data, function (error, body) {
 		cb(error, body);
 	});
@@ -428,7 +435,7 @@ Blockcy.prototype.delHDWallet = function (name, cb) {
  * @memberof Blockcy
  * @method getTX
  */
-Blockcy.prototype.getTX = function (hash, params, cb) {
+Blockcy.prototype.getTX = function (hash, params, cb) { //TODO allow params to be optional getTX(hash, cb) should work
 	this._get('/txs/' + hash, params, function (error, body) {
 		cb(error, body);
 	});
@@ -451,7 +458,7 @@ Blockcy.prototype.getUnTXs = function (cb) {
  * <b>New Transaction</b>
  * Creates a new transaction skeleton, which returns the transaction along with data that needs to be signed. You can see more information on how this process works here: <a href="http://dev.blockcypher.com/?javascript#creating-transactions">http://dev.blockcypher.com/?javascript#creating-transactions</a>
  * @callback cb
- * @param {Object}     tx      Transaction base you're using to build a TX.
+ * @param {Object}     tx      Transaction base you're using to build a TX. https://www.blockcypher.com/dev/bitcoin/#tx
  * @memberof Blockcy
  * @method newTX
  */
@@ -465,7 +472,7 @@ Blockcy.prototype.newTX = function (tx, cb) {
  * <b>Send Transaction</b>
  * Sends a signed transaction skeleton, which returns the completed transaction. You can read more information on how this process works here: <a href="http://dev.blockcypher.com/?javascript#creating-transactions">http://dev.blockcypher.com/?javascript#creating-transactions</a>
  * @callback cb
- * @param {Object}     txskel     Signed transaction skeleton you're sending.
+ * @param {Object}     txskel     Signed transaction skeleton you're sending. https://www.blockcypher.com/dev/bitcoin/#txskeleton
  * @memberof Blockcy
  * @method sendTX
  */
@@ -548,7 +555,9 @@ Blockcy.prototype.getTXConf = function (hash, cb) {
 /**
  * <b>Create Payment Forward</b>
  * Creates a new payment forward.
- * @param {Object}    data    JSON Data used to create payment forward.
+ * @param {Object}    data    							JSON Data used to create payment forward.
+ * @param {String}    data.destination    	Destination address
+ * @param {String}    data.callback_url    	callback url
  * @callback cb
  * @memberof Blockcy
  * @method createPayFwd
@@ -589,7 +598,10 @@ Blockcy.prototype.delPayFwd = function (id, cb) {
 /**
  * <b>Create WebHook</b>
  * Creates a new webhook.
- * @param {Object}    data    JSON Data used to create webhook.
+ * @param {Object}    data    				JSON Data used to create webhook.
+ * @param {String}    data.event    	Event name
+ * @param {String}    data.address    address
+ * @param {String}    data.url    		url
  * @callback cb
  * @memberof Blockcy
  * @method createHook