pathchain 1.0.9 → 1.0.11

package/README.md

@@ -17,6 +17,7 @@ Maker functions recieve new data to encode into the chain.
 | [`makeSecret()`](#Secret)    | author, format                          |
 
 
+
 ## Getters
 Getter functions retrieve objects given a hashname and author information
 
@@ -27,6 +28,8 @@ Getter functions retrieve objects given a hashname and author information
 | [`getSecret()`](#Secret)    | xsecret                                  |
 
 
+---
+
 
 ## Moment
 
@@ -86,6 +89,7 @@ Parameter rules:
 |{float}  z        |(optional)|
 |{string} format   |(optional)|
 
+
 Summoning `makeMoment(datetime, lat, lon, x, y, z, format)`:
 ```javascript
 const pathchain = require("pathchain"); // Summoning pathchain
@@ -107,6 +111,7 @@ Parameter rules:
 |{string} xauthor  |(optional)|
 |{string} xmoment  |(required)|
 
+
 Summoning `getMomentObj(xauthor, xmoment)`
 ```
 const pathchain = require("pathchain"); // Summoning pathchain
@@ -164,6 +169,7 @@ Parameter rules:
 |{string} author          |(required)|
 |{string} format          |(optional)|
 
+
 Summoning `makeMoment(author, format)`:
 ```javascript
 const pathchain = require("pathchain"); // Summoning pathchain
@@ -184,7 +190,8 @@ Parameter rules:
 |-------------------------|----------|
 |{string} xsecret         |(required)|
 
-Summoning `useSecret(xsecret)`:
+
+Summoning `useSecret(xsecret)` & `isSecretUsed(xsecret)`:
 ```javascript
 const pathchain = require("pathchain"); // Summoning pathchain
 
@@ -224,6 +231,7 @@ Parameter rules:
 |-------------------------|----------|
 |{string} xsecret         |(optional)|
 
+
 Summoning `getSecretObj(xsecret)`
 ```
 const pathchain = require("pathchain"); // Summoning pathchain

package/checker.js

@@ -50,7 +50,7 @@ function checkEmptyDir(dir) {
  */
 function isSecretUsed(xsecret) {
     // DECODING SECRET
-    var secret_pb = pb(fs.readFileSync('node_modules/pathos-proto-infra/proto/secret.proto'))
+    var secret_pb = pb(fs.readFileSync('node_modules/pathchain/proto/secret.proto'))
 
     // NOT FOUND EXCEPTION
     var secret_enc;
@@ -68,7 +68,7 @@ function isSecretUsed(xsecret) {
 
     if(secret_obj.used == false){
         return false
-    }
+    }  
     return true;
 }
 

package/getter.js

@@ -28,7 +28,7 @@ function getMomentObj(xmoment) {
     }
 
     // LOADING PB
-    var moment_pb = pb(fs.readFileSync('node_modules/pathos-proto-infra/proto/moment.proto'))
+    var moment_pb = pb(fs.readFileSync('node_modules/pathchain/proto/moment.proto'))
     
     // NOT FOUND EXCEPTION
     var fileContents;
@@ -59,7 +59,7 @@ function getMomentObj(xmoment) {
 function getPioneerObj(xpioneer) {
 
     // LOADING PB
-    var pioneer_pb = pb(fs.readFileSync('node_modules/pathos-proto-infra/proto/entity.proto'))
+    var pioneer_pb = pb(fs.readFileSync('node_modules/pathchain/proto/entity.proto'))
     
     // NOT FOUND EXCEPTION
     var fileContents;
@@ -89,23 +89,23 @@ function getPioneerObj(xpioneer) {
  * 
  * @return void
  */
-function getSecretObj(xsecret) {
+function getSecretObj(xsecret, xauthor) {
     // "secret/hash" FORMAT EXCEPTION
     /*if(xsecret.split("/").length > 1){ 
         xsecret = xsecret.split("/")[xsecret.length -1]
     }*/
 
-    if(author_folder != ""){
-        author_folder = author_folder + '/';
+    if(xauthor != ""){
+        xauthor = xauthor + '/';
     }
 
     // LOADING PB
-    var secret_pb = pb(fs.readFileSync('node_modules/pathos-proto-infra/proto/secret.proto'))
+    var secret_pb = pb(fs.readFileSync('node_modules/pathchain/proto/secret.proto'))
     
     // NOT FOUND EXCEPTION
     var fileContents;
     try {
-        fileContents = fs.readFileSync("files/" + author_folder + "secrets/" + xsecret);
+        fileContents = fs.readFileSync("files/" + xauthor + "secrets/" + xsecret);
     } catch (err) {
         if (err.code === 'ENOENT') {
             return "Secret not found";

package/maker.js

@@ -19,7 +19,7 @@ const checker = require("./checker");
  * @return {string} moment_buffer
  */
 function moment(datetime, lat, lon, x, y, z, format) {
-    var moment_pb = pb(fs.readFileSync('node_modules/pathos-proto-infra/proto/moment.proto'));
+    var moment_pb = pb(fs.readFileSync('node_modules/pathchain/proto/moment.proto'));
     
     var date_obj = dt.preparse(datetime, format);
     var moment_obj = {
@@ -68,7 +68,7 @@ function secret(author, format) {
 
     // There is no pioneer
     if(checker.checkEmptyDir("files/entities/")){
-        var secret_pb = pb(fs.readFileSync('node_modules/pathos-proto-infra/proto/secret.proto'))
+        var secret_pb = pb(fs.readFileSync('node_modules/pathchain/proto/secret.proto'))
 
         var register = new Date()
         register = dt.format(register, dt.compile(format, true));
@@ -112,7 +112,7 @@ function pioneer(xbigbang, format) {
     // There is no pioneer
     if(checker.checkEmptyDir("files/entities/")){
         // CREATING PIONEER
-        var entity = pb(fs.readFileSync('node_modules/pathos-proto-infra/proto/entity.proto'))
+        var entity = pb(fs.readFileSync('node_modules/pathchain/proto/entity.proto'))
         
         var register = new Date()
         register = dt.format(register, dt.compile(format, true));
@@ -132,7 +132,7 @@ function pioneer(xbigbang, format) {
         var buffer = entity.entity.encode({
             birthday: "moments/"+birthday_moment,
             register: "moments/"+register_moment_hash,
-            invite: "entities/"+pioneer_hash, // points to itself as inviting entity in the chain
+            invite: "entities/"+pioneer_hash, // points to itself as ancestor entity in the chain
             tag: "entities/"+pioneer_hash,
         })
 
@@ -155,5 +155,55 @@ function pioneer(xbigbang, format) {
     }
 }
 
+/** entity
+ * [Entity Protocol Buffer Creation]
+ * 
+ * @param {string} xsecret (required)
+ * @param {string} format  (optional)
+ * 
+ * @return {string} secret_hash
+ */
+function entity(xsecret, format) {
+    // "secret/hash" FORMAT EXCEPTION
+    /*if(xsecret.split("/").length > 1){ 
+        xsecret = xsecret.split("/")[1]
+    }*/
+
+    checker.checkDir("files/entities/");
+    if(checker.checkEmptyDir("files/entities/")){
+        return "A pioneer's secret is needed to create the first entity. There was no pioneer, but here is the one at 'files/pioneer/'" + pioneer();
+    }
+    else{
+        if(!checker.isSecretUsed(xsecret)){
+            // CREATING entity
+            var entity = pb(fs.readFileSync('node_modules/pathchain/proto/entity.proto'))
+            
+            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 ancestor_entity_hash = getter.getSecretObj(xsecret).author;
+            // console.log("-> ancestor ENTITY HASH: ", ancestor_entity_hash);
+
+            var entity_hash = sha256(register_moment_hash + "_" + ancestor_entity_hash);
+
+
+            var buffer = entity.entity.encode({
+                register: "moments/"+register_moment_hash,
+                invite: ancestor_entity_hash,
+                tag: "entities/"+entity_hash,
+            })
+
+            checker.checkDir("files/entities/") // checking
+            fs.writeFileSync("files/entities/" + entity_hash, buffer);
+
+            return "entities/"+entity_hash
+        }
+        else{
+            return "Secret has been already used!"
+        }
+    }
+}
+
 
-module.exports = { moment, pioneer, secret }
+module.exports = { moment, pioneer, secret, entity }

package/package.json

@@ -1,4 +1,4 @@
 {
   "name": "pathchain",
-  "version": "1.0.9"
+  "version": "1.0.11"
 }

package/proto/entity.proto

@@ -2,6 +2,6 @@ syntax = "proto3";
 
 message entity {
     required string register = 1;
-    required string invite = 2;
+    required string ancestor = 2;
     required string tag = 3;
 }

package/proto/secret.proto

@@ -3,6 +3,7 @@ syntax = "proto3";
 message secret {
     required string register = 1;
     required string author = 2;
-    required bool used = 3;
+    required string user = 3;
+    required string used = 3;
     required string tag = 4;
 }

package/updater.js

@@ -0,0 +1,48 @@
+var fs = require("fs");
+const maker = require("./maker");
+var pb = require('protocol-buffers');
+
+/** useSecret
+ * [Function that changes a secret state to used]
+ * 
+ * @param {string} xsecret
+ * 
+ * @return {string} xsecret
+ */
+function useSecret(xsecret, xentity){
+    // DECODING SECRET
+    var secret_pb = pb(fs.readFileSync('node_modules/pathos-proto-infra/proto/secret.proto'))
+
+    // NOT FOUND EXCEPTION
+    var secret_enc;
+    try {
+        secret_enc = fs.readFileSync("files/secrets/"+xsecret)
+    } catch (err) {
+        if (err.code === 'ENOENT') {
+            return "Secret not found :(";
+        } else {
+            throw err;
+        }
+    }
+    
+    var secret_obj = secret_pb.secret.decode(secret_enc)
+
+    if(secret_obj.used == false){
+        // USING INVITE SECRET
+        secret_obj.used = true
+
+        var register = new Date()
+        register = dt.format(register, dt.compile(format, true));
+
+        var register_moment_hash = moment(register, format, 0, 0, 0, 0, 0)
+
+        
+
+        fs.writeFileSync("files/secrets/" + xsecret, secret_pb.secret.encode(secret_obj));
+
+        return xsecret;
+    }
+    return xsecret;
+}
+
+module.exports = { useSecret }