trac-msb 0.1.7 → 0.1.9

package/msb.mjs

@@ -10,6 +10,5 @@ const opts = {
 const msb = new MainSettlementBus(opts);
 
 msb.ready().then(() => {
-    console.log('MSB is ready.');
     msb.interactiveMode();
 });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "trac-msb",
   "main": "msb.mjs",
-  "version": "0.1.7",
+  "version": "0.1.9",
   "pear": {
     "name": "trac-msb",
     "type": "terminal"
@@ -12,7 +12,7 @@
     "test": "brittle test/*.test.js"
   },
   "dependencies": {
-    "trac-wallet": "^0.0.40",
+    "trac-wallet": "^0.0.42",
     "hyperbee": "2.24.2",
     "hypercore": "11.5.0",
     "corestore": "7.4.0",

package/src/index.js

@@ -26,8 +26,6 @@ import Network from './network.js';
 import Check from './utils/check.js';
 import DHT from 'hyperdht'
 
-//TODO: CHANGE NONCE.
-
 export class MainSettlementBus extends ReadyResource {
     // Internal flags
     #shouldListenToAdminEvents = false;
@@ -88,13 +86,15 @@ export class MainSettlementBus extends ReadyResource {
         this.#signature_whitelist = options.signature_whitelist !== undefined && Array.isArray(options.signature_whitelist) ? options.signature_whitelist : [];
         this.#opts = options;
         this.#readline_instance = null;
-
-        try{
-            this.#readline_instance = readline.createInterface({
-                input: new tty.ReadStream(0),
-                output: new tty.WriteStream(1)
-            });
-        }catch(e){ }
+        this.enable_interactive_mode = options.enable_interactive_mode !== false;
+        if(this.enable_interactive_mode !== false){
+            try{
+                this.#readline_instance = readline.createInterface({
+                    input: new tty.ReadStream(0),
+                    output: new tty.WriteStream(1)
+                });
+            }catch(e){ }
+        }
     }
 
     // TODO: Implement other getters as necessary
