pathchain 1.0.8 → 1.0.9

package/README.md

@@ -1,8 +1,8 @@
-# pathchain [![npm version](https://badge.fury.io/js/pathchain.svg)](https://badge.fury.io/js/pathchain) [![open source](https://img.shields.io/badge/open%20source-pathchain-grey?labelColor=purple&style=flat&logo=Github&logoColor=white&link=http://github.com/rockstarallegue/pathoschain.git)](http://github.com/rockstarallegue/pathoschain.git)
+# pathchain [![npm version](https://badge.fury.io/js/pathchain.svg)](https://badge.fury.io/js/pathchain) [![open source](https://img.shields.io/badge/open%20source-pathchain-grey?labelColor=purple&style=flat&logo=Github&logoColor=white&link=http://github.com/rockstarallegue/pathchain.git)](http://github.com/rockstarallegue/pathchain.git)
 ![image](https://user-images.githubusercontent.com/104391124/282268780-cbbc1ee6-8d97-4d80-b896-66ae3eb723dd.png)
 
 
-Pathchain is a tool to build path-shaped data structures that are chained one to another from the moment the tool was initialized. The data behaves like a tree where you can track the very origin of your data by tracking the SHA-256 hashname origin of the files. Pathchain uses Google's Protocol Buffers to encode and decode the data structures optimally.
+Pathchain is a tool to build path-shaped data structures that are chained one to another from the very moment the tool is initialized. The data behaves like a data tree where you can track the very origin of anything by tracking the origin file hashnames that created any hashname of any file in the chain. Pathchain uses Google's Protocol Buffers to encode and decode the data structures optimally and SHA-256 to build the hashname chain.
 
 ---
 # Pathchain documentation
@@ -10,18 +10,29 @@ Pathchain is a tool to build path-shaped data structures that are chained one to
 ## 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                                  |
+| Function                     | Parameters                              |
+| ---------------------------- | --------------------------------------- |
+| [`makeMoment()`](#Moment)    | datetime, lat, lon, x, y, z, format     |
+| [`makePioneer()`](#Pioneer)  | format                                  |
+| [`makeSecret()`](#Secret)    | author, format                          |
 
 
+## Getters
+Getter functions retrieve objects given a hashname and author information
 
-### Moments
+| Function                    | Parameters                               |
+| --------------------------- | ---------------------------------------- |
+| [`getMoment()`](#Moment)    | xmoment                                  |
+| [`getPioneer()`](#Pioneer)  | (none)                                   |
+| [`getSecret()`](#Secret)    | xsecret                                  |
 
-A moment is the mimimum representation of the pathoschain data structures. Moments are the trunk of any 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`.
 
-`<moment>` :: space and time data ::= { `<“moment/”>` + sha256(`<moment>`) }
+
+## 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`.
+
+`<moment>` :: space and time data ::= { `<“moments/”>` + sha256(`<moment>`) }
 
 #### Protocol Buffer file:
 
@@ -125,3 +136,129 @@ Moment object:  {
   }
 }
 ```
+
+## Secret
+
+A secret is an OTP (One Time Password) generated by an entity. The moment it is used, it becomes useless. Secrets are represented as SHA-256 hashes, like everything on pathchain.
+
+`<secret>` :: secret hash generated by an entity ::= { `<“secrets/”>` + sha256(`<moment>` + `<entity>`) }
+
+#### Protocol Buffer file:
+
+``` proto
+syntax = "proto3";
+
+message secret {
+    required string register = 1;
+    required string author = 2;
+    required bool used = 3;
+    required string tag = 4;
+}
+```
+
+#### Secret maker
+
+Parameter rules:
+|Parameter                |Required  |
+|-------------------------|----------|
+|{string} author          |(required)|
+|{string} format          |(optional)|
+
+Summoning `makeMoment(author, format)`:
+```javascript
+const pathchain = require("pathchain"); // Summoning pathchain
+
+var sec_pioneer_buff = pathchain.makeSecret(author); // Making a secret with an existing entity hash
+console.log("Secret buffer: ", secret); // Printing
+```
+
+Console: 
+``` bash
+Secret buffer:  c0f9d300e1b28253455e1835f13ca18d000333152a6a9a9b106d0407612980a8
+```
+
+#### Secret usage (using a secret / checking if a secret has been used)
+
+Parameter rules:
+|Parameter                |Required  |
+|-------------------------|----------|
+|{string} xsecret         |(required)|
+
+Summoning `useSecret(xsecret)`:
+```javascript
+const pathchain = require("pathchain"); // Summoning pathchain
+
+var secret_buff = pathchain.makeSecret(author); // Making a secret with an existing entity hash
+console.log("Secret buffer: ", secret); // Printing
+
+// Checking if the secret has been used (before using it)
+var used = pathchain.isSecretUsed(secret_buff);
+console.log("Secret buffer used?: ", used); // Printing
+
+// Using the secret
+pathchain.useSecret(secret_buff);
+
+// Checking if the secret has been used (before using it)
+var used = pathchain.isSecretUsed(secret_buff);
+console.log("Secret buffer used?: ", used); // Printing
+```
+
+Console: 
+``` bash
+Secret buffer:  c0f9d300e1b28253455e1835f13ca18d000333152a6a9a9b106d0407612980a8
+```
+
+``` bash
+Secret buffer used?: false
+```
+
+``` bash
+Secret buffer used?: true
+```
+
+
+#### Secret getter
+
+Parameter rules:
+|Parameter                |Required  |
+|-------------------------|----------|
+|{string} xsecret         |(optional)|
+
+Summoning `getSecretObj(xsecret)`
+```
+const pathchain = require("pathchain"); // Summoning pathchain
+
+const secret_nuff = pathchain.makeSecret(author); // Secret creation
+
+var secret_obj = pathchain.getSecretObj(secret_buff); // Getting object from hashname
+
+console.log("Secret object: ", secret_obj); // Printing
+```
+
+Console: 
+``` bash
+Secret object:  {
+  register: 'moments/638976edf4684e746f9bd013bd2e9145b1316ee42b40b0877185f6aeda960b8d',
+  author: 'pioneer/ebd4ff7e4f69d1c4c2b529eb60a7ca72bb459c1458e1a011b26b6ea84901d143',
+  used: false,
+  tag: 'secrets/574e8fee76ba4dc93c2f4cd79399aa01e6cfb19257e4eb305dcfaeb16649b7bf'
+}
+```
+
+
+## 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.
+
+`<pioneer>` :: pioneer entity ::= { `<“pioneer/”>` + sha256(`<moment>`) }
+
+#### Protocol Buffer file:
+``` javascript
+syntax = "proto3";
+
+message entity {
+    required string register = 1;
+    required string invite = 2;
+    required string tag = 3;
+}
+```

package/index.js

@@ -1,5 +1,6 @@
 const maker = require("./maker");
 const getter = require("./getter");
+const checker = require("./checker");
 
 ///////////////
 ///  HELLO  ///
@@ -103,6 +104,16 @@ exports.useSecret = (xsecret) => {
     return secret_buffer
 }
 
+/** isSecretUsed
+ * [Check secret availability]
+ * 
+ * @return {bool} true/false
+ */
+exports.isSecretUsed = (xsecret) => {
+    const is_secret_used = checker.isSecretUsed(xsecret)
+    return is_secret_used
+}
+
 /** getSecretObj
  * [Function that recieves a moment hash and returns the moment object]
  * 

package/maker.js

@@ -101,7 +101,7 @@ function secret(author, format) {
 /** pioneer
  * [Pioneer Protocol Buffer Creation]
  * 
- * @param {string} datetime (required)
+ * @param {string} xbigbang (required) // The creation moment is the bigbang of the system
  * @param {string} format   (required)
  * 
  * @return {string} pioneer_buffer

package/package.json

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

package/proto/entity.proto

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

package/proto/secret.proto

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