pathchain 1.0.30 → 1.0.31

package/README.md

@@ -15,6 +15,9 @@ Maker functions recieve new data to encode into the chain.
 | [`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   |
 
 
 
@@ -26,6 +29,9 @@ Getter functions retrieve objects given a hashname and author information
 | [`getMoment()`](#Moment)    | xmoment                                  |
 | [`getPioneer()`](#Pioneer)  | (none)                                   |
 | [`getSecret()`](#Secret)    | xsecret                                  |
+| [`getEntity()`](#Entity)    | xentity                                  |
+| [`getNode()`](#Node)        | xnode                                    |
+| [`getPath()`](#Path)        | xpath                                    |
 
 
 ---
@@ -81,13 +87,13 @@ message moment {
 Parameter rules:
 |Parameter                |Required  |
 |-------------------------|----------|
-|{string} datetime |(optional)|
-|{float}  lat      |(optional)|
-|{float}  lon      |(optional)|
-|{float}  x        |(optional)|
-|{float}  y        |(optional)|
-|{float}  z        |(optional)|
-|{string} format   |(optional)|
+|{string} datetime        |(optional)|
+|{float}  lat             |(optional)|
+|{float}  lon             |(optional)|
+|{float}  x               |(optional)|
+|{float}  y               |(optional)|
+|{float}  z               |(optional)|
+|{string} format          |(optional)|
 
 
 Summoning `makeMoment(datetime, lat, lon, x, y, z, format)`:
@@ -229,11 +235,12 @@ Secret buffer used?: true
 Parameter rules:
 |Parameter                |Required  |
 |-------------------------|----------|
-|{string} xsecret         |(optional)|
+|{string} xsecret         |(required)|
 
 
-Summoning `getSecretObj(xsecret)`
-```
+Summoning `getSecretObj(xsecret)`:
+```javascript
+
 const pathchain = require("pathchain"); // Summoning pathchain
 
 const secret_buff = pathchain.makeSecret(author); // Secret creation
@@ -256,18 +263,65 @@ Secret object:  {
 
 ## Pioneer
 
-A pioneer is a user with all its content made public. It is the first entity on the system and can only generate one [secret](#Secret) in order to initiate the human chain for the system. The pioneer buffer exists as a single buffer in the `pioneer` folder and as an entity in the `entities` folder.
+A pioneer is a user with all its content made public. It is the first entity on the system and can only generate one [secret](#Secret) in order to initiate the human chain for the system. The pioneer buffer exists as a single buffer in the `pioneer` folder and as an [entity](#Entity) in the `entities` folder.
 
-`<pioneer>` :: pioneer entity ::= { `<“pioneer/”>` + sha256(`<moment>`) }
+`<pioneer>` :: pioneer entity ::= { `<“pioneer/”>` + sha256(`<moment>` +  `<moment>`) }
 
-#### Protocol Buffer file:
-``` javascript
-syntax = "proto3";
 
-message entity {
-    required string register = 1;
-    required string invite = 2;
-    required string tag = 3;
+#### Pioneer maker
+
+Parameter rules:
+|Parameter                |Required  |
+|-------------------------|----------|
+|                         |(nothing) |
+
+
+Summoning `makePioneer()`:
+```javascript
+
+const pathchain = require("pathchain"); // Summoning pathchain
+
+var pioneer_buff = pathchain.makePioneer(); // Pioneer creation
+
+console.log("Pioneer buffer: ", pioneer_buff);
+```
+
+Console: 
+``` bash
+Pioneer buffer:  d945dfb67de94dafbcf0ea35281c7ca534a293db3a4d1ffd82523cd97ff8110f
+```
+
+** If you summon `makePioneer()` again, it will always return the original pioneer. The pioneer will be the same forever and ever!. For the same reason, summoning `getPioneerObj()` does not require parameters. If the pioneer does not exist, it is automatically created by the system. **
+
+#### Pioneer getter
+
+Parameter rules:
+|Parameter                |Required  |
+|-------------------------|----------|
+|                         |(nothing) |
+
+
+Summoning `getPioneerObj()`:
+```javascript
+
+const pathchain = require("pathchain"); // Summoning pathchain
+
+
+var pioneer_buff = pathchain.makePioneer(); // Pioneer creation
+var pioneer_obj = pathchain.getPioneerObj();
+
+console.log("Pioneer buffer: ", pioneer_buff);
+console.log("Pioneer object: ", pioneer_obj);
+```
+
+
+Console: 
+``` bash
+Pioneer buffer:  d945dfb67de94dafbcf0ea35281c7ca534a293db3a4d1ffd82523cd97ff8110f
+Pioneer object:  {
+  register: 'moments/c73d1ca5abc2e158c76747f7c2d56afc729614042a88d46603991fe8f3d4b518',
+  ancestor: 'entities/d945dfb67de94dafbcf0ea35281c7ca534a293db3a4d1ffd82523cd97ff8110f',
+  tag: 'entities/d945dfb67de94dafbcf0ea35281c7ca534a293db3a4d1ffd82523cd97ff8110f'
 }
 ```
 
@@ -318,11 +372,11 @@ Entity buffer:  c0f9d300e1b28253455e1835f13ca18d000333152a6a9a9b106d0407612980a8
 Parameter rules:
 |Parameter                |Required  |
 |-------------------------|----------|
-|{string} xentity         |(optional)|
+|{string} xentity         |(required)|
 
 
-Summoning `getEntityObj(xentity)`
-```
+Summoning `getEntityObj(xentity)`:
+```javascript
 const pathchain = require("pathchain"); // Summoning pathchain
 
 // Entity creation
@@ -392,3 +446,105 @@ Console:
 Node buffer:  a0f9d300e1b28253455e1835f13ca18d000333152a6a9a9b106d0407612980a8
 ```
 
+
+#### Node getter
+
+Parameter rules:
+|Parameter                |Required  |
+|-------------------------|----------|
+|{string} xnode           |(required)|
+|{string} xauthor         |(optional)|
+
+
+Summoning `getNodeObj(xnode)`:
+```javascript
+const pathchain = require("pathchain"); // Summoning pathchain
+
+// Node creation
+var node_buff = pathchain.makeNode(secret);
+
+// Getting node obj
+var node_obj = pathchain.getNodeObj(node_buff);
+
+console.log("Node buffer: ", node_buff);
+console.log("Node object: ", node_obj);
+```
+
+Console: 
+``` bash
+Node buffer:  1014d11c4ed954035790bfed6a3c45e2eda2efbd8d77668c8d8c5d95edc6b0dc
+Node object:  {
+  register: 'moments/299b4964df437863fdd316c86559e032105ee0f6a6388effd004df60b311f75a',
+  author: 'd945dfb67de94dafbcf0ea35281c7ca534a293db3a4d1ffd82523cd97ff8110f',
+  text: 'Learning to fly, one step closer to knowing',
+  tag: 'nodes/1014d11c4ed954035790bfed6a3c45e2eda2efbd8d77668c8d8c5d95edc6b0dc'
+}
+```
+
+
+## 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>`) }
+
+#### Protocol Buffer file:
+
+``` proto
+```
+
+
+#### Path maker
+
+Parameter rules:
+|Parameter                |Required  |
+|-------------------------|----------|
+|{string} xauthor         |(required)|
+|{string} text            |(required)|
+|{string} head            |(required)|
+|{string} format          |(optional)|
+
+Summoning `makePath(secret, text, format)`:
+```javascript
+const pathchain = require("pathchain"); // Summoning pathchain
+
+// Path creation
+var path_buff = pathchain.makePath(author, text, head);
+
+console.log("Path buffer: ", path_buff);
+```
+
+Console: 
+``` bash
+Path buffer:  a0f9d300e1b28253455e1835f13ca18d000333152a6a9a9b106d0407612980a8
+```
+
+
+#### Path getter
+
+Parameter rules:
+|Parameter                |Required  |
+|-------------------------|----------|
+|{string} xpath           |(required)|
+|{string} xauthor         |(optional)|
+
+
+Summoning `getPathObj(xpath)`:
+```javascript
+const pathchain = require("pathchain"); // Summoning pathchain
+
+// Path creation
+var path_buff = pathchain.makePath(secret);
+
+// Getting path obj
+var path_obj = pathchain.getPathObj(path_buff);
+
+console.log("Path buffer: ", path_buff);
+console.log("Path object: ", path_obj);
+```
+
+Console: 
+``` bash
+```
+
+

