allowing channels with height 1

Author: cr0ssing

lib/message.js

@@ -16,7 +16,7 @@ const MESSAGE_FRAGMENT_TRYTES = 2187
 
 const Errors = {
     INVALID_LENGTH: `The message cannot be longer than ${Math.pow(27, MESSAGE_LENGTH_TRYTES)} trytes.`,
-    INVALID_HEIGHT: "Merkle tree height must be between 2 and 26.",
+    INVALID_HEIGHT: "Merkle tree height must be between 1 and 26.",
     INVALID_SECURITY_LEVEL: "Key security must be between 1 and 4.",
     INVALID_INDEX: "Index is either negative or to big for amount of provided authentication hashes.",
     WRONG_INDEX: "Message has different index than requested. Please check channel root.",
@@ -54,7 +54,7 @@ function createTransfers(merkleRoot, message, sig, index,
     const key = getKey(merkleRoot, channelPassword, indexTrits, messagePassword)
 
     const height = authPathHashes.length
-    if (height < 2 || height > 26) {
+    if (height < 1 || height > 26) {
         throw new Error(Errors.INVALID_HEIGHT)
     }
     if (index < 0 || index >= Math.pow(2, height)) {

lib/raam.js

@@ -27,6 +27,8 @@ class RAAM extends RAAMReader {
      * keys of the messages.
      * @param {Array.<Node>} hashes - The nodes of the merkle tree which will be used for the 
      * authentication path of the messages.
+     * @param {number} height - A number between 1 and 26 representing the height 
+     * of the merkle tree used for this channel.
      * @param {object} [options] - Optional parameters.
      * @param {API} [options.iota] - A composed IOTA API for communication with a full node providing POW.
      * @param {Trytes} [options.channelPassword] - The optional password for the channel as trytes.
@@ -68,7 +70,7 @@ class RAAM extends RAAMReader {
      * An object representing the compiled RAAM message with all neccessary information to create its transfers.
      * @typedef {object} Message
      * @property {number} index - The index of the message in the channel.
-     * @property {number} height - A number between 2 and 26 representing the height 
+     * @property {number} height - A number between 1 and 26 representing the height 
      * of the merkle tree used for this channel.
      * @property {number} security - The security of the signing and encryption keys as a number between 1 and 4. 
      * @property {Trytes} message - The message to attach to the channel as trytes.
@@ -184,7 +186,7 @@ class RAAM extends RAAMReader {
      * @param {Trytes} seed - The seed from which the signing keys are created.
      * @param {object} [options] - Optional parameters.
      * @param {number} [options.amount] - The maximum amount of messages that can be published in this channel.
-     * @param {number} [options.height = Math.ceil(Math.log2(amount))] - A number between 2 and 26 representing the height 
+     * @param {number} [options.height = Math.ceil(Math.log2(amount))] - A number between 1 and 26 representing the height 
      * of the merkle tree used for this channel.
      * @param {API} [options.iota = this.iota] - A composed IOTA API for communication with a full node providing POW.
      * @param {Trytes} [options.channelPassword] - The optional password for the channel as trytes.
@@ -241,7 +243,7 @@ class RAAM extends RAAMReader {
      * @param {API} [options.iota = this.iota] - A composed IOTA API for communication with a full node providing POW.
      * @param {Trytes} [options.channelPassword] - The optional password for the channel as trytes.
      * @param {number} [options.amount] - The maximum amount of messages that can be published in this channel.
-     * @param {number} [options.height = Math.ceil(Math.log2(amount))] - A number between 2 and 26 representing the height 
+     * @param {number} [options.height = Math.ceil(Math.log2(amount))] - A number between 1 and 26 representing the height 
      * of the merkle tree used for this channel.
      * @param {Trytes} [options.seed] - The seed from which the signing keys are created.
      * @param {number} [options.offset = 0] - The starting index used for building the subroots from which the keys are created.

lib/raamReader.js

@@ -27,7 +27,7 @@ class RAAMReader {
      * This is parameter is only used as an extra verification information.
      * @param {number} [options.amount] - The maximum amount of messages in this channel. 
      * From this the height of the channel can be calculated. This is parameter is only used as an extra verification information.
-     * @param {number} [options.height] - The height as a number between 2 and 26 of the channel yielding the maximum 
+     * @param {number} [options.height] - The height as a number between 1 and 26 of the channel yielding the maximum 
      * amount of messages of the channel. This is parameter is only used as an extra verification information.
      */
     constructor(channelRoot, {iota, channelPassword, security, 
@@ -245,7 +245,7 @@ class RAAMReader {
      * different messages. The ith element is the password for the ith message in the channel.
      * @param {number} [options.security] - The security of the signing and encryption keys as a number between 1 and 4. 
      * This is parameter is only used as an extra verification information.
-     * @param {number} [options.height] - The height as a number between 2 and 26 of the channel yielding the maximum 
+     * @param {number} [options.height] - The height as a number between 1 and 26 of the channel yielding the maximum 
      * amount of messages of the channel. This is parameter is only used as an extra verification information.
      * 
      * @returns {Promise}
@@ -312,7 +312,7 @@ class RAAMReader {
      * the found message.
      * @param {number} [options.security] - The security of the signing and encryption keys as a number between 1 and 4. 
      * This is parameter is only used as an extra verification information.
-     * @param {number} [options.height] - The height as a number between 2 and 26 of the channel yielding the maximum 
+     * @param {number} [options.height] - The height as a number between 1 and 26 of the channel yielding the maximum 
      * amount of messages of the channel. This is parameter is only used as an extra verification information.
      * 
      * @returns {Promise}
@@ -359,7 +359,7 @@ class RAAMReader {
      * the found message.
      * @param {number} [options.security] - The security of the signing and encryption keys as a number between 1 and 4. 
      * This is parameter is only used as an extra verification information.
-     * @param {number} [options.height] - The height as a number between 2 and 26 of the channel yielding the maximum 
+     * @param {number} [options.height] - The height as a number between 1 and 26 of the channel yielding the maximum 
      * amount of messages of the channel. This is parameter is only used as an extra verification information.
      * 
      * @returns {SingleSubscription} An object containing information about the created subscription, including the 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "raam.client.js",
-  "version": "0.7.2",
+  "version": "0.7.3",
   "description": "A messaging protocol for the IOTA tangle allowing access of arbitrary messages in O(1)",
   "keywords": [
     "iota",

types/raam.d.ts

@@ -46,7 +46,7 @@ export class MessageTransfers {
  * An object representing the compiled RAAM message with all neccessary information to create its transfers.
  * @typedef {object} Message
  * @property {number} index - The index of the message in the channel.
- * @property {number} height - A number between 2 and 26 representing the height 
+ * @property {number} height - A number between 1 and 26 representing the height 
  * of the merkle tree used for this channel.
  * @property {number} security - The security of the signing and encryption keys as a number between 1 and 4. 
  * @property {Trytes} message - The message to attach to the channel as trytes.
@@ -178,7 +178,7 @@ export class RAAM extends RAAMReader {
      * @param {Trytes} seed - The seed from which the signing keys are created.
      * @param {object} [options] - Optional parameters.
      * @param {number} [options.amount] - The maximum amount of messages that can be published in this channel.
-     * @param {number} [options.height = Math.ceil(Math.log2(amount))] - A number between 2 and 26 representing the height 
+     * @param {number} [options.height = Math.ceil(Math.log2(amount))] - A number between 1 and 26 representing the height 
      * of the merkle tree used for this channel.
      * @param {API} [options.iota = this.iota] - A composed IOTA API for communication with a full node providing POW.
      * @param {Trytes} [options.channelPassword] - The optional password for the channel as trytes.
@@ -207,7 +207,7 @@ export class RAAM extends RAAMReader {
      * @param {API} [options.iota = this.iota] - A composed IOTA API for communication with a full node providing POW.
      * @param {Trytes} [options.channelPassword] - The optional password for the channel as trytes.
      * @param {number} [options.amount] - The maximum amount of messages that can be published in this channel.
-     * @param {number} [options.height = Math.ceil(Math.log2(amount))] - A number between 2 and 26 representing the height 
+     * @param {number} [options.height = Math.ceil(Math.log2(amount))] - A number between 1 and 26 representing the height 
      * of the merkle tree used for this channel.
      * @param {Trytes} [options.seed] - The seed from which the signing keys are created.
      * @param {number} [options.offset = 0] - The starting index used for building the subroots from which the keys are created.

types/raamReader.d.ts

@@ -126,7 +126,7 @@ export class RAAMReader {
      * This is parameter is only used as an extra verification information.
      * @param {number} [options.amount] - The maximum amount of messages in this channel. 
      * From this the height of the channel can be calculated. This is parameter is only used as an extra verification information.
-     * @param {number} [options.height] - The height as a number between 2 and 26 of the channel yielding the maximum 
+     * @param {number} [options.height] - The height as a number between 1 and 26 of the channel yielding the maximum 
      * amount of messages of the channel. This is parameter is only used as an extra verification information.
      */
     public constructor(channelRoot: Int8Array, {iota, channelPassword, security, 
@@ -239,7 +239,7 @@ export class RAAMReader {
      * different messages. The ith element is the password for the ith message in the channel.
      * @param {number} [options.security] - The security of the signing and encryption keys as a number between 1 and 4. 
      * This is parameter is only used as an extra verification information.
-     * @param {number} [options.height] - The height as a number between 2 and 26 of the channel yielding the maximum 
+     * @param {number} [options.height] - The height as a number between 1 and 26 of the channel yielding the maximum 
      * amount of messages of the channel. This is parameter is only used as an extra verification information.
      * 
      * @returns {Promise}
@@ -264,7 +264,7 @@ export class RAAMReader {
      * the found message.
      * @param {number} [options.security] - The security of the signing and encryption keys as a number between 1 and 4. 
      * This is parameter is only used as an extra verification information.
-     * @param {number} [options.height] - The height as a number between 2 and 26 of the channel yielding the maximum 
+     * @param {number} [options.height] - The height as a number between 1 and 26 of the channel yielding the maximum 
      * amount of messages of the channel. This is parameter is only used as an extra verification information.
      * 
      * @returns {Promise}
@@ -295,7 +295,7 @@ export class RAAMReader {
      * the found message.
      * @param {number} [options.security] - The security of the signing and encryption keys as a number between 1 and 4. 
      * This is parameter is only used as an extra verification information.
-     * @param {number} [options.height] - The height as a number between 2 and 26 of the channel yielding the maximum 
+     * @param {number} [options.height] - The height as a number between 1 and 26 of the channel yielding the maximum 
      * amount of messages of the channel. This is parameter is only used as an extra verification information.
      * 
      * @returns {Subscription} An object containing information about the created subscription, including the