Merge pull request #488 from braydonf/trim-tx

address: include options to trim transaction results
bitpay · Jul 20, 2016 · 802aae2 · 802aae2
2 parents 5e54eac + 5eb32cf
commit 802aae2
Show file tree

Hide file tree

Showing 4 changed files with 234 additions and 36 deletions.
diff --git a/README.md b/README.md
@@ -292,6 +292,9 @@ POST params:
 addrs: 2NF2baYuJAkCKo5onjUKEPdARQkZ6SYyKd5,2NAre8sX2povnjy4aeiHKeEh97Qhn97tB1f
 from (optional): 0
 to (optional): 20
+noAsm (optional): 1 (will omit script asm from results)
+noScriptSig (optional): 1 (will omit the scriptSig from all inputs)
+noSpent (option): 1 (will omit spent information per output)
 ```
 
 Sample output:

diff --git a/lib/addresses.js b/lib/addresses.js
@@ -169,6 +169,14 @@ AddressController.prototype.transformUtxo = function(utxoArg) {
   return utxo;
 };
 
+AddressController.prototype._getTransformOptions = function(req) {
+  return {
+    noAsm: parseInt(req.query.noAsm) ? true : false,
+    noScriptSig: parseInt(req.query.noScriptSig) ? true : false,
+    noSpent: parseInt(req.query.noSpent) ? true : false
+  };
+};
+
 AddressController.prototype.multitxs = function(req, res, next) {
   var self = this;
 
@@ -183,7 +191,9 @@ AddressController.prototype.multitxs = function(req, res, next) {
       return self.common.handleErrors(err, res);
     }
 
-    self.transformAddressHistoryForMultiTxs(result.items, function(err, items) {
+    var transformOptions = self._getTransformOptions(req);
+
+    self.transformAddressHistoryForMultiTxs(result.items, transformOptions, function(err, items) {
       if (err) {
         return self.common.handleErrors(err, res);
       }
@@ -198,7 +208,7 @@ AddressController.prototype.multitxs = function(req, res, next) {
   });
 };
 
-AddressController.prototype.transformAddressHistoryForMultiTxs = function(txinfos, callback) {
+AddressController.prototype.transformAddressHistoryForMultiTxs = function(txinfos, options, callback) {
   var self = this;
 
   var items = txinfos.map(function(txinfo) {
@@ -210,7 +220,7 @@ AddressController.prototype.transformAddressHistoryForMultiTxs = function(txinfo
   async.map(
     items,
     function(item, next) {
-      self.txController.transformTransaction(item, next);
+      self.txController.transformTransaction(item, options, next);
     },
     callback
   );

diff --git a/lib/transactions.js b/lib/transactions.js
@@ -44,7 +44,11 @@ TxController.prototype.transaction = function(req, res, next) {
   });
 };
 
-TxController.prototype.transformTransaction = function(transaction, callback) {
+TxController.prototype.transformTransaction = function(transaction, options, callback) {
+  if (_.isFunction(options)) {
+    callback = options;
+    options = {};
+  }
   $.checkArgument(_.isFunction(callback));
 
   var confirmations = 0;
@@ -67,10 +71,10 @@ TxController.prototype.transformTransaction = function(transaction, callback) {
       }
     ];
   } else {
-    transformed.vin = transaction.inputs.map(this.transformInput.bind(this));
+    transformed.vin = transaction.inputs.map(this.transformInput.bind(this, options));
   }
 
-  transformed.vout = transaction.outputs.map(this.transformOutput.bind(this));
+  transformed.vout = transaction.outputs.map(this.transformOutput.bind(this, options));
 
   transformed.blockhash = transaction.blockHash;
   transformed.blockheight = transaction.height;
@@ -96,19 +100,24 @@ TxController.prototype.transformTransaction = function(transaction, callback) {
   callback(null, transformed);
 };
 
-TxController.prototype.transformInput = function(input, index) {
+TxController.prototype.transformInput = function(options, input, index) {
   // Input scripts are validated and can be assumed to be valid
   var transformed = {
     txid: input.prevTxId,
     vout: input.outputIndex,
-    scriptSig: {
-      asm: input.scriptAsm,
-      hex: input.script
-    },
     sequence: input.sequence,
     n: index
   };
 
+  if (!options.noScriptSig) {
+    transformed.scriptSig = {
+      hex: input.script
+    };
+    if (!options.noAsm) {
+      transformed.scriptSig.asm = input.scriptAsm;
+    }
+  }
+
   transformed.addr = input.address;
   transformed.valueSat = input.satoshis;
   transformed.value = input.satoshis / 1e8;
@@ -120,21 +129,25 @@ TxController.prototype.transformInput = function(input, index) {
   return transformed;
 };
 
-TxController.prototype.transformOutput = function(output, index) {
+TxController.prototype.transformOutput = function(options, output, index) {
   var transformed = {
     value: (output.satoshis / 1e8).toFixed(8),
     n: index,
     scriptPubKey: {
-      hex: output.script,
-      asm: output.scriptAsm
-      //reqSigs: null, // TODO
-    },
-    spentTxId: output.spentTxId || null,
-    spentIndex: _.isUndefined(output.spentIndex) ? null : output.spentIndex,
-    spentHeight: output.spentHeight || null
-    //spentTs: undefined // TODO
+      hex: output.script
+    }
   };
 
+  if (!options.noAsm) {
+    transformed.scriptPubKey.asm = output.scriptAsm;
+  }
+
+  if (!options.noSpent) {
+    transformed.spentTxId = output.spentTxId || null;
+    transformed.spentIndex = _.isUndefined(output.spentIndex) ? null : output.spentIndex;
+    transformed.spentHeight = output.spentHeight || null;
+  }
+
   if (output.address) {
     transformed.scriptPubKey.addresses = [output.address];
     var address = bitcore.Address(output.address); //TODO return type from bitcore-node