pathchain 1.0.44 → 1.0.46

package/README.md

@@ -7,36 +7,43 @@ Pathchain is a tool to build path-shaped data structures that are chained one to
 ---
 # Pathchain documentation
 
-## Makers
-Maker functions recieve new data to encode into the chain.
 
-| Function                     | Parameters                              |
-| ---------------------------- | --------------------------------------- |
-| [`makeMoment()`](#Moment)    | datetime, lat, lon, x, y, z, format     |
-| [`makePioneer()`](#Pioneer)  | format                                  |
-| [`makeSecret()`](#Secret)    | author, format                          |
-| [`makeEntity()`](#Entity)    | xsecret, format                         |
-| [`makeNode()`](#Node)        | text, xauthor, format                   |
-| [`makePath()`](#Path)        | xauthor, text, head, ancestor, format   |
+---
+# Makers
+Maker functions recieve new data to encode into the chain.
 
+| Function                      | Parameters                              |
+| ----------------------------- | --------------------------------------- |
+| [`makeMoment()`](#Moment)     | datetime, lat, lon, x, y, z, format     |
+| [`makePioneer()`](#Pioneer)   | format                                  |
+| [`makeSecret()`](#Secret)     | author, format                          |
+| [`makeEntity()`](#Entity)     | xsecret, format                         |
+| [`makeNode()`](#Node)         | text, xauthor, format                   |
+| [`makeNodelink()`](#Nodelink) | first, second, author, ancestor, format |
+| [`makePath()`](#Path)         | xauthor, text, head, ancestor, format   |
+| [`makePathlink()`](#Pathlink) | first, second, author, ancestor, format |
+| [`makeTree()`](#Tree)         | xauthor, text, head, ancestor, format   |
 
 
-## Getters
+---
+# Getters
 Getter functions retrieve objects given a hashname and author information
 
-| Function                    | Parameters                               |
-| --------------------------- | ---------------------------------------- |
-| [`getMoment()`](#Moment)    | xmoment                                  |
-| [`getPioneer()`](#Pioneer)  | (none)                                   |
-| [`getSecret()`](#Secret)    | xsecret                                  |
-| [`getEntity()`](#Entity)    | xentity                                  |
-| [`getNode()`](#Node)        | xnode                                    |
-| [`getPath()`](#Path)        | xpath                                    |
+| Function                     | Parameters                               |
+| ---------------------------- | ---------------------------------------- |
+| [`getMoment()`](#Moment)     | xmoment                                  |
+| [`getPioneer()`](#Pioneer)   | (none)                                   |
+| [`getSecret()`](#Secret)     | xsecret, xauthor                         |
+| [`getEntity()`](#Entity)     | xentity, xauthor                         |
+| [`getNode()`](#Node)         | xnode, xauthor                           |
+| [`getNodelink()`](#Nodelink) | xnodelink, xauthor                       |
+| [`getPath()`](#Path)         | xpath, xauthor                           |
+| [`getPathlink()`](#Pathlink) | xpathlink, xauthor                       |
+| [`getTree()`](#Tree)         | xtree, xauthor                           |
+| [`getTreelink()`](#Treelink) | xtreelink, xauthor                       |
 
 
 ---
-
-
 ## Moment
 
 A moment is the mimimum representation of the pathchain data structures. Moments are the trunk of every path . They're represented by default with a `MM DD YYYY HH:mm:SSS [GMT]Z` datetime format for `time` and a planet earth representation (0, 0, 0) in general as `space`.
@@ -96,6 +103,7 @@ Parameter rules:
 |{string} format          |(optional)|
 
 
+---
 Summoning `makeMoment(datetime, lat, lon, x, y, z, format)`:
 ```javascript
 const pathchain = require("pathchain"); // Summoning pathchain
@@ -118,6 +126,7 @@ Parameter rules:
 |{string} xmoment  |(required)|
 
 
+---
 Summoning `getMomentObj(xauthor, xmoment)`
 ```
 const pathchain = require("pathchain"); // Summoning pathchain
@@ -175,7 +184,7 @@ Parameter rules:
 |{string} author          |(required)|
 |{string} format          |(optional)|
 
-
+---
 Summoning `makeMoment(author, format)`:
 ```javascript
 const pathchain = require("pathchain"); // Summoning pathchain
@@ -197,6 +206,7 @@ Parameter rules:
 |{string} xsecret         |(required)|
 
 
+---
 Summoning `useSecret(xsecret)` & `isSecretUsed(xsecret)`:
 ```javascript
 const pathchain = require("pathchain"); // Summoning pathchain
@@ -238,6 +248,7 @@ Parameter rules:
 |{string} xsecret         |(required)|
 
 
+---
 Summoning `getSecretObj(xsecret)`:
 ```javascript
 
@@ -276,6 +287,7 @@ Parameter rules:
 |                         |(nothing) |
 
 
+---
 Summoning `makePioneer()`:
 ```javascript
 
@@ -301,6 +313,7 @@ Parameter rules:
 |                         |(nothing) |
 
 
+---
 Summoning `getPioneerObj()`:
 ```javascript
 
@@ -332,6 +345,7 @@ Entities are the actors/users that create/author and organize information on the
 
 `<entity>` :: entity ::= { `<“entities/”>` + sha256(`<moment>` + `<entity>`) }
 
+
 #### Protocol Buffer file:
 
 ``` proto
@@ -344,6 +358,7 @@ message entity {
 }
 ```
 
+
 #### Entity maker
 
 Parameter rules:
@@ -352,6 +367,8 @@ Parameter rules:
 |{string} author          |(required)|
 |{string} format          |(optional)|
 
+
+---
 Summoning `makeEntity(secret, format)`:
 ```javascript
 const pathchain = require("pathchain"); // Summoning pathchain
@@ -367,6 +384,7 @@ Console:
 Entity buffer:  c0f9d300e1b28253455e1835f13ca18d000333152a6a9a9b106d0407612980a8
 ```
 
+
 #### Entity getter
 
 Parameter rules:
@@ -375,6 +393,7 @@ Parameter rules:
 |{string} xentity         |(required)|
 
 
+---
 Summoning `getEntityObj(xentity)`:
 ```javascript
 const pathchain = require("pathchain"); // Summoning pathchain
@@ -404,7 +423,8 @@ Entity object:  {
 
 Nodes are the primary data storage elements of the pathchain. They can be the representation of plain `text`, the direction of a `file`, or an internet `url`. 
 
-`<node>` :: node ::= { `<“nodes/”>` + sha256(`<moment>` + `<author>`) }
+`<node>` :: node ::= { `<“nodes/”>` + sha256(`<moment>` + `<author>` + `<content>`) }
+
 
 #### Protocol Buffer file:
 
@@ -431,6 +451,8 @@ Parameter rules:
 |{string} text            |(optional)|
 |{string} format          |(optional)|
 
+
+---
 Summoning `makeNode(secret, text, format)`:
 ```javascript
 const pathchain = require("pathchain"); // Summoning pathchain
@@ -456,6 +478,7 @@ Parameter rules:
 |{string} xauthor         |(optional)|
 
 
+---
 Summoning `getNodeObj(xnode)`:
 ```javascript
 const pathchain = require("pathchain"); // Summoning pathchain
@@ -482,15 +505,116 @@ Node object:  {
 ```
 
 
+## Nodelink
+
+Nodelinks are the joints of the paths. They __link__ one node with another. 
+
+`<nodelink>` :: nodelink ::= { `<“nodelinks/”>` + sha256(`<moment>` + `<author>` + `<first>` + `<second>`) }
+
+
+#### Protocol Buffer file:
+
+``` proto
+syntax = "proto3";
+
+message nodelink {
+    required string register = 1;
+    required string author = 2;
+    required string ancestor = 3;
+    required string first = 4;
+    required string second = 5;
+    required string tag = 6;
+}
+```
+
+
+#### Nodelink maker
+
+Parameter rules:
+|Parameter                |Required  |
+|-------------------------|----------|
+|{string} first           |(required)|
+|{string} second          |(required)|
+|{string} author          |(required)|
+|{string} ancestor        |(optional)|
+|{string} format          |(optional)|
+
+
+---
+Summoning `makeNodelink(first, second, author, ancestor, format)`:
+```javascript
+const pathchain = require("pathchain"); // Summoning pathchain
+
+// Nodelink creation
+var nodelink_buff = pathchain.makeNodelink(node_buff);
+
+console.log("Nodelink buffer: ", nodelink_buff);
+```
+
+Console: 
+``` bash
+Nodelink buffer:  e0f9d300e1b28253455e1835f13ca18d000333152a6a9a9b106d0407612980a8
+```
+
+
+#### Nodelink getter
+
+Parameter rules:
+|Parameter                |Required  |
+|-------------------------|----------|
+|{string} xnodelink       |(required)|
+|{string} xauthor         |(optional)|
+
+
+---
+Summoning `getNodlinkeObj(xnodelink)`:
+```javascript
+const pathchain = require("pathchain"); // Summoning pathchain
+
+// Nodelink creation
+var nodelink_buff = pathchain.makeNodelink(node_buff, "ec59b50c235b66b4e5d78311a1c3313c9ac43a57d763fb530d5e6c67a64d0ee7");
+
+// Getting node obj
+var nodelink_obj = pathchain.getNodeObj(nodelink_buff);
+
+console.log("Nodelink buffer: ", nodelink_buff);
+console.log("Nodelink object: ", nodelink_obj);
+```
+
+Console: 
+``` bash
+Nodelink buffer:  2aea1c448756e1b8e7163483d8d8ce17798c0d272adfaeed6907c5f87432e0a5
+Nodelink object:  {
+  register: 'moments/61f89718cfe72b5aab21cef45d3c01c807e760939e437b48357403e2971c3cd8',
+  author: 'etities/ad7f31ed77042ed1681119a65b00bbd909b72ecdfb8db5c5f8af596c5a8518bc',
+  ancestor: 'nodelinks/2aea1c448756e1b8e7163483d8d8ce17798c0d272adfaeed6907c5f87432e0a5',
+  first: 'nodes/1baf64c528e787ade5f6b98d7cb0c2c8c0e295ac0ff5ee3939653cddea6ab58f',
+  second: 'nodes/ec59b50c235b66b4e5d78311a1c3313c9ac43a57d763fb530d5e6c67a64d0ee7',
+  tag: 'nodelinks/2aea1c448756e1b8e7163483d8d8ce17798c0d272adfaeed6907c5f87432e0a5'
+}
+```
+
+
 ## Path
 
 Paths are the skeleton of the data trees built on pathchain. They are a linear way to connect data.
 
-`<path>` :: path ::= { `<“paths/”>` + sha256(`<moment>` + `<author>`) }
+`<path>` :: path ::= { `<“paths/”>` + sha256(`<moment>` + `<author>` + `<head>`) }
 
 #### Protocol Buffer file:
 
 ``` proto
+syntax = "proto3";
+
+message path {
+    required string register = 1;
+    required string author = 2;
+    required string text = 3;
+    required string head = 4;
+    required string ancestor = 5;
+    optional string chain = 6;
+    required string tag = 7;
+}
 ```
 
 
@@ -504,6 +628,8 @@ Parameter rules:
 |{string} head            |(required)|
 |{string} format          |(optional)|
 
+
+---
 Summoning `makePath(secret, text, format)`:
 ```javascript
 const pathchain = require("pathchain"); // Summoning pathchain
@@ -529,6 +655,7 @@ Parameter rules:
 |{string} xauthor         |(optional)|
 
 
+---
 Summoning `getPathObj(xpath)`:
 ```javascript
 const pathchain = require("pathchain"); // Summoning pathchain
@@ -545,6 +672,240 @@ console.log("Path object: ", path_obj);
 
 Console: 
 ``` bash
+Path buffer:  426cc58ad2576d48429e2bc32a58b39572fba3e8a1465ae9ecb7826a105d5b31
+Path object:  {
+  register: 'moments/0fede6ab5d5078f7cb535cfdf50f7339c02e343fd9793bd7d68bd544e984ab5b',
+  author: 'ad7f31ed77042ed1681119a65b00bbd909b72ecdfb8db5c5f8af596c5a8518bc',
+  text: 'pathlink',
+  head: 'nodelinks/1d3fbcff97b1b995eb83b6c70b23ea95b385add1b9bcef5d5adcd7db21591aac',
+  ancestor: 'paths/426cc58ad2576d48429e2bc32a58b39572fba3e8a1465ae9ecb7826a105d5b31',
+  chain: '',
+  tag: 'paths/426cc58ad2576d48429e2bc32a58b39572fba3e8a1465ae9ecb7826a105d5b31'
+}
+```
+
+
+#### Pathlink maker
+
+Parameter rules:
+|Parameter                |Required  |
+|-------------------------|----------|
+|{string} first           |(required)|
+|{string} second          |(required)|
+|{string} author          |(required)|
+|{string} ancestor        |(optional)|
+|{string} format          |(optional)|
+
+
+---
+Summoning `makePathlink(first, second, author, ancestor, format)`:
+```javascript
+const pathchain = require("pathchain"); // Summoning pathchain
+
+// Pathlink creation
+var pathlink_buff = pathchain.makePathlink(node_buff);
+
+console.log("Pathlink buffer: ", pathlink_buff);
+```
+
+Console: 
+``` bash
+Pathlink buffer:  e0f9d300e1b28253455e1835f13ca18d000333152a6a9a9b106d0407612980a8
+```
+
+
+#### Pathlink getter
+
+Parameter rules:
+|Parameter                |Required  |
+|-------------------------|----------|
+|{string} xpathlink       |(required)|
+|{string} xauthor         |(optional)|
+
+
+---
+Summoning `getNodlinkeObj(xpathlink)`:
+```javascript
+const pathchain = require("pathchain"); // Summoning pathchain
+
+// Pathlink creation
+var pathlink_buff = pathchain.makePathlink(path_buff, "ec59b50c235b66b4e5d78311a1c3313c9ac43a57d763fb530d5e6c67a64d0ee7");
+
+// Getting node obj
+var pathlink_obj = pathchain.getNodeObj(pathlink_buff);
+
+console.log("Pathlink buffer: ", pathlink_buff);
+console.log("Pathlink object: ", pathlink_obj);
+```
+
+Console: 
+``` bash
+Pathlink buffer:  2aea1c448756e1b8e7163483d8d8ce17798c0d272adfaeed6907c5f87432e0a5
+Pathlink object:  {
+  register: 'moments/61f89718cfe72b5aab21cef45d3c01c807e760939e437b48357403e2971c3cd8',
+  author: 'etities/ad7f31ed77042ed1681119a65b00bbd909b72ecdfb8db5c5f8af596c5a8518bc',
+  ancestor: 'pathlinks/2aea1c448756e1b8e7163483d8d8ce17798c0d272adfaeed6907c5f87432e0a5',
+  first: 'nodes/1baf64c528e787ade5f6b98d7cb0c2c8c0e295ac0ff5ee3939653cddea6ab58f',
+  second: 'nodes/ec59b50c235b66b4e5d78311a1c3313c9ac43a57d763fb530d5e6c67a64d0ee7',
+  tag: 'pathlinks/2aea1c448756e1b8e7163483d8d8ce17798c0d272adfaeed6907c5f87432e0a5'
+}
+```
+
+
+## Tree
+
+Trees are the biggest data representation elements of the pathchain. They are ordered representations of the aglomeration of paths.
+
+`<tree>` :: tree ::= { `<“trees/”>` + sha256(`<moment>` + `<author>` + `<head>`) }
+
+#### Protocol Buffer file:
+
+``` proto
+syntax = "proto3";
+
+message tree {
+    required string register = 1;
+    required string author = 2;
+    required string text = 3;
+    required string head = 4;
+    required string ancestor = 5;
+    optional string chain = 6;
+    required string tag = 7;
+}
+
+```
+
+
+#### Tree maker
+
+Parameter rules:
+|Parameter                |Required  |
+|-------------------------|----------|
+|{string} xauthor         |(required)|
+|{string} text            |(required)|
+|{string} head            |(required)|
+|{string} format          |(optional)|
+
+
+---
+Summoning `makeTree(secret, text, format)`:
+```javascript
+const pathchain = require("pathchain"); // Summoning pathchain
+
+// Tree creation
+var tree_buff = pathchain.makeTree("tree", "1d3fbcff97b1b995eb83b6c70b23ea95b385add1b9bcef5d5adcd7db21591aac");
+
+
+console.log("Tree buffer: ", tree_buff);
+```
+
+Console: 
+``` bash
+Tree buffer:  a0f9d300e1b28253455e1835f13ca18d000333152a6a9a9b106d0407612980a8
+```
+
+
+#### Tree getter
+
+Parameter rules:
+|Parameter                |Required  |
+|-------------------------|----------|
+|{string} xtree           |(required)|
+|{string} xauthor         |(optional)|
+
+
+---
+Summoning `getTreeObj(xtree)`:
+```javascript
+const pathchain = require("pathchain"); // Summoning pathchain
+
+// Tree creation
+var tree_buff = pathchain.makeTree("tree", "1d3fbcff97b1b995eb83b6c70b23ea95b385add1b9bcef5d5adcd7db21591aac");
+
+// Getting tree obj
+var tree_obj = pathchain.getTreeObj(tree_buff);
+
+console.log("Tree buffer: ", tree_buff);
+console.log("Tree object: ", tree_obj);
+```
+
+Console: 
+``` bash
+Tree buffer:  8d9abf006f5ba6dc1b415baf6d9e37b5d18d6b43451e01d9fa27b10b393a8d89
+Tree object:  {
+  register: 'moments/8a6601db7ae0f1dc69b7d5e63c510bbae44d0d58ea2683e289a4a23f0ca2a08c',
+  author: 'ad7f31ed77042ed1681119a65b00bbd909b72ecdfb8db5c5f8af596c5a8518bc',
+  text: 'tree',
+  head: 'nodelinks/1d3fbcff97b1b995eb83b6c70b23ea95b385add1b9bcef5d5adcd7db21591aac',
+  ancestor: 'trees/8d9abf006f5ba6dc1b415baf6d9e37b5d18d6b43451e01d9fa27b10b393a8d89',
+  chain: '',
+  tag: 'trees/8d9abf006f5ba6dc1b415baf6d9e37b5d18d6b43451e01d9fa27b10b393a8d89'
+}
+```
+
+
+#### Treelink maker
+
+Parameter rules:
+|Parameter                |Required  |
+|-------------------------|----------|
+|{string} first           |(required)|
+|{string} second          |(required)|
+|{string} author          |(required)|
+|{string} ancestor        |(optional)|
+|{string} format          |(optional)|
+
+
+---
+Summoning `makeTreelink(first, second, author, ancestor, format)`:
+```javascript
+const pathchain = require("pathchain"); // Summoning pathchain
+
+// Treelink creation
+var treelink_buff = pathchain.makeTreelink(node_buff);
+
+console.log("Treelink buffer: ", treelink_buff);
+```
+
+Console: 
+``` bash
+Treelink buffer:  e0f9d300e1b28253455e1835f13ca18d000333152a6a9a9b106d0407612980a8
 ```
 
 
+#### Treelink getter
+
+Parameter rules:
+|Parameter                |Required  |
+|-------------------------|----------|
+|{string} xtreelink       |(required)|
+|{string} xauthor         |(optional)|
+
+
+---
+Summoning `getNodlinkeObj(xtreelink)`:
+```javascript
+const pathchain = require("pathchain"); // Summoning pathchain
+
+// Treelink creation
+var treelink_buff = pathchain.makeTreelink(path_buff, "ec59b50c235b66b4e5d78311a1c3313c9ac43a57d763fb530d5e6c67a64d0ee7");
+
+// Getting node obj
+var treelink_obj = pathchain.getNodeObj(treelink_buff);
+
+console.log("Treelink buffer: ", treelink_buff);
+console.log("Treelink object: ", treelink_obj);
+```
+
+Console: 
+``` bash
+Treelink buffer:  2aea1c448756e1b8e7163483d8d8ce17798c0d272adfaeed6907c5f87432e0a5
+Treelink object:  {
+  register: 'moments/61f89718cfe72b5aab21cef45d3c01c807e760939e437b48357403e2971c3cd8',
+  author: 'etities/ad7f31ed77042ed1681119a65b00bbd909b72ecdfb8db5c5f8af596c5a8518bc',
+  ancestor: 'treelinks/2aea1c448756e1b8e7163483d8d8ce17798c0d272adfaeed6907c5f87432e0a5',
+  first: 'nodes/1baf64c528e787ade5f6b98d7cb0c2c8c0e295ac0ff5ee3939653cddea6ab58f',
+  second: 'nodes/ec59b50c235b66b4e5d78311a1c3313c9ac43a57d763fb530d5e6c67a64d0ee7',
+  tag: 'treelinks/2aea1c448756e1b8e7163483d8d8ce17798c0d272adfaeed6907c5f87432e0a5'
+}
+```

package/maker.js

@@ -276,7 +276,7 @@ function nodelink(first, second, author, ancestor, format = 'MM DD YYYY HH:mm:SS
 
     var register_moment_hash = moment(register, 0, 0, 0, 0, 0, format)
     
-    var nodelink_hash = sha256(register_moment_hash + "_" + author);
+    var nodelink_hash = sha256(register_moment_hash + "_" + author + "_" + first + "_" + second);
 
     if(ancestor == ""){
         ancestor = nodelink_hash;        

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pathchain",
-  "version": "1.0.44",
+  "version": "1.0.46",
   "dependencies": {
     "date-and-time": "^3.0.2",
     "empty-dir": "^3.0.0",