@@ -379,13 +379,14 @@ export class MainSettlementBus extends ReadyResource {
         if (this.#enable_wallet) {
             await this.#wallet.initKeyPair(this.KEY_PAIR_PATH, this.#readline_instance);
         }
-        console.log('View Length:', this.#base.view.core.length);
-        console.log('View Signed Length:', this.#base.view.core.signedLength);
-        console.log('MSB Key:', b4a.from(this.#base.view.core.key).toString('hex'));
 
+        console.log('');
+        console.log('#####################################################################################');
+        console.log('# MSB Address:    ', this.#wallet.publicKey, '#');
         this.#writingKey = b4a.toString(this.#base.local.key, 'hex');
-        console.log('Writer Key:', this.#writingKey);
-
+        console.log('# MSB Writer:     ', this.#writingKey, '#');
+        console.log('#####################################################################################');
+        console.log('');
         if (this.#replicate) {
             this.#swarm = await Network.replicate(this, this.#network, this.#enable_txchannel, this.#base, this.#writingKey, this.#dht_bootstrap, this.#swarm, this.#enable_wallet, this.#store, this.#wallet, this.#channel, this.#isStreaming, this.#handleIncomingEvent.bind(this), this.emit.bind(this));
             this.#dht_node = this.#swarm.dht;
@@ -409,8 +410,9 @@ export class MainSettlementBus extends ReadyResource {
 
         console.log(`isIndexer: ${this.#base.isIndexer}`);
         console.log(`isWriter: ${this.#base.writable}`);
-        console.log('View Length:', this.#base.view.core.length);
-        console.log('View Signed Length:', this.#base.view.core.signedLength);
+        console.log('MSB Unsigned Length:', this.#base.view.core.length);
+        console.log('MSB Signed Length:', this.#base.view.core.signedLength);
+        console.log('');
     }
 
     async close() {
@@ -424,7 +426,6 @@ export class MainSettlementBus extends ReadyResource {
     async #setUpRoleAutomatically() {
         if (!this.#base.writable) {
             await this.#requestWriterRole(false)
-            console.log('Wait please...');
             setTimeout(async () => {
                 await this.#requestWriterRole(true)
             }, 5_000);
@@ -745,22 +746,31 @@ export class MainSettlementBus extends ReadyResource {
         await this.#requestWriterRole(false);
     }
 
+    printHelp(){
+        console.log('Available commands:');
+        console.log('- /add_writer: add yourself as validator to this MSB once whitelisted.');
+        console.log('- /remove_writer: remove yourself from this MSB.');
+        console.log('- /add_admin: register admin entry with bootstrap key. (initial setup)');
+        console.log('- /add_whitelist: add all specified whitelist addresses. (admin only)');
+        console.log('- /add_indexer <address>: change a role of the selected writer node to indexer role. (admin only)');
+        console.log('- /remove_indexer <address>: change a role of the selected indexer node to default role. (admin only)');
+        console.log('- /get_node_info <address>: get information about a node with the given address.');
+        console.log('- /dag: check system properties such as writing key, DAG, etc.');
+        console.log('- /exit: Exit the program.');
+        console.log('- /help: display this help.');
+    }
+
     async interactiveMode() {
         if(this.#readline_instance === null) return;
         const rl = this.#readline_instance;
 
-        console.log('MSB started. Available commands:');
-        console.log('- /add_admin: register admin entry with bootstrap key.');
-        console.log('- /add_whitelist: add a list of Trac public keys. Nodes that own these public keys can become writers.');
-        console.log('- /add_indexer <trac_public_key>: change a role of the selected writer node to indexer role');
-        console.log('- /push_writer_add: try to enforce adding this peer as writer after whitelisting.');
-        console.log('- /remove_indexer <trac_public_key>: change a role of the selected indexer node to default role');
-        console.log('- /get_node_info <trac_public_key>: get information about a node with the given Trac public key');
-        console.log('- /dag: check system properties such as writing key, DAG, etc.');
-        console.log('- /exit: Exit the program');
+        this.printHelp();
 
         rl.on('line', async (input) => {
             switch (input) {
+                case '/help':
+                    this.printHelp();
+                    break;
                 case '/exit':
                     console.log('Exiting...');
                     rl.close();
@@ -783,15 +793,12 @@ export class MainSettlementBus extends ReadyResource {
                     await this.#handleRemoveWriterOperation();
                     break
                 case '/flags':
-                    // Only for DEBUG
                     console.log("shouldListenToAdminEvents: ", this.#shouldListenToAdminEvents);
                     console.log("shouldListenToWriterEvents: ", this.#shouldListenToWriterEvents);
                     console.log("isWritable: ", this.#base.writable);
                     console.log("isIndexer: ", this.#base.isIndexer);
                     break
                 case '/show':
-                    // /get_node_info 9da99d98f02f24bdb13d46ba5d346c9a3eda03c18ab6e1441b7bac9743cf0bcc1
-                    // Only for DEBUG
                     const admin = await this.get(EntryType.ADMIN);
                     console.log('Admin:', admin);
                     const indexers = await this.get(EntryType.INDEXERS);

package/src/network.js

@@ -12,8 +12,9 @@ import {
     EntryType
 } from './utils/constants.js';
 import {sleep } from './utils/functions.js';
-import MsgUtils from './utils/msgUtils.js';
 import Check from './utils/check.js';
+import Wallet from 'trac-wallet';
+
 const wakeup = new w();
 
 class Network {
@@ -99,7 +100,7 @@ class Network {
                                     parsedPreTx.wp === wallet.publicKey &&
                                     null === await base.view.get(parsedPreTx.tx)
                                 ) {
-                                    const nonce = MsgUtils.generateNonce();
+                                    const nonce = Wallet.generateNonce().toString('hex');
                                     const signature = wallet.sign(b4a.from(parsedPreTx.tx + nonce), b4a.from(wallet.secretKey, 'hex'));
                                     const append_tx = {
                                         op: OperationType.POST_TX,

package/src/utils/check.js

@@ -71,7 +71,7 @@ class Check {
                 $$type: "object",
                 pub: { type: 'is_hex_string', length: 64, required: true },
                 wk: { type: 'is_hex_string', length: 64, required: true },
-                nonce: { type: 'string', min: 1, max: 256, required: true },
+                nonce: { type: 'is_hex_string', length: 64, required: true },
                 sig: { type: 'is_hex_string', length: 128, required: true },
 
             }
@@ -91,7 +91,7 @@ class Check {
             value: {
                 $$strict: true,
                 $$type: "object",
-                nonce: { type: 'string', min: 1, max: 256, required: true },
+                nonce: { type: 'is_hex_string', length: 64, required: true },
                 sig: { type: 'is_hex_string', length: 128, required: true },
 
             }
@@ -113,7 +113,7 @@ class Check {
             i: { type: 'is_hex_string', length: 64, required: true },
             ipk: { type: 'is_hex_string', length: 64, required: true },
             ch: { type: 'is_hex_string', required: true }, // TODO: if we will use only 256 bit hash then change to length: 64
-            in: { type: 'string', min: 1, max: 256, required: true },
+            in: { type: 'is_hex_string', length: 64,  required: true },
             bs: { type: 'is_hex_string', length: 64, required: true },
             mbs: { type: 'is_hex_string', length: 64, required: true },
         };
@@ -139,12 +139,12 @@ class Check {
                 i: { type: 'is_hex_string', length: 64, required: true },
                 ipk: { type: 'is_hex_string', length: 64, required: true },
                 ch: { type: 'is_hex_string', required: true }, // TODO: if we will use only 256 bit hash then change to length: 64
-                in: { type: 'string', min: 1, max: 256, required: true },
+                in: { type: 'is_hex_string', length: 64, required: true },
                 bs: { type: 'is_hex_string', length: 64, required: true },
                 mbs: { type: 'is_hex_string', length: 64, required: true },
                 ws: { type: 'is_hex_string', length: 128, required: true },
                 wp: { type: 'is_hex_string', length: 64, required: true },
-                wn: { type: 'string', min: 1, required: true }
+                wn: { type: 'is_hex_string', length: 64, required: true }
             }
         };
         return this.#_validator.compile(schema);

package/src/utils/functions.js

@@ -19,7 +19,6 @@ export async function verifyDag(base) {
         //console.log("this.base.system.core", this.base.system.core);
         console.log(`base.key: ${base.key.toString('hex')}`);
         console.log('discoveryKey:', b4a.toString(base.discoveryKey, 'hex'));
-
         console.log(`VIEW Dag: ${dagView.toString('hex')} (length: ${lengthdagView})`);
         console.log(`SYSTEM Dag: ${dagSystem.toString('hex')} (length: ${lengthdagSystem})`);
 

package/src/utils/msgUtils.js

@@ -2,7 +2,7 @@ import { isHexString, createHash } from './functions.js';
 import { OperationType } from './constants.js';
 import fileUtils from './fileUtils.js';
 import b4a from 'b4a';
-
+import Wallet from 'trac-wallet';
 // TODO: This class is trying to solve too many problems at once.
 //       It is responsible for creating messages, verifying them, reading public keys from a file, etc.
 //       It would be better to separate these concerns into different classes or modules.
@@ -10,9 +10,6 @@ import b4a from 'b4a';
 //       This would make the code more modular and easier to maintain.
 //       It would also make it easier to create tests and mocks in the future.
 class MsgUtils {
-    static generateNonce() {
-        return Math.random() + '-' + Date.now(); // TODO: Change it to crypto.randomBytes. Math.random might not be secure enough. It's even better to use nonce generator from sodium. GENERATE NONCE WITH CRYPTO LIBRARY WHICH ALLOW US TO GENERATE IT WITH UNIFORM DISTRIBUTION.
-    }
 
     static createMessage(...args) {
         let buf = null;
@@ -35,7 +32,7 @@ class MsgUtils {
             case OperationType.ADD_ADMIN:
             case OperationType.ADD_WRITER:
             case OperationType.REMOVE_WRITER:
-                nonce = this.generateNonce();
+                nonce = Wallet.generateNonce().toString('hex');
                 msg = this.createMessage(wallet.publicKey, keyParam, nonce, operationType);
                 hash = await createHash('sha256', msg);
                 value = {
@@ -48,7 +45,7 @@ class MsgUtils {
             case OperationType.APPEND_WHITELIST:
             case OperationType.ADD_INDEXER:
             case OperationType.REMOVE_INDEXER:
-                nonce = this.generateNonce();
+                nonce = Wallet.generateNonce().toString('hex');
                 msg = this.createMessage(keyParam, nonce, operationType);
                 hash = await createHash('sha256', msg);
                 baseKey = keyParam;