commit 1bd0f7449aae05861219874c7a08bcfe5d8a172b Author: Kagami Hiiragi Date: Sat Jan 3 19:04:14 2015 +0300 Publish docs diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b86cc9e --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +* +!/docs/ diff --git a/docs/address.js.html b/docs/address.js.html new file mode 100644 index 0000000..6d0010b --- /dev/null +++ b/docs/address.js.html @@ -0,0 +1,284 @@ + + + + + JSDoc: Source: address.js + + + + + + + + + + +

+ +

Source: address.js

+ + + + + + +

/**
+ * Working with Bitmessage addresses.
+ * @see {@link https://bitmessage.org/wiki/Address}
+ * @module bitmessage/address
+ */
+
+"use strict";
+
+require("object.assign").shim();
+var assert = require("assert");
+var bufferEqual = require("buffer-equal");
+var bs58 = require("bs58");
+var var_int = require("./structs").var_int;
+var bmcrypto = require("./crypto");
+
+/**
+ * Create a new Bitmessage address object.
+ * @param {?Object} opts - Address options
+ * @constructor
+ * @static
+ */
+function Address(opts) {
+  if (!(this instanceof Address)) {
+    return new Address(opts);
+  }
+  opts = opts || {};
+  Object.assign(this, opts);
+  this.version = this.version || 4;
+  assert(this.version <= 4, "Version too high");
+  assert(this.version >= 1, "Version too low");
+  this.stream = this.stream || 1;
+  if (this.ripe) {
+    assertripelen(getripelen(this.ripe), this.version, this.ripe);
+    if (this.ripe.length < 20) {
+      var fullripe = new Buffer(20);
+      fullripe.fill(0);
+      this.ripe.copy(fullripe, 20 - this.ripe.length);
+      this.ripe = fullripe;
+    }
+  }
+}
+
+/**
+ * Parse Bitmessage address into address object.
+ * @param {String} str - Address string (with or without `BM-` prefix)
+ * @return {Address} Decoded address object.
+ */
+Address.decode = function(str) {
+  str = str.trim();
+  if (str.slice(0, 3) === "BM-") {
+    str = str.slice(3);
+  }
+
+  var bytes = bs58.decode(str);
+  var data = new Buffer(bytes.slice(0, -4));
+  var checksum = new Buffer(bytes.slice(-4));
+  assert(bufferEqual(checksum, getchecksum(data)), "Bad checkum");
+
+  var decoded = var_int.decode(data);
+  var version = decoded.value;
+
+  data = decoded.rest;
+  decoded = var_int.decode(data);
+  var stream = decoded.value;
+
+  var ripe = decoded.rest;
+  if (version === 4) {
+    assert(ripe[0] !== 0, "Ripe encode error");
+  }
+
+  return new Address({version: version, stream: stream, ripe: ripe});
+};
+
+// Compute the Bitmessage checksum for the given data.
+function getchecksum(data) {
+  return bmcrypto.sha512(bmcrypto.sha512(data)).slice(0, 4);
+}
+
+// Get RIPEMD160(SHA512(SIGN_PUBLIC_KEY || ENC_PUBLIC_KEY)).
+// Arguments could be either private or public keys. Private keys are
+// **always** 32 bytes in length.
+function keys2ripe(signKey, encKey) {
+  var signPublicKey, encPublicKey;
+  if (signKey.length === 32) {
+    signPublicKey = bmcrypto.getPublic(signKey);
+  } else {
+    signPublicKey = signKey;
+  }
+  if (encKey.length === 32) {
+    encPublicKey = bmcrypto.getPublic(encKey);
+  } else {
+    encPublicKey = encKey;
+  }
+  var concat = Buffer.concat([signPublicKey, encPublicKey]);
+  return bmcrypto.ripemd160(bmcrypto.sha512(concat));
+}
+
+/**
+ * Calculate the ripe hash of the address.
+ * @param {?Object} opts - Options
+ * @return {Buffer} Resulting ripe hash.
+ */
+Address.prototype.getRipe = function(opts) {
+  var ripe;
+  opts = opts || {};
+  if (this.ripe) {
+    ripe = this.ripe;
+  } else {
+    var signKey = this.signPrivateKey || this.signPublicKey;
+    assert(signKey, "No signing key");
+    var encKey = this.encPrivateKey || this.encPublicKey;
+    assert(encKey, "No encryption key");
+    ripe = keys2ripe(signKey, encKey);
+  }
+  var ripelen = getripelen(ripe);
+  assertripelen(ripelen, this.version, ripe);
+  if (opts.short) {
+    return ripe.slice(20 - ripelen);
+  } else {
+    return ripe;
+  }
+};
+
+// Get truncated ripe hash length.
+function getripelen(ripe) {
+  var zeroes = 0;
+  for (var i = 0; i < 20, ripe[i] === 0; i++) {
+    zeroes++;
+  }
+  return 20 - zeroes;
+}
+
+// Do neccessary checkings of the truncated ripe hash length depending
+// on the address version.
+function assertripelen(ripelen, version, ripe) {
+  if (ripe) {
+    assert(ripe.length <= 20, "Bad ripe");
+  }
+  switch (version) {
+    case 1:
+      assert(ripelen === 20, "Bad ripe length");
+      break;
+    case 2:
+    case 3:
+      assert(ripelen >= 18, "Ripe is too short");
+      assert(ripelen <= 20, "Ripe is too long");
+      break;
+    case 4:
+      assert(ripelen >= 4, "Ripe is too short");
+      assert(ripelen <= 20, "Ripe is too long");
+      break;
+    default:
+      throw new Error("Bad version");
+  }
+}
+
+// The same as `assertripelen` but return boolean instead of thrown an
+// Error.
+function checkripelen(ripelen, version) {
+  try {
+    assertripelen(ripelen, version);
+    return true;
+  } catch(e) {
+    return false;
+  }
+}
+
+/**
+ * Encode Bitmessage address object into address string.
+ * @return {string} Address string.
+ */
+Address.prototype.encode = function() {
+  var ripe = this.getRipe({short: true});
+  var data = Buffer.concat([
+    var_int.encode(this.version),
+    var_int.encode(this.stream),
+    ripe,
+  ]);
+  var addr = Buffer.concat([data, getchecksum(data)]);
+  return "BM-" + bs58.encode(addr);
+};
+
+function popkey(obj, key) {
+  var value = obj[key];
+  delete obj[key];
+  return value;
+}
+
+/**
+ * Create new Bitmessage address from random encryption and signing
+ * private keys.
+ * @param {?Object} opts - Address options
+ * @return {Address} Generated address object.
+ */
+Address.fromRandom = function(opts) {
+  opts = Object.assign({}, opts);
+  var version = opts.version = opts.version || 4;
+  var ripelen = popkey(opts, "ripelen") || 19;
+  assertripelen(ripelen, version);
+  // Should the generated ripe length be strictly equal to the specified
+  // (less or equal by default).
+  var strictripelen = !!popkey(opts, "strictripelen");
+
+  // TODO(Kagami): Speed it up using web workers in Browser.
+  // TODO(Kagami): Bind to C++ version of this code in Node.
+  var encPrivateKey, encPublicKey, ripe;
+  var signPrivateKey = bmcrypto.getPrivate();
+  var signPublicKey = bmcrypto.getPublic(signPrivateKey);
+  var keysbuf = Buffer(130);
+  signPublicKey.copy(keysbuf);
+  while (true) {
+    encPrivateKey = bmcrypto.getPrivate();
+    encPublicKey = bmcrypto.getPublic(encPrivateKey);
+    encPublicKey.copy(keysbuf, 65);
+    ripe = bmcrypto.ripemd160(bmcrypto.sha512(keysbuf));
+    var len = getripelen(ripe);
+    if (
+      (strictripelen && len === ripelen) ||
+      (!strictripelen && len <= ripelen && checkripelen(ripelen, version))
+    ) {
+      // TODO(Kagami): Do we need to put all these properties or compute
+      // them manually via ECMA5 getters/setters instead?
+      opts.signPrivateKey = signPrivateKey;
+      opts.signPublicKey = signPublicKey;
+      opts.encPrivateKey = encPrivateKey;
+      opts.encPublicKey = encPublicKey;
+      opts.ripe = ripe;
+      return new Address(opts);
+    }
+  }
+};
+
+module.exports = Address;
+

+ + + + +

+ + + +
+ + + + + + + diff --git a/docs/crypto.js.html b/docs/crypto.js.html new file mode 100644 index 0000000..626996d --- /dev/null +++ b/docs/crypto.js.html @@ -0,0 +1,109 @@ + + + + + JSDoc: Source: crypto.js + + + + + + + + + + +

+ +

Source: crypto.js

+ + + + + + +

