Bitmessage/bitmessage-js
2
0
Fork 1
Code Issues 1 Pull Requests 1 Actions Packages Releases Activity

Publish docs

Browse Source
This commit is contained in:
Kagami Hiiragi 2015-03-16 22:33:24 +03:00
parent fffa8c80d1
commit feb254d01f
39 changed files with 353 additions and 165 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/address.js.html
View File

@ -119,6 +119,8 @@ Address.decode = function(str) {
str = str.trim();
if (str.slice(0, 3) === "BM-") {
str = str.slice(3);
} else if (str.slice(0, 11) === "bitmessage:") {
str = str.slice(11);
}
var bytes = bs58.decode(str);
@ -461,7 +463,7 @@ module.exports = Address;
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Sat Feb 28 2015 22:57:02 GMT+0300 (MSK)
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)
</footer>
<script> prettyPrint(); </script>

2
docs/crypto.js.html
View File

@ -218,7 +218,7 @@ exports.decrypt = function(privateKey, buf) {
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Sat Feb 28 2015 22:57:02 GMT+0300 (MSK)
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)
</footer>
<script> prettyPrint(); </script>

6
docs/index.html
View File

@ -43,7 +43,7 @@
<section>
<article><h1>bitmessage <a href="https://travis-ci.org/bitchan/bitmessage"><img src="https://travis-ci.org/bitchan/bitmessage.svg?branch=master" alt="Build Status"></a></h1><p><a href="https://www.npmjs.com/package/bitmessage"><img src="https://nodei.co/npm/bitmessage.png" alt="NPM"></a></p>
<article><h1>bitmessage <a href="https://travis-ci.org/bitchan/bitmessage"><img src="https://travis-ci.org/bitchan/bitmessage.svg?branch=master" alt="Build Status"></a></h1><p><a href="https://www.npmjs.com/package/bitmessage"><img src="https://nodei.co/npm/bitmessage.png?downloads=true" alt="NPM"></a></p>
<p>JavaScript Bitmessage library for both browserify and node. The goal of this project is to implement Bitmessage protocol v3 for both platforms at the maximum possible level (we still can't create TCP connections or listen for incoming connections in the Browser but the Proof of work and crypto is fully doable).</p>
<p>Public library API is currently in alpha stage, breaking changes are very likely to happen.</p>
<p>API documentation is available <a href="https://bitchan.github.io/bitmessage/docs/">here</a>.</p>
@ -179,7 +179,7 @@ tcp.on(&quot;established&quot;, function(version) {
}
});
});</code></pre><h2>License</h2><p>bitmessage - JavaScript Bitmessage library</p>
<p>Written in 2014-2015 by Kagami Hiiragi <a href="&#109;&#x61;&#x69;&#108;&#x74;&#111;&#58;&#107;&#97;&#x67;&#97;&#109;&#105;&#64;&#103;&#x65;&#x6e;&#x73;&#104;&#105;&#x6b;&#x65;&#x6e;&#x2e;&#x6f;&#x72;&#x67;">&#107;&#97;&#x67;&#97;&#109;&#105;&#64;&#103;&#x65;&#x6e;&#x73;&#104;&#105;&#x6b;&#x65;&#x6e;&#x2e;&#x6f;&#x72;&#x67;</a></p>
<p>Written in 2014-2015 by Kagami Hiiragi <a href="&#109;&#x61;&#105;&#x6c;&#116;&#x6f;&#58;&#107;&#x61;&#x67;&#97;&#x6d;&#x69;&#64;&#103;&#101;&#x6e;&#115;&#x68;&#105;&#107;&#x65;&#x6e;&#x2e;&#x6f;&#x72;&#x67;">&#107;&#x61;&#x67;&#97;&#x6d;&#x69;&#64;&#103;&#101;&#x6e;&#115;&#x68;&#105;&#107;&#x65;&#x6e;&#x2e;&#x6f;&#x72;&#x67;</a></p>
<p>To the extent possible under law, the author(s) have dedicated all copyright and related and neighboring rights to this software to the public domain worldwide. This software is distributed without any warranty.</p>
<p>You should have received a copy of the CC0 Public Domain Dedication along with this software. If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.</p></article>
</section>
@ -198,7 +198,7 @@ tcp.on(&quot;established&quot;, function(version) {
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Sat Feb 28 2015 22:57:02 GMT+0300 (MSK)
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)
</footer>
<script> prettyPrint(); </script>

2
docs/index.js.html
View File

@ -71,7 +71,7 @@ exports.UserAgent = require("./user-agent");
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Sat Feb 28 2015 22:57:02 GMT+0300 (MSK)
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)
</footer>
<script> prettyPrint(); </script>

51
docs/messages.js.html
View File