package/getter.js

@@ -145,7 +145,7 @@ function getEntityObj(xentity, xauthor) {
         }
     }
 
-    // DECODING SECRET
+    // DECODING ENTITY
     var entity_enc = fileContents
     var entity_obj = entity_pb.entity.decode(entity_enc)
 
@@ -187,4 +187,40 @@ function getNodeObj(xnode, xauthor) {
     return node_obj;
 }
 
-module.exports = { getCurrentDate, getMomentObj, getPioneerObj, getSecretObj, getEntityObj, getNodeObj }
+
+/** getPathObj
+ * [Function that recieves a path hash and returns the path object]
+ * 
+ * @param {string} xpath (required)
+ * 
+ * @return void
+ */
+function getPathObj(xpath, xauthor) {
+
+    if(xauthor != ""){
+        xauthor = xauthor + '/';
+    }
+
+    // LOADING PB
+    var path_pb = pb(fs.readFileSync('path_modules/pathchain/proto/path.proto'))
+    
+    // NOT FOUND EXCEPTION
+    var fileContents;
+    try {
+        fileContents = fs.readFileSync("files/" + xauthor + "paths/" + xpath);
+    } catch (err) {
+        if (err.code === 'ENOENT') {
+            return "Path not found";
+        } else {
+            throw err;
+        }
+    }
+
+    // DECODING PATH
+    var path_enc = fileContents
+    var path_obj = path_pb.path.decode(path_enc)
+
+    return path_obj;
+}
+
+module.exports = { getCurrentDate, getMomentObj, getPioneerObj, getSecretObj, getEntityObj, getNodeObj, getPathObj }

