Bitmessage/bitmessage-js
2
0
Fork 1
Code Issues 1 Pull Requests 1 Actions Packages Releases Activity
feb254d01f
bitmessage-js/docs/messages.js.html

680 lines
23 KiB
HTML
Raw Normal View History

Publish docs
2015-01-03 16:04:14 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Source: messages.js</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Source: messages.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>/**
* Working with messages.
* @see {@link https://bitmessage.org/wiki/Protocol_specification#Message_types}
Publish docs
2015-01-31 11:54:23 +00:00
* @see {@link https://bitmessage.org/wiki/Protocol_specification_v3#Message_types}
* @see {@link https://bitmessage.org/Bitmessage%20Technical%20Paper.pdf}
Publish docs
2015-01-03 16:04:14 +00:00
* @module bitmessage/messages
Publish docs
2015-02-12 10:44:15 +00:00
* @example
* var structs = require("bitmessage").structs;
* var messages = require("bitmessage").messages;
*
* // Simple encoding and decoding:
* var vermsg = messages.version.encode({
* remoteHost: "1.1.1.1",
* remotePort: 8444,
* });
* console.log(messages.version.decode(vermsg).remoteHost); // 1.1.1.1
*
* // Low-level encoding and decoding:
* var addrPayload = messages.addr.encodePayload([
* {host: "2.2.2.2", port: 28444},
* ]);
* var addrmsg = structs.message.encode("addr", addrPayload);
* var decoded = structs.message.decode(addrmsg);
* console.log(decoded.command); // addr
Publish docs
2015-02-28 19:57:18 +00:00
* var addr = messages.addr.decodePayload(decoded.payload);
* console.log(addr.addrs[0].host); // 2.2.2.2
Publish docs
2015-02-12 10:44:15 +00:00
*
* // Encode with empty payload:
* var verackmsg = structs.message.encode("verack");
* console.log(structs.message.decode(verackmsg).command); // verack
Publish docs
2015-01-03 16:04:14 +00:00
*/
Publish docs
2015-01-31 11:54:23 +00:00
"use strict";
var objectAssign = Object.assign || require("object-assign");
Publish docs
2015-02-28 19:57:18 +00:00
var bufferEqual = require("buffer-equal");
Publish docs
2015-01-31 11:54:23 +00:00
var assert = require("./_util").assert;
var structs = require("./structs");
Publish docs
2015-02-12 10:44:15 +00:00
var bmcrypto = require("./crypto");
Publish docs
2015-01-31 11:54:23 +00:00
var UserAgent = require("./user-agent");
var util = require("./_util");
var message = structs.message;
var ServicesBitfield = structs.ServicesBitfield;
Publish docs
2015-02-28 19:57:18 +00:00
var IPv4_MAPPING = util.IPv4_MAPPING;
var inet_pton = util.inet_pton;
Publish docs
2015-01-31 11:54:23 +00:00
/**
* Try to get command of the given encoded message.
* Note that this function doesn't do any validation because it is
* already provided by
* [message.decode]{@link module:bitmessage/structs.message.decode}
Publish docs
2015-02-12 10:44:15 +00:00
* routine.
Publish docs
2015-01-31 11:54:23 +00:00
* @param {Buffer} buf - Buffer that starts with encoded message
* @return {?string} Message's command if any.
*/
exports.getCommand = function(buf) {
if (buf.length &lt; 16) {
return;
}
var command = buf.slice(4, 16);
var firstNonNull = 0;
for (var i = 11; i >=0; i--) {
if (command[i] !== 0) {
firstNonNull = i + 1;
break;
}
}
return command.slice(0, firstNonNull).toString("ascii");
};
/**
* `version` message.
* @see {@link https://bitmessage.org/wiki/Protocol_specification#version}
* @namespace
* @static
*/
var version = exports.version = {
/**
Publish docs
2015-02-12 10:44:15 +00:00
* @typedef {Object} DecodeResult
Publish docs
2015-02-24 17:23:55 +00:00
* @property {number} protoVersion - Identifies protocol version being
* used by the node. Should equal 3. Nodes should disconnect if the
* remote node's version is lower but continue with the connection if
* it is higher.
Publish docs
2015-02-12 10:44:15 +00:00
* @property {Object} services -
* [Service]{@link module:bitmessage/structs.ServicesBitfield}
* features to be enabled for this connection
* @property {Date} time - Node time
* @property {string} remoteHost - IPv4/IPv6 address of the node
* receiving this message
* @property {number} remotePort - Port of the node receiving this
* message
* @property {number} port - Incoming port of the node sending this
* message
Publish docs
2015-02-24 17:23:55 +00:00
* @property {Buffer} nonce - An 8-byte random nonce used to detect
* connection to self
* @property {string} userAgent - [User agent]{@link
* module:bitmessage/user-agent} of the node
* @property {number[]} streams - Streams accepted by the node
Publish docs
2015-02-12 10:44:15 +00:00
* @property {number} length - Real data length
* @memberof module:bitmessage/messages.version
Publish docs
2015-01-31 11:54:23 +00:00
*/
Publish docs
2015-02-24 17:23:55 +00:00
/**
* Random nonce used to detect connections to self.
* @constant {Buffer}
*/
randomNonce: bmcrypto.randomBytes(8),
Publish docs
2015-01-31 11:54:23 +00:00
/**
Publish docs
2015-02-12 10:44:15 +00:00
* Decode `version` message.
Publish docs
2015-01-31 11:54:23 +00:00
* NOTE: `nonce` is copied.
* @param {Buffer} buf - Message
Publish docs
2015-02-12 10:44:15 +00:00
* @return {DecodeResult}
* [Decoded `version` structure.]{@link module:bitmessage/messages.version.DecodeResult}
Publish docs
2015-01-31 11:54:23 +00:00
*/
decode: function(buf) {
var decoded = message.decode(buf);
assert(decoded.command === "version", "Bad command");
return version.decodePayload(decoded.payload);
},
/**
* Decode `version` message payload.
Publish docs
2015-02-12 10:44:15 +00:00
* The same as [decode]{@link module:bitmessage/messages.version.decode}.
Publish docs
2015-01-31 11:54:23 +00:00
*/
decodePayload: function(buf) {
// 4 + 8 + 8 + 26 + 26 + 8 + (1+) + (1+)
assert(buf.length >= 82, "Buffer is too small");
var protoVersion = buf.readUInt32BE(0, true);
var services = ServicesBitfield(buf.slice(4, 12), {copy: true});
var time = util.readTime64BE(buf, 12);
var short = {short: true};
var addrRecv = structs.net_addr.decode(buf.slice(20, 46), short);
var addrFrom = structs.net_addr.decode(buf.slice(46, 72), short);
var nonce = new Buffer(8);
buf.copy(nonce, 0, 72, 80);
var decodedUa = UserAgent.decode(buf.slice(80));
Publish docs
2015-02-24 17:23:55 +00:00
assert(decodedUa.length &lt;= 5000, "User agent is too long");
var decodedStreams = structs.var_int_list.decode(decodedUa.rest);
assert(decodedStreams.list.length &lt;= 160000, "Too many streams");
Publish docs
2015-01-31 11:54:23 +00:00
return {
Publish docs
2015-02-24 17:23:55 +00:00
protoVersion: protoVersion,
Publish docs
2015-01-31 11:54:23 +00:00
services: services,
time: time,
remoteHost: addrRecv.host,
remotePort: addrRecv.port,
port: addrFrom.port,
nonce: nonce,
userAgent: decodedUa.str,
Publish docs
2015-02-24 17:23:55 +00:00
streams: decodedStreams.list,
Publish docs
2015-01-31 11:54:23 +00:00
// NOTE(Kagami): Real data length. It may be some gap between end
// of stream numbers list and end of payload:
// [payload..............[stream numbers]xxxx]
// We are currently ignoring that.
Publish docs
2015-02-24 17:23:55 +00:00
length: 80 + decodedUa.length + decodedStreams.length,
Publish docs
2015-01-31 11:54:23 +00:00
};
},
/**
* Encode `version` message.
* @param {Object} opts - Version options
Publish docs
2015-02-12 10:44:15 +00:00
* @param {Object=} opts.services -
* [Service]{@link module:bitmessage/structs.ServicesBitfield}
* features to be enabled for this connection (`NODE_NETWORK` by
* default)
* @param {Date=} opts.time - Node time (current time by default)
* @param {string} opts.remoteHost - IPv4/IPv6 address of the node
* receiving this message
* @param {number} opts.remotePort - Port of the node receiving this
* message
* @param {number=} opts.port - Incoming port of the node (8444 by
* default)
Publish docs
2015-02-24 17:23:55 +00:00
* @param {Buffer=} opts.nonce - An 8-byte random nonce used to detect
* connection to self (unique per node.js process by default)
Publish docs
2015-02-12 10:44:15 +00:00
* @param {(Array|string|Buffer)=} opts.userAgent -
* [User agent]{@link module:bitmessage/user-agent} of the node
Publish docs
2015-02-24 17:23:55 +00:00
* (user agent of bitmessage library by default)
* @param {Array&lt;number>=} opts.streams - Streams accepted by the node
* ([1] by default)
Publish docs
2015-01-31 11:54:23 +00:00
* @return {Buffer} Encoded message.
*/
encode: function(opts) {
var payload = version.encodePayload(opts);
return message.encode("version", payload);
},
/**
* Encode `version` message payload.
Publish docs
2015-02-12 10:44:15 +00:00
* The same as [encode]{@link module:bitmessage/messages.version.encode}.
Publish docs
2015-01-31 11:54:23 +00:00
*/
encodePayload: function(opts) {
// Deal with default options.
var services = opts.services ||
ServicesBitfield().set(ServicesBitfield.NODE_NETWORK);
var time = opts.time || new Date();
Publish docs
2015-02-24 17:23:55 +00:00
var nonce = opts.nonce || version.randomNonce;
Publish docs
2015-01-31 11:54:23 +00:00
assert(nonce.length === 8, "Bad nonce");
Publish docs
2015-02-12 10:44:15 +00:00
var port = opts.port || 8444;
Publish docs
2015-02-24 17:23:55 +00:00
var userAgent = UserAgent.encode(opts.userAgent || UserAgent.SELF);
assert(userAgent.length &lt;= 5000, "User agent is too long");
var streams = opts.streams || [1];
assert(streams.length &lt;= 160000, "Too many streams");
Publish docs
2015-01-31 11:54:23 +00:00
// Start encoding.
var protoVersion = new Buffer(4);
protoVersion.writeUInt32BE(util.PROTOCOL_VERSION, 0);
var addrRecv = structs.net_addr.encode({
services: services,
host: opts.remoteHost,
port: opts.remotePort,
short: true,
});
var addrFrom = structs.net_addr.encode({
services: services,
host: "127.0.0.1",
Publish docs
2015-02-12 10:44:15 +00:00
port: port,
Publish docs
2015-01-31 11:54:23 +00:00
short: true,
});
return Buffer.concat([
protoVersion,
services.buffer,
util.writeTime64BE(null, time),
addrRecv,
addrFrom,
nonce,
Publish docs
2015-02-24 17:23:55 +00:00
userAgent,
structs.var_int_list.encode(streams),
Publish docs
2015-01-31 11:54:23 +00:00
]);
},
};
Publish docs
2015-02-28 19:57:18 +00:00
var IPv6_LOOPBACK = new Buffer(
[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1]
);
// Check whether given encoded IPv6 or IPv4-mapped IPv6 is in private
// network range. See
// &lt;https://en.wikipedia.org/wiki/Reserved_IP_addresses> for details.
// TODO(Kagami): Do we also need to filter multicasts and other reserved
// ranges?
function isPrivateIp(buf) {
// IPv4.
if (bufferEqual(buf.slice(0, 12), IPv4_MAPPING)) {
buf = buf.slice(12);
if (buf[0] === 127) {
return true;
} else if (buf[0] === 10) {
return true;
} else if (buf[0] === 192 &amp;&amp; buf[1] === 168) {
return true;
// XXX(Kagami): ignore:start and ignore:end doesn't ignore this for
// some reason. Probably related:
// &lt;https://github.com/jshint/jshint/issues/1465>.
} else if (buf[0] === 172 &amp;&amp; (buf[1] &amp; 0xf0) === 0x10) {//jshint ignore:line
return true;
} else if (buf[0] === 169 &amp;&amp; buf[1] === 254) {
return true;
} else {
return false;
}
// IPv6.
} else {
if (bufferEqual(buf, IPv6_LOOPBACK)) {
return true;
} else if (buf[0] === 0xfe &amp;&amp; (buf[1] &amp; 0xc0) === 0x80) {//jshint ignore:line
return true;
} else if ((buf[0] &amp; 0xfe) === 0xfc) { // jshint ignore:line
return true;
} else {
return false;
}
}
}
// Helper to make it easier to filter out private IPs.
function checkAddrOpts(opts) {
return !isPrivateIp(inet_pton(opts.host));
}
Publish docs
2015-01-31 11:54:23 +00:00
/**
* `addr` message. Provide information on known nodes of the network.
* @see {@link https://bitmessage.org/wiki/Protocol_specification#addr}
* @namespace
* @static
*/
var addr = exports.addr = {
Publish docs
2015-02-12 10:44:15 +00:00
/**
* @typedef {Object} DecodeResult
* @property {Object[]} addrs - List of
* [decoded `net_addr` structures]{@link module:bitmessage/structs.net_addr.DecodeResult}
* @property {number} length - Real data length
* @memberof module:bitmessage/messages.addr
*/
Publish docs
2015-01-31 11:54:23 +00:00
/**
* Decode `addr` message.
* @param {Buffer} buf - Message
Publish docs
2015-02-12 10:44:15 +00:00
* @return {DecodeResult}
* [Decoded `addr` structure.]{@link module:bitmessage/messages.addr.DecodeResult}
Publish docs
2015-01-31 11:54:23 +00:00
*/
decode: function(buf) {
var decoded = message.decode(buf);
assert(decoded.command === "addr", "Bad command");
return addr.decodePayload(decoded.payload);
},
/**
* Decode `addr` message payload.
Publish docs
2015-02-12 10:44:15 +00:00
* The same as [decode]{@link module:bitmessage/messages.addr.decode}.
Publish docs
2015-01-31 11:54:23 +00:00
*/
decodePayload: function(buf) {
var decoded = structs.var_int.decode(buf);
var listLength = decoded.value;
Publish docs
2015-02-28 19:57:18 +00:00
// NOTE(Kagami): Check length before filtering private IPs because
// we shouldn't even receive them.
Publish docs
2015-01-31 11:54:23 +00:00
assert(listLength &lt;= 1000, "Too many address entires");
var length = decoded.length + listLength * 38;
assert(buf.length >= length, "Buffer is too small");
var rest = decoded.rest;
Publish docs
2015-02-28 19:57:18 +00:00
var addrs = [];
var addrBuf;
Publish docs
2015-01-31 11:54:23 +00:00
for (var i = 0; i &lt; listLength; i++) {
Publish docs
2015-02-28 19:57:18 +00:00
addrBuf = rest.slice(i*38, (i+1)*38);
if (!isPrivateIp(addrBuf.slice(20, 36))) {
addrs.push(structs.net_addr.decode(addrBuf));
}
Publish docs
2015-01-31 11:54:23 +00:00
}
return {
addrs: addrs,
// Real data length.
length: length,
};
},
/**
* Encode `addr` message.
Publish docs
2015-02-12 10:44:15 +00:00
* @param {Object[]} addrs - List of
* [net_addr encode options]{@link module:bitmessage/structs.net_addr.encode}
Publish docs
2015-01-31 11:54:23 +00:00
* @return {Buffer} Encoded message.
*/
encode: function(addrs) {
var payload = addr.encodePayload(addrs);
return message.encode("addr", payload);
},
/**
* Encode `addr` message payload.
Publish docs
2015-02-12 10:44:15 +00:00
* The same as [encode]{@link module:bitmessage/messages.addr.encode}.
Publish docs
2015-01-31 11:54:23 +00:00
*/
encodePayload: function(addrs) {
Publish docs
2015-02-28 19:57:18 +00:00
addrs = addrs.filter(checkAddrOpts);
Publish docs
2015-01-31 11:54:23 +00:00
assert(addrs.length &lt;= 1000, "Too many address entires");
Publish docs
2015-02-12 10:44:15 +00:00
var addrBufs = addrs.map(structs.net_addr.encode);
var bufs = [structs.var_int.encode(addrs.length)].concat(addrBufs);
return Buffer.concat(bufs);
Publish docs
2015-01-31 11:54:23 +00:00
},
};
/**
* `inv` message. Allows a node to advertise its knowledge of one or
* more objects.
* @see {@link https://bitmessage.org/wiki/Protocol_specification#inv}
* @namespace
* @static
*/
var inv = exports.inv = {
Publish docs
2015-02-12 10:44:15 +00:00
/**
* @typedef {Object} DecodeResult
Publish docs
2015-03-16 19:33:24 +00:00
* @property {Buffer[]} vectors - List of [inventory vectors]{@link
* module:bitmessage/structs.inv_vect}
Publish docs
2015-02-12 10:44:15 +00:00
* @property {number} length - Real data length
* @memberof module:bitmessage/messages.inv
*/
Publish docs
2015-01-31 11:54:23 +00:00
/**
* Decode `inv` message.
* @param {Buffer} buf - Message
Publish docs
2015-02-12 10:44:15 +00:00
* @return {DecodeResult}
* [Decoded `inv` structure.]{@link module:bitmessage/messages.inv.DecodeResult}
Publish docs
2015-01-31 11:54:23 +00:00
*/
decode: function(buf) {
var decoded = message.decode(buf);
assert(decoded.command === "inv", "Bad command");
return inv.decodePayload(decoded.payload);
},
/**
* Decode `inv` message payload.
Publish docs
2015-02-12 10:44:15 +00:00
* The same as [decode]{@link module:bitmessage/messages.inv.decode}.
Publish docs
2015-01-31 11:54:23 +00:00
*/
decodePayload: function(buf) {
var decoded = structs.var_int.decode(buf);
var listLength = decoded.value;
Publish docs
2015-03-16 19:33:24 +00:00
assert(listLength &lt;= 50000, "Too many vectors");
Publish docs
2015-01-31 11:54:23 +00:00
var length = decoded.length + listLength * 32;
assert(buf.length >= length, "Buffer is too small");
var rest = decoded.rest;
Publish docs
2015-03-16 19:33:24 +00:00
var vectors = new Array(listLength);
Publish docs
2015-01-31 11:54:23 +00:00
for (var i = 0; i &lt; listLength; i++) {
Publish docs
2015-03-16 19:33:24 +00:00
vectors[i] = rest.slice(i*32, (i+1)*32);
Publish docs
2015-01-31 11:54:23 +00:00
}
return {
Publish docs
2015-03-16 19:33:24 +00:00
vectors: vectors,
Publish docs
2015-01-31 11:54:23 +00:00
// Real data length.
length: length,
};
},
/**
* Encode `inv` message.
Publish docs
2015-03-16 19:33:24 +00:00
* @param {Buffer[]} vectors - [Inventory vector]{@link
* module:bitmessage/structs.inv_vect} list
Publish docs
2015-01-31 11:54:23 +00:00
* @return {Buffer} Encoded message.
*/
Publish docs
2015-03-16 19:33:24 +00:00
encode: function(vectors) {
var payload = inv.encodePayload(vectors);
Publish docs
2015-01-31 11:54:23 +00:00
return message.encode("inv", payload);
},
/**
* Encode `inv` message payload.
Publish docs
2015-02-12 10:44:15 +00:00
* The same as [encode]{@link module:bitmessage/messages.inv.encode}.
Publish docs
2015-01-31 11:54:23 +00:00
*/
Publish docs
2015-03-16 19:33:24 +00:00
encodePayload: function(vectors) {
assert(vectors.length &lt;= 50000, "Too many vectors");
Publish docs
2015-02-12 10:44:15 +00:00
// TODO(Kagami): Validate vectors length.
Publish docs
2015-03-16 19:33:24 +00:00
var bufs = [structs.var_int.encode(vectors.length)].concat(vectors);
Publish docs
2015-02-12 10:44:15 +00:00
return Buffer.concat(bufs);
Publish docs
2015-01-31 11:54:23 +00:00
},
};
/**
* `getdata` message. `getdata` is used in response to an
* [inv]{@link module:bitmessage/messages.inv} message to retrieve the
* content of a specific object after filtering known elements.
* @see {@link https://bitmessage.org/wiki/Protocol_specification#getdata}
* @namespace
*/
exports.getdata = objectAssign({}, inv, {
Publish docs
2015-02-12 10:44:15 +00:00
/**
* @typedef {Object} DecodeResult
Publish docs
2015-03-16 19:33:24 +00:00
* @property {Buffer[]} vectors - List of [inventory vectors]{@link
* module:bitmessage/structs.inv_vect}
Publish docs
2015-02-12 10:44:15 +00:00
* @property {number} length - Real data length
* @memberof module:bitmessage/messages.getdata
*/
Publish docs
2015-01-31 11:54:23 +00:00
/**
* Decode `getdata` message.
* @param {Buffer} buf - Message
Publish docs
2015-02-12 10:44:15 +00:00
* @return {DecodeResult}
* [Decoded `getdata` structure.]{@link module:bitmessage/messages.getdata.DecodeResult}
Publish docs
2015-01-31 11:54:23 +00:00
* @memberof module:bitmessage/messages.getdata
*/
decode: function(buf) {
var decoded = message.decode(buf);
assert(decoded.command === "getdata", "Bad command");
return inv.decodePayload(decoded.payload);
},
Publish docs
2015-02-12 10:44:15 +00:00
/**
* Decode `getdata` message payload.
* The same as [decode]{@link module:bitmessage/messages.getdata.decode}.
* @function decodePayload
* @memberof module:bitmessage/messages.getdata
*/
Publish docs
2015-01-31 11:54:23 +00:00
/**
* Encode `getdata` message.
Publish docs
2015-03-16 19:33:24 +00:00
* @param {Buffer[]} vectors - [Inventory vector]{@link
* module:bitmessage/structs.inv_vect} list
Publish docs
2015-01-31 11:54:23 +00:00
* @return {Buffer} Encoded message.
* @memberof module:bitmessage/messages.getdata
*/
Publish docs
2015-03-16 19:33:24 +00:00
encode: function(vectors) {
var payload = inv.encodePayload(vectors);
Publish docs
2015-01-31 11:54:23 +00:00
return message.encode("getdata", payload);
},
Publish docs
2015-02-12 10:44:15 +00:00
Publish docs
2015-01-31 11:54:23 +00:00
/**
* Encode `getdata` message payload.
Publish docs
2015-02-12 10:44:15 +00:00
* The same as [encode]{@link module:bitmessage/messages.getdata.encode}.
Publish docs
2015-01-31 11:54:23 +00:00
* @function encodePayload
* @memberof module:bitmessage/messages.getdata
*/
});
/**
* `error` message.
* @see {@link https://bitmessage.org/wiki/Protocol_specification_v3#error}
* @namespace
* @static
*/
var error = exports.error = {
/**
* Just a warning.
* @constant {number}
*/
WARNING: 0,
/**
* It's an error, something was going wrong (e.g. an object got lost).
* @constant {number}
*/
ERROR: 1,
/**
* It's a fatal error. The node will drop the line for that error and
* maybe ban you for some time.
* @constant {number}
*/
FATAL: 2,
Publish docs
2015-02-24 17:23:55 +00:00
/**
* Convert error type to a human-readable string.
* @param {number} type - Type of the error
* @return {string}
*/
type2str: function(type) {
switch (type) {
case error.WARNING: return "warning";
case error.ERROR: return "error";
case error.FATAL: return "fatal";
default: return "unknown";
}
},
Publish docs
2015-02-12 10:44:15 +00:00
/**
* @typedef {Object} DecodeResult
Publish docs
2015-02-24 17:23:55 +00:00
* @property {number} type - Type of the error
Publish docs
2015-02-12 10:44:15 +00:00
* @property {number} banTime - The other node informs that it will
* not accept further connections for this number of seconds
Publish docs
2015-03-16 19:33:24 +00:00
* @property {?Buffer} vector - [Inventory vector]{@link
* module:bitmessage/structs.inv_vect} related to the error
Publish docs
2015-02-12 10:44:15 +00:00
* @property {string} errorText - A human-readable error description
* @property {number} length - Real data length
* @memberof module:bitmessage/messages.error
*/
Publish docs
2015-01-31 11:54:23 +00:00
/**
* Decode `error` message.
* @param {Buffer} buf - Message
Publish docs
2015-02-12 10:44:15 +00:00
* @return {DecodeResult}
* [Decoded `error` structure.]{@link module:bitmessage/messages.error.DecodeResult}
Publish docs
2015-01-31 11:54:23 +00:00
*/
decode: function(buf) {
var decoded = message.decode(buf);
assert(decoded.command === "error", "Bad command");
return error.decodePayload(decoded.payload);
},
/**
* Decode `error` message payload.
Publish docs
2015-02-12 10:44:15 +00:00
* The same as [decode]{@link module:bitmessage/messages.error.decode}.
Publish docs
2015-01-31 11:54:23 +00:00
*/
decodePayload: function(buf) {
assert(buf.length >= 4, "Buffer is too small");
Publish docs
2015-02-24 17:23:55 +00:00
var decodedType = structs.var_int.decode(buf);
var decodedBanTime = structs.var_int.decode(decodedType.rest);
Publish docs
2015-02-12 10:44:15 +00:00
var decodedVectorLength = structs.var_int.decode(decodedBanTime.rest);
// NOTE(Kagami): Inventory vector should be only 32-byte in size but
// currently we don't ensure it.
var vectorLength = decodedVectorLength.value;
var rest = decodedVectorLength.rest;
assert(rest.length >= vectorLength, "Buffer is too small");
var vector = null;
if (vectorLength) {
vector = new Buffer(vectorLength);
rest.copy(vector);
rest = rest.slice(vectorLength);
}
var decodedErrorText = structs.var_str.decode(rest);
Publish docs
2015-01-31 11:54:23 +00:00
var length = (
Publish docs
2015-02-24 17:23:55 +00:00
decodedType.length +
Publish docs
2015-01-31 11:54:23 +00:00
decodedBanTime.length +
Publish docs
2015-02-12 10:44:15 +00:00
decodedVectorLength.length + vectorLength +
Publish docs
2015-01-31 11:54:23 +00:00
decodedErrorText.length
);
return {
Publish docs
2015-02-24 17:23:55 +00:00
type: decodedType.value,
Publish docs
2015-01-31 11:54:23 +00:00
banTime: decodedBanTime.value,
Publish docs
2015-02-12 10:44:15 +00:00
vector: vector,
Publish docs
2015-01-31 11:54:23 +00:00
errorText: decodedErrorText.str,
// Real data length.
length: length,
};
},
/**
* Encode `error` message.
* @param {Object} opts - Error options
Publish docs
2015-02-24 17:23:55 +00:00
* @param {number=} opts.type - Type of the error
Publish docs
2015-02-12 10:44:15 +00:00
* ([warning]{@link module:bitmessage/messages.error.WARNING} by
* default)
* @param {number=} opts.banTime - Inform the other node, that you
* will not accept further connections for this number of seconds (0
* by default)
Publish docs
2015-03-16 19:33:24 +00:00
* @param {Buffer=} opts.vector - A 32-byte [inventory vector]{@link
* module:bitmessage/structs.inv_vect} related to the error (empty by
* default)
Publish docs
2015-02-12 10:44:15 +00:00
* @param {string} opts.errorText - A human-readable error description
Publish docs
2015-01-31 11:54:23 +00:00
* @return {Buffer} Encoded message.
*/
encode: function(opts) {
var payload = error.encodePayload(opts);
return message.encode("error", payload);
},
/**
* Encode `error` message payload.
Publish docs
2015-02-12 10:44:15 +00:00
* The same as [encode]{@link module:bitmessage/messages.error.encode}.
Publish docs
2015-01-31 11:54:23 +00:00
*/
encodePayload: function(opts) {
Publish docs
2015-02-24 17:23:55 +00:00
var type = opts.type || error.WARNING;
Publish docs
2015-01-31 11:54:23 +00:00
var banTime = opts.banTime || 0;
Publish docs
2015-02-12 10:44:15 +00:00
// TODO(Kagami): Validate vector length.
var vector = opts.vector || new Buffer(0);
Publish docs
2015-01-31 11:54:23 +00:00
return Buffer.concat([
Publish docs
2015-02-24 17:23:55 +00:00
structs.var_int.encode(type),
Publish docs
2015-01-31 11:54:23 +00:00
structs.var_int.encode(banTime),
Publish docs
2015-02-12 10:44:15 +00:00
structs.var_int.encode(vector.length),
vector,
structs.var_str.encode(opts.errorText),
Publish docs
2015-01-31 11:54:23 +00:00
]);
},
};
Publish docs
2015-01-03 16:04:14 +00:00
</code></pre>
</article>
</section>
</div>
<nav>
Publish docs
2015-02-28 19:57:18 +00:00
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-bitmessage.html">bitmessage</a></li><li><a href="module-bitmessage_address.html">bitmessage/address</a></li><li><a href="module-bitmessage_crypto.html">bitmessage/crypto</a></li><li><a href="module-bitmessage_messages.html">bitmessage/messages</a></li><li><a href="module-bitmessage_objects.html">bitmessage/objects</a></li><li><a href="module-bitmessage_pow.html">bitmessage/pow</a></li><li><a href="module-bitmessage_structs.html">bitmessage/structs</a></li><li><a href="module-bitmessage_user-agent.html">bitmessage/user-agent</a></li><li><a href="module-bitmessage_wif.html">bitmessage/wif</a></li></ul><h3>Classes</h3><ul><li><a href="module-bitmessage_address.Address.html">Address</a></li><li><a href="module-bitmessage_structs.PubkeyBitfield.html">PubkeyBitfield</a></li><li><a href="module-bitmessage_structs.ServicesBitfield.html">ServicesBitfield</a></li></ul><h3>Namespaces</h3><ul><li><a href="module-bitmessage_messages.addr.html">addr</a></li><li><a href="module-bitmessage_messages.error.html">error</a></li><li><a href="module-bitmessage_messages.getdata.html">getdata</a></li><li><a href="module-bitmessage_messages.inv.html">inv</a></li><li><a href="module-bitmessage_messages.version.html">version</a></li><li><a href="module-bitmessage_objects.broadcast.html">broadcast</a></li><li><a href="module-bitmessage_objects.getpubkey.html">getpubkey</a></li><li><a href="module-bitmessage_objects.msg.html">msg</a></li><li><a href="module-bitmessage_objects.pubkey.html">pubkey</a></li><li><a href="module-bitmessage_structs.encrypted.html">encrypted</a></li><li><a href="module-bitmessage_structs.inv_vect.html">inv_vect</a></li><li><a href="module-bitmessage_structs.message.html">message</a></li><li><a href="module-bitmessage_structs.net_addr.html">net_addr</a></li><li><a href="module-bitmessage_structs.object.html">object</a></li><li><a href="module-bitmessage_structs.var_int.html">var_int</a></li><li><a href="module-bitmessage_structs.var_int_list.html">var_int_list</a></li><li><a href="module-bitmessage_structs.var_str.html">var_str</a></li></ul>
Publish docs
2015-01-03 16:04:14 +00:00
</nav>
<br class="clear">
<footer>
Publish docs
2015-03-16 19:33:24 +00:00
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Mon Mar 16 2015 22:32:51 GMT+0300 (MSK)
Publish docs
2015-01-03 16:04:14 +00:00
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>
Reference in New Issue Copy Permalink