@ -394,8 +394,8 @@ var addr = exports.addr = {
var inv = exports.inv = {
/**
* @typedef {Object} DecodeResult
* @property {Buffer[]} inventory - List of
* [inventory vectors]{@link module:bitmessage/structs.inv_vect}
* @property {Buffer[]} vectors - List of [inventory vectors]{@link
* module:bitmessage/structs.inv_vect}
* @property {number} length - Real data length
* @memberof module:bitmessage/messages.inv
*/
@ -419,16 +419,16 @@ var inv = exports.inv = {
decodePayload: function(buf) {
var decoded = structs.var_int.decode(buf);
var listLength = decoded.value;
assert(listLength &lt;= 50000, "Too many inventory entires");
assert(listLength &lt;= 50000, "Too many vectors");
var length = decoded.length + listLength * 32;
assert(buf.length >= length, "Buffer is too small");
var rest = decoded.rest;
var inventory = new Array(listLength);
var vectors = new Array(listLength);
for (var i = 0; i &lt; listLength; i++) {
inventory[i] = rest.slice(i*32, (i+1)*32);
vectors[i] = rest.slice(i*32, (i+1)*32);
}
return {
inventory: inventory,
vectors: vectors,
// Real data length.
length: length,
};
@ -436,12 +436,12 @@ var inv = exports.inv = {
/**
* Encode `inv` message.
* @param {Buffer[]} inventory -
* [Inventory vector]{@link module:bitmessage/structs.inv_vect} list
* @param {Buffer[]} vectors - [Inventory vector]{@link
* module:bitmessage/structs.inv_vect} list
* @return {Buffer} Encoded message.
*/
encode: function(inventory) {
var payload = inv.encodePayload(inventory);
encode: function(vectors) {
var payload = inv.encodePayload(vectors);
return message.encode("inv", payload);
},
@ -449,10 +449,10 @@ var inv = exports.inv = {
* Encode `inv` message payload.
* The same as [encode]{@link module:bitmessage/messages.inv.encode}.
*/
encodePayload: function(inventory) {
assert(inventory.length &lt;= 50000, "Too many inventory entires");
encodePayload: function(vectors) {
assert(vectors.length &lt;= 50000, "Too many vectors");
// TODO(Kagami): Validate vectors length.
var bufs = [structs.var_int.encode(inventory.length)].concat(inventory);
var bufs = [structs.var_int.encode(vectors.length)].concat(vectors);
return Buffer.concat(bufs);
},
};
@ -467,8 +467,8 @@ var inv = exports.inv = {
exports.getdata = objectAssign({}, inv, {
/**
* @typedef {Object} DecodeResult
* @property {Buffer[]} inventory - List of
* [inventory vectors]{@link module:bitmessage/structs.inv_vect}
* @property {Buffer[]} vectors - List of [inventory vectors]{@link
* module:bitmessage/structs.inv_vect}
* @property {number} length - Real data length
* @memberof module:bitmessage/messages.getdata
*/
@ -495,13 +495,13 @@ exports.getdata = objectAssign({}, inv, {
/**
* Encode `getdata` message.
* @param {Buffer[]} inventory -
* [Inventory vector]{@link module:bitmessage/structs.inv_vect} list
* @param {Buffer[]} vectors - [Inventory vector]{@link
* module:bitmessage/structs.inv_vect} list
* @return {Buffer} Encoded message.
* @memberof module:bitmessage/messages.getdata
*/
encode: function(inventory) {
var payload = inv.encodePayload(inventory);
encode: function(vectors) {
var payload = inv.encodePayload(vectors);
return message.encode("getdata", payload);
},
@ -558,9 +558,8 @@ var error = exports.error = {
* @property {number} type - Type of the error
* @property {number} banTime - The other node informs that it will
* not accept further connections for this number of seconds
* @property {?Buffer} vector -
* [Inventory vector]{@link module:bitmessage/structs.inv_vect}
* related to the error
* @property {?Buffer} vector - [Inventory vector]{@link
* module:bitmessage/structs.inv_vect} related to the error
* @property {string} errorText - A human-readable error description
* @property {number} length - Real data length
* @memberof module:bitmessage/messages.error
@ -626,9 +625,9 @@ var error = exports.error = {
* @param {number=} opts.banTime - Inform the other node, that you
* will not accept further connections for this number of seconds (0
* by default)
* @param {Buffer=} opts.vector - A 32-byte
* [inventory vector]{@link module:bitmessage/structs.inv_vect}
* related to the error (empty by default)
* @param {Buffer=} opts.vector - A 32-byte [inventory vector]{@link
* module:bitmessage/structs.inv_vect} related to the error (empty by
* default)
* @param {string} opts.errorText - A human-readable error description
* @return {Buffer} Encoded message.
*/
@ -671,7 +670,7 @@ var error = exports.error = {
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Sat Feb 28 2015 22:57:02 GMT+0300 (MSK)
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)
</footer>
<script> prettyPrint(); </script>

2
docs/module-bitmessage.html
View File

@ -660,7 +660,7 @@
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Sat Feb 28 2015 22:57:02 GMT+0300 (MSK)
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)
</footer>
<script> prettyPrint(); </script>

20
docs/module-bitmessage_address.Address.html
View File

@ -863,7 +863,7 @@ RIPEMD hash (19 by default)</p></td>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="address.js.html">address.js</a>, <a href="address.js.html#line297">line 297</a>
<a href="address.js.html">address.js</a>, <a href="address.js.html#line299">line 299</a>
</li></ul></dd>
@ -1148,7 +1148,7 @@ hash (19 by default)</p></td>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="address.js.html">address.js</a>, <a href="address.js.html#line259">line 259</a>
<a href="address.js.html">address.js</a>, <a href="address.js.html#line261">line 261</a>
</li></ul></dd>
@ -1506,7 +1506,7 @@ readability and consistent with <code>isArray</code>, <code>isBuffer</code>, etc
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="address.js.html">address.js</a>, <a href="address.js.html#line238">line 238</a>
<a href="address.js.html">address.js</a>, <a href="address.js.html#line240">line 240</a>
</li></ul></dd>
@ -1611,7 +1611,7 @@ readability and consistent with <code>isArray</code>, <code>isBuffer</code>, etc
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="address.js.html">address.js</a>, <a href="address.js.html#line163">line 163</a>
<a href="address.js.html">address.js</a>, <a href="address.js.html#line165">line 165</a>
</li></ul></dd>
@ -1717,7 +1717,7 @@ encrypt/decrypt
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="address.js.html">address.js</a>, <a href="address.js.html#line177">line 177</a>
<a href="address.js.html">address.js</a>, <a href="address.js.html#line179">line 179</a>
</li></ul></dd>
@ -1822,7 +1822,7 @@ encrypt/decrypt
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="address.js.html">address.js</a>, <a href="address.js.html#line144">line 144</a>
<a href="address.js.html">address.js</a>, <a href="address.js.html#line146">line 146</a>
</li></ul></dd>
@ -1928,7 +1928,7 @@ encrypt/decrypt
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="address.js.html">address.js</a>, <a href="address.js.html#line154">line 154</a>
<a href="address.js.html">address.js</a>, <a href="address.js.html#line156">line 156</a>
</li></ul></dd>
@ -2032,7 +2032,7 @@ encrypt/decrypt
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="address.js.html">address.js</a>, <a href="address.js.html#line125">line 125</a>
<a href="address.js.html">address.js</a>, <a href="address.js.html#line127">line 127</a>
</li></ul></dd>
@ -2136,7 +2136,7 @@ encrypt/decrypt
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="address.js.html">address.js</a>, <a href="address.js.html#line185">line 185</a>
<a href="address.js.html">address.js</a>, <a href="address.js.html#line187">line 187</a>
</li></ul></dd>
@ -2206,7 +2206,7 @@ encrypt/decrypt
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Sat Feb 28 2015 22:57:02 GMT+0300 (MSK)
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)
</footer>
<script> prettyPrint(); </script>

2
docs/module-bitmessage_address.html
View File

@ -177,7 +177,7 @@ console.log("Deterministic Bitmessage address:", addr2.encode());</code></pre>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Sat Feb 28 2015 22:57:02 GMT+0300 (MSK)
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)
</footer>
<script> prettyPrint(); </script>

2
docs/module-bitmessage_crypto.html
View File

@ -2034,7 +2034,7 @@ and rejects on bad key or signature.</p>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Sat Feb 28 2015 22:57:02 GMT+0300 (MSK)
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)
</footer>
<script> prettyPrint(); </script>

2
docs/module-bitmessage_messages.addr.html
View File

@ -757,7 +757,7 @@ The same as <a href="module-bitmessage_messages.addr.html#.encode">encode</a>.</
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Sat Feb 28 2015 22:57:02 GMT+0300 (MSK)
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)
</footer>
<script> prettyPrint(); </script>

18
docs/module-bitmessage_messages.error.html
View File

@ -440,7 +440,7 @@ maybe ban you for some time.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line547">line 547</a>
<a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line546">line 546</a>
</li></ul></dd>
@ -545,7 +545,7 @@ The same as <a href="module-bitmessage_messages.error.html#.decode">decode</a>.<
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line557">line 557</a>
<a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line556">line 556</a>
</li></ul></dd>
@ -759,9 +759,8 @@ by default)</p></td>
<td class="description last"><p>A 32-byte
<a href="module-bitmessage_structs.inv_vect.html">inventory vector</a>
related to the error (empty by default)</p></td>
<td class="description last"><p>A 32-byte <a href="module-bitmessage_structs.inv_vect.html">inventory vector</a> related to the error (empty by
default)</p></td>
</tr>
@ -840,7 +839,7 @@ related to the error (empty by default)</p></td>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line607">line 607</a>
<a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line606">line 606</a>
</li></ul></dd>
@ -945,7 +944,7 @@ The same as <a href="module-bitmessage_messages.error.html#.encode">encode</a>.<
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line616">line 616</a>
<a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line615">line 615</a>
</li></ul></dd>
@ -1260,8 +1259,7 @@ not accept further connections for this number of seconds</p></td>
<td class="description last"><p><a href="module-bitmessage_structs.inv_vect.html">Inventory vector</a>
related to the error</p></td>
<td class="description last"><p><a href="module-bitmessage_structs.inv_vect.html">Inventory vector</a> related to the error</p></td>
</tr>
@ -1394,7 +1392,7 @@ related to the error</p></td>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Sat Feb 28 2015 22:57:02 GMT+0300 (MSK)
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)
</footer>
<script> prettyPrint(); </script>

11
docs/module-bitmessage_messages.getdata.html
View File

@ -357,7 +357,7 @@ The same as <a href="module-bitmessage_messages.getdata.html#.decode">decode</a>
<h4 class="name" id=".encode"><span class="type-signature">(static) </span>encode<span class="signature">(inventory)</span><span class="type-signature"> &rarr; {Buffer}</span></h4>
<h4 class="name" id=".encode"><span class="type-signature">(static) </span>encode<span class="signature">(vectors)</span><span class="type-signature"> &rarr; {Buffer}</span></h4>
@ -400,7 +400,7 @@ The same as <a href="module-bitmessage_messages.getdata.html#.decode">decode</a>
<tr>
<td class="name"><code>inventory</code></td>
<td class="name"><code>vectors</code></td>
<td class="type">
@ -643,7 +643,7 @@ The same as <a href="module-bitmessage_messages.getdata.html#.encode">encode</a>
<tr>
<td class="name"><code>inventory</code></td>
<td class="name"><code>vectors</code></td>
<td class="type">
@ -659,8 +659,7 @@ The same as <a href="module-bitmessage_messages.getdata.html#.encode">encode</a>
<td class="description last"><p>List of
<a href="module-bitmessage_structs.inv_vect.html">inventory vectors</a></p></td>
<td class="description last"><p>List of <a href="module-bitmessage_structs.inv_vect.html">inventory vectors</a></p></td>
</tr>
@ -758,7 +757,7 @@ The same as <a href="module-bitmessage_messages.getdata.html#.encode">encode</a>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Sat Feb 28 2015 22:57:02 GMT+0300 (MSK)
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)
</footer>
<script> prettyPrint(); </script>

2
docs/module-bitmessage_messages.html
View File

@ -368,7 +368,7 @@ routine.</p>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Sat Feb 28 2015 22:57:02 GMT+0300 (MSK)
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)
</footer>
<script> prettyPrint(); </script>

11
docs/module-bitmessage_messages.inv.html
View File

@ -356,7 +356,7 @@ The same as <a href="module-bitmessage_messages.inv.html#.decode">decode</a>.</p
<h4 class="name" id=".encode"><span class="type-signature">(static) </span>encode<span class="signature">(inventory)</span><span class="type-signature"> &rarr; {Buffer}</span></h4>
<h4 class="name" id=".encode"><span class="type-signature">(static) </span>encode<span class="signature">(vectors)</span><span class="type-signature"> &rarr; {Buffer}</span></h4>
@ -399,7 +399,7 @@ The same as <a href="module-bitmessage_messages.inv.html#.decode">decode</a>.</p
<tr>
<td class="name"><code>inventory</code></td>
<td class="name"><code>vectors</code></td>
<td class="type">
@ -642,7 +642,7 @@ The same as <a href="module-bitmessage_messages.inv.html#.encode">encode</a>.</p
<tr>
<td class="name"><code>inventory</code></td>
<td class="name"><code>vectors</code></td>
<td class="type">
@ -658,8 +658,7 @@ The same as <a href="module-bitmessage_messages.inv.html#.encode">encode</a>.</p
<td class="description last"><p>List of
<a href="module-bitmessage_structs.inv_vect.html">inventory vectors</a></p></td>
<td class="description last"><p>List of <a href="module-bitmessage_structs.inv_vect.html">inventory vectors</a></p></td>
</tr>
@ -757,7 +756,7 @@ The same as <a href="module-bitmessage_messages.inv.html#.encode">encode</a>.</p
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Sat Feb 28 2015 22:57:02 GMT+0300 (MSK)
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)
</footer>
<script> prettyPrint(); </script>

2
docs/module-bitmessage_messages.version.html
View File

@ -1325,7 +1325,7 @@ connection to self</p></td>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Sat Feb 28 2015 22:57:02 GMT+0300 (MSK)
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)
</footer>
<script> prettyPrint(); </script>

43
docs/module-bitmessage_objects.broadcast.html
View File

@ -76,7 +76,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line875">line 875</a>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line878">line 878</a>
</li></ul></dd>
@ -301,7 +301,7 @@ respectfully.</p></td>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line923">line 923</a>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line927">line 927</a>
</li></ul></dd>
@ -407,7 +407,7 @@ The same as <a href="module-bitmessage_objects.broadcast.html#.decodeAsync">deco
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line936">line 936</a>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line940">line 940</a>
</li></ul></dd>
@ -766,7 +766,7 @@ default)</p></td>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line1073">line 1073</a>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line1077">line 1077</a>
</li></ul></dd>
@ -872,7 +872,7 @@ The same as <a href="module-bitmessage_objects.broadcast.html#.encodeAsync">enco
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line1084">line 1084</a>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line1088">line 1088</a>
</li></ul></dd>
@ -1011,6 +1011,35 @@ The same as <a href="module-bitmessage_objects.broadcast.html#.encodeAsync">enco
<tr>
<td class="name"><code>expires</code></td>
<td class="type">
<span class="param-type">Date</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>Object expiration date</p></td>
</tr>
<tr>
<td class="name"><code>type</code></td>
@ -1550,7 +1579,7 @@ unparsed buffer data for other encodings</p></td>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line876">line 876</a>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line879">line 879</a>
</li></ul></dd>
@ -1586,7 +1615,7 @@ unparsed buffer data for other encodings</p></td>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Sat Feb 28 2015 22:57:02 GMT+0300 (MSK)
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)
</footer>
<script> prettyPrint(); </script>

33
docs/module-bitmessage_objects.getpubkey.html
View File

@ -264,7 +264,7 @@ for the public key.</p></div>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line118">line 118</a>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line119">line 119</a>
</li></ul></dd>
@ -370,7 +370,7 @@ The same as <a href="module-bitmessage_objects.getpubkey.html#.decodeAsync">deco
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line131">line 131</a>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line132">line 132</a>
</li></ul></dd>
@ -625,7 +625,7 @@ default)</p></td>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line161">line 161</a>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line162">line 162</a>
</li></ul></dd>
@ -732,7 +732,7 @@ The same as
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line172">line 172</a>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line173">line 173</a>
</li></ul></dd>
@ -857,6 +857,29 @@ The same as
<tr>
<td class="name"><code>expires</code></td>
<td class="type">
<span class="param-type">Date</span>
</td>
<td class="description last"><p>Object expiration date</p></td>
</tr>
<tr>
<td class="name"><code>type</code></td>
@ -1090,7 +1113,7 @@ for address version &gt;= 4</p></td>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Sat Feb 28 2015 22:57:02 GMT+0300 (MSK)
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)
</footer>
<script> prettyPrint(); </script>