/**
+ * Isomorphic Bitmessage crypto module. Reexports platform-dependent
+ * implementations and and also some common routines.
+ * @module bitmessage/crypto
+ */
+
+"use strict";
+
+var eccrypto = require("eccrypto");
+var platform = require("./platform");
+
+/**
+ * Calculate SHA-512 hash.
+ * @param {Buffer} buf - Input data
+ * @return {Buffer} Resulting hash.
+ * @function
+ */
+exports.sha512 = platform.sha512;
+
+/**
+ * Calculate SHA-256 hash.
+ * @param {Buffer} buf - Input data
+ * @return {Buffer} Resulting hash.
+ * @function
+ */
+exports.sha256 = platform.sha256;
+
+/**
+ * Calculate RIPEMD-160 hash.
+ * @param {Buffer} buf - Input data
+ * @return {Buffer} Resulting hash.
+ * @function
+ */
+exports.ripemd160 = platform.ripemd160;
+
+/**
+ * Generate cryptographically strong pseudo-random data.
+ * @param {number} size - Number of bytes
+ * @return {Buffer} Buffer with random data.
+ * @function
+ */
+exports.randomBytes = platform.randomBytes;
+
+/**
+ * Generate new random private key.
+ * @return {Buffer} New private key.
+ */
+exports.getPrivate = function() {
+  return platform.randomBytes(32);
+};
+
+/**
+ * Generate public key for a given private key.
+ * @param {Buffer} privateKey - Private key
+ * @return {Buffer} Public key.
+ * @function
+ */
+exports.getPublic = eccrypto.getPublic;
+

+ + + + +

+ + + +
+ + + + + + + diff --git a/docs/fonts/OpenSans-Bold-webfont.eot b/docs/fonts/OpenSans-Bold-webfont.eot new file mode 100644 index 0000000..5d20d91 Binary files /dev/null and b/docs/fonts/OpenSans-Bold-webfont.eot differ diff --git a/docs/fonts/OpenSans-Bold-webfont.svg b/docs/fonts/OpenSans-Bold-webfont.svg new file mode 100644 index 0000000..3ed7be4 --- /dev/null +++ b/docs/fonts/OpenSans-Bold-webfont.svg @@ -0,0 +1,1830 @@ + + + \ No newline at end of file diff --git a/docs/fonts/OpenSans-Bold-webfont.woff b/docs/fonts/OpenSans-Bold-webfont.woff new file mode 100644 index 0000000..1205787 Binary files /dev/null and b/docs/fonts/OpenSans-Bold-webfont.woff differ diff --git a/docs/fonts/OpenSans-BoldItalic-webfont.eot b/docs/fonts/OpenSans-BoldItalic-webfont.eot new file mode 100644 index 0000000..1f639a1 Binary files /dev/null and b/docs/fonts/OpenSans-BoldItalic-webfont.eot differ diff --git a/docs/fonts/OpenSans-BoldItalic-webfont.svg b/docs/fonts/OpenSans-BoldItalic-webfont.svg new file mode 100644 index 0000000..6a2607b --- /dev/null +++ b/docs/fonts/OpenSans-BoldItalic-webfont.svg @@ -0,0 +1,1830 @@ + + + \ No newline at end of file diff --git a/docs/fonts/OpenSans-BoldItalic-webfont.woff b/docs/fonts/OpenSans-BoldItalic-webfont.woff new file mode 100644 index 0000000..ed760c0 Binary files /dev/null and b/docs/fonts/OpenSans-BoldItalic-webfont.woff differ diff --git a/docs/fonts/OpenSans-Italic-webfont.eot b/docs/fonts/OpenSans-Italic-webfont.eot new file mode 100644 index 0000000..0c8a0ae Binary files /dev/null and b/docs/fonts/OpenSans-Italic-webfont.eot differ diff --git a/docs/fonts/OpenSans-Italic-webfont.svg b/docs/fonts/OpenSans-Italic-webfont.svg new file mode 100644 index 0000000..e1075dc --- /dev/null +++ b/docs/fonts/OpenSans-Italic-webfont.svg @@ -0,0 +1,1830 @@ + + + \ No newline at end of file diff --git a/docs/fonts/OpenSans-Italic-webfont.woff b/docs/fonts/OpenSans-Italic-webfont.woff new file mode 100644 index 0000000..ff652e6 Binary files /dev/null and b/docs/fonts/OpenSans-Italic-webfont.woff differ diff --git a/docs/fonts/OpenSans-Light-webfont.eot b/docs/fonts/OpenSans-Light-webfont.eot new file mode 100644 index 0000000..1486840 Binary files /dev/null and b/docs/fonts/OpenSans-Light-webfont.eot differ diff --git a/docs/fonts/OpenSans-Light-webfont.svg b/docs/fonts/OpenSans-Light-webfont.svg new file mode 100644 index 0000000..11a472c --- /dev/null +++ b/docs/fonts/OpenSans-Light-webfont.svg @@ -0,0 +1,1831 @@ + + + \ No newline at end of file diff --git a/docs/fonts/OpenSans-Light-webfont.woff b/docs/fonts/OpenSans-Light-webfont.woff new file mode 100644 index 0000000..e786074 Binary files /dev/null and b/docs/fonts/OpenSans-Light-webfont.woff differ diff --git a/docs/fonts/OpenSans-LightItalic-webfont.eot b/docs/fonts/OpenSans-LightItalic-webfont.eot new file mode 100644 index 0000000..8f44592 Binary files /dev/null and b/docs/fonts/OpenSans-LightItalic-webfont.eot differ diff --git a/docs/fonts/OpenSans-LightItalic-webfont.svg b/docs/fonts/OpenSans-LightItalic-webfont.svg new file mode 100644 index 0000000..431d7e3 --- /dev/null +++ b/docs/fonts/OpenSans-LightItalic-webfont.svg @@ -0,0 +1,1835 @@ + + + \ No newline at end of file diff --git a/docs/fonts/OpenSans-LightItalic-webfont.woff b/docs/fonts/OpenSans-LightItalic-webfont.woff new file mode 100644 index 0000000..43e8b9e Binary files /dev/null and b/docs/fonts/OpenSans-LightItalic-webfont.woff differ diff --git a/docs/fonts/OpenSans-Regular-webfont.eot b/docs/fonts/OpenSans-Regular-webfont.eot new file mode 100644 index 0000000..6bbc3cf Binary files /dev/null and b/docs/fonts/OpenSans-Regular-webfont.eot differ diff --git a/docs/fonts/OpenSans-Regular-webfont.svg b/docs/fonts/OpenSans-Regular-webfont.svg new file mode 100644 index 0000000..25a3952 --- /dev/null +++ b/docs/fonts/OpenSans-Regular-webfont.svg @@ -0,0 +1,1831 @@ + + + \ No newline at end of file diff --git a/docs/fonts/OpenSans-Regular-webfont.woff b/docs/fonts/OpenSans-Regular-webfont.woff new file mode 100644 index 0000000..e231183 Binary files /dev/null and b/docs/fonts/OpenSans-Regular-webfont.woff differ diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..3adc910 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,159 @@ + + + + + JSDoc: Home + + + + + + + + + + +

+ +

Home

+ + + + + + + + +

+ + + + + + + + + + + + + + + +

bitmessage

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).

Public library API is currently in alpha stage, breaking changes are very likely to happen.

API documentation is available here.

References

Feature matrix (both Browser and Node)

[ ] crypto
- [x] SHA-512
- [x] SHA-256
- [x] RIPEMD-160
- [x] PRNG
- [x] ECC keys manipulation
- [x] ECDSA
- [ ] ECDH
- [ ] ECIES
- [ ] AES-256-CBC
- [ ] HMAC-SHA-256
+
[ ] Common structures
- [ ] message
- [x] var_int
- [x] var_str
- [x] var_int_list
- [ ] net_addr
- [ ] inv_vect
- [ ] encrypted
- [ ] encoding
- [ ] bitfield
+
[ ] Message types
- [ ] version
- [ ] verack
- [ ] addr
- [ ] inv
- [ ] getdata
- [ ] error
- [ ] object
+
[ ] Object types
- [ ] getpubkey
- [ ] pubkey
- [ ] msg
- [ ] broadcast
+
[x] WIF
[ ] POW
[ ] High-level classes
- [ ] Address
  - [x] encode
  - [x] decode
  - [x] getRipe
  - [x] fromRandom
  - [ ] fromPassphrase
  +
- [ ] Message
  - [ ] encrypt
  - [ ] decrypt
  +
+
[ ] Parse PyBitmessage configs
- [ ] keys.dat
- [ ] knownnodes.dat
- [ ] messages.dat
+

Feature matrix (Node.js only)

[ ] Network
- [ ] Bootstrap
- [ ] Connect to the network
- [ ] Accept connections
+

Usage

// Generate a new random Bitmessage identity.
+var Address = require("bitmessage").Address;
+var addr = Address.fromRandom();
+console.log("New random Bitmessage address:", addr.encode());

License

bitmessage - JavaScript Bitmessage library

Written in 2014 by Kagami Hiiragi kagami@genshiken.org

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.

You should have received a copy of the CC0 Public Domain Dedication along with this software. If not, see .

+ + + + + + +

+ + + +
+ + + + + + + \ No newline at end of file diff --git a/docs/index.js.html b/docs/index.js.html new file mode 100644 index 0000000..5a8ab91 --- /dev/null +++ b/docs/index.js.html @@ -0,0 +1,72 @@ + + + + + JSDoc: Source: index.js + + + + + + + + + + +

+ +

Source: index.js

+ + + + + + +

