trac-msb 0.1.13 → 0.1.15

package/Whitelist/pubkeys.csv

@@ -1 +1,2 @@
-5caea67fce54e53fd7741d2c4a61d0629b6595f840236abfdf165b64ab9e9f4b
+e914ba0570858924b6cf7bfc1852882cf1fc520f410ea84dc0c0248ba2ca725f
+01a6fc0108514ef6c8ff7b23e1eb25235724934e7e31bea391903baf15b742b9

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "trac-msb",
   "main": "msb.mjs",
-  "version": "0.1.13",
+  "version": "0.1.15",
   "pear": {
     "name": "trac-msb",
     "type": "terminal"
@@ -14,13 +14,13 @@
   "dependencies": {
     "trac-wallet": "^0.0.42",
     "hyperbee": "2.24.2",
-    "hypercore": "11.5.0",
-    "corestore": "7.4.0",
+    "hypercore": "11.6.2",
+    "corestore": "7.4.1",
+    "autobase": "7.6.2",
     "hypercore-crypto": "3.4.0",
     "hyperdht": "^6.20.1",
     "hyperswarm": "4.11.5",
     "b4a": "1.6.7",
-    "autobase": "7.4.0",
     "ready-resource": "^1.0.0",
     "bare-readline": "^1.0.7",
     "readline": "npm:bare-node-readline",

package/src/index.js

@@ -24,7 +24,6 @@ import {
 } from './utils/constants.js';
 import Network from './network.js';
 import Check from './utils/check.js';
-import DHT from 'hyperdht'
 
 export class MainSettlementBus extends ReadyResource {
     // Internal flags
@@ -87,13 +86,13 @@ export class MainSettlementBus extends ReadyResource {
         this.#opts = options;
         this.#readline_instance = null;
         this.enable_interactive_mode = options.enable_interactive_mode !== false;
-        if(this.enable_interactive_mode !== false){
-            try{
+        if (this.enable_interactive_mode !== false) {
+            try {
                 this.#readline_instance = readline.createInterface({
                     input: new tty.ReadStream(0),
                     output: new tty.WriteStream(1)
                 });
-            }catch(e){ }
+            } catch (e) { }
         }
     }
 
@@ -159,6 +158,7 @@ export class MainSettlementBus extends ReadyResource {
             [OperationType.REMOVE_WRITER]: this.#handleApplyRemoveWriterOperation.bind(this),
             [OperationType.ADD_INDEXER]: this.#handleApplyAddIndexerOperation.bind(this),
             [OperationType.REMOVE_INDEXER]: this.#handleApplyRemoveIndexerOperation.bind(this),
+            [OperationType.BAN_VALIDATOR]: this.#handleApplyBanValidatorOperation.bind(this),
         };
         return handlers[type] || null;
     }
@@ -170,8 +170,8 @@ export class MainSettlementBus extends ReadyResource {
             null === await batch.get(op.key) &&
             this.check.sanitizePostTx(op) &&
             op.key === postTx.tx &&
-            this.#wallet.verify(b4a.from(postTx.is, 'hex'), b4a.from(postTx.tx + postTx.in), b4a.from(postTx.ipk, 'hex')) && // sender verification
-            this.#wallet.verify(b4a.from(postTx.ws, 'hex'), b4a.from(postTx.tx + postTx.wn), b4a.from(postTx.wp, 'hex')) && // writer verification
+            this.#wallet.verify(b4a.from(postTx.is, 'hex'), b4a.from(postTx.tx + postTx.in), b4a.from(postTx.ipk, 'hex')) &&
+            this.#wallet.verify(b4a.from(postTx.ws, 'hex'), b4a.from(postTx.tx + postTx.wn), b4a.from(postTx.wp, 'hex')) &&
             postTx.tx === await this.generateTx(postTx.bs, this.bootstrap, postTx.wp, postTx.i, postTx.ipk, postTx.ch, postTx.in) &&
             b4a.byteLength(JSON.stringify(postTx)) <= 4096
         ) {
@@ -240,6 +240,11 @@ export class MainSettlementBus extends ReadyResource {
         await batch.put(whitelistKey, true);
     }
 
+    async #deleteWhitelistEntry(batch, pubKey) {
+        const whitelistKey = WHITELIST_PREFIX + pubKey;
+        await batch.del(whitelistKey);
+    }
+
     async #handleApplyAddWriterOperation(op, view, base, node, batch) {
         const adminEntry = await batch.get(EntryType.ADMIN);
         if (null === adminEntry || !this.check.sanitizeAdminAndWritersOperations(op) || !this.#isAdmin(adminEntry.value, node)) return;
@@ -258,18 +263,18 @@ export class MainSettlementBus extends ReadyResource {
         if (nodeEntry === null || !nodeEntry.value.isWriter) {
             await base.addWriter(b4a.from(op.value.wk, 'hex'), { isIndexer: false })
             await batch.put(op.key, {
-                pub : op.value.pub,
+                pub: op.value.pub,
                 wk: op.value.wk,
                 isWriter: true,
                 isIndexer: false
             });
             let length = await batch.get('wrl');
-            if(null === length){
+            if (null === length) {
                 length = 0;
             } else {
                 length = length.value;
             }
-            await batch.put('wri/'+length, op.value.pub);
+            await batch.put('wri/' + length, op.value.pub);
             await batch.put('wrl', length + 1);
             console.log(`Writer added: ${op.key}:${op.value.wk}`);
         }
@@ -304,7 +309,8 @@ export class MainSettlementBus extends ReadyResource {
             }
 
             await batch.put(op.key, nodeEntry);
-            console.log(`Writer removed: ${op.key}:${op.value.wk}`);
+            console.log(`Writer removed: ${op.key}${op.value.wk ? `:${op.value.wk}` : ''}`);
+
         }
     }
 
@@ -349,8 +355,7 @@ export class MainSettlementBus extends ReadyResource {
         if (!this.check.sanitizeIndexerOrWhitelistOperations(op)) return;
         const adminEntry = await batch.get(EntryType.ADMIN);
         let indexersEntry = await batch.get(EntryType.INDEXERS);
-        if (null === adminEntry  || !this.#isAdmin(adminEntry.value, node) || null === indexersEntry || !Array.from(indexersEntry.value).includes(op.key) || Array.from(indexersEntry.value).length <= 1) return;
-        // TODO: is the below an admin signature? -yes
+        if (null === adminEntry || !this.#isAdmin(adminEntry.value, node) || null === indexersEntry || !Array.from(indexersEntry.value).includes(op.key) || Array.from(indexersEntry.value).length <= 1) return;
         const isMessageVerifed = await this.#verifyMessage(op.value.sig, adminEntry.value.tracPublicKey, MsgUtils.createMessage(op.key, op.value.nonce, op.type))
         if (isMessageVerifed) {
             let nodeEntry = await batch.get(op.key);
@@ -374,13 +379,29 @@ export class MainSettlementBus extends ReadyResource {
         }
     }
 
+    async #handleApplyBanValidatorOperation(op, view, base, node, batch) {
+        const adminEntry = await batch.get(EntryType.ADMIN);
+        if (null === adminEntry || !this.#isAdmin(adminEntry.value, node)) return;
+        if (!this.check.sanitizeIndexerOrWhitelistOperations(op)) return;
+        const isWhitelisted = await this.#isWhitelisted2(op.key, batch);
+        if (!isWhitelisted) return;
+
+        const nodeEntry = await batch.get(op.key)
+        if (null === nodeEntry || nodeEntry.value.isIndexer === true) return; // even if node is not writable atm it should be possible to ban it.
+        const isMessageVerifed = await this.#verifyMessage(op.value.sig, adminEntry.value.tracPublicKey, MsgUtils.createMessage(op.key, op.value.nonce, op.type))
+        if (!isMessageVerifed) return;
+        await this.#deleteWhitelistEntry(batch, op.key);
+        await this.#removeWriter(op, batch, base);
+
+    }
+    
     async _open() {
         await this.#base.ready();
         if (this.#enable_wallet) {
             await this.#wallet.initKeyPair(this.KEY_PAIR_PATH, this.#readline_instance);
         }
 
-        if(this.#enable_wallet){
+        if (this.#enable_wallet) {
             console.log('');
             console.log('#####################################################################################');
             console.log('# MSB Address:    ', this.#wallet.publicKey, '#');
@@ -562,7 +583,7 @@ export class MainSettlementBus extends ReadyResource {
         });
 
         this.#base.on(EventType.UNWRITABLE, async () => {
-            if(this.#enable_wallet === false) {
+            if (this.#enable_wallet === false) {
                 console.log('Current node is unwritable');
                 return;
             }
@@ -581,7 +602,7 @@ export class MainSettlementBus extends ReadyResource {
 
     async #adminEventListener() {
         this.on(EventType.ADMIN_EVENT, async (parsedRequest) => {
-            if(this.#enable_wallet === false) return;
+            if (this.#enable_wallet === false) return;
             const isWhitelisted = await this.#isWhitelisted(parsedRequest.key);
             const isEventMessageVerifed = await MsgUtils.verifyEventMessage(parsedRequest, this.#wallet)
             if (isWhitelisted && isEventMessageVerifed) {
@@ -592,7 +613,7 @@ export class MainSettlementBus extends ReadyResource {
 
     async #writerEventListener() {
         this.on(EventType.WRITER_EVENT, async (parsedRequest) => {
-            if(this.#enable_wallet === false) return;
+            if (this.#enable_wallet === false) return;
             const adminEntry = await this.get(EntryType.ADMIN);
             const isEventMessageVerifed = await MsgUtils.verifyEventMessage(parsedRequest, this.#wallet)
             if (adminEntry && adminEntry.tracPublicKey === parsedRequest.key && isEventMessageVerifed) {
@@ -649,7 +670,7 @@ export class MainSettlementBus extends ReadyResource {
     }
 
     async #handleWhitelistOperations() {
-        if(this.#enable_wallet === false) return;
+        if (this.#enable_wallet === false) return;
         const adminEntry = await this.get(EntryType.ADMIN);
         if (!this.#isAdmin(adminEntry)) return;
 
@@ -681,7 +702,7 @@ export class MainSettlementBus extends ReadyResource {
     }
 
     async #requestWriterRole(toAdd) {
-        if(this.#enable_wallet === false) return;
+        if (this.#enable_wallet === false) return;
         const adminEntry = await this.get(EntryType.ADMIN);
         const nodeEntry = await this.get(this.#wallet.publicKey);
         const isAlreadyWriter = !!(nodeEntry && nodeEntry.isWriter)
@@ -705,7 +726,7 @@ export class MainSettlementBus extends ReadyResource {
     }
 
     async #updateIndexerRole(tracPublicKey, toAdd) {
-        if(this.#enable_wallet === false) return;
+        if (this.#enable_wallet === false) return;
         const adminEntry = await this.get(EntryType.ADMIN);
         if (!this.#isAdmin(adminEntry) && !this.#base.writable) return;
 
@@ -733,6 +754,18 @@ export class MainSettlementBus extends ReadyResource {
         }
     }
 
+    async #banValidator(tracPublicKey) {
+        const adminEntry = await this.get(EntryType.ADMIN);
+        if (!this.#isAdmin(adminEntry)) return;
+        const isWhitelisted = await this.#isWhitelisted(tracPublicKey);
+        const nodeEntry = await this.get(tracPublicKey);
+        if (!isWhitelisted || null === nodeEntry || nodeEntry.isIndexer === true) return;
+
+        const assembledBanValidatorMessage = await MsgUtils.assembleBanValidatorMessage(this.#wallet, tracPublicKey);
+        this.#base.append(assembledBanValidatorMessage);
+
+    }
+
     async #handleAddIndexerOperation(tracPublicKey) {
         this.#updateIndexerRole(tracPublicKey, true);
     }
@@ -749,7 +782,11 @@ export class MainSettlementBus extends ReadyResource {
         await this.#requestWriterRole(false);
     }
 
-    printHelp(){
+    async #handleBanValidatorOperation(tracPublicKey) {
+        await this.#banValidator(tracPublicKey);
+    }
+
+    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.');
@@ -757,14 +794,15 @@ export class MainSettlementBus extends ReadyResource {
         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('- /ban_writer <address>: demote a whitelisted writer to default role and remove it from the whitelist. (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('- /stats: check system stats 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;
+        if (this.#readline_instance === null) return;
         const rl = this.#readline_instance;
 
         this.printHelp();
@@ -807,8 +845,8 @@ export class MainSettlementBus extends ReadyResource {
                     const indexers = await this.get(EntryType.INDEXERS);
                     console.log('Indexers:', indexers);
                     break;
-                case '/dag':
-                    await verifyDag(this.#base);
+                case '/stats':
+                    await verifyDag(this.#base, this.#swarm, this.#wallet, this.#writingKey);
                     break;
                 default:
                     if (input.startsWith('/get_node_info')) {
@@ -824,6 +862,11 @@ export class MainSettlementBus extends ReadyResource {
                         const tracPublicKey = splitted[1]
                         await this.#handleRemoveIndexerOperation(tracPublicKey);
                     }
+                    else if (input.startsWith('/ban_writer')) {
+                        const splitted = input.split(' ');
+                        const tracPublicKey = splitted[1]
+                        await this.#handleBanValidatorOperation(tracPublicKey);
+                    }
             }
             rl.prompt();
         });

package/src/network.js

@@ -38,7 +38,7 @@ class Network {
                 };
             }
 
-            swarm = new Hyperswarm({ keyPair, randomPunchInterval: 500, bootstrap : bootstrap, maxPeers: MAX_PEERS, maxParallel: MAX_PARALLEL, maxServerConnections: MAX_SERVER_CONNECTIONS, maxClientConnections :  MAX_CLIENT_CONNECTIONS});
+            swarm = new Hyperswarm({ keyPair, randomPunchInterval: 5_000, bootstrap : bootstrap, maxPeers: MAX_PEERS, maxParallel: MAX_PARALLEL, maxServerConnections: MAX_SERVER_CONNECTIONS, maxClientConnections :  MAX_CLIENT_CONNECTIONS});
 
             console.log(`Channel: ${b4a.toString(channel)}`);
             swarm.on('connection', async (connection) => {
@@ -85,7 +85,6 @@ class Network {
                                 //await connection.destroy();
                                 if (base.isIndexer || !base.writable) return;
 
-                                // TODO: decide if a tx rejection should be responded with
                                 if (network.tx_pool.length >= 1000) {
                                     console.log('pool full');
                                     return

package/src/utils/check.js

@@ -1,5 +1,6 @@
 import Validator from 'fastest-validator';
 import { isHexString } from './functions.js';
+import {OperationType} from './constants.js';
 class Check {
     #_validator;
     #_sanitizeAdminAndWritersOperations;
@@ -60,11 +61,12 @@ class Check {
         this.#_sanitizePreTx = this.#compilePreTxSchema();
         this.#_sanitizePostTx = this.#compilePostTxSchema();
     }
-
+    //TODO: rename this function
     #compileSanitizationAdminAndWriterOperationsSchema() {
+        // TODO: Create constants for int values below
         const schema = {
             $$strict: true,
-            type: { type: 'string', enum: ['addAdmin', 'addWriter', 'removeWriter'], required: true },
+            type: { type: 'string', enum: [OperationType.ADD_ADMIN, OperationType.ADD_WRITER, OperationType.REMOVE_WRITER], required: true },
             key: { type: "is_hex_string", length: 64, required: true },
             value: {
                 $$strict: true,
@@ -82,11 +84,12 @@ class Check {
     sanitizeAdminAndWritersOperations(op) {
         return this.#_sanitizeAdminAndWritersOperations(op) === true;
     }
-
+    //TODO: rename this function
     #compileIndexerOrWhitelistOperationSchema() {
+        // TODO: Create constants for int values below
         const schema = {
             $$strict: true,
-            type: { type: 'string', enum: ['addIndexer', 'removeIndexer', 'AppendWhitelist'], required: true },
+            type: { type: 'string', enum: [OperationType.ADD_INDEXER, OperationType.REMOVE_INDEXER, OperationType.APPEND_WHITELIST, OperationType.BAN_VALIDATOR], required: true },
             key: { type: "is_hex_string", length: 64, required: true },
             value: {
                 $$strict: true,
@@ -104,6 +107,7 @@ class Check {
     }
 
     #compilePreTxSchema() {
+        // TODO: Create constants for int values below
         const schema = {
             $$strict: true,
             op: { type: 'string', enum: ['pre-tx'], required: true },
@@ -125,6 +129,7 @@ class Check {
     }
 
     #compilePostTxSchema() {
+        // TODO: Create constants for int values below
         const schema = {
             $$strict: true,
             type: { type: 'string', enum: ['tx'], required: true },

package/src/utils/constants.js

@@ -11,6 +11,7 @@ export const OperationType = Object.freeze({
     REMOVE_WRITER: 'removeWriter',
     ADD_INDEXER: 'addIndexer',
     REMOVE_INDEXER: 'removeIndexer',
+    BAN_VALIDATOR: 'banValidator',
     TX: 'tx',
     PRE_TX: 'pre-tx',
     POST_TX: 'post-tx',

package/src/utils/functions.js

@@ -1,26 +1,31 @@
 import b4a from 'b4a';
 import sodium from 'sodium-native';
+import {peer} from "hyperdht/lib/messages.js";
 
 export function isHexString(string) {
     return typeof string === 'string' && /^[0-9a-fA-F]+$/.test(string) && string.length % 2 === 0;
 }
 
-export async function verifyDag(base) {
+export async function verifyDag(base, swarm, wallet, writerKey) {
     try {
-        console.log('--- DAG Monitoring ---');
+        console.log('--- Stats ---');
         const dagView = await base.view.core.treeHash();
         const lengthdagView = base.view.core.length;
         const dagSystem = await base.system.core.treeHash();
         const lengthdagSystem = base.system.core.length;
-        console.log('this.base.view.core.signedLength:', base.view.core.signedLength);
-        console.log("this.base.signedLength", base.signedLength);
-        console.log("this.base.linearizer.indexers.length", base.linearizer.indexers.length);
-        console.log("this.base.indexedLength", base.indexedLength);
-        //console.log("this.base.system.core", this.base.system.core);
+        console.log('wallet.publicKey:', wallet !== null ? wallet.publicKey : 'unset');
+        console.log('msb.writerKey:', writerKey);
+        console.log('swarm.connections.size:', swarm.connections.size);
+        console.log('base.view.core.signedLength:', base.view.core.signedLength);
+        console.log("base.signedLength", base.signedLength);
+        console.log("base.indexedLength", base.indexedLength);
+        console.log("base.linearizer.indexers.length", base.linearizer.indexers.length);
         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})`);
+        const wl = await base.view.get('wrl');
+        console.log('Total Registered Writers:', wl !== null ? wl.value : 0);
 
     } catch (error) {
         console.error('Error during DAG monitoring:', error.message);

package/src/utils/msgUtils.js

@@ -43,6 +43,7 @@ class MsgUtils {
                 };
                 break;
             case OperationType.APPEND_WHITELIST:
+            case OperationType.BAN_VALIDATOR:
             case OperationType.ADD_INDEXER:
             case OperationType.REMOVE_INDEXER:
                 nonce = Wallet.generateNonce().toString('hex');
@@ -110,6 +111,10 @@ class MsgUtils {
         return await this.#assembleMessageBase(wallet, writerTracPublicKey, OperationType.REMOVE_INDEXER);
     }
 
+    static async assembleBanValidatorMessage(wallet, validatorTracPublicKey) {
+        return await this.#assembleMessageBase(wallet, validatorTracPublicKey, OperationType.BAN_VALIDATOR);
+    }
+
     static async verifyEventMessage(parsedRequest, wallet) {
         //TODO: Here we can add some sanitization
         const msg = this.createMessage(parsedRequest.key, parsedRequest.value.wk, parsedRequest.value.nonce, parsedRequest.type);