fullnode: document events.

This commit is contained in:
Christopher Jeffrey 2017-02-07 14:17:41 -08:00
parent b0b7745039
commit 182b25f9ab
No known key found for this signature in database
GPG Key ID: 8962AB9DE6666BBD

View File

@ -20,26 +20,12 @@ var HTTPServer = require('../http/server');
var policy = require('../protocol/policy');
/**
* Create a fullnode complete with a chain,
* mempool, miner, wallet, etc.
* Respresents a fullnode complete with a
* chain, mempool, miner, wallet, etc.
* @alias module:node.FullNode
* @extends Node
* @constructor
* @param {Object?} options
* @param {Boolean?} options.limitFree
* @param {Number?} options.limitFreeRelay
* @param {Boolean?} options.requireStandard
* @param {Boolean?} options.rejectInsaneFees
* @param {Boolean?} options.replaceByFee
* @param {Boolean?} options.selfish
* @param {Base58Address?} options.payoutAddress
* @param {String?} options.coinbaseFlags
* @param {Buffer?} options.sslKey
* @param {Buffer?} options.sslCert
* @param {Number?} options.httpPort
* @param {String?} options.httpHost
* @param {Object?} options.wallet - Primary {@link Wallet} options.
* @property {Boolean} loaded
* @property {Chain} chain
* @property {PolicyEstimator} fees
* @property {Mempool} mempool
@ -49,6 +35,9 @@ var policy = require('../protocol/policy');
* @property {HTTPServer} http
* @emits FullNode#block
* @emits FullNode#tx
* @emits FullNode#connect
* @emits FullNode#disconnect
* @emits FullNode#reset
* @emits FullNode#error
*/