ethershell 0.1.0-alpha.8 → 0.1.1-alpha.15

package/README.md

@@ -29,18 +29,22 @@ An interactive Node.js console for Ethereum smart contract development. Write, c
 ### Installation
 
 ```bash
-# Install globally
+# Install globally:
 npm i -g ethershell
 
-# Start EtherShell
-npm start
+# Start EtherShell:
+ethershell 
+
+#or
+
+npx ethershell
 ```
 
 ### Basic Usage
 
 ```bash
 # Start the console
-npm start
+ethershell
 
 # You should see:
 # EtherShell>
@@ -54,7 +58,7 @@ First, connect to a blockchain network:
 
 ```javascript
 // View current network
-EtherShell> chain()
+EtherShell> chainInfo()
 { URL: 'http://127.0.0.1:8545', name: 'unknown', chainId: 1337n }
 
 // Switch to a different network

package/bin/cli.js

@@ -35,6 +35,7 @@ import {
 
 import { deploy, add } from '../src/services/addContracts.js';
 import { getContracts } from '../src/services/contracts.js';
+import { getConfigInfo } from '../src/services/config.js';
 
 /**
  * REPL instance for EtherShell interactive environment
@@ -53,7 +54,7 @@ export const r = repl.start({
 
 // Network commands
 r.context.chain = set;
-r.context.chain = get;
+r.context.chainInfo = get;
 r.context.defaultChain = getDefault;
 
 // Compile commands
@@ -63,6 +64,9 @@ r.context.compInfo = getCompilerOptions;
 r.context.compOpts = compilerOptions;
 r.context.build = compile;
 
+// Config commands
+r.context.configInfo = getConfigInfo;
+
 // Clean build folder
 r.context.clean = deleteDirectory;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ethershell",
-  "version": "0.1.0-alpha.8",
+  "version": "0.1.1-alpha.15",
   "description": "Interactive JavaScript console for Ethereum smart contract management",
   "license": "BUSL-1.1",
   "author": "Alireza Kiakojouri (alirezaethdev@gmail.com)",

package/src/services/build.js

@@ -8,13 +8,39 @@
 import path from 'path';
 import solc from 'solc';
 import { check, collectSolFiles } from '../utils/dir.js';
-import { setVersion, build } from '../utils/builder.js';
+import { 
+  setVersion,
+  build, 
+  loadSolcVersion, 
+  extractLoadableVersion 
+} from '../utils/builder.js';
+import fs from 'fs';
 
 /**
- * Current Solidity compiler instance
+ * Stored compiler config path
+ * @type {string}
+ */
+const compConfigPath = './localStorage/compilerConfig.json';
+
+/**
+ * Global compiler configuration state
+ * @type {Object}
+ * @property {Object} currentSolcInstance - Current Solidity compiler instance
+ * @property {boolean} optimizer - Whether gas optimizer is enabled
+ * @property {number} optimizerRuns - Number of optimizer runs
+ * @property {boolean} viaIR - Whether to use IR-based code generation
+ */
+let compConfig = {};
+
+/**
+ * JSON file fields of compiler configuration
  * @type {Object}
+ * @property {string} version - Current Solidity compiler version
+ * @property {boolean} optimizer - Whether gas optimizer is enabled
+ * @property {number} optimizerRuns - Number of optimizer runs
+ * @property {boolean} viaIR - Whether to use IR-based code generation
  */
-let currentSolcInstance = solc; // default local compiler
+export let compConfigFile = {};
 
 /**
  * Global compiler configuration state
@@ -23,11 +49,37 @@ let currentSolcInstance = solc; // default local compiler
  * @property {number} optimizerRuns - Number of optimizer runs
  * @property {boolean} viaIR - Whether to use IR-based code generation
  */
-let compilerConfig = {
-  optimizer: false,
-  optimizerRuns: 200,
-  viaIR: false
-};
+let storedCompConfig;
+
+// Load config file
+if(fs.existsSync(compConfigPath)){
+  storedCompConfig = JSON.parse(fs.readFileSync(compConfigPath));
+} else {
+  storedCompConfig = null;
+}
+
+// Initialize global configuration of compiler
+if(storedCompConfig){
+  compConfigFile = storedCompConfig;
+  compConfig.currentSolcInstance = await loadSolcVersion(compConfigFile.version);
+  compConfig.optimizer = compConfigFile.optimizer;
+  compConfig.viaIR = compConfigFile.viaIR;
+  compConfig.optimizerRuns = compConfigFile.optimizerRuns;
+} else {
+  compConfig = {
+    currentSolcInstance: solc, // default local compiler
+    optimizer: false,
+    viaIR: false,
+    optimizerRuns: 200
+  }
+  compConfigFile.version = extractLoadableVersion(compConfig.currentSolcInstance.version());
+  compConfigFile.optimizer = compConfig.optimizer;
+  compConfigFile.viaIR = compConfig.viaIR;
+  compConfigFile.optimizerRuns = compConfig.optimizerRuns;
+
+  // Update config file
+  fs.writeFileSync(compConfigPath, JSON.stringify(compConfigFile, null, 2));
+}
 
 /**
  * Update the Solidity compiler to a specific version
@@ -40,7 +92,12 @@ let compilerConfig = {
  */
 export async function updateCompiler(version){
   try{
-    currentSolcInstance = await setVersion(version, currentSolcInstance);
+    // Update global configuration
+    compConfig.currentSolcInstance = await setVersion(version, compConfig.currentSolcInstance);
+
+    // Update config file
+    compConfigFile.version = extractLoadableVersion(compConfig.currentSolcInstance.version());
+    fs.writeFileSync(compConfigPath, JSON.stringify(compConfigFile, null, 2));
   } catch(err) {
     console.error(err);
   }
@@ -53,7 +110,7 @@ export async function updateCompiler(version){
  * const version = currentCompiler(); // Returns: "0.8.20+commit.a1b79de6.Emscripten.clang"
  */
 export function currentCompiler(){
-  return currentSolcInstance.version();
+  return compConfig.currentSolcInstance.version();
 }
 
 /**
@@ -80,19 +137,24 @@ export function compilerOptions(gasOptimizer, viaIR, optimizerRuns = 200) {
     }
 
     // Update global configuration
-    compilerConfig.optimizer = gasOptimizer;
-    compilerConfig.viaIR = viaIR;
-    compilerConfig.optimizerRuns = optimizerRuns;
+    compConfig.optimizer = gasOptimizer;
+    compConfig.viaIR = viaIR;
+    compConfig.optimizerRuns = optimizerRuns;
+
+    compConfigFile.optimizer = compConfig.optimizer;
+    compConfigFile.viaIR = compConfig.viaIR;
+    compConfigFile.optimizerRuns = compConfig.optimizerRuns;
+
+    // Update config file
+    fs.writeFileSync(compConfigPath, JSON.stringify(compConfigFile, null, 2));
 
     // Provide user feedback
     console.log('✓ Compiler options updated:');
-    console.log(`  Gas Optimizer: ${compilerConfig.optimizer ? 'Enabled' : 'Disabled'}`);
-    if (compilerConfig.optimizer) {
-        console.log(`  Optimizer Runs: ${compilerConfig.optimizerRuns}`);
+    console.log(`  Gas Optimizer: ${compConfig.optimizer ? 'Enabled' : 'Disabled'}`);
+    if (compConfig.optimizer) {
+        console.log(`  Optimizer Runs: ${compConfig.optimizerRuns}`);
     }
-    console.log(`  ViaIR: ${compilerConfig.viaIR ? 'Enabled' : 'Disabled'}`);
-    
-    return compilerConfig;
+    console.log(`  ViaIR: ${compConfig.viaIR ? 'Enabled' : 'Disabled'}`);
   } catch (error) {
       console.error('Error setting compiler options:', error.message);
       return null;
@@ -106,7 +168,7 @@ export function compilerOptions(gasOptimizer, viaIR, optimizerRuns = 200) {
  * const opts = getCompilerOptions();
  */
 export function getCompilerOptions() {
-  return { ...compilerConfig };
+  return { ...compConfig };
 }
 
 /**

package/src/services/config.js

@@ -0,0 +1,5 @@
+import { compConfigFile } from './build.js';
+
+export function getConfigInfo() {
+    console.log(compConfigFile); 
+}

package/src/services/wallet.js

@@ -12,22 +12,18 @@ import {
     deleteByIndex, 
     deleteByIndexArr, 
     getAccountInfo, 
-    detectDupWallet
+    detectDupWallet,
+    updateWalletJSON,
+    getWalletJSON,
+    updateAccountMemory
  } from '../utils/accounter.js';
- import fs from 'fs';
-
-
-/**
- * Object containing all stored accounts (imported, generated, HD, and node-managed)
- * @type {Object}
- */
-let walletJSON;
 
 /**
  * Array containing all accounts (imported, generated, HD, and node-managed)
  * @type {Array<Object>}
  */
 export let allAccounts = [];
+allAccounts = getWalletJSON();
 
 /**
  * Array containing only regular accounts (imported and generated)
@@ -41,6 +37,11 @@ export let accounts = [];
  */
 export let hdAccounts = [];
 
+// Update accounts & hdAccounts arrays
+const { memAccArr, memHDAccArr } = updateAccountMemory(allAccounts);
+accounts = memAccArr;
+hdAccounts = memHDAccArr;
+
 /**
  * Add accounts from private key(s)
  * @param {string|Array<string>} privKeyArr - Single private key or array of private keys
@@ -58,6 +59,7 @@ export function addAccounts(privKeyArr) {
         throw `You need to add at least one private key. If you have no private key you can create new accounts by 'newAccounts()'! `;
     }
 
+    let newAccObj;
     const dupWallet = detectDupWallet(privKeyArr);
 
     if(dupWallet.status) {
@@ -68,38 +70,33 @@ export function addAccounts(privKeyArr) {
 
     if(typeof privKeyArr === 'string'){
         const newAccount = new ethers.Wallet(privKeyArr, provider);
-        allAccounts.push({
+        newAccObj = {
             index: allAccounts.length,
             address: newAccount.address,
             privateKey: privKeyArr,
             type: 'user-imported',
             contracts: []
-        });
-        accounts.push({
-            index: allAccounts.length - 1,
-            address: newAccount.address,
-            privateKey: privKeyArr,
-            type: 'user-imported',
-            contracts: []
-        });
+        }
+        allAccounts.push(newAccObj);
+        updateWalletJSON(allAccounts);
+        newAccObj.index = allAccounts.length - 1;
+        accounts.push(newAccObj);
         console.log(allAccounts[newFrom]);
     }
 
     if(Array.isArray(privKeyArr)){
         privKeyArr.map(privKey => {
             const newAccount = new ethers.Wallet(privKey, provider);
-            allAccounts.push({
+            newAccObj = {
                 index: allAccounts.length,
                 address: newAccount.address,
                 privateKey: privKey,
                 contracts: []
-            });
-            accounts.push({
-                index: allAccounts.length - 1,
-                address: newAccount.address,
-                privateKey: privKey,
-                contracts: []
-            });
+            }
+            allAccounts.push(newAccObj);
+            updateWalletJSON(allAccounts);
+            newAccObj.index = allAccounts.length - 1;
+            accounts.push(newAccObj);
         });
 
         console.log(allAccounts.slice(newFrom));
@@ -115,6 +112,7 @@ export function addAccounts(privKeyArr) {
  */
 export function addHD(phrase, count = 10) {
     const newFrom = allAccounts.length;
+    let newAccObj;
     const hdNode = ethers.HDNodeWallet.fromPhrase(phrase);
 
     const existingPhrase = allAccounts.find(wallet => wallet.phrase == phrase);
@@ -128,7 +126,7 @@ export function addHD(phrase, count = 10) {
         if(dupHDWallet.status) {
             throw `Error: Wallets may NOT be duplicated! You are adding wallet index ${dupHDWallet.index} again!`
         } else {
-            allAccounts.push({
+            newAccObj = {
                 index: allAccounts.length,
                 address: hdWallet.address,
                 phrase: hdWallet.mnemonic.phrase,
@@ -137,20 +135,13 @@ export function addHD(phrase, count = 10) {
                 path: hdWallet.path,
                 depth: hdWallet.depth,
                 contracts: []
-            });
-            hdAccounts.push({
-                index: allAccounts.length - 1,
-                address: hdWallet.address,
-                phrase: hdWallet.mnemonic.phrase,
-                privateKey: hdWallet.privateKey,
-                type: 'user-imported',
-                path: hdWallet.path,
-                depth: hdWallet.depth,
-                contracts: []
-            });
+            },
+            allAccounts.push(newAccObj);
+            newAccObj.index = allAccounts.length - 1;
+            hdAccounts.push(newAccObj);
         }
     }
-
+    updateWalletJSON(allAccounts);
     console.log(`!WARNING!\n The generated accounts are NOT safe. Do NOT use them on main net!`);
     console.log(allAccounts.slice(newFrom));
 }
@@ -164,25 +155,22 @@ export function addHD(phrase, count = 10) {
 export function createAccounts(count = 1) {
     const newAccounts = Array.from({length: count}, () => ethers.Wallet.createRandom());
     const newFrom = accounts.length;
+    let newAccObj;
 
     for(let i = 0; i < newAccounts.length; i++) {
-
-        allAccounts.push({
+        newAccObj = {
             index: allAccounts.length,
             address:  newAccounts[i].address,
             privateKey: newAccounts[i].privateKey,
             type: 'user-generated',
             contracts: []
-        });
-        accounts.push({
-            index: allAccounts.length - 1,
-            address: newAccounts[i].address,
-            privateKey: newAccounts[i].privateKey,
-            type: 'user-generated',
-            contracts: []
-        })
+        }
+        allAccounts.push(newAccObj);
+        newAccObj.index = allAccounts.length - 1;
+        accounts.push(newAccObj);
 
     }
+    updateWalletJSON(allAccounts);
     console.log(`!WARNING!\n The generated accounts are NOT safe. Do NOT use them on main net!`);
     console.log(allAccounts.slice(newFrom));
 }
@@ -196,10 +184,11 @@ export function createAccounts(count = 1) {
 export function createHD(count = 10) {
     const hdNode = ethers.HDNodeWallet.createRandom();
     const newFrom = allAccounts.length;
+    let newAccObj;
     
     for (let i = 0; i < count; i++) {
         const hdWallet = hdNode.derivePath(i.toString());
-        allAccounts.push({
+        newAccObj = {
             index: allAccounts.length,
             address: hdWallet.address,
             phrase: hdWallet.mnemonic.phrase,
@@ -210,21 +199,12 @@ export function createHD(count = 10) {
             path: hdWallet.path,
             depth: hdWallet.depth,
             contracts: []
-        });
-        hdAccounts.push({
-            index: allAccounts.length - 1,
-            address: hdWallet.address,
-            phrase: hdWallet.mnemonic.phrase,
-            privateKey: hdWallet.privateKey,
-            type: 'user-generated',
-            nonce: 0,
-            balance: 0,
-            path: hdWallet.path,
-            depth: hdWallet.depth,
-            contracts: []
-        });
+        }
+        allAccounts.push(newAccObj);
+        newAccObj.index = allAccounts.length - 1;
+        hdAccounts.push(newAccObj);
     }
-
+    updateWalletJSON(allAccounts);
     console.log(`!WARNING!\n The generated accounts are NOT safe. Do NOT use them on main net!`);
     console.log(allAccounts.slice(newFrom));
 }
@@ -342,6 +322,7 @@ export async function connectWallet() {
                 signer: accSigner // Store signer reference
             }) 
         }
+        updateWalletJSON(allAccounts);
     } catch(err) {
         console.error(err);
     }

package/src/utils/accounter.js

@@ -7,6 +7,13 @@
 
 import { allAccounts, accounts, hdAccounts } from '../services/wallet.js';
 import { provider } from '../services/network.js';
+import fs from 'fs';
+
+/**
+ * The path which in wallets json file will be saved.
+ * @type {String}
+ */
+const walletJSONPath = './localStorage/wallets.json';
 
 /**
  * Delete account(s) by index
@@ -22,6 +29,8 @@ export function deleteByIndex(index) {
         deleteByIndexArr(index);
     } else if (typeof index === 'number') {
         _deleteBySingIndex(index);
+    } else if (index === null || index === undefined) {
+        _deleteAll();
     }
 }
 
@@ -82,6 +91,46 @@ export function detectDupWallet(privKeyArr) {
     }
 }
 
+/**
+ * Writes/Updates wallets json file
+ * @param {Array<string>} walletArr - Account array
+ * @example
+ * updateWalletJSON([{
+            index: allAccounts.length,
+            address: newAccount.address,
+            privateKey: privKeyArr,
+            type: 'user-imported',
+            contracts: []
+        }]);
+ */
+export function updateWalletJSON(walletArr) {
+    fs.writeFileSync(walletJSONPath, JSON.stringify(walletArr, null, 2));
+}
+
+/**
+ * Returns wallets' object from saved json file
+ * @returns {Object}
+ */
+export function getWalletJSON() {
+    return JSON.parse(fs.readFileSync(walletJSONPath));
+}
+
+export function updateAccountMemory(allAccArr) {
+    let memAccArr = [];
+    let memHDAccArr = [];
+    for(let i = 0; i < allAccArr.length; i++) {
+        if(allAccArr[i].phrase) {
+            memHDAccArr.push(allAccArr[i])
+        } else {
+            memAccArr.push(allAccArr[i]);
+        }
+    }
+    return {
+        memAccArr,
+        memHDAccArr
+    }
+}
+
 /**
  * Get information for multiple accounts (internal)
  * @private
@@ -127,13 +176,6 @@ async function _getAccountInfo(_index) {
  * @returns {void}
  */
 function _deleteBySingIndex(_index) {
-    if (_index === null || _index === undefined) {
-        // Clear all arrays
-        allAccounts.splice(0);
-        accounts.splice(0);
-        hdAccounts.splice(0);
-        return;
-    }
 
     // Find and remove from allAccounts
     const accountIndex = allAccounts.findIndex(acc => acc.index === _index);
@@ -144,6 +186,9 @@ function _deleteBySingIndex(_index) {
         for (let i = accountIndex; i < allAccounts.length; i++) {
             allAccounts[i].index = i;
         }
+
+        // Update wallet json file
+        fs.writeFileSync(walletJSONPath, JSON.stringify(allAccounts, null, 2));
         
         // Remove from accounts array if it exists there
         const regularIndex = accounts.findIndex(acc => acc.index === _index);
@@ -210,4 +255,17 @@ function _findDupWalletByArr(privKeyArr) {
         return {
             status: false
         }
+}
+
+/**
+ * Removes all accounts from storage and memory
+ * @private
+ * @returns {null}
+ */
+function _deleteAll() {
+    allAccounts.splice(0);
+    accounts.splice(0);
+    hdAccounts.splice(0);
+    fs.writeFileSync(walletJSONPath, JSON.stringify([], null, 2));
+    return;
 }

package/src/utils/builder.js

@@ -167,3 +167,18 @@ export function build(fullPath, selectedContracts, buildPath){
   });
 }
 
+/**
+ * Extract loadable version format from full version string
+ * @param {string} fullVersion - Full version string (e.g., "0.8.20+commit.a1b79de6.Emscripten.clang")
+ * @returns {string} Loadable version format (e.g., "v0.8.20+commit.a1b79de6")
+ * @example
+ * extractLoadableVersion("0.8.20+commit.a1b79de6.Emscripten.clang"); // Returns: "v0.8.20+commit.a1b79de6"
+ */
+export function extractLoadableVersion(fullVersion) {
+  // Match version number and commit hash from full version string
+  const match = fullVersion.match(/(\d+\.\d+\.\d+)\+commit\.([a-f0-9]+)/);
+  if (!match) {
+    throw new Error(`Unable to extract version from: ${fullVersion}`);
+  }
+  return `v${match[1]}+commit.${match[2]}`;
+}