package/index.js

@@ -180,3 +180,32 @@ exports.getNodeObj = (xnode, xauthor="") => {
     const node_object = getter.getNodeObj(xnode, xauthor);
     return node_object;
 }
+
+
+//////////////////
+///    PATH    ///
+//////////////////
+
+/** makePath
+ * [Path maker]
+ * 
+ * @return {string} path_buffer
+ */
+exports.makePath = (xauthor = "", text ="", head="", ancestor="", format = 'MM DD YYYY HH:mm:SSS [GMT]Z') => {
+    const path_buffer = maker.path(xauthor, text, head, ancestor, format);
+    return path_buffer;
+}
+
+/** getPathObj
+ * [Function that recieves a path hash and returns the path object]
+ * 
+ * @param {string} xpath (required)
+ * 
+ * @return {obj} path_object (path object)
+ */
+exports.getPathObj = (xpath, xauthor="") => {
+    const path_object = getter.getPathObj(xpath, xauthor);
+    return path_object;
+}
+
+

package/maker.js

@@ -236,7 +236,7 @@ function node(text, author, format = 'MM DD YYYY HH:mm:SSS [GMT]Z') {
     
     var buffer = node_pb.node.encode({
         register: "moments/" + register_moment_hash,
-        author: author,
+        author: "etities/" + author,
         text: text,
         tag: "nodes/" + node_hash
     })
@@ -248,4 +248,54 @@ function node(text, author, format = 'MM DD YYYY HH:mm:SSS [GMT]Z') {
 }
 
 
-module.exports = { moment, pioneer, secret, entity, node }
+
+/**
+* [Pioneer Protocol Buffer Creation]
+* 
+* @param {string} author (optional, default=pioneer_hash)
+* @param {string} text   (optional, default=path_hash)
+* @param {string} head   (required)
+* @param {string} ancestor (optional, default=path_hash)
+* @param {string} format (required)
+* 
+* @return {string} path_hash
+*/
+function path(author, text, head, ancestor, format = 'MM DD YYYY HH:mm:SSS [GMT]Z') {
+   var path_pb = pb(fs.readFileSync('node_modules/pathchain/proto/path.proto'))
+
+   var author_folder = author;
+   if(author == ""){
+        author = pioneer();
+        author_folder = "";
+   }else{
+        author_folder = author_folder + '/';
+   }
+
+   var register = new Date()
+   register = dt.format(register, dt.compile(format, true));
+
+   var register_moment_hash = moment(register, 0, 0, 0, 0, 0, format)
+
+   var path_hash = sha256(register_moment_hash + "_" + author);
+   
+   if(text == ""){ text = path_hash; }
+   if(head == ""){ return "Head node_link is required to create a path!" }
+   if(ancestor == ""){ ancestor = path_hash; }
+
+   var buffer = path_pb.path.encode({
+       register: "moments/"+register_moment_hash,
+       author: author,
+       text: text,
+       head: head,
+       ancestor: ancestor,
+       tag: "paths/"+path_hash,
+   })
+
+   checker.checkDir("files/" + author_folder + "paths/") // checking
+   fs.writeFileSync("files/" + author_folder + "paths/" + path_hash, buffer);
+   
+   return author_folder + "/paths/" + path_hash;
+}
+
+
+module.exports = { moment, pioneer, secret, entity, node, path }

package/package.json

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

package/proto/path.proto

@@ -0,0 +1,11 @@
+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;
+}