trac-peer 0.1.5 → 0.1.6

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "trac-peer",
   "main": "src/index.js",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "type": "module",
   "dependencies": {
     "trac-wallet": "^0.0.35",

package/src/contract.js

@@ -9,13 +9,11 @@ class Contract {
         this.features = {};
         this.schemata = {};
         this.message_handler = null;
-        this.root = null;
         this.address = null;
         this.validator_address = null;
         this.tx = null;
         this.op = null;
         this.value = null;
-        this.node = null;
 
         this.enter_execute_schema = this.protocol.peer.check.validator.compile({
             value : {
@@ -28,7 +26,7 @@ class Contract {
         });
 
         this.tx_schema = this.protocol.peer.check.validator.compile({
-            key : { type : "string", hex : null },
+            key : { type : "is_hex" },
             value : {
                 $$type: "object",
                 value : {
@@ -54,7 +52,7 @@ class Contract {
         });
     }
 
-    async execute(op, node, storage){
+    async execute(op, storage){
 
         this.address = null;
         this.validator_address = null;
@@ -63,9 +61,7 @@ class Contract {
         this.tx = null;
         this.op = null;
         this.value = null;
-        this.node = null;
         this.storage = null;
-        this.root = null;
 
         if(true !== this.enter_execute_schema(op)) return false;
 
@@ -84,15 +80,14 @@ class Contract {
         this.tx = op.type === 'tx' ? op.key : null;
         this.op = op.value.dispatch;
         this.value = this.op.value !== undefined ? this.op.value : null;
-        this.node = node;
         this.storage = storage;
-        this.root = op;
 
         let _return = null;
 
         if(this.isFeature()) {
             if(this.features[this.op.type] !== undefined){
-                _return = await this.features[this.op.type]();
+                // feature returns aren't handled by peer, so not necessary to track
+                await this.features[this.op.type]();
             }
         } else if(this.isMessage()) {
             if(this.message_handler !== undefined){
@@ -119,9 +114,7 @@ class Contract {
         this.tx = null;
         this.op = null;
         this.value = null;
-        this.node = null;
         this.storage = null;
-        this.root = null;
 
         return _return;
     }
@@ -155,7 +148,16 @@ class Contract {
         return this.is_message;
     }
 
+    isReservedKey(key){
+        return key.startsWith('sh/') || key.startsWith('tx/') || key === 'msgl' || key.startsWith('kcin/') || key.startsWith('delm/') ||
+            key.startsWith('umsg/') || key.startsWith('umsg/') || key.startsWith('msgl/') || key === 'admin' || key === 'auto_add_writers'
+            || key.startsWith('nick/') || key.startsWith('mod/') || key === 'chat_status' || key.startsWith('mtd/') || key === 'delml' ||
+            key === 'wlst' || key === 'txl' || key.startsWith('txi/') || key.startsWith('wl/');
+    }
+
     async del(key){
+        if(typeof this.storage === "undefined" || this.storage === null) throw new Error('del(key): storage undefined');
+        if(this.isReservedKey(key)) throw Error('del(key): ' + key + 'is reserved');
         await this.storage.del(key);
     }
 
@@ -168,11 +170,7 @@ class Contract {
 
     async put(key, value){
         if(typeof this.storage === "undefined" || this.storage === null) throw new Error('put(key,value): storage undefined');
-        if(key.startsWith('sh/') || key.startsWith('tx/') || key === 'msgl' || key.startsWith('kcin/') || key.startsWith('delm/') ||
-            key.startsWith('umsg/') || key.startsWith('umsg/') || key.startsWith('msgl/') || key === 'admin' || key === 'auto_add_writers'
-            || key.startsWith('nick/') || key.startsWith('mod/') || key === 'chat_status' || key.startsWith('mtd/') || key === 'delml' ||
-            key === 'wlst' || key === 'txl' || key.startsWith('txi/') || key.startsWith('wl/'))
-            throw Error('put(key,value): ' + key + 'is reserved');
+        if(this.isReservedKey(key)) throw Error('put(key,value): ' + key + 'is reserved');
         return await this.storage.put(key, value);
     }
 

package/src/functions.js

@@ -296,8 +296,18 @@ export async function addWriter(input, peer){
 
 export async function tx(input, peer){
     const splitted = peer.protocol_instance.parseArgs(input);
-    if(splitted.validator === undefined || splitted.command === undefined){
+    if(splitted.sim === undefined && (splitted.validator === undefined || splitted.command === undefined)){
         throw new Error('Missing option. Please use --validator and --command flags.');
+    } else if(splitted.sim !== undefined && splitted.command === undefined){
+        throw new Error('Missing option. Please use the --command flag when simulating a tx.');
     }
-    await peer.protocol_instance.tx(splitted);
+    let res = false;
+    try{
+        if(splitted.sim !== undefined && parseInt(splitted.sim) === 1){
+            peer.protocol_instance.sim = true;
+        }
+        res = await peer.protocol_instance.tx(splitted);
+    } catch(e){ console.log(e) }
+    peer.protocol_instance.sim = false;
+    return res;
 }

package/src/index.js

@@ -100,7 +100,7 @@ export class Peer extends ReadyResource {
                                 post_tx.value.w, post_tx.value.i, post_tx.value.ipk,
                                 post_tx.value.ch, post_tx.value.in
                             ) &&
-                            false !== await _this.contract_instance.execute(op, node, batch)) {
+                            false !== await _this.contract_instance.execute(op, batch)) {
                             let len = await batch.get('txl');
                             if(null === len) {
                                 len = 0;
@@ -143,7 +143,7 @@ export class Peer extends ReadyResource {
                             null === await batch.get('sh/'+op.hash) &&
                             b4a.byteLength(str_value) <= 10_2400 &&
                             chat_status.value === 'on' &&
-                            false !== await _this.contract_instance.execute(op, node, batch)){
+                            false !== await _this.contract_instance.execute(op, batch)){
                             let len = await batch.get('msgl');
                             if(null === len) {
                                 len = 0;
@@ -172,7 +172,7 @@ export class Peer extends ReadyResource {
                             null === await batch.get('sh/'+op.value.dispatch.hash)){
                             const verified = _this.wallet.verify(op.value.dispatch.hash, str_dispatch_value + op.value.dispatch.nonce, admin.value);
                             if(true === verified) {
-                                await _this.contract_instance.execute(op, node, batch);
+                                await _this.contract_instance.execute(op, batch);
                                 await batch.put('sh/'+op.value.dispatch.hash, '');
                                 console.log(`Feature ${op.key} appended`);
                             }
@@ -659,7 +659,7 @@ export class Peer extends ReadyResource {
         console.log('- /set_whitelist_status | Only admin. Add/remove users to/from the chat whitelist: \'/set_whitelist_status --user "<address>" --status 1\'.');
         console.log(' ');
         console.log('- System Commands:');
-        console.log('- /tx | Perform a contract transaction. The validator flag broadcasts the transaction to the desired validator. The command flag contains contract commands in json format: \'/tx --validator "<validator writer key>" --command "<string, content depends on the protocol>"\'');
+        console.log('- /tx | Perform a contract transaction. The validator flag broadcasts the transaction to the desired validator. The command flag contains contract commands in json format: \'/tx --validator "<validator writer key>" --command "<string, content depends on the protocol>"\'. To simulate a tx, you must leave out the \'--validator\' flag and instead use \'--sim 1\' instead.');
         console.log('- /dag | check system properties such as writer key, DAG, etc.');
         console.log('- /get_keys | prints your public and private keys. Be careful and never share your private key!');
         console.log('- /exit | Exit the program');

package/src/protocol.js

@@ -17,6 +17,7 @@ class Protocol{
         this.nonce = 0;
         this.prepared_transactions_content = {};
         this.features = {};
+        this.sim = false;
     }
 
     safeBigInt(value) {
@@ -84,10 +85,36 @@ class Protocol{
         return await this.peer.createHash('sha256', await this.peer.createHash('sha256', tx));
     }
 
+    async simulateTransaction(obj){
+        const storage = new SimStorage(this.peer);
+        const null_hex = '0000000000000000000000000000000000000000000000000000000000000000';
+        let nonce = Math.random() + '-' + Date.now();
+        const content_hash = await this.peer.createHash('sha256', JSON.stringify(obj));
+        let tx = await this.generateTx(this.peer.bootstrap, this.peer.msb.bootstrap, null_hex,
+            this.peer.writerLocalKey, this.peer.wallet.publicKey, content_hash, nonce);
+        const op = {
+            type : 'tx',
+            key : tx,
+            value : {
+                dispatch : obj,
+                value : {
+                    ipk : this.peer.wallet.publicKey,
+                    wp : null_hex
+                }
+            }
+        }
+        return await this.peer.contract_instance.execute(op, storage);
+    }
+
     async broadcastTransaction(validator_writer_key, obj){
+        if(true === this.sim) {
+            return await this.simulateTransaction(obj);
+        }
         if(this.peer.wallet.publicKey !== null &&
             this.peer.wallet.secretKey !== null &&
-            this.base.localWriter !== null)
+            this.base.localWriter !== null &&
+            obj.type !== undefined &&
+            obj.value !== undefined)
         {
             this.nonce = Math.random() + '-' + Date.now();
             const content_hash = await this.peer.createHash('sha256', JSON.stringify(obj));
@@ -110,6 +137,7 @@ class Protocol{
         } else {
             throw Error('broadcastTransaction(writer, obj): Cannot prepare transaction. Please make sure inputs and local writer are set.');
         }
+        return true;
     }
 
     async tokenizeInput(input){
@@ -121,9 +149,7 @@ class Protocol{
         }
     }
 
-    async tx(subject){
-        throw new Error('Not implemented: Protocol.tx(subject)');
-    }
+    async tx(subject){ }
 
     async customCommand(input){ }
 
@@ -145,4 +171,32 @@ class Protocol{
     }
 }
 
+class SimStorage{
+    constructor(peer) {
+        this.peer = peer;
+        this.values = {};
+    }
+
+    async del(key){
+        if(this.peer.contract_instance.isReservedKey(key)) throw Error('del(key): ' + key + 'is reserved');
+        delete this.values[key];
+        return this.peer.contract_instance.emptyPromise();
+    }
+
+    async get(key){
+        if(this.values[key] !== undefined) {
+            return this.values[key];
+        }
+        let result = await this.peer.base.view.get(key);
+        if(null === result) return null;
+        return result.value;
+    }
+
+    async put(key, value){
+        if(this.peer.contract_instance.isReservedKey(key)) throw Error('put(key,value): ' + key + 'is reserved');
+        this.values[key] = value;
+        return this.peer.contract_instance.emptyPromise();
+    }
+}
+
 export default Protocol;