/**
+ * Bitmessage library entry point. Just reexports common submodules.
+ * @module bitmessage
+ */
+
+"use strict";
+
+/** [Common structures.]{@link module:bitmessage/structs} */
+exports.structs = require("./structs");
+/** [Messages.]{@link module:bitmessage/messages} */
+exports.messages = require("./messages");
+/** [Objects.]{@link module:bitmessage/objects} */
+exports.objects = require("./objects");
+
+/** [Working with WIF.]{@link module:bitmessage/wif} */
+exports.WIF = require("./wif");
+/** [Proof of work.]{@link module:bitmessage/pow} */
+exports.POW = require("./pow");
+
+/** [Working with addresses.]{@link module:bitmessage/address} */
+exports.Address = require("./address");
+

+ + + + +

+ + + +
+ + + + + + + diff --git a/docs/messages.js.html b/docs/messages.js.html new file mode 100644 index 0000000..5ab3849 --- /dev/null +++ b/docs/messages.js.html @@ -0,0 +1,56 @@ + + + + + JSDoc: Source: messages.js + + + + + + + + + + +

+ +

Source: messages.js

+ + + + + + +

/**
+ * Working with messages.
+ * @see {@link https://bitmessage.org/wiki/Protocol_specification#Message_types}
+ * @module bitmessage/messages
+ */
+

+ + + + +

+ + + +
+ + + + + + + diff --git a/docs/module-bitmessage.html b/docs/module-bitmessage.html new file mode 100644 index 0000000..3728e03 --- /dev/null +++ b/docs/module-bitmessage.html @@ -0,0 +1,535 @@ + + + + + JSDoc: Module: bitmessage + + + + + + + + + + +

+ +

Module: bitmessage

+ + + + + + +

+ +

+ + + + + +

+ +

+ + +

Bitmessage library entry point. Just reexports common submodules.

+ + + + + + + + + + + + + + + + + + + +

Source:

+ index.js, line 1 +

+ + + + + + + +

Source:

+ index.js, line 16 +

+ + + + + + + + + + + + + + +

+ +

+ + + + +

+ + + +
+ + + + + + + \ No newline at end of file diff --git a/docs/module-bitmessage_address.Address.html b/docs/module-bitmessage_address.Address.html new file mode 100644 index 0000000..257ef95 --- /dev/null +++ b/docs/module-bitmessage_address.Address.html @@ -0,0 +1,228 @@ + + + + + JSDoc: Class: Address + + + + + + + + + + +

+ +

Class: Address

+ + + + + + +

+ +

+ bitmessage/address. + + Address +

+ + +

+ +

+ + + + +

Constructor

+ + +

new Address(optsnullable)

+ + + + + +

Create a new Bitmessage address object.

+ + + + + + + + + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Name	Type	Attributes	Description
`opts`	+ + +Object + + + +	+ + + + <nullable> + + + +	Address options

+ + + + + +

Source:

+ address.js, line 22 +

+ + + + + + + + + + + + + + + + + +

+ + + + + + + + + + + + + + + + + + +

+ +

+ + + + +

+ + + +
+ + + + + + + \ No newline at end of file diff --git a/docs/module-bitmessage_address.html b/docs/module-bitmessage_address.html new file mode 100644 index 0000000..c6eef64 --- /dev/null +++ b/docs/module-bitmessage_address.html @@ -0,0 +1,173 @@ + + + + + JSDoc: Module: bitmessage/address + + + + + + + + + + +

+ +

Module: bitmessage/address

+ + + + + + +

+ +

+ + + + + +

+ +

+ + +

Working with Bitmessage addresses.

+ + + + + + + + + + + + + + + + + + + +

Source:

+ address.js, line 1 +

See:

https://bitmessage.org/wiki/Address

+ + + + + + + + + + + + + + + + + + +

+ + + + + + +

Classes

+ +

Address

+ + + + + + + + + + + + + +

+ +

+ + + + +

+ + + +
+ + + + + + + \ No newline at end of file diff --git a/docs/module-bitmessage_crypto.html b/docs/module-bitmessage_crypto.html new file mode 100644 index 0000000..b3bf6dc --- /dev/null +++ b/docs/module-bitmessage_crypto.html @@ -0,0 +1,1028 @@ + + + + + JSDoc: Module: bitmessage/crypto + + + + + + + + + + +

+ +

Module: bitmessage/crypto

+ + + + + + +

+ +

+ + + + + +

+ +

+ + +

Isomorphic Bitmessage crypto module. Reexports platform-dependent +implementations and and also some common routines.

+ + + + + + + + + + + + + + + + + + + +

Source:

+ crypto.js, line 1 +

+ + + + + + + + + + + + + + + + + + +

+ + + + + + + + + + + + + + +

Methods

+ + + + + + +

(static) getPrivate() → {Buffer}

+ + + + + +

Generate new random private key.

+ + + + + + + + + + + + + +

Source:

+ crypto.js, line 48 +

+ + + + + + + + + + + + + +

Returns:

+ + +

New private key.

+ + + +

+ Type +: + +Buffer + + +

+ + + + + + + + + + +

(static) getPublic(privateKey) → {Buffer}

+ + + + + +

Generate public key for a given private key.

+ + + + + + + + + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Name	Type	Description
`privateKey`	+ + +Buffer + + + +	Private key

+ + + + + +

Source:

+ crypto.js, line 58 +

+ + + + + + + + + + + + + +

Returns:

+ + +

Public key.

+ + + +

+ Type +: + +Buffer + + +

+ + + + + + + + + + +

(static) randomBytes(size) → {Buffer}

+ + + + + +

Generate cryptographically strong pseudo-random data.

+ + + + + + + + + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Name	Type	Description
`size`	+ + +number + + + +	Number of bytes

+ + + + + +

Source:

+ crypto.js, line 42 +

+ + + + + + + + + + + + + +

Returns:

+ + +

Buffer with random data.

+ + + +

+ Type +: + +Buffer + + +

+ + + + + + + + + + +

(static) ripemd160(buf) → {Buffer}

+ + + + + +

Calculate RIPEMD-160 hash.

+ + + + + + + + + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Name	Type	Description
`buf`	+ + +Buffer + + + +	Input data

+ + + + + +

Source:

+ crypto.js, line 34 +

+ + + + + + + + + + + + + +

Returns:

+ + +

Resulting hash.

+ + + +

+ Type +: + +Buffer + + +

+ + + + + + + + + + +

(static) sha256(buf) → {Buffer}

+ + + + + +

Calculate SHA-256 hash.

+ + + + + + + + + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Name	Type	Description
`buf`	+ + +Buffer + + + +	Input data

+ + + + + +

Source:

+ crypto.js, line 26 +

+ + + + + + + + + + + + + +

Returns:

+ + +

Resulting hash.

+ + + +

+ Type +: + +Buffer + + +

+ + + + + + + + + + +

(static) sha512(buf) → {Buffer}

+ + + + + +

Calculate SHA-512 hash.

+ + + + + + + + + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Name	Type	Description
`buf`	+ + +Buffer + + + +	Input data

+ + + + + +

Source:

+ crypto.js, line 18 +

+ + + + + + + + + + + + + +

Returns:

+ + +

Resulting hash.

+ + + +

+ Type +: + +Buffer + + +

+ + + + + + + + + + + +

+ +

+ + + + +

+ + + +
+ + + + + + + \ No newline at end of file diff --git a/docs/module-bitmessage_messages.html b/docs/module-bitmessage_messages.html new file mode 100644 index 0000000..9997463 --- /dev/null +++ b/docs/module-bitmessage_messages.html @@ -0,0 +1,166 @@ + + + + + JSDoc: Module: bitmessage/messages + + + + + + + + + + +

+ +

Module: bitmessage/messages

+ + + + + + +

+ +

+ + + + + +

+ +

+ + +

Working with messages.

+ + + + + + + + + + + + + + + + + + + +

Source:

+ messages.js, line 1 +

See:

https://bitmessage.org/wiki/Protocol_specification#Message_types

+ + + + + + + + + + + + + + + + + + +

+ +

+ + + + +

+ + + +
+ + + + + + + \ No newline at end of file diff --git a/docs/module-bitmessage_objects.html b/docs/module-bitmessage_objects.html new file mode 100644 index 0000000..77dad8f --- /dev/null +++ b/docs/module-bitmessage_objects.html @@ -0,0 +1,166 @@ + + + + + JSDoc: Module: bitmessage/objects + + + + + + + + + + +

+ +

Module: bitmessage/objects

+ + + + + + +

+ +

+ + + + + +

+ +

+ + +

Working with objects.

+ + + + + + + + + + + + + + + + + + + +

Source:

+ objects.js, line 1 +

See:

https://bitmessage.org/wiki/Protocol_specification#Object_types

+ + + + + + + + + + + + + + + + + + +

+ +

+ + + + +

+ + + +
+ + + + + + + \ No newline at end of file diff --git a/docs/module-bitmessage_pow.html b/docs/module-bitmessage_pow.html new file mode 100644 index 0000000..4e28009 --- /dev/null +++ b/docs/module-bitmessage_pow.html @@ -0,0 +1,166 @@ + + + + + JSDoc: Module: bitmessage/pow + + + + + + + + + + +

