BTCPrivate
/
bitcore
mirror of https://github.com/BTCPrivate/bitcore.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

update transaction.getFee() JSDoc

This commit is contained in:
Chris Arnesen 2015-03-26 15:41:41 -07:00
parent 4390b08b48
commit 8af63ec8d0
1 changed files with 13 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
lib/transaction/transaction.js
View File

@ -741,13 +741,20 @@ Transaction.prototype._updateChangeOutput = function() {
}
};
/**
* Calculates the fees for the transaction.
* Calculates the fee of the transaction.
*
* If there is no change output set, the fee will be the
* output amount minus the input amount.
* If there's a fixed fee set, return that
* If there's no fee set, estimate it based on size
* @return {Number} miner fee for this transaction in satoshis
* If there is no change output set, the fee is the
* total value of the outputs minus inputs. Note that
* a serialized transaction only specifies the value
* of its outputs. (The value of inputs are recorded
* in the previous transaction outputs being spent.)
* This method therefore raises a "MissingPreviousOutput"
* error when called on a serialized transaction.
*
* If there's a fixed fee set, return that.
* If there's no fee set, estimate it based on size.
*
* @return {Number} fee of this transaction in satoshis
*/
Transaction.prototype.getFee = function() {
// if no change output is set, fees should equal all the unspent amount