2
docs/module-bitmessage_objects.html
View File

@ -419,7 +419,7 @@ then call decode function of the appropriate object handler.</p>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Sat Feb 28 2015 22:57:02 GMT+0300 (MSK)
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)
</footer>
<script> prettyPrint(); </script>

49
docs/module-bitmessage_objects.msg.html
View File

@ -76,7 +76,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line567">line 567</a>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line569">line 569</a>
</li></ul></dd>
@ -169,7 +169,7 @@ simply be sharing its public key with you.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line573">line 573</a>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line575">line 575</a>
</li></ul></dd>
@ -241,7 +241,7 @@ simply be sharing its public key with you.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line584">line 584</a>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line586">line 586</a>
</li></ul></dd>
@ -314,7 +314,7 @@ of data, like URIs or magnet links.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line579">line 579</a>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line581">line 581</a>
</li></ul></dd>
@ -517,7 +517,7 @@ to decrypt the message</p></td>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line630">line 630</a>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line633">line 633</a>
</li></ul></dd>
@ -624,7 +624,7 @@ The same as <a href="module-bitmessage_objects.msg.html#.decodeAsync">decodeAsyn
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line643">line 643</a>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line646">line 646</a>
</li></ul></dd>
@ -1048,7 +1048,7 @@ default)</p></td>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line754">line 754</a>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line757">line 757</a>
</li></ul></dd>
@ -1154,7 +1154,7 @@ The same as <a href="module-bitmessage_objects.msg.html#.encodeAsync">encodeAsyn
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line765">line 765</a>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line768">line 768</a>
</li></ul></dd>
@ -1293,6 +1293,35 @@ The same as <a href="module-bitmessage_objects.msg.html#.encodeAsync">encodeAsyn
<tr>
<td class="name"><code>expires</code></td>
<td class="type">
<span class="param-type">Date</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>Object expiration date</p></td>
</tr>
<tr>
<td class="name"><code>type</code></td>
@ -1860,7 +1889,7 @@ unparsed buffer data for other encodings</p></td>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line586">line 586</a>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line588">line 588</a>
</li></ul></dd>
@ -1896,7 +1925,7 @@ unparsed buffer data for other encodings</p></td>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Sat Feb 28 2015 22:57:02 GMT+0300 (MSK)
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)
</footer>
<script> prettyPrint(); </script>