+ +

Module: bitmessage/pow

+ + + + + + +

+ +

+ + + + + +

+ +

+ + +

Implements proof of work.

+ + + + + + + + + + + + + + + + + + + +

Source:

+ pow.js, line 1 +

See:

https://bitmessage.org/wiki/Proof_of_work

+ + + + + + + + + + + + + + + + + + +

+ +

+ + + + +

+ + + +
+ + + + + + + \ No newline at end of file diff --git a/docs/module-bitmessage_structs.html b/docs/module-bitmessage_structs.html new file mode 100644 index 0000000..42a756d --- /dev/null +++ b/docs/module-bitmessage_structs.html @@ -0,0 +1,179 @@ + + + + + JSDoc: Module: bitmessage/structs + + + + + + + + + + +

+ +

Module: bitmessage/structs

+ + + + + + +

+ +

+ + + + + +

+ +

+ + +

Implements common structures.

+ + + + + + + + + + + + + + + + + + + +

Source:

+ structs.js, line 1 +

See:

https://bitmessage.org/wiki/Protocol_specification#Common_structures

+ + + + + + + + + + + + + + + + + + +

+ + + + + + + + + + +

Namespaces

+ +

var_int
var_int_list
var_str

+ + + + + + + + + +

+ +

+ + + + +

+ + + +
+ + + + + + + \ No newline at end of file diff --git a/docs/module-bitmessage_structs.var_int.html b/docs/module-bitmessage_structs.var_int.html new file mode 100644 index 0000000..e0f76e1 --- /dev/null +++ b/docs/module-bitmessage_structs.var_int.html @@ -0,0 +1,452 @@ + + + + + JSDoc: Namespace: var_int + + + + + + + + + + +

+ +

Namespace: var_int

+ + + + + + +

+ +

+ bitmessage/structs. + + var_int +

+ + +

+ +

+ + +

var_int.

+ + + + + +

Source:

+ structs.js, line 17 +

See:

https://bitmessage.org/wiki/Protocol_specification#Variable_length_integer

+ + + + +

+ + + + + + + + + + + + + + +

Methods

+ + + + + + +

(static) decode(buf) → {Object}

+ + + + + +

Decode var_int.

+ + + + + + + + + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Name	Type	Description
`buf`	+ + +Buffer + + + +	A buffer that starts with encoded var_int

+ + + + + +

Source:

+ structs.js, line 24 +

+ + + + + + + + + + + + + +

Returns:

+ + +

Decoded var_int structure.

+ + + +

+ Type +: + +Object + + +

+ + + + + + + + + + +

(static) encode(value) → {Buffer}

+ + + + + +

Encode number into var_int.

+ + + + + + + + + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Name	Type	Description
`value`	+ + +number +\| + +Buffer + + + +	Input number

+ + + + + +

Source:

+ structs.js, line 69 +

+ + + + + + + + + + + + + +

Returns:

+ + +

Encoded var_int.

+ + + +

+ Type +: + +Buffer + + +

+ + + + + + + + + + + +

+ +

+ + + + +

+ + + +
+ + + + + + + \ No newline at end of file diff --git a/docs/module-bitmessage_structs.var_int_list.html b/docs/module-bitmessage_structs.var_int_list.html new file mode 100644 index 0000000..872841e --- /dev/null +++ b/docs/module-bitmessage_structs.var_int_list.html @@ -0,0 +1,450 @@ + + + + + JSDoc: Namespace: var_int_list + + + + + + + + + + +

+ +

Namespace: var_int_list

+ + + + + + +

+ +

+ bitmessage/structs. + + var_int_list +

+ + +

+ +

+ + +

var_int_list.

+ + + + + +

Source:

+ structs.js, line 142 +

See:

https://bitmessage.org/wiki/Protocol_specification#Variable_length_list_of_integers

+ + + + +

+ + + + + + + + + + + + + + +

Methods

+ + + + + + +

(static) decode(buf) → {Object}

+ + + + + +

Decode var_int_list.

+ + + + + + + + + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Name	Type	Description
`buf`	+ + +Buffer + + + +	A buffer that starts with encoded +var_int_list

+ + + + + +

Source:

+ structs.js, line 150 +

+ + + + + + + + + + + + + +

Returns:

+ + +

Decoded var_int_list structure.

+ + + +

+ Type +: + +Object + + +

+ + + + + + + + + + +

(static) encode(list) → {Buffer}

+ + + + + +

Encode list of numbers into var_int_list.

+ + + + + + + + + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Name	Type	Description
`list`	+ + +Array.<number> + + + +	A number list

+ + + + + +

Source:

+ structs.js, line 170 +

+ + + + + + + + + + + + + +

Returns:

+ + +

Encoded var_int_list.

+ + + +

+ Type +: + +Buffer + + +

+ + + + + + + + + + + +

+ +

+ + + + +

+ + + +
+ + + + + + + \ No newline at end of file diff --git a/docs/module-bitmessage_structs.var_str.html b/docs/module-bitmessage_structs.var_str.html new file mode 100644 index 0000000..7d414ee --- /dev/null +++ b/docs/module-bitmessage_structs.var_str.html @@ -0,0 +1,449 @@ + + + + + JSDoc: Namespace: var_str + + + + + + + + + + +

+ +

Namespace: var_str

+ + + + + + +

+ +

+ bitmessage/structs. + + var_str +

+ + +

+ +

+ + +

var_str.

+ + + + + +

Source:

+ structs.js, line 109 +

See:

https://bitmessage.org/wiki/Protocol_specification#Variable_length_string

+ + + + +

+ + + + + + + + + + + + + + +

Methods

+ + + + + + +

(static) decode(buf) → {Object}

+ + + + + +

Decode var_str.

+ + + + + + + + + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Name	Type	Description
`buf`	+ + +Buffer + + + +	A buffer that starts with encoded var_str

+ + + + + +

Source:

+ structs.js, line 116 +

+ + + + + + + + + + + + + +

Returns:

+ + +

Decoded var_str structure.

+ + + +

+ Type +: + +Object + + +

+ + + + + + + + + + +

(static) encode(str) → {Buffer}

+ + + + + +

Encode string into var_str.

+ + + + + + + + + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Name	Type	Description
`str`	+ + +string + + + +	A string

+ + + + + +

Source:

+ structs.js, line 130 +

+ + + + + + + + + + + + + +

Returns:

+ + +

Encoded var_str.

+ + + +

+ Type +: + +Buffer + + +

+ + + + + + + + + + + +

+ +

+ + + + +

+ + + +
+ + + + + + + \ No newline at end of file diff --git a/docs/module-bitmessage_wif.html b/docs/module-bitmessage_wif.html new file mode 100644 index 0000000..bfd983d --- /dev/null +++ b/docs/module-bitmessage_wif.html @@ -0,0 +1,474 @@ + + + + + JSDoc: Module: bitmessage/wif + + + + + + + + + + +

+ +

Module: bitmessage/wif

+ + + + + + +

+ +

+ + + + + +

+ +

+ + +

Implements WIF encoding/decoding.

+ + + + + + + + + + + + + + + + + + + +

Source:

+ wif.js, line 1 +

See:

https://en.bitcoin.it/wiki/Wallet_import_format

+ + + + + + + + + + + + + + + + + + +

+ + + + + + + + + + + + + + +

Methods

+ + + + + + +

(static) decode(wif) → {Buffer}

+ + + + + +

Decode WIF encoded private key.

+ + + + + + + + + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Name	Type	Description
`wif`	+ + +string + + + +	Encoded key

+ + + + + +

Source:

+ wif.js, line 24 +

+ + + + + + + + + + + + + +

Returns:

+ + +

Private key.

+ + + +

+ Type +: + +Buffer + + +

+ + + + + + + + + + +

(static) encode(privateKey) → {string}

+ + + + + +

Convert private key to a WIF.

+ + + + + + + + + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Name	Type	Description
`privateKey`	+ + +Buffer + + + +	A private key to encode

+ + + + + +

Source:

+ wif.js, line 38 +

+ + + + + + + + + + + + + +

Returns:

+ + +

Encoded private key.

+ + + +

+ Type +: + +string + + +

+ + + + + + + + + + + +

+ +

+ + + + +

+ + + +
+ + + + + + + \ No newline at end of file diff --git a/docs/objects.js.html b/docs/objects.js.html new file mode 100644 index 0000000..dc43733 --- /dev/null +++ b/docs/objects.js.html @@ -0,0 +1,56 @@ + + + + + JSDoc: Source: objects.js + + + + + + + + + + +

+ +

Source: objects.js

+ + + + + + +

/**
+ * Working with objects.
+ * @see {@link https://bitmessage.org/wiki/Protocol_specification#Object_types}
+ * @module bitmessage/objects
+ */
+

+ + + + +

+ + + +
+ + + + + + + diff --git a/docs/pow.js.html b/docs/pow.js.html new file mode 100644 index 0000000..5d194b4 --- /dev/null +++ b/docs/pow.js.html @@ -0,0 +1,56 @@ + + + + + JSDoc: Source: pow.js + + + + + + + + + + +

+ +

Source: pow.js

