diff --git a/lib/messages/commands/addr.js b/lib/messages/commands/addr.js index 83125f9..3428476 100644 --- a/lib/messages/commands/addr.js +++ b/lib/messages/commands/addr.js @@ -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) { diff --git a/lib/messages/commands/alert.js b/lib/messages/commands/alert.js index 12b07cf..48ebf00 100644 --- a/lib/messages/commands/alert.js +++ b/lib/messages/commands/alert.js @@ -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); diff --git a/lib/messages/commands/block.js b/lib/messages/commands/block.js index fdb6180..1c27d0b 100644 --- a/lib/messages/commands/block.js +++ b/lib/messages/commands/block.js @@ -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); diff --git a/lib/messages/commands/filteradd.js b/lib/messages/commands/filteradd.js index 48ffc62..2f75c45 100644 --- a/lib/messages/commands/filteradd.js +++ b/lib/messages/commands/filteradd.js @@ -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)) { diff --git a/lib/messages/commands/filterclear.js b/lib/messages/commands/filterclear.js index 3808254..e35c429 100644 --- a/lib/messages/commands/filterclear.js +++ b/lib/messages/commands/filterclear.js @@ -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); diff --git a/lib/messages/commands/filterload.js b/lib/messages/commands/filterload.js index 98acdf2..4c3e9da 100644 --- a/lib/messages/commands/filterload.js +++ b/lib/messages/commands/filterload.js @@ -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); diff --git a/lib/messages/commands/getaddr.js b/lib/messages/commands/getaddr.js index 70d0e7b..d684c5a 100644 --- a/lib/messages/commands/getaddr.js +++ b/lib/messages/commands/getaddr.js @@ -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); }; diff --git a/lib/messages/commands/getdata.js b/lib/messages/commands/getdata.js index 4035e6e..1cf947a 100644 --- a/lib/messages/commands/getdata.js +++ b/lib/messages/commands/getdata.js @@ -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) { diff --git a/lib/messages/commands/inv.js b/lib/messages/commands/inv.js index 9f5065c..730a637 100644 --- a/lib/messages/commands/inv.js +++ b/lib/messages/commands/inv.js @@ -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) { diff --git a/lib/messages/commands/notfound.js b/lib/messages/commands/notfound.js index 8e124a2..f7eed04 100644 --- a/lib/messages/commands/notfound.js +++ b/lib/messages/commands/notfound.js @@ -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) { diff --git a/lib/messages/commands/tx.js b/lib/messages/commands/tx.js index f136a24..a5931a5 100644 --- a/lib/messages/commands/tx.js +++ b/lib/messages/commands/tx.js @@ -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);