RanchiMall/fcoin
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

wallet: comments.

Browse Source
This commit is contained in:
Christopher Jeffrey 2016-10-20 10:01:45 -07:00
parent 2cc2ec4bf3
commit c2c06f732b
No known key found for this signature in database
GPG Key ID: 8962AB9DE6666BBD
2 changed files with 21 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
lib/chain/chaindb.js
View File

@ -1099,6 +1099,7 @@ ChainDB.prototype.scan = co(function* scan(start, filter, iter) {
} }
yield iter(entry, txs); yield iter(entry, txs);
entry = yield entry.getNext(); entry = yield entry.getNext();
} }

40
lib/wallet/wallet.js
View File

@ -1747,7 +1747,7 @@ Wallet.prototype.sign = co(function* sign(tx, passphrase) {
}); });
/** /**
* Fill transaction with coins (accesses db). * Fill transaction with coins.
* @param {TX} tx * @param {TX} tx
* @returns {Promise} - Returns {@link TX}. * @returns {Promise} - Returns {@link TX}.
*/ */
@ -1757,7 +1757,7 @@ Wallet.prototype.fillCoins = function fillCoins(tx) {
}; };
/** /**
* Fill transaction with historical coins (accesses db). * Fill transaction with historical coins.
* @param {TX} tx * @param {TX} tx
* @returns {Promise} - Returns {@link TX}. * @returns {Promise} - Returns {@link TX}.
*/ */
@ -1767,9 +1767,9 @@ Wallet.prototype.fillHistory = function fillHistory(tx) {
}; };
/** /**
* Fill transaction with historical coins (accesses db). * Convert transaction to transaction details.
* @param {TX} tx * @param {TX} tx
* @returns {Promise} - Returns {@link TX}. * @returns {Promise} - Returns {@link Details}.
*/ */
Wallet.prototype.toDetails = function toDetails(tx) { Wallet.prototype.toDetails = function toDetails(tx) {
@ -1777,17 +1777,17 @@ Wallet.prototype.toDetails = function toDetails(tx) {
}; };
/** /**
* Fill transaction with historical coins (accesses db). * Get transaction details.
* @param {TX} tx * @param {Hash} hash
* @returns {Promise} - Returns {@link TX}. * @returns {Promise} - Returns {@link Details}.
*/ */
Wallet.prototype.getDetails = function getDetails(tx) { Wallet.prototype.getDetails = function getDetails(hash) {
return this.txdb.getDetails(tx); return this.txdb.getDetails(hash);
}; };
/** /**
* Get a coin from the wallet (accesses db). * Get a coin from the wallet.
* @param {Hash} hash * @param {Hash} hash
* @param {Number} index * @param {Number} index
* @returns {Promise} - Returns {@link Coin}. * @returns {Promise} - Returns {@link Coin}.
@ -1798,7 +1798,7 @@ Wallet.prototype.getCoin = function getCoin(hash, index) {
}; };
/** /**
* Get a transaction from the wallet (accesses db). * Get a transaction from the wallet.
* @param {Hash} hash * @param {Hash} hash
* @returns {Promise} - Returns {@link TX}. * @returns {Promise} - Returns {@link TX}.
*/ */
@ -1808,7 +1808,7 @@ Wallet.prototype.getTX = function getTX(hash) {
}; };
/** /**
* Add a transaction to the wallets TX history (accesses db). * Add a transaction to the wallets TX history.
* @param {TX} tx * @param {TX} tx
* @returns {Promise} * @returns {Promise}
*/ */
@ -1899,7 +1899,7 @@ Wallet.prototype.remove = co(function* remove(hash) {
}); });
/** /**
* Zap stale TXs from wallet (accesses db). * Zap stale TXs from wallet.
* @param {(Number|String)?} acct * @param {(Number|String)?} acct
* @param {Number} age - Age threshold (unix time, default=72 hours). * @param {Number} age - Age threshold (unix time, default=72 hours).
* @returns {Promise} * @returns {Promise}
@ -1928,7 +1928,7 @@ Wallet.prototype._zap = co(function* zap(acct, age) {
}); });
/** /**
* Abandon transaction (accesses db). * Abandon transaction.
* @param {Hash} hash * @param {Hash} hash
* @returns {Promise} * @returns {Promise}
*/ */
@ -1990,7 +1990,7 @@ Wallet.prototype.getLocked = function getLocked() {
}; };
/** /**
* Get all transactions in transaction history (accesses db). * Get all transactions in transaction history.
* @param {(String|Number)?} acct * @param {(String|Number)?} acct
* @returns {Promise} - Returns {@link TX}[]. * @returns {Promise} - Returns {@link TX}[].
*/ */
@ -2001,7 +2001,7 @@ Wallet.prototype.getHistory = co(function* getHistory(acct) {
}); });
/** /**
* Get all available coins (accesses db). * Get all available coins.
* @param {(String|Number)?} account * @param {(String|Number)?} account
* @returns {Promise} - Returns {@link Coin}[]. * @returns {Promise} - Returns {@link Coin}[].
*/ */
@ -2012,7 +2012,7 @@ Wallet.prototype.getCoins = co(function* getCoins(acct) {
}); });
/** /**
* Get all pending/unconfirmed transactions (accesses db). * Get all pending/unconfirmed transactions.
* @param {(String|Number)?} acct * @param {(String|Number)?} acct
* @returns {Promise} - Returns {@link TX}[]. * @returns {Promise} - Returns {@link TX}[].
*/ */
@ -2023,7 +2023,7 @@ Wallet.prototype.getPending = co(function* getPending(acct) {
}); });
/** /**
* Get wallet balance (accesses db). * Get wallet balance.
* @param {(String|Number)?} acct * @param {(String|Number)?} acct
* @returns {Promise} - Returns {@link Balance}. * @returns {Promise} - Returns {@link Balance}.
*/ */
@ -2034,7 +2034,7 @@ Wallet.prototype.getBalance = co(function* getBalance(acct) {
}); });
/** /**
* Get a range of transactions between two timestamps (accesses db). * Get a range of transactions between two timestamps.
* @param {(String|Number)?} acct * @param {(String|Number)?} acct
* @param {Object} options * @param {Object} options
* @param {Number} options.start * @param {Number} options.start
@ -2053,7 +2053,7 @@ Wallet.prototype.getRange = co(function* getRange(acct, options) {
}); });
/** /**
* Get the last N transactions (accesses db). * Get the last N transactions.
* @param {(String|Number)?} acct * @param {(String|Number)?} acct
* @param {Number} limit * @param {Number} limit
* @returns {Promise} - Returns {@link TX}[]. * @returns {Promise} - Returns {@link TX}[].