37
docs/module-bitmessage_objects.pubkey.html
View File

@ -76,7 +76,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line252">line 252</a>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line253">line 253</a>
</li></ul></dd>
@ -321,7 +321,7 @@ respectfully.</p></td>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line293">line 293</a>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line295">line 295</a>
</li></ul></dd>
@ -428,7 +428,7 @@ The same as <a href="module-bitmessage_objects.pubkey.html#.decodeAsync">decodeA
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line306">line 306</a>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line308">line 308</a>
</li></ul></dd>
@ -714,7 +714,7 @@ default)</p></td>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line391">line 391</a>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line393">line 393</a>
</li></ul></dd>
@ -820,7 +820,7 @@ The same as <a href="module-bitmessage_objects.pubkey.html#.encodeAsync">encodeA
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line402">line 402</a>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line404">line 404</a>
</li></ul></dd>
@ -945,6 +945,29 @@ The same as <a href="module-bitmessage_objects.pubkey.html#.encodeAsync">encodeA
<tr>
<td class="name"><code>expires</code></td>
<td class="type">
<span class="param-type">Date</span>
</td>
<td class="description last"><p>Object expiration date</p></td>
</tr>
<tr>
<td class="name"><code>type</code></td>
@ -1260,7 +1283,7 @@ only for <code>pubkey</code> version &gt;= 3)</p></td>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line253">line 253</a>
<a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line254">line 254</a>
</li></ul></dd>
@ -1296,7 +1319,7 @@ only for <code>pubkey</code> version &gt;= 3)</p></td>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Sat Feb 28 2015 22:57:02 GMT+0300 (MSK)
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)
</footer>
<script> prettyPrint(); </script>

2
docs/module-bitmessage_pow.html
View File

@ -1095,7 +1095,7 @@ raised to 1000.</p></td>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Sat Feb 28 2015 22:57:02 GMT+0300 (MSK)
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)
</footer>
<script> prettyPrint(); </script>

14
docs/module-bitmessage_structs.PubkeyBitfield.html
View File

@ -190,7 +190,7 @@ not provided or will be copied if <code>opts.copy</code> is <code>true</code>)</
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line1011">line 1011</a>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line1022">line 1022</a>
</li></ul></dd>
@ -308,7 +308,7 @@ dropping them).</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line1043">line 1043</a>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line1054">line 1054</a>
</li></ul></dd>
@ -383,7 +383,7 @@ bound for them.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line1052">line 1052</a>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line1063">line 1063</a>
</li></ul></dd>
@ -455,7 +455,7 @@ bound for them.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line1028">line 1028</a>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line1039">line 1039</a>
</li></ul></dd>
@ -582,7 +582,7 @@ bound for them.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line1012">line 1012</a>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line1023">line 1023</a>
</li></ul></dd>
@ -734,7 +734,7 @@ bound for them.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line1020">line 1020</a>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line1031">line 1031</a>
</li></ul></dd>
@ -804,7 +804,7 @@ bound for them.</p>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Sat Feb 28 2015 22:57:02 GMT+0300 (MSK)
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)
</footer>
<script> prettyPrint(); </script>