+ + + + + + +

/**
+ * Implements proof of work.
+ * @see {@link https://bitmessage.org/wiki/Proof_of_work}
+ * @module bitmessage/pow
+ */
+

+ + + + +

+ + + +
+ + + + + + + diff --git a/docs/scripts/linenumber.js b/docs/scripts/linenumber.js new file mode 100644 index 0000000..8d52f7e --- /dev/null +++ b/docs/scripts/linenumber.js @@ -0,0 +1,25 @@ +/*global document */ +(function() { + var source = document.getElementsByClassName('prettyprint source linenums'); + var i = 0; + var lineNumber = 0; + var lineId; + var lines; + var totalLines; + var anchorHash; + + if (source && source[0]) { + anchorHash = document.location.hash.substring(1); + lines = source[0].getElementsByTagName('li'); + totalLines = lines.length; + + for (; i < totalLines; i++) { + lineNumber++; + lineId = 'line' + lineNumber; + lines[i].id = lineId; + if (lineId === anchorHash) { + lines[i].className += ' selected'; + } + } + } +})(); diff --git a/docs/scripts/prettify/Apache-License-2.0.txt b/docs/scripts/prettify/Apache-License-2.0.txt new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/docs/scripts/prettify/Apache-License-2.0.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/docs/scripts/prettify/lang-css.js b/docs/scripts/prettify/lang-css.js new file mode 100644 index 0000000..041e1f5 --- /dev/null +++ b/docs/scripts/prettify/lang-css.js @@ -0,0 +1,2 @@ +PR.registerLangHandler(PR.createSimpleLexer([["pln",/^[\t\n\f\r ]+/,null," \t\r\n"]],[["str",/^"(?:[^\n\f\r"\\]|\$?:\r\n?|\n|\f)|\\[\S\s])*"/,null],["str",/^'(?:[^\n\f\r'\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*'/,null],["lang-css-str",/^url\(([^"')]*)$/i],["kwd",/^(?:url|rgb|!important|@import|@page|@media|@charset|inherit)(?=[^\w-]|$)/i,null],["lang-css-kw",/^(-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*)\s*:/i],["com",/^\/\*[^*]*\*+(?:[^*/][^*]*\*+)*\//],["com", +/^(?:<\!--|--\>)/],["lit",/^(?:\d+|\d*\.\d+)(?:%|[a-z]+)?/i],["lit",/^#[\da-f]{3,6}/i],["pln",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i],["pun",/^[^\s\w"']+/]]),["css"]);PR.registerLangHandler(PR.createSimpleLexer([],[["kwd",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i]]),["css-kw"]);PR.registerLangHandler(PR.createSimpleLexer([],[["str",/^[^"')]+/]]),["css-str"]); diff --git a/docs/scripts/prettify/prettify.js b/docs/scripts/prettify/prettify.js new file mode 100644 index 0000000..eef5ad7 --- /dev/null +++ b/docs/scripts/prettify/prettify.js @@ -0,0 +1,28 @@ +var q=null;window.PR_SHOULD_USE_CONTINUATION=!0; +(function(){function L(a){function m(a){var f=a.charCodeAt(0);if(f!==92)return f;var b=a.charAt(1);return(f=r[b])?f:"0"<=b&&b<="7"?parseInt(a.substring(1),8):b==="u"||b==="x"?parseInt(a.substring(2),16):a.charCodeAt(1)}function e(a){if(a<32)return(a<16?"\\x0":"\\x")+a.toString(16);a=String.fromCharCode(a);if(a==="\\"||a==="-"||a==="["||a==="]")a="\\"+a;return a}function h(a){for(var f=a.substring(1,a.length-1).match(/\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\[0-3][0-7]{0,2}|\\[0-7]{1,2}|\\[\S\s]|[^\\]/g),a= +[],b=[],o=f[0]==="^",c=o?1:0,i=f.length;c122||(d<65||j>90||b.push([Math.max(65,j)|32,Math.min(d,90)|32]),d<97||j>122||b.push([Math.max(97,j)&-33,Math.min(d,122)&-33]))}}b.sort(function(a,f){return a[0]-f[0]||f[1]-a[1]});f=[];j=[NaN,NaN];for(c=0;ci[0]&&(i[1]+1>i[0]&&b.push("-"),b.push(e(i[1])));b.push("]");return b.join("")}function y(a){for(var f=a.source.match(/\[(?:[^\\\]]|\\[\S\s])*]|\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\\d+|\\[^\dux]|\(\?[!:=]|[()^]|[^()[\\^]+/g),b=f.length,d=[],c=0,i=0;c=2&&a==="["?f[c]=h(j):a!=="\\"&&(f[c]=j.replace(/[A-Za-z]/g,function(a){a=a.charCodeAt(0);return"["+String.fromCharCode(a&-33,a|32)+"]"}));return f.join("")}for(var t=0,s=!1,l=!1,p=0,d=a.length;p=5&&"lang-"===b.substring(0,5))&&!(o&&typeof o[1]==="string"))c=!1,b="src";c||(r[f]=b)}i=d;d+=f.length;if(c){c=o[1];var j=f.indexOf(c),k=j+c.length;o[2]&&(k=f.length-o[2].length,j=k-c.length);b=b.substring(5);B(l+i,f.substring(0,j),e,p);B(l+i+j,c,C(b,c),p);B(l+i+k,f.substring(k),e,p)}else p.push(l+i,b)}a.e=p}var h={},y;(function(){for(var e=a.concat(m), +l=[],p={},d=0,g=e.length;d=0;)h[n.charAt(k)]=r;r=r[1];n=""+r;p.hasOwnProperty(n)||(l.push(r),p[n]=q)}l.push(/[\S\s]/);y=L(l)})();var t=m.length;return e}function u(a){var m=[],e=[];a.tripleQuotedStrings?m.push(["str",/^(?:'''(?:[^'\\]|\\[\S\s]|''?(?=[^']))*(?:'''|$)|"""(?:[^"\\]|\\[\S\s]|""?(?=[^"]))*(?:"""|$)|'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$))/,q,"'\""]):a.multiLineStrings?m.push(["str",/^(?:'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$)|`(?:[^\\`]|\\[\S\s])*(?:`|$))/, +q,"'\"`"]):m.push(["str",/^(?:'(?:[^\n\r'\\]|\\.)*(?:'|$)|"(?:[^\n\r"\\]|\\.)*(?:"|$))/,q,"\"'"]);a.verbatimStrings&&e.push(["str",/^@"(?:[^"]|"")*(?:"|$)/,q]);var h=a.hashComments;h&&(a.cStyleComments?(h>1?m.push(["com",/^#(?:##(?:[^#]|#(?!##))*(?:###|$)|.*)/,q,"#"]):m.push(["com",/^#(?:(?:define|elif|else|endif|error|ifdef|include|ifndef|line|pragma|undef|warning)\b|[^\n\r]*)/,q,"#"]),e.push(["str",/^<(?:(?:(?:\.\.\/)*|\/?)(?:[\w-]+(?:\/[\w-]+)+)?[\w-]+\.h|[a-z]\w*)>/,q])):m.push(["com",/^#[^\n\r]*/, +q,"#"]));a.cStyleComments&&(e.push(["com",/^\/\/[^\n\r]*/,q]),e.push(["com",/^\/\*[\S\s]*?(?:\*\/|$)/,q]));a.regexLiterals&&e.push(["lang-regex",/^(?:^^\.?|[!+-]|!=|!==|#|%|%=|&|&&|&&=|&=|\(|\*|\*=|\+=|,|-=|->|\/|\/=|:|::|;|<|<<|<<=|<=|=|==|===|>|>=|>>|>>=|>>>|>>>=|[?@[^]|\^=|\^\^|\^\^=|{|\||\|=|\|\||\|\|=|~|break|case|continue|delete|do|else|finally|instanceof|return|throw|try|typeof)\s*(\/(?=[^*/])(?:[^/[\\]|\\[\S\s]|\[(?:[^\\\]]|\\[\S\s])*(?:]|$))+\/)/]);(h=a.types)&&e.push(["typ",h]);a=(""+a.keywords).replace(/^ | $/g, +"");a.length&&e.push(["kwd",RegExp("^(?:"+a.replace(/[\s,]+/g,"|")+")\\b"),q]);m.push(["pln",/^\s+/,q," \r\n\t\xa0"]);e.push(["lit",/^@[$_a-z][\w$@]*/i,q],["typ",/^(?:[@_]?[A-Z]+[a-z][\w$@]*|\w+_t\b)/,q],["pln",/^[$_a-z][\w$@]*/i,q],["lit",/^(?:0x[\da-f]+|(?:\d(?:_\d+)*\d*(?:\.\d*)?|\.\d\+)(?:e[+-]?\d+)?)[a-z]*/i,q,"0123456789"],["pln",/^\\[\S\s]?/,q],["pun",/^.[^\s\w"-$'./@\\`]*/,q]);return x(m,e)}function D(a,m){function e(a){switch(a.nodeType){case 1:if(k.test(a.className))break;if("BR"===a.nodeName)h(a), +a.parentNode&&a.parentNode.removeChild(a);else for(a=a.firstChild;a;a=a.nextSibling)e(a);break;case 3:case 4:if(p){var b=a.nodeValue,d=b.match(t);if(d){var c=b.substring(0,d.index);a.nodeValue=c;(b=b.substring(d.index+d[0].length))&&a.parentNode.insertBefore(s.createTextNode(b),a.nextSibling);h(a);c||a.parentNode.removeChild(a)}}}}function h(a){function b(a,d){var e=d?a.cloneNode(!1):a,f=a.parentNode;if(f){var f=b(f,1),g=a.nextSibling;f.appendChild(e);for(var h=g;h;h=g)g=h.nextSibling,f.appendChild(h)}return e} +for(;!a.nextSibling;)if(a=a.parentNode,!a)return;for(var a=b(a.nextSibling,0),e;(e=a.parentNode)&&e.nodeType===1;)a=e;d.push(a)}var k=/(?:^|\s)nocode(?:\s|$)/,t=/\r\n?|\n/,s=a.ownerDocument,l;a.currentStyle?l=a.currentStyle.whiteSpace:window.getComputedStyle&&(l=s.defaultView.getComputedStyle(a,q).getPropertyValue("white-space"));var p=l&&"pre"===l.substring(0,3);for(l=s.createElement("LI");a.firstChild;)l.appendChild(a.firstChild);for(var d=[l],g=0;g=0;){var h=m[e];A.hasOwnProperty(h)?window.console&&console.warn("cannot override language handler %s",h):A[h]=a}}function C(a,m){if(!a||!A.hasOwnProperty(a))a=/^\s*=o&&(h+=2);e>=c&&(a+=2)}}catch(w){"console"in window&&console.log(w&&w.stack?w.stack:w)}}var v=["break,continue,do,else,for,if,return,while"],w=[[v,"auto,case,char,const,default,double,enum,extern,float,goto,int,long,register,short,signed,sizeof,static,struct,switch,typedef,union,unsigned,void,volatile"], +"catch,class,delete,false,import,new,operator,private,protected,public,this,throw,true,try,typeof"],F=[w,"alignof,align_union,asm,axiom,bool,concept,concept_map,const_cast,constexpr,decltype,dynamic_cast,explicit,export,friend,inline,late_check,mutable,namespace,nullptr,reinterpret_cast,static_assert,static_cast,template,typeid,typename,using,virtual,where"],G=[w,"abstract,boolean,byte,extends,final,finally,implements,import,instanceof,null,native,package,strictfp,super,synchronized,throws,transient"], +H=[G,"as,base,by,checked,decimal,delegate,descending,dynamic,event,fixed,foreach,from,group,implicit,in,interface,internal,into,is,lock,object,out,override,orderby,params,partial,readonly,ref,sbyte,sealed,stackalloc,string,select,uint,ulong,unchecked,unsafe,ushort,var"],w=[w,"debugger,eval,export,function,get,null,set,undefined,var,with,Infinity,NaN"],I=[v,"and,as,assert,class,def,del,elif,except,exec,finally,from,global,import,in,is,lambda,nonlocal,not,or,pass,print,raise,try,with,yield,False,True,None"], +J=[v,"alias,and,begin,case,class,def,defined,elsif,end,ensure,false,in,module,next,nil,not,or,redo,rescue,retry,self,super,then,true,undef,unless,until,when,yield,BEGIN,END"],v=[v,"case,done,elif,esac,eval,fi,function,in,local,set,then,until"],K=/^(DIR|FILE|vector|(de|priority_)?queue|list|stack|(const_)?iterator|(multi)?(set|map)|bitset|u?(int|float)\d*)/,N=/\S/,O=u({keywords:[F,H,w,"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END"+ +I,J,v],hashComments:!0,cStyleComments:!0,multiLineStrings:!0,regexLiterals:!0}),A={};k(O,["default-code"]);k(x([],[["pln",/^[^]*(?:>|$)/],["com",/^<\!--[\S\s]*?(?:--\>|$)/],["lang-",/^<\?([\S\s]+?)(?:\?>|$)/],["lang-",/^<%([\S\s]+?)(?:%>|$)/],["pun",/^(?:<[%?]|[%?]>)/],["lang-",/^]*>([\S\s]+?)<\/xmp\b[^>]*>/i],["lang-js",/^]*>([\S\s]*?)(<\/script\b[^>]*>)/i],["lang-css",/^]*>([\S\s]*?)(<\/style\b[^>]*>)/i],["lang-in.tag",/^(<\/?[a-z][^<>]*>)/i]]), +["default-markup","htm","html","mxml","xhtml","xml","xsl"]);k(x([["pln",/^\s+/,q," \t\r\n"],["atv",/^(?:"[^"]*"?|'[^']*'?)/,q,"\"'"]],[["tag",/^^<\/?[a-z](?:[\w-.:]*\w)?|\/?>$/i],["atn",/^(?!style[\s=]|on)[a-z](?:[\w:-]*\w)?/i],["lang-uq.val",/^=\s*([^\s"'>]*(?:[^\s"'/>]|\/(?=\s)))/],["pun",/^[/<->]+/],["lang-js",/^on\w+\s*=\s*"([^"]+)"/i],["lang-js",/^on\w+\s*=\s*'([^']+)'/i],["lang-js",/^on\w+\s*=\s*([^\s"'>]+)/i],["lang-css",/^style\s*=\s*"([^"]+)"/i],["lang-css",/^style\s*=\s*'([^']+)'/i],["lang-css", +/^style\s*=\s*([^\s"'>]+)/i]]),["in.tag"]);k(x([],[["atv",/^[\S\s]+/]]),["uq.val"]);k(u({keywords:F,hashComments:!0,cStyleComments:!0,types:K}),["c","cc","cpp","cxx","cyc","m"]);k(u({keywords:"null,true,false"}),["json"]);k(u({keywords:H,hashComments:!0,cStyleComments:!0,verbatimStrings:!0,types:K}),["cs"]);k(u({keywords:G,cStyleComments:!0}),["java"]);k(u({keywords:v,hashComments:!0,multiLineStrings:!0}),["bsh","csh","sh"]);k(u({keywords:I,hashComments:!0,multiLineStrings:!0,tripleQuotedStrings:!0}), +["cv","py"]);k(u({keywords:"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END",hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["perl","pl","pm"]);k(u({keywords:J,hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["rb"]);k(u({keywords:w,cStyleComments:!0,regexLiterals:!0}),["js"]);k(u({keywords:"all,and,by,catch,class,else,extends,false,finally,for,if,in,is,isnt,loop,new,no,not,null,of,off,on,or,return,super,then,true,try,unless,until,when,while,yes", +hashComments:3,cStyleComments:!0,multilineStrings:!0,tripleQuotedStrings:!0,regexLiterals:!0}),["coffee"]);k(x([],[["str",/^[\S\s]+/]]),["regex"]);window.prettyPrintOne=function(a,m,e){var h=document.createElement("PRE");h.innerHTML=a;e&&D(h,e);E({g:m,i:e,h:h});return h.innerHTML};window.prettyPrint=function(a){function m(){for(var e=window.PR_SHOULD_USE_CONTINUATION?l.now()+250:Infinity;p=0){var k=k.match(g),f,b;if(b= +!k){b=n;for(var o=void 0,c=b.firstChild;c;c=c.nextSibling)var i=c.nodeType,o=i===1?o?b:c:i===3?N.test(c.nodeValue)?b:o:o;b=(f=o===b?void 0:o)&&"CODE"===f.tagName}b&&(k=f.className.match(g));k&&(k=k[1]);b=!1;for(o=n.parentNode;o;o=o.parentNode)if((o.tagName==="pre"||o.tagName==="code"||o.tagName==="xmp")&&o.className&&o.className.indexOf("prettyprint")>=0){b=!0;break}b||((b=(b=n.className.match(/\blinenums\b(?::(\d+))?/))?b[1]&&b[1].length?+b[1]:!0:!1)&&D(n,b),d={g:k,h:n,i:b},E(d))}}p + + + + JSDoc: Source: structs.js + + + + + + + + + + +

+ +

Source: structs.js

+ + + + + + +

/**
+ * Implements common structures.
+ * @see {@link https://bitmessage.org/wiki/Protocol_specification#Common_structures}
+ * @module bitmessage/structs
+ */
+
+"use strict";
+
+var assert = require("assert");
+
+/**
+ * var_int.
+ * @see {@link https://bitmessage.org/wiki/Protocol_specification#Variable_length_integer}
+ * @namespace
+ * @static
+ */
+var var_int = exports.var_int = {
+  /**
+   * Decode var_int.
+   * @param {Buffer} buf - A buffer that starts with encoded var_int
+   * @return {{value: number, length: number, rest: Buffer}}
+   * Decoded var_int structure.
+   */
+  decode: function(buf) {
+    var value, length;
+    assert(buf.length > 0, "Empty buffer");
+    switch (buf[0]) {
+      case 253:
+        value = buf.readUInt16BE(1);
+        assert(value >= 253, "Impractical var_int");
+        length = 3;
+        break;
+      case 254:
+        value = buf.readUInt32BE(1);
+        assert(value >= 65536, "Impractical var_int");
+        length = 5;
+        break;
+      case 255:
+        var hi = buf.readUInt32BE(1);
+        assert(hi !== 0, "Impractical var_int");
+        // Max safe number = 2^53 - 1 =
+        // 0b0000000000011111111111111111111111111111111111111111111111111111
+        // = 2097151*(2^32) + (2^32 - 1).
+        // So it's safe until hi <= 2097151. See
+        // <http://mdn.io/issafeinteger>,
+        // <https://stackoverflow.com/q/307179> for details.
+        // TODO(Kagami): We may want to return raw Buffer for
+        // 2^53 <= value <= 2^64 - 1 range. Possibly using the optional
+        // argument because most of the code expect to get a number when
+        // calling `var_int.decode`.
+        assert(hi <= 2097151, "Unsafe integer");
+        var lo = buf.readUInt32BE(5);
+        value = hi * 4294967296 + lo;
+        length = 9;
+        break;
+      default:
+        value = buf[0];
+        length = 1;
+    }
+    var rest = buf.slice(length);
+    return {value: value, length: length, rest: rest};
+  },
+
+  /**
+   * Encode number into var_int.
+   * @param {(number|Buffer)} value - Input number
+   * @return {Buffer} Encoded var_int.
+   */
+  encode: function(value) {
+    var buf, targetStart;
+    if (typeof value === "number") {
+      assert(value >= 0, "Value cannot be less than zero");
+      if (value < 253) {
+        buf = new Buffer([value]);
+      } else if (value < 65536) {
+        buf = new Buffer(3);
+        buf[0] = 253;
+        buf.writeUInt16BE(value, 1, true);
+      } else if (value < 4294967296) {
+        buf = new Buffer(5);
+        buf[0] = 254;
+        buf.writeUInt32BE(value, 1, true);
+      } else {
+        assert(value <= 9007199254740991, "Unsafe integer");
+        buf = new Buffer(9);
+        buf[0] = 255;
+        buf.writeUInt32BE(Math.floor(value / 4294967296), 1, true);  // high32
+        buf.writeUInt32BE(value % 4294967296, 5, true);  // low32
+      }
+    } else if (Buffer.isBuffer(value)) {
+      assert(value.length <= 8, "Buffer is too big");
+      buf = new Buffer(9);
+      buf.fill(0);
+      buf[0] = 255;
+      targetStart = 1 + (8 - value.length);
+      value.copy(buf, targetStart);
+    } else {
+      throw new Error("Value encode error");
+    }
+    return buf;
+  },
+};
+
+/**
+ * var_str.
+ * @see {@link https://bitmessage.org/wiki/Protocol_specification#Variable_length_string}
+ * @namespace
+ */
+exports.var_str = {
+  /**
+   * Decode var_str.
+   * @param {Buffer} buf - A buffer that starts with encoded var_str
+   * @return {{str: string, length: number, rest: Buffer}}
+   * Decoded var_str structure.
+   */
+  decode: function(buf) {
+    var decoded = var_int.decode(buf);
+    var strLength = decoded.value;
+    // XXX(Kagami): Spec doesn't mention encoding, using UTF-8.
+    var str = decoded.rest.slice(0, strLength).toString();
+    var rest = decoded.rest.slice(strLength);
+    return {str: str, length: decoded.length + strLength, rest: rest};
+  },
+
+  /**
+   * Encode string into var_str.
+   * @param {string} str - A string
+   * @return {Buffer} Encoded var_str.
+   */
+  encode: function(str) {
+    // XXX(Kagami): Spec doesn't mention encoding, using UTF-8.
+    var strBuf = new Buffer(str);
+    return Buffer.concat([var_int.encode(strBuf.length), strBuf]);
+  },
+};
+
+/**
+ * var_int_list.
+ * @see {@link https://bitmessage.org/wiki/Protocol_specification#Variable_length_list_of_integers}
+ * @namespace
+ */
+exports.var_int_list = {
+  /**
+   * Decode var_int_list.
+   * @param {Buffer} buf - A buffer that starts with encoded
+   * var_int_list
+   * @return {{list: number[], length: number, rest: Buffer}}
+   * Decoded var_int_list structure.
+   */
+  decode: function(buf) {
+    var decoded = var_int.decode(buf);
+    var listLength = decoded.value;
+    var list = new Array(listLength);
+    var rest = decoded.rest;
+    var sumLength = decoded.length;
+    for (var i = 0; i < listLength; i++) {
+      decoded = var_int.decode(rest);
+      list[i] = decoded.value;
+      rest = decoded.rest;
+      sumLength += decoded.length;
+    }
+    return {list: list, length: sumLength, rest: rest};
+  },
+
+  /**
+   * Encode list of numbers into var_int_list.
+   * @param {number[]} list - A number list
+   * @return {Buffer} Encoded var_int_list.
+   */
+  encode: function(list) {
+    var listBuf = Buffer.concat(list.map(var_int.encode));
+    return Buffer.concat([var_int.encode(list.length), listBuf]);
+  },
+};
+

+ + + + +

+ + + +
+ + + + + + + diff --git a/docs/styles/jsdoc-default.css b/docs/styles/jsdoc-default.css new file mode 100644 index 0000000..0067cb1 --- /dev/null +++ b/docs/styles/jsdoc-default.css @@ -0,0 +1,351 @@ +@font-face { + font-family: 'Open Sans'; + font-weight: normal; + font-style: normal; + src: url('../fonts/OpenSans-Regular-webfont.eot'); + src: + local('Open Sans'), + local('OpenSans'), + url('../fonts/OpenSans-Regular-webfont.eot?#iefix') format('embedded-opentype'), + url('../fonts/OpenSans-Regular-webfont.woff') format('woff'), + url('../fonts/OpenSans-Regular-webfont.svg#open_sansregular') format('svg'); +} + +@font-face { + font-family: 'Open Sans Light'; + font-weight: normal; + font-style: normal; + src: url('../fonts/OpenSans-Light-webfont.eot'); + src: + local('Open Sans Light'), + local('OpenSans Light'), + url('../fonts/OpenSans-Light-webfont.eot?#iefix') format('embedded-opentype'), + url('../fonts/OpenSans-Light-webfont.woff') format('woff'), + url('../fonts/OpenSans-Light-webfont.svg#open_sanslight') format('svg'); +} + +html +{ + overflow: auto; + background-color: #fff; + font-size: 14px; +} + +body +{ + font-family: 'Open Sans', sans-serif; + line-height: 1.5; + color: #4d4e53; + background-color: white; +} + +a, a:visited, a:active { + color: #0095dd; + text-decoration: none; +} + +a:hover { + text-decoration: underline; +} + +header +{ + display: block; + padding: 0px 4px; +} + +tt, code, kbd, samp { + font-family: Consolas, Monaco, 'Andale Mono', monospace; +} + +.class-description { + font-size: 130%; + line-height: 140%; + margin-bottom: 1em; + margin-top: 1em; +} + +.class-description:empty { + margin: 0; +} + +#main { + float: left; + width: 70%; +} + +article dl { + margin-bottom: 40px; +} + +section +{ + display: block; + background-color: #fff; + padding: 12px 24px; + border-bottom: 1px solid #ccc; + margin-right: 30px; +} + +.variation { + display: none; +} + +.signature-attributes { + font-size: 60%; + color: #aaa; + font-style: italic; + font-weight: lighter; +} + +nav +{ + display: block; + float: right; + margin-top: 28px; + width: 30%; + box-sizing: border-box; + border-left: 1px solid #ccc; + padding-left: 16px; +} + +nav ul { + font-family: 'Lucida Grande', 'Lucida Sans Unicode', arial, sans-serif; + font-size: 100%; + line-height: 17px; + padding: 0; + margin: 0; + list-style-type: none; +} + +nav ul a, nav ul a:visited, nav ul a:active { + font-family: Consolas, Monaco, 'Andale Mono', monospace; + line-height: 18px; + color: #4D4E53; +} + +nav h3 { + margin-top: 12px; +} + +nav li { + margin-top: 6px; +} + +footer { + display: block; + padding: 6px; + margin-top: 12px; + font-style: italic; + font-size: 90%; +} + +h1, h2, h3, h4 { + font-weight: 200; + margin: 0; +} + +h1 +{ + font-family: 'Open Sans Light', sans-serif; + font-size: 48px; + letter-spacing: -2px; + margin: 12px 24px 20px; +} + +h2, h3 +{ + font-size: 30px; + font-weight: 700; + letter-spacing: -1px; + margin-bottom: 12px; +} + +h4 +{ + font-size: 18px; + letter-spacing: -0.33px; + margin-bottom: 12px; + color: #4d4e53; +} + +h5, .container-overview .subsection-title +{ + font-size: 120%; + font-weight: bold; + letter-spacing: -0.01em; + margin: 8px 0 3px 0; +} + +h6 +{ + font-size: 100%; + letter-spacing: -0.01em; + margin: 6px 0 3px 0; + font-style: italic; +} + +.ancestors { color: #999; } +.ancestors a +{ + color: #999 !important; + text-decoration: none; +} + +.clear +{ + clear: both; +} + +.important +{ + font-weight: bold; + color: #950B02; +} + +.yes-def { + text-indent: -1000px; +} + +.type-signature { + color: #aaa; +} + +.name, .signature { + font-family: Consolas, Monaco, 'Andale Mono', monospace; +} + +.details { margin-top: 14px; border-left: 2px solid #DDD; } +.details dt { width: 120px; float: left; padding-left: 10px; padding-top: 6px; } +.details dd { margin-left: 70px; } +.details ul { margin: 0; } +.details ul { list-style-type: none; } +.details li { margin-left: 30px; padding-top: 6px; } +.details pre.prettyprint { margin: 0 } +.details .object-value { padding-top: 0; } + +.description { + margin-bottom: 1em; + margin-top: 1em; +} + +.code-caption +{ + font-style: italic; + font-size: 107%; + margin: 0; +} + +.prettyprint +{ + border: 1px solid #ddd; + width: 80%; + overflow: auto; +} + +.prettyprint.source { + width: inherit; +} + +.prettyprint code +{ + font-size: 100%; + line-height: 18px; + display: block; + padding: 4px 12px; + margin: 0; + background-color: #fff; + color: #4D4E53; +} + +.prettyprint code span.line +{ + display: inline-block; +} + +.prettyprint.linenums +{ + padding-left: 70px; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} + +.prettyprint.linenums ol +{ + padding-left: 0; +} + +.prettyprint.linenums li +{ + border-left: 3px #ddd solid; +} + +.prettyprint.linenums li.selected, +.prettyprint.linenums li.selected * +{ + background-color: lightyellow; +} + +.prettyprint.linenums li * +{ + -webkit-user-select: text; + -moz-user-select: text; + -ms-user-select: text; + user-select: text; +} + +.params, .props +{ + border-spacing: 0; + border: 0; + border-collapse: collapse; +} + +.params .name, .props .name, .name code { + color: #4D4E53; + font-family: Consolas, Monaco, 'Andale Mono', monospace; + font-size: 100%; +} + +.params td, .params th, .props td, .props th +{ + border: 1px solid #ddd; + margin: 0px; + text-align: left; + vertical-align: top; + padding: 4px 6px; + display: table-cell; +} + +.params thead tr, .props thead tr +{ + background-color: #ddd; + font-weight: bold; +} + +.params .params thead tr, .props .props thead tr +{ + background-color: #fff; + font-weight: bold; +} + +.params th, .props th { border-right: 1px solid #aaa; } +.params thead .last, .props thead .last { border-right: 1px solid #ddd; } + +.params td.description > p:first-child +{ + margin-top: 0; + padding-top: 0; +} + +.params td.description > p:last-child +{ + margin-bottom: 0; + padding-bottom: 0; +} + +.disabled { + color: #454545; +} diff --git a/docs/styles/prettify-jsdoc.css b/docs/styles/prettify-jsdoc.css new file mode 100644 index 0000000..5a2526e --- /dev/null +++ b/docs/styles/prettify-jsdoc.css @@ -0,0 +1,111 @@ +/* JSDoc prettify.js theme */ + +/* plain text */ +.pln { + color: #000000; + font-weight: normal; + font-style: normal; +} + +/* string content */ +.str { + color: #006400; + font-weight: normal; + font-style: normal; +} + +/* a keyword */ +.kwd { + color: #000000; + font-weight: bold; + font-style: normal; +} + +/* a comment */ +.com { + font-weight: normal; + font-style: italic; +} + +/* a type name */ +.typ { + color: #000000; + font-weight: normal; + font-style: normal; +} + +/* a literal value */ +.lit { + color: #006400; + font-weight: normal; + font-style: normal; +} + +/* punctuation */ +.pun { + color: #000000; + font-weight: bold; + font-style: normal; +} + +/* lisp open bracket */ +.opn { + color: #000000; + font-weight: bold; + font-style: normal; +} + +/* lisp close bracket */ +.clo { + color: #000000; + font-weight: bold; + font-style: normal; +} + +/* a markup tag name */ +.tag { + color: #006400; + font-weight: normal; + font-style: normal; +} + +/* a markup attribute name */ +.atn { + color: #006400; + font-weight: normal; + font-style: normal; +} + +/* a markup attribute value */ +.atv { + color: #006400; + font-weight: normal; + font-style: normal; +} + +/* a declaration */ +.dec { + color: #000000; + font-weight: bold; + font-style: normal; +} + +/* a variable name */ +.var { + color: #000000; + font-weight: normal; + font-style: normal; +} + +/* a function name */ +.fun { + color: #000000; + font-weight: bold; + font-style: normal; +} + +/* Specify class=linenums on a pre to get line numbering */ +ol.linenums { + margin-top: 0; + margin-bottom: 0; +} diff --git a/docs/styles/prettify-tomorrow.css b/docs/styles/prettify-tomorrow.css new file mode 100644 index 0000000..b6f92a7 --- /dev/null +++ b/docs/styles/prettify-tomorrow.css @@ -0,0 +1,132 @@ +/* Tomorrow Theme */ +/* Original theme - https://github.com/chriskempson/tomorrow-theme */ +/* Pretty printing styles. Used with prettify.js. */ +/* SPAN elements with the classes below are added by prettyprint. */ +/* plain text */ +.pln { + color: #4d4d4c; } + +@media screen { + /* string content */ + .str { + color: #718c00; } + + /* a keyword */ + .kwd { + color: #8959a8; } + + /* a comment */ + .com { + color: #8e908c; } + + /* a type name */ + .typ { + color: #4271ae; } + + /* a literal value */ + .lit { + color: #f5871f; } + + /* punctuation */ + .pun { + color: #4d4d4c; } + + /* lisp open bracket */ + .opn { + color: #4d4d4c; } + + /* lisp close bracket */ + .clo { + color: #4d4d4c; } + + /* a markup tag name */ + .tag { + color: #c82829; } + + /* a markup attribute name */ + .atn { + color: #f5871f; } + + /* a markup attribute value */ + .atv { + color: #3e999f; } + + /* a declaration */ + .dec { + color: #f5871f; } + + /* a variable name */ + .var { + color: #c82829; } + + /* a function name */ + .fun { + color: #4271ae; } } +/* Use higher contrast and text-weight for printable form. */ +@media print, projection { + .str { + color: #060; } + + .kwd { + color: #006; + font-weight: bold; } + + .com { + color: #600; + font-style: italic; } + + .typ { + color: #404; + font-weight: bold; } + + .lit { + color: #044; } + + .pun, .opn, .clo { + color: #440; } + + .tag { + color: #006; + font-weight: bold; } + + .atn { + color: #404; } + + .atv { + color: #060; } } +/* Style */ +/* +pre.prettyprint { + background: white; + font-family: Consolas, Monaco, 'Andale Mono', monospace; + font-size: 12px; + line-height: 1.5; + border: 1px solid #ccc; + padding: 10px; } +*/ + +/* Specify class=linenums on a pre to get line numbering */ +ol.linenums { + margin-top: 0; + margin-bottom: 0; } + +/* IE indents via margin-left */ +li.L0, +li.L1, +li.L2, +li.L3, +li.L4, +li.L5, +li.L6, +li.L7, +li.L8, +li.L9 { + /* */ } + +/* Alternate shading for lines */ +li.L1, +li.L3, +li.L5, +li.L7, +li.L9 { + /* */ } diff --git a/docs/wif.js.html b/docs/wif.js.html new file mode 100644 index 0000000..b42a8de --- /dev/null +++ b/docs/wif.js.html @@ -0,0 +1,94 @@ + + + + + JSDoc: Source: wif.js + + + + + + + + + + +

+ +

Source: wif.js

+ + + + + + +

/**
+ * Implements WIF encoding/decoding.
+ * @see {@link https://en.bitcoin.it/wiki/Wallet_import_format}
+ * @module bitmessage/wif
+ */
+
+"use strict";
+
+var assert = require("assert");
+var bufferEqual = require("buffer-equal");
+var bs58 = require("bs58");
+var bmcrypto = require("./crypto");
+
+// Compute the WIF checksum for the given data.
+function getchecksum(data) {
+  return bmcrypto.sha256(bmcrypto.sha256(data)).slice(0, 4);
+}
+
+/**
+ * Decode WIF encoded private key.
+ * @param {string} wif - Encoded key
+ * @return {Buffer} Private key.
+ */
+exports.decode = function(wif) {
+  var bytes = bs58.decode(wif);
+  assert(bytes[0] === 0x80, "Bad WIF");
+  var data = new Buffer(bytes.slice(0, -4));
+  var checksum = new Buffer(bytes.slice(-4));
+  assert(bufferEqual(checksum, getchecksum(data)), "Bad checkum");
+  return data.slice(1);
+};
+
+/**
+ * Convert private key to a WIF.
+ * @param {Buffer} privateKey - A private key to encode
+ * @return {string} Encoded private key.
+ */
+exports.encode = function(privateKey) {
+  var data = Buffer.concat([new Buffer([0x80]), privateKey]);
+  var checksum = getchecksum(data);
+  var bytes = Buffer.concat([data, checksum]);
+  return bs58.encode(bytes);
+};
+

+ + + + +

+ + + +
+ + + + + + +