Updated JSDocs for Message Commands
This commit is contained in:
parent
f21e2439be
commit
3921c46507
@ -11,6 +11,7 @@ var BufferWriter = bitcore.encoding.BufferWriter;
|
||||
* @param {Object=} arg
|
||||
* @param {Buffer=} arg.payload
|
||||
* @param {Buffer=} arg.signature
|
||||
* @param {Object} options
|
||||
* @param {Number} options.magicNumber
|
||||
* @extends Message
|
||||
* @constructor
|
||||
|
||||
@ -9,7 +9,8 @@ var BufferWriter = bitcore.encoding.BufferWriter;
|
||||
var _ = bitcore.deps._;
|
||||
|
||||
/**
|
||||
* @param {Object|Array=} - options - If options is an array will use as "inventory"
|
||||
* @param {Array=} arg - An array of inventory
|
||||
* @param {Object} options
|
||||
* @param {Array=} options.inventory - An array of inventory items
|
||||
* @param {Number} options.magicNumber
|
||||
* @extends Message
|
||||
|
||||
@ -9,7 +9,7 @@ var BufferWriter = bitcore.encoding.BufferWriter;
|
||||
var _ = bitcore.deps._;
|
||||
|
||||
/**
|
||||
* @param {Array} arg - If options is an array will use as "inventory"
|
||||
* @param {Array} arg - An array of inventory
|
||||
* @param {Object} options
|
||||
* @param {Array=} options.inventory - An array of inventory items
|
||||
* @param {Number} options.magicNumber
|
||||
|
||||
@ -10,7 +10,6 @@ var BufferReader = bitcore.encoding.BufferReader;
|
||||
* A message to confirm that a connection is still valid.
|
||||
* @param {Number} arg - A nonce for the Ping message
|
||||
* @param {Object=} options
|
||||
* @param {Buffer=} options.nonce
|
||||
* @param {Number} options.magicNumber
|
||||
* @extends Message
|
||||
* @constructor
|
||||
|
||||
@ -10,7 +10,6 @@ var BufferReader = bitcore.encoding.BufferReader;
|
||||
* A message in response to a ping message.
|
||||
* @param {Number} arg - A nonce for the Pong message
|
||||
* @param {Object=} options
|
||||
* @param {Buffer=} options.nonce
|
||||
* @param {Number} options.magicNumber
|
||||
* @extends Message
|
||||
* @constructor
|
||||
|
||||
@ -7,8 +7,8 @@ var $ = bitcore.util.preconditions;
|
||||
var _ = bitcore.deps._;
|
||||
|
||||
/**
|
||||
* @param {Object|Transaction=} options - If is an instance of Transaction will use as options.transaction
|
||||
* @param {Transaction=} options.transaction - An instance of a Transaction
|
||||
* @param {Transaction=} arg - An instance of Transaction
|
||||
* @param {Object} options
|
||||
* @param {Number} options.magicNumber
|
||||
* @extends Message
|
||||
* @constructor
|
||||
|
||||
@ -17,13 +17,14 @@ var packageInfo = require('../../../package.json');
|
||||
* communication is possible until both peers have exchanged their versions.
|
||||
*
|
||||
* @see https://en.bitcoin.it/wiki/Protocol_documentation#version
|
||||
* @param {Object=} obj - properties for the version
|
||||
* @param {Buffer=} obj.nonce - a random 8 byte buffer
|
||||
* @param {String=} obj.subversion - version of the client
|
||||
* @param {BN=} obj.services
|
||||
* @param {Date=} obj.timestamp
|
||||
* @param {Number=} obj.startHeight
|
||||
* @param {Number} obj.magicNumber
|
||||
* @param {Object=} arg - properties for the version message
|
||||
* @param {Buffer=} arg.nonce - a random 8 byte buffer
|
||||
* @param {String=} arg.subversion - version of the client
|
||||
* @param {BN=} arg.services
|
||||
* @param {Date=} arg.timestamp
|
||||
* @param {Number=} arg.startHeight
|
||||
* @param {Object} options
|
||||
* @param {Number} options.magicNumber
|
||||
* @extends Message
|
||||
* @constructor
|
||||
*/
|
||||
|
||||
Loading…
Reference in New Issue
Block a user