16
docs/module-bitmessage_structs.ServicesBitfield.html
View File

@ -190,7 +190,7 @@ not provided or will be copied if <code>opts.copy</code> is <code>true</code>)</
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line946">line 946</a>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line957">line 957</a>
</li></ul></dd>
@ -304,7 +304,7 @@ web/mobile clients (proposal feature).</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line992">line 992</a>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line1003">line 1003</a>
</li></ul></dd>
@ -384,7 +384,7 @@ capabilities (proposal feature).</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line984">line 984</a>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line995">line 995</a>
</li></ul></dd>
@ -463,7 +463,7 @@ capabilities (proposal feature).</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line976">line 976</a>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line987">line 987</a>
</li></ul></dd>
@ -535,7 +535,7 @@ capabilities (proposal feature).</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line963">line 963</a>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line974">line 974</a>
</li></ul></dd>
@ -662,7 +662,7 @@ capabilities (proposal feature).</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line947">line 947</a>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line958">line 958</a>
</li></ul></dd>
@ -814,7 +814,7 @@ capabilities (proposal feature).</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line955">line 955</a>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line966">line 966</a>
</li></ul></dd>
@ -884,7 +884,7 @@ capabilities (proposal feature).</p>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Sat Feb 28 2015 22:57:02 GMT+0300 (MSK)
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)
</footer>
<script> prettyPrint(); </script>

10
docs/module-bitmessage_structs.encrypted.html
View File

@ -76,7 +76,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line822">line 822</a>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line833">line 833</a>
</li></ul></dd>
@ -219,7 +219,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line837">line 837</a>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line848">line 848</a>
</li></ul></dd>
@ -492,7 +492,7 @@ size)</p></td>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line846">line 846</a>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line857">line 857</a>
</li></ul></dd>
@ -720,7 +720,7 @@ size)</p></td>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line828">line 828</a>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line839">line 839</a>
</li></ul></dd>
@ -756,7 +756,7 @@ size)</p></td>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Sat Feb 28 2015 22:57:02 GMT+0300 (MSK)
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)
</footer>
<script> prettyPrint(); </script>

2
docs/module-bitmessage_structs.html
View File

@ -216,7 +216,7 @@ console.log(decoded4.list); // [1, 2, 3]</code></pre>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Sat Feb 28 2015 22:57:02 GMT+0300 (MSK)
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)
</footer>
<script> prettyPrint(); </script>

6
docs/module-bitmessage_structs.inv_vect.html
View File

@ -76,7 +76,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line808">line 808</a>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line819">line 819</a>
</li></ul></dd>
@ -219,7 +219,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line817">line 817</a>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line828">line 828</a>
</li></ul></dd>
@ -289,7 +289,7 @@
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Sat Feb 28 2015 22:57:02 GMT+0300 (MSK)
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)
</footer>
<script> prettyPrint(); </script>

2
docs/module-bitmessage_structs.message.html
View File

@ -1149,7 +1149,7 @@ processing message</p></td>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Sat Feb 28 2015 22:57:02 GMT+0300 (MSK)
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)
</footer>
<script> prettyPrint(); </script>

10
docs/module-bitmessage_structs.net_addr.html
View File

@ -76,7 +76,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line706">line 706</a>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line717">line 717</a>
</li></ul></dd>
@ -264,7 +264,7 @@ decode <code>net_addr</code> from
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line730">line 730</a>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line741">line 741</a>
</li></ul></dd>
@ -647,7 +647,7 @@ provided by the node (<code>NODE_NETWORK</code> by default)</p></td>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line771">line 771</a>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line782">line 782</a>
</li></ul></dd>
@ -900,7 +900,7 @@ provided by the node</p></td>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line707">line 707</a>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line718">line 718</a>
</li></ul></dd>
@ -936,7 +936,7 @@ provided by the node</p></td>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Sat Feb 28 2015 22:57:02 GMT+0300 (MSK)
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)
</footer>
<script> prettyPrint(); </script>

90
docs/module-bitmessage_structs.object.html
View File

@ -628,7 +628,7 @@ nodes.</p></div>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line326">line 326</a>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line327">line 327</a>
</li></ul></dd>
@ -762,7 +762,7 @@ The same as <a href="module-bitmessage_structs.object.html#.decode">decode</a>.<
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line336">line 336</a>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line337">line 337</a>
</li></ul></dd>
@ -1109,7 +1109,7 @@ The same as <a href="module-bitmessage_structs.object.html#.decode">decode</a>.<
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line432">line 432</a>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line443">line 443</a>
</li></ul></dd>
@ -1214,7 +1214,7 @@ The same as <a href="module-bitmessage_structs.object.html#.encode">encode</a>.<
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line441">line 441</a>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line452">line 452</a>
</li></ul></dd>
@ -1531,7 +1531,7 @@ useful if you are going to calculate it later).</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line470">line 470</a>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line481">line 481</a>
</li></ul></dd>
@ -1686,7 +1686,56 @@ useful if you are going to calculate it later).</p>
<td class="description last"><p>Any of <a href="module-bitmessage_structs.object.html#.decode">object.decode</a> options</p></td>
<td class="description last"><p>Any of <a href="module-bitmessage_structs.object.html#.decode">object.decode</a> options and:</p>
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>stream</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>Expected object's stream</p></td>
</tr>
</tbody>
</table>
</td>
</tr>
@ -1727,7 +1776,7 @@ useful if you are going to calculate it later).</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line394">line 394</a>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line398">line 398</a>
</li></ul></dd>
@ -1833,7 +1882,7 @@ The same as <a href="module-bitmessage_structs.object.html#.validate">validate</
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line412">line 412</a>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line416">line 416</a>
</li></ul></dd>
@ -1958,6 +2007,29 @@ The same as <a href="module-bitmessage_structs.object.html#.validate">validate</
<tr>
<td class="name"><code>expires</code></td>
<td class="type">
<span class="param-type">Date</span>
</td>
<td class="description last"><p>Object expiration date</p></td>
</tr>
<tr>
<td class="name"><code>type</code></td>
@ -2143,7 +2215,7 @@ The same as <a href="module-bitmessage_structs.object.html#.validate">validate</
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Sat Feb 28 2015 22:57:02 GMT+0300 (MSK)
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)
</footer>
<script> prettyPrint(); </script>

10
docs/module-bitmessage_structs.var_int.html
View File

@ -76,7 +76,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line495">line 495</a>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line506">line 506</a>
</li></ul></dd>
@ -219,7 +219,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line511">line 511</a>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line522">line 522</a>
</li></ul></dd>
@ -375,7 +375,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line556">line 556</a>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line567">line 567</a>
</li></ul></dd>
@ -579,7 +579,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line496">line 496</a>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line507">line 507</a>
</li></ul></dd>
@ -615,7 +615,7 @@
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Sat Feb 28 2015 22:57:02 GMT+0300 (MSK)
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)
</footer>
<script> prettyPrint(); </script>

10
docs/module-bitmessage_structs.var_int_list.html
View File

@ -76,7 +76,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line640">line 640</a>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line651">line 651</a>
</li></ul></dd>
@ -220,7 +220,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line657">line 657</a>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line668">line 668</a>
</li></ul></dd>
@ -373,7 +373,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line677">line 677</a>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line688">line 688</a>
</li></ul></dd>
@ -577,7 +577,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line641">line 641</a>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line652">line 652</a>
</li></ul></dd>
@ -613,7 +613,7 @@
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Sat Feb 28 2015 22:57:02 GMT+0300 (MSK)
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)
</footer>
<script> prettyPrint(); </script>

10
docs/module-bitmessage_structs.var_str.html
View File

@ -76,7 +76,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line596">line 596</a>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line607">line 607</a>
</li></ul></dd>
@ -219,7 +219,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line612">line 612</a>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line623">line 623</a>
</li></ul></dd>
@ -372,7 +372,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line628">line 628</a>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line639">line 639</a>
</li></ul></dd>
@ -576,7 +576,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line597">line 597</a>
<a href="structs.js.html">structs.js</a>, <a href="structs.js.html#line608">line 608</a>
</li></ul></dd>
@ -612,7 +612,7 @@
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Sat Feb 28 2015 22:57:02 GMT+0300 (MSK)
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)
</footer>
<script> prettyPrint(); </script>

2
docs/module-bitmessage_user-agent.html
View File

@ -907,7 +907,7 @@ format because it's not that important.</p>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Sat Feb 28 2015 22:57:02 GMT+0300 (MSK)
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)
</footer>
<script> prettyPrint(); </script>

2
docs/module-bitmessage_wif.html
View File

@ -469,7 +469,7 @@ key).</p>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Sat Feb 28 2015 22:57:02 GMT+0300 (MSK)
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)
</footer>
<script> prettyPrint(); </script>

6
docs/objects.js.html
View File

@ -122,6 +122,7 @@ var getpubkey = exports.getpubkey = {
* @typedef {Object} DecodeResult
* @property {Buffer} nonce - A 8-byte object nonce
* @property {number} ttl - Time to live in seconds
* @property {Date} expires - Object expiration date
* @property {number} type - Object type
* @property {number} version - Object version
* @property {number} stream - Object stream
@ -282,6 +283,7 @@ var pubkey = exports.pubkey = {
* @typedef {Object} DecodeResult
* @property {Buffer} nonce - A 8-byte object nonce
* @property {number} ttl - Time to live in seconds
* @property {Date} expires - Object expiration date
* @property {number} type - Object type
* @property {number} version - Object version
* @property {number} stream - Object stream
@ -615,6 +617,7 @@ var msg = exports.msg = {
* @typedef {Object} DecodeResult
* @property {Buffer} nonce - A 8-byte object nonce
* @property {number} ttl - Time to live in seconds
* @property {Date} expires - Object expiration date
* @property {number} type - Object type
* @property {number} version - Object version
* @property {number} stream - Object stream
@ -905,6 +908,7 @@ var broadcast = exports.broadcast = {
* @typedef {Object} DecodeResult
* @property {Buffer} nonce - A 8-byte object nonce
* @property {number} ttl - Time to live in seconds
* @property {Date} expires - Object expiration date
* @property {number} type - Object type
* @property {number} version - Object version
* @property {number} stream - Object stream
@ -1176,7 +1180,7 @@ var broadcast = exports.broadcast = {
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Sat Feb 28 2015 22:57:02 GMT+0300 (MSK)
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)
</footer>
<script> prettyPrint(); </script>

2
docs/pow.js.html
View File

@ -156,7 +156,7 @@ exports.doAsync = function(opts) {
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Sat Feb 28 2015 22:57:02 GMT+0300 (MSK)
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)
</footer>
<script> prettyPrint(); </script>

19
docs/structs.js.html
View File

@ -332,6 +332,7 @@ var object = exports.object = {
* @typedef {Object} DecodeResult
* @property {Buffer} nonce - A 8-byte object nonce
* @property {number} ttl - Time to live in seconds
* @property {Date} expires - Object expiration date
* @property {number} type - Object type
* @property {number} version - Object version
* @property {number} stream - Object stream
@ -375,6 +376,7 @@ var object = exports.object = {
// TTL.
var expiresTime = util.readTimestamp64BE(buf.slice(8, 16));
var expires = new Date(expiresTime * 1000);
var ttl = expiresTime - util.tnow();
assert(ttl &lt;= 2430000, "expiresTime is too far in the future");
if (!opts.allowExpired) {
@ -395,7 +397,7 @@ var object = exports.object = {
var decodedStream = var_int.decode(decodedVersion.rest);
var headerLength = 20 + decodedVersion.length + decodedStream.length;
if (opts._validate) { return; }
if (opts._validate) { return {stream: decodedStream.value}; }
var objectPayload = new Buffer(decodedStream.rest.length);
decodedStream.rest.copy(objectPayload);
@ -403,6 +405,7 @@ var object = exports.object = {
return {
nonce: nonce,
ttl: ttl,
expires: expires,
type: type,
version: decodedVersion.value,
stream: decodedStream.value,
@ -415,7 +418,8 @@ var object = exports.object = {
* Check whether given `object` message is valid.
* @param {Buffer} buf - Message
* @param {Object=} opts - Any of [object.decode]{@link
* module:bitmessage/structs.object.decode} options
* module:bitmessage/structs.object.decode} options and:
* @param {number} opts.stream - Expected object's stream
* @return {?Error} Return an error with description if object is
* invalid.
*/
@ -439,11 +443,18 @@ var object = exports.object = {
*/
validatePayload: function(buf, opts) {
opts = objectAssign({}, opts, {_validate: true});
var decoded;
try {
object.decodePayload(buf, opts);
decoded = object.decodePayload(buf, opts);
} catch(e) {
return e;
}
if (opts.stream &amp;&amp; decoded.stream !== opts.stream) {
return new Error(
"The stream number " + opts.stream +
" is not the one we are interested in"
);
}
},
/**
@ -1095,7 +1106,7 @@ exports.PubkeyBitfield = objectAssign(Bitfield(32), {
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Sat Feb 28 2015 22:57:02 GMT+0300 (MSK)
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)
</footer>
<script> prettyPrint(); </script>

2
docs/user-agent.js.html
View File

@ -154,7 +154,7 @@ exports.encodeSelfWith = function(software) {
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Sat Feb 28 2015 22:57:02 GMT+0300 (MSK)
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)
</footer>
<script> prettyPrint(); </script>

2
docs/wif.js.html
View File

@ -87,7 +87,7 @@ exports.encode = function(privateKey) {
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Sat Feb 28 2015 22:57:02 GMT+0300 (MSK)
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)
</footer>
<script> prettyPrint(); </script>