pathchain 1.0.25 → 1.0.28

package/README.md

@@ -203,7 +203,7 @@ var used = pathchain.isSecretUsed(secret_buff);
 console.log("Secret buffer used?: ", used); // Printing
 
 // Using the secret
-pathchain.useSecret(secret_buff);
+pathchain.useSecret(secret_buff, xentity);
 
 // Checking if the secret has been used (before using it)
 var used = pathchain.isSecretUsed(secret_buff);
@@ -236,9 +236,9 @@ Summoning `getSecretObj(xsecret)`
 ```
 const pathchain = require("pathchain"); // Summoning pathchain
 
-const secret_nuff = pathchain.makeSecret(author); // Secret creation
+const secret_buff = pathchain.makeSecret(author); // Secret creation
 
-var secret_obj = pathchain.getSecretObj(secret_buff); // Getting object from hashname
+var secret_obj = pathchain.getSecretObj(secret_buff); //   Getting object from hashname
 
 console.log("Secret object: ", secret_obj); // Printing
 ```
@@ -269,4 +269,126 @@ message entity {
     required string invite = 2;
     required string tag = 3;
 }
-```
+```
+
+
+## Entity
+
+Entities are the actors/users that create/author and organize information on the pathchain. Entities are linked to information from their origin and their relationship with other entities and data in the system. Entities can expand and organize with other entities to publish or modify data in the name of an 'alter-ego' or an 'organization'. An entity can only join the pathchain using another entitie(s) secret.
+
+`<entity>` :: entity ::= { `<“entities/”>` + sha256(`<moment>` + `<entity>`) }
+
+#### Protocol Buffer file:
+
+``` proto
+syntax = "proto3";
+
+message entity {
+    required string register = 1;
+    required string ancestor = 2;
+    required string tag = 3;
+}
+```
+
+#### Entity maker
+
+Parameter rules:
+|Parameter                |Required  |
+|-------------------------|----------|
+|{string} author          |(required)|
+|{string} format          |(optional)|
+
+Summoning `makeEntity(secret, format)`:
+```javascript
+const pathchain = require("pathchain"); // Summoning pathchain
+
+// Entity creation
+var entity_buff = pathchain.makeEntity(secret);
+
+console.log("Entity buffer: ", entity_buff);
+```
+
+Console: 
+``` bash
+Entity buffer:  c0f9d300e1b28253455e1835f13ca18d000333152a6a9a9b106d0407612980a8
+```
+
+#### Entity getter
+
+Parameter rules:
+|Parameter                |Required  |
+|-------------------------|----------|
+|{string} xentity         |(optional)|
+
+
+Summoning `getEntityObj(xentity)`
+```
+const pathchain = require("pathchain"); // Summoning pathchain
+
+// Entity creation
+var entity_buff = pathchain.makeEntity(secret);
+
+// Getting entity obj
+var entity_obj = pathchain.getEntityObj(entity_buff);
+
+console.log("Entity buffer: ", entity_buff);
+console.log("Entity object: ", entity_obj);
+```
+
+Console: 
+``` bash
+Entity buffer:  9a07ccefa200a3bcf3322fee26f35302f0ec206784d537bb06065bfb9f92885c
+Entity object:  {
+  register: 'moments/28013246663010e61e9fca8dd21d309959954d95ac90739616126f40b8d93ede',
+  ancestor: 'entities/undefined',
+  tag: 'entities/9a07ccefa200a3bcf3322fee26f35302f0ec206784d537bb06065bfb9f92885c'
+}
+```
+
+
+## Node
+
+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>`) }
+
+#### Protocol Buffer file:
+
+``` proto
+syntax = "proto3";
+
+message node {
+    required string register = 1;
+    required string author = 2;
+    required string file = 3;
+    required string text = 4;
+    required string url = 5;
+    required string tag = 6;
+}
+```
+
+
+#### Node maker
+
+Parameter rules:
+|Parameter                |Required  |
+|-------------------------|----------|
+|{string} author          |(required)|
+|{string} text            |(optional)|
+|{string} format          |(optional)|
+
+Summoning `makeNode(secret, text, format)`:
+```javascript
+const pathchain = require("pathchain"); // Summoning pathchain
+
+// Node creation
+var node_buff = pathchain.makeNode(author, content);
+
+console.log("Node buffer: ", node_buff);
+```
+
+Console: 
+``` bash
+Node buffer:  a0f9d300e1b28253455e1835f13ca18d000333152a6a9a9b106d0407612980a8
+```
+

package/getter.js

@@ -152,4 +152,39 @@ function getEntityObj(xentity, xauthor) {
     return entity_obj;
 }
 
-module.exports = { getCurrentDate, getMomentObj, getPioneerObj, getSecretObj, getEntityObj }
+/** getNodeObj
+ * [Function that recieves a node hash and returns the node object]
+ * 
+ * @param {string} xnode (required)
+ * 
+ * @return void
+ */
+function getNodeObj(xnode, xauthor) {
+
+    if(xauthor != ""){
+        xauthor = xauthor + '/';
+    }
+
+    // LOADING PB
+    var node_pb = pb(fs.readFileSync('node_modules/pathchain/proto/node.proto'))
+    
+    // NOT FOUND EXCEPTION
+    var fileContents;
+    try {
+        fileContents = fs.readFileSync("files/" + xauthor + "nodes/" + xnode);
+    } catch (err) {
+        if (err.code === 'ENOENT') {
+            return "Node not found";
+        } else {
+            throw err;
+        }
+    }
+
+    // DECODING NODE
+    var node_enc = fileContents
+    var node_obj = node_pb.node.decode(node_enc)
+
+    return node_obj;
+}
+
+module.exports = { getCurrentDate, getMomentObj, getPioneerObj, getSecretObj, getEntityObj, getNodeObj }

package/index.js

@@ -152,4 +152,31 @@ exports.isSecretUsed = (xsecret) => {
 exports.getSecretObj = (xsecret, xauthor = "") => {
     const secret_object = getter.getSecretObj(xsecret, xauthor);
     return secret_object;
+}
+
+
+//////////////////
+///    NODE    ///
+//////////////////
+
+/** makeNode
+ * [Node maker]
+ * 
+ * @return {string} node_buffer
+ */
+exports.makeNode = (xauthor = "", text ="", format = 'MM DD YYYY HH:mm:SSS [GMT]Z') => {
+    const node_buffer = maker.node(xauthor, text, format);
+    return node_buffer;
+}
+
+/** getNodeObj
+ * [Function that recieves a node hash and returns the node object]
+ * 
+ * @param {string} xnode (required)
+ * 
+ * @return {obj} node_object (node object)
+ */
+exports.getNodeObj = (xnode, xauthor="") => {
+    const node_object = getter.getNodeObj(xnode, xauthor);
+    return node_object;
 }

package/maker.js

@@ -206,4 +206,46 @@ function entity(xsecret, format) {
 }
 
 
-module.exports = { moment, pioneer, secret, entity }
+/** node
+ * [Node Protocol Buffer Creation]
+ * 
+ * @param {string} author (optional, default=pioneer_hash)
+ * @param {string} file   (optional)
+ * @param {string} str    (optional)
+ * @param {string} format (required)
+ * 
+ * @return {string} node_hash
+ */
+function node(author, text, format = 'MM DD YYYY HH:mm:SSS [GMT]Z') {
+    var node_pb = pb(fs.readFileSync('node_modules/pathchain/proto/node.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, format, 0, 0, 0, 0, 0)
+    
+    var node_hash = sha256(register_moment_hash + "_" + author);
+    
+    var buffer = node_pb.node.encode({
+        register: "moments/"+register_moment_hash,
+        author: author,
+        text: text,
+        tag: "nodes/"+node_hash,
+    })
+
+    checker.checkDir("files/" + author_folder + "nodes/") // checking
+    fs.writeFileSync("files/" + author_folder + "nodes/" + node_hash, buffer);
+    
+    return node_hash;
+}
+
+
+module.exports = { moment, pioneer, secret, entity, node }

package/package.json

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

package/proto/node.proto

@@ -0,0 +1,8 @@
+syntax = "proto3";
+
+message node {
+    required string register = 1;
+    required string author = 2;
+    required string text = 3;
+    required string tag = 4;
+}

package/updater.js

@@ -36,11 +36,8 @@ function useSecret(xsecret, xauthor = "") {
         // USING INVITE SECRET
         secret_obj.used = true;
         secret_obj.user = "entities/"+xauthor;
-        
-        // Private handling
-        fs.writeFileSync("files/" + xauthor + "secrets/" + xsecret, secret_pb.secret.encode(secret_obj));
 
-        // Publuc handling
+        // Public handling only >:c
         fs.writeFileSync("files/secrets/" + xsecret, secret_pb.secret.encode(secret_obj));
     }
     return secret_obj;