added jsdocs for message commands
This commit is contained in:
parent
4c4d53a4c5
commit
42985a7716
@ -9,6 +9,12 @@ var BufferWriter = bitcore.encoding.BufferWriter;
|
||||
|
||||
var magicNumber = bitcore.Networks.defaultNetwork.networkMagic.readUInt32LE(0);
|
||||
|
||||
/**
|
||||
* @param {Object} - options
|
||||
* @param {Array} - options.addresses - An array of addrs
|
||||
* @extends Message
|
||||
* @constructor
|
||||
*/
|
||||
function AddrMessage(options) {
|
||||
if (!(this instanceof AddrMessage)) {
|
||||
return new AddrMessage(options);
|
||||
@ -20,7 +26,7 @@ function AddrMessage(options) {
|
||||
this.command = 'addr';
|
||||
this.magicNumber = magicNumber;
|
||||
this.addresses = options.addresses;
|
||||
};
|
||||
}
|
||||
inherits(AddrMessage, Message);
|
||||
|
||||
AddrMessage.fromObject = function(options) {
|
||||
|
||||
@ -9,6 +9,13 @@ var BufferWriter = bitcore.encoding.BufferWriter;
|
||||
|
||||
var magicNumber = bitcore.Networks.defaultNetwork.networkMagic.readUInt32LE(0);
|
||||
|
||||
/**
|
||||
* @param {Object} - options
|
||||
* @param {Buffer} - options.payload
|
||||
* @param {Buffer} - options.signature
|
||||
* @extends Message
|
||||
* @constructor
|
||||
*/
|
||||
function AlertMessage(options) {
|
||||
if (!(this instanceof AlertMessage)) {
|
||||
return new AlertMessage(options);
|
||||
|
||||
@ -7,6 +7,12 @@ var bitcore = require('bitcore');
|
||||
var Block = bitcore.Block;
|
||||
var magicNumber = bitcore.Networks.defaultNetwork.networkMagic.readUInt32LE(0);
|
||||
|
||||
/**
|
||||
* @param {Object|Block} - options - If is an instance of Block will use as options.block
|
||||
* @param {Block} - options.block - An instance of a Block
|
||||
* @extends Message
|
||||
* @constructor
|
||||
*/
|
||||
function BlockMessage(options) {
|
||||
if (!(this instanceof BlockMessage)) {
|
||||
return new BlockMessage(options);
|
||||
|
||||
@ -13,9 +13,9 @@ var magicNumber = bitcore.Networks.defaultNetwork.networkMagic.readUInt32LE(0);
|
||||
|
||||
/**
|
||||
* Request peer to add data to a bloom filter already set by 'filterload'
|
||||
*
|
||||
* @name P2P.Message.filteradd
|
||||
* @param{Buffer} data - Array of bytes representing bloom filter data
|
||||
* @param {Buffer} data - Array of bytes representing bloom filter data
|
||||
* @extends Message
|
||||
* @constructor
|
||||
*/
|
||||
function FilteraddMessage(options) {
|
||||
if (!(this instanceof FilteraddMessage)) {
|
||||
|
||||
@ -7,6 +7,11 @@ var BufferUtil = bitcore.util.buffer;
|
||||
|
||||
var magicNumber = bitcore.Networks.defaultNetwork.networkMagic.readUInt32LE(0);
|
||||
|
||||
/**
|
||||
* Request peer to clear data for a bloom filter
|
||||
* @extends Message
|
||||
* @constructor
|
||||
*/
|
||||
function FilterclearMessage(options) {
|
||||
if (!(this instanceof FilterclearMessage)) {
|
||||
return new FilterclearMessage(options);
|
||||
|
||||
@ -10,6 +10,12 @@ var _ = bitcore.deps._;
|
||||
|
||||
var magicNumber = bitcore.Networks.defaultNetwork.networkMagic.readUInt32LE(0);
|
||||
|
||||
/**
|
||||
* Request peer to send inv messages based on a bloom filter
|
||||
* @param {BloomFilter} options.filter - An instance of BloomFilter
|
||||
* @extends Message
|
||||
* @constructor
|
||||
*/
|
||||
function FilterloadMessage(options) {
|
||||
if (!(this instanceof FilterloadMessage)) {
|
||||
return new FilterloadMessage(options);
|
||||
|
||||
@ -24,7 +24,7 @@ GetaddrMessage.fromObject = function(options) {
|
||||
return new GetaddrMessage(options);
|
||||
};
|
||||
|
||||
GetaddrMessage.fromBuffer = function(payload) {
|
||||
GetaddrMessage.fromBuffer = function() {
|
||||
var obj = {};
|
||||
return GetaddrMessage.fromObject(obj);
|
||||
};
|
||||
|
||||
@ -14,6 +14,7 @@ var magicNumber = bitcore.Networks.defaultNetwork.networkMagic.readUInt32LE(0);
|
||||
/**
|
||||
* @param {Object|Array} - options - If options is an array will use as "inventory"
|
||||
* @param {Array} options.inventory - An array of inventory items
|
||||
* @extends Message
|
||||
* @constructor
|
||||
*/
|
||||
function GetdataMessage(options) {
|
||||
|
||||
@ -14,6 +14,7 @@ var magicNumber = bitcore.Networks.defaultNetwork.networkMagic.readUInt32LE(0);
|
||||
/**
|
||||
* @param {Object|Array} - options - If options is an array will use as "inventory"
|
||||
* @param {Array} options.inventory - An array of inventory items
|
||||
* @extends Message
|
||||
* @constructor
|
||||
*/
|
||||
function InvMessage(options) {
|
||||
|
||||
@ -14,6 +14,7 @@ var magicNumber = bitcore.Networks.defaultNetwork.networkMagic.readUInt32LE(0);
|
||||
/**
|
||||
* @param {Object|Array} - options - If options is an array will use as "inventory"
|
||||
* @param {Array} options.inventory - An array of inventory items
|
||||
* @extends Message
|
||||
* @constructor
|
||||
*/
|
||||
function NotfoundMessage(options) {
|
||||
|
||||
@ -7,6 +7,12 @@ var bitcore = require('bitcore');
|
||||
var Transaction = bitcore.Transaction;
|
||||
var magicNumber = bitcore.Networks.defaultNetwork.networkMagic.readUInt32LE(0);
|
||||
|
||||
/**
|
||||
* @param {Object|Transaction} - options - If is an instance of Transaction will use as options.transaction
|
||||
* @param {Transaction} - options.transaction - An instance of a Transaction
|
||||
* @extends Message
|
||||
* @constructor
|
||||
*/
|
||||
function TransactionMessage(options) {
|
||||
if (!(this instanceof TransactionMessage)) {
|
||||
return new TransactionMessage(options);
|
||||
|
||||
Loading…
Reference in New Issue
Block a user