ethershell 0.1.0-alpha.8 → 0.1.0-beta.0

package/LICENSE

@@ -1,55 +1,21 @@
-Business Source License 1.1
-
-Parameters
------------
-Licensor:             Alireza Kiakojouri
-Licensed Work:        EtherShell
-                      The Licensed Work is © 2025 Alireza Kiakojouri
-Additional Use Grant: You may make production use of the Licensed Work 
-                      to develop, test, deploy, and maintain your own 
-                      software and applications, provided you do not 
-                      offer the Licensed Work itself or any derivative 
-                      thereof as a product or service to third parties.
-
-Change Date:          2029-11-30
-Change License:       Apache License, Version 2.0
-
-Terms
------
-The Licensor hereby grants you the right to copy, modify, create derivative
-works, redistribute, and make non-production use of the Licensed Work. The
-Licensor may make an Additional Use Grant, above, permitting limited production use.
-
-Effective on the Change Date, or the fourth anniversary of the first publicly
-available distribution of a specific version of the Licensed Work under this
-License, whichever comes first, the Licensor hereby grants you rights under
-the terms of the Change License, and the rights granted in the paragraph
-above terminate.
-
-If your use of the Licensed Work does not comply with the requirements
-currently in effect as described in this License, you must purchase a
-commercial license from the Licensor, its affiliated entities, or authorized
-resellers, or you must refrain from using the Licensed Work.
-
-All copies of the original and modified Licensed Work, and derivative works
-of the Licensed Work, are subject to this License. This License applies
-separately for each version of the Licensed Work and the Change Date may vary
-for each version of the Licensed Work released by Licensor.
-
-You must conspicuously display this License on each original or modified copy
-of the Licensed Work. If you receive the Licensed Work in original or
-modified form from a third party, the terms and conditions set forth in this
-License apply to your use of that work.
-
-Any use of the Licensed Work in violation of this License will automatically
-terminate your rights under this License for the current and all other
-versions of the Licensed Work.
-
-This License does not grant you any right in any trademark or logo of
-Licensor or its affiliates (provided that you may use a trademark or logo of
-Licensor as expressly required by this License).
-
-TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
-AN "AS IS" BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
-EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
-MERCHANTABILITY,
+MIT License
+
+Copyright (c) 2025 Alireza Kiakojouri
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,6 +1,6 @@
 # 🔷 EtherShell - Interactive Ethereum Smart Contract Console
 
-**⚠️ WARNING: This package is in ALPHA testing. NOT production ready!**
+**⚠️ WARNING: This package is in BETA testing. NOT production ready!**
 
 An interactive Node.js console for Ethereum smart contract development. Write, compile, deploy, and manage smart contracts directly from the shell with an intuitive, Solidity-focused developer experience.
 
@@ -13,34 +13,41 @@ An interactive Node.js console for Ethereum smart contract development. Write, c
 
 ## ✨ Features
 
-- **Interactive Shell** - Built-in async support for all commands
-- **Solidity Compilation** - Compile contracts with configurable optimization
+- **Interactive REPL Shell** - Built-in async support for all commands with custom evaluation
+- **Solidity Compilation** - Compile contracts with configurable optimization and viaIR mode
 - **Smart Contract Deployment** - Deploy contracts to any EVM network
-- **Wallet Management** - Create, import, and manage wallets (regular & HD wallets)
-- **Multi-Network Support** - Switch between different blockchain networks
-- **Contract Interactions** - Call contract methods directly from the shell
-- **ABI & Bytecode Generation** - Organized artifact output
+- **Wallet Management** - Create, import, and manage wallets (regular & HD wallets, node-managed accounts)
+- **Multi-Network Support** - Switch between different blockchain networks with persistent configuration
+- **Contract Proxy Wrapper** - Enhanced contract interaction with flexible transaction options (from, value, gasLimit, maxFeePerGas, etc.)
+- **Contract Interactions** - Call contract methods with advanced options directly from the shell
+- **ABI & Bytecode Generation** - Organized artifact output with metadata
 - **Node Signer Integration** - Connect to node-managed accounts (Ganache, Hardhat)
-- **TypeScript JSDoc** - Full IDE autocomplete and type hints
-- **Gas Optimization** - Configure compiler optimization levels
+- **TypeScript Code Generation** - Auto-generate TypeScript types from contract ABIs
+- **Gas Optimization** - Configure compiler optimization levels and viaIR code generation
+- **Persistent Configuration** - Save and restore network, compiler, and wallet settings
+- **Comprehensive JSDoc** - Full IDE autocomplete and type hints
 
 ## 🚀 Quick Start
 
 ### 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 +61,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
@@ -160,6 +167,13 @@ EtherShell> walletInfo(0)
 EtherShell> walletInfo('0x1234...5678')
 // or multiple
 EtherShell> walletInfo([0, 1, 2])
+
+// Change default account
+EtherShell> changeDefWallet(0)
+// or by address
+EtherShell> changeDefWallet('0x1234...5678')
+// or import and set as default in one command
+EtherShell> changeDefWallet('0xPrivateKeyHere')
 ```
 
 #### Delete Wallets
@@ -194,7 +208,7 @@ EtherShell> compiler()
 EtherShell> compUpdate('v0.8.19+commit.7dd6d404')
 Loaded solc version: 0.8.19+commit.7dd6d404.Emscripten.clang
 
-// Configure compilation options
+// Configure compilation options (gasOptimizer, viaIR, optimizerRuns)
 EtherShell> compOpts(true, false, 1000)
 ✓ Compiler options updated:
  Gas Optimizer: Enabled
@@ -204,6 +218,27 @@ EtherShell> compOpts(true, false, 1000)
 // Get current options
 EtherShell> compInfo()
 { optimizer: true, optimizerRuns: 1000, viaIR: false }
+
+// Get current config info
+EtherShell> configInfo()
+{ 
+  providerEndpoint: '...',
+  defaultWallet: { ... },
+  compiler: {
+    version: 'v0.8.29+commit.ab55807c',
+    optimizer: false,
+    viaIR: false,
+    optimizerRuns: 200,
+    compilePath: './build'
+  }
+}
+
+// Get default wallet
+EtherShell> defWallet()
+{ address: '0x...', ... }
+
+// Change build output path
+EtherShell> compPath('./custom-build')
 ```
 
 #### Compile Contracts
@@ -212,6 +247,7 @@ EtherShell> compInfo()
 // Compile all .sol files in ./contracts directory
 EtherShell> build()
 Contracts compiled into /path/to/build
+TypeScript types generated in /path/to/build/types
 
 // Compile a specific contract file
 EtherShell> build('./contracts/MyToken.sol')
@@ -232,7 +268,8 @@ build/
 ├── artifacts/          # Complete contract data with metadata
 ├── abis/              # Contract ABIs (.abi.json files)
 ├── bytecode/          # Contract bytecode (.bin files)
-└── metadata/          # Contract metadata (.metadata.json files)
+├── metadata/          # Contract metadata (.metadata.json files)
+└── types/             # Auto-generated TypeScript types
 ```
 
 ### 4. Smart Contract Deployment
@@ -240,7 +277,35 @@ build/
 #### Deploy New Contracts
 
 ```javascript
-// Deploy MyToken contract with constructor args
+// Deploy contract without constructor args and with default wallet
+// Arguments: contractName
+EtherShell> deploy('contractName')
+{
+  hash: '0x123abc...',
+  from: '0x1234...5678',
+  to: null,
+  address: '0xabcd...ef01',
+  name: 'contractName',
+  chain: 'sepolia',
+  chainId: 11155111n,
+  deployType: 'ethershell-deployed'
+}
+
+// Deploy MyToken contract with constructor args and default wallet
+// Arguments: contractName, args[], walletIndex, [chainURL], [abiLocation], [bytecodeLocation]
+EtherShell> deploy('MyToken', ['MyTokenName', 'MTK', 1000000])
+{
+  hash: '0x123abc...',
+  from: '0x1234...5678',
+  to: null,
+  address: '0xabcd...ef01',
+  name: 'MyToken',
+  chain: 'sepolia',
+  chainId: 11155111n,
+  deployType: 'ethershell-deployed'
+}
+
+// Deploy MyToken contract with constructor args and a non-default wallet
 // Arguments: contractName, args[], walletIndex, [chainURL], [abiLocation], [bytecodeLocation]
 EtherShell> deploy('MyToken', ['MyTokenName', 'MTK', 1000000], 0)
 {
@@ -250,13 +315,14 @@ EtherShell> deploy('MyToken', ['MyTokenName', 'MTK', 1000000], 0)
   address: '0xabcd...ef01',
   name: 'MyToken',
   chain: 'sepolia',
+  chainId: 11155111n,
   deployType: 'ethershell-deployed'
 }
 
 // Deploy with custom chain
 EtherShell> deploy('MyContract', ['arg1', 'arg2'], 0, 'https://custom-rpc.url')
 
-// The deployed contract is automatically added to console context
+// The deployed contract is automatically added to console context as a proxy
 EtherShell> MyToken
 Contract {
   target: '0xabcd...ef01',
@@ -300,16 +366,14 @@ EtherShell> contracts()
     address: '0xabcd...ef01',
     chain: 'sepolia',
     chainId: 11155111n,
-    deployType: 'ethershell-deployed',
-    balance: 0n
+    deployType: 'ethershell-deployed'
   },
   {
     index: 1,
     name: 'USDT',
     address: '0xdAC17F958D2ee523a2206206994597C13D831ec7',
     chain: 'mainnet',
-    deployType: 'pre-deployed',
-    balance: 0n
+    deployType: 'pre-deployed'
   }
 ]
 
@@ -341,11 +405,36 @@ EtherShell> MyToken.totalSupply()
 EtherShell> MyToken.transfer('0xRecipientAddress', 100)
 ContractTransactionResponse { ... }
 
+// Call with advanced transaction options
+EtherShell> MyToken.transfer('0xRecipientAddress', 100, {
+  from: '0xSenderAddress',          // Switch signer
+  value: 10000000000000n,    // Send ETH (for payable functions)
+  gasLimit: 500000,                 // Custom gas limit
+  maxFeePerGas: 100000000000n,    // EIP-1559
+  maxPriorityFeePerGas: 2000000000n,
+  nonce: 42,
+  chainId: 1
+})
+
 // Check balance
 EtherShell> MyToken.balanceOf('0x1234...5678')
 100n
 ```
 
+**Contract Proxy Options:**
+The contract proxy wrapper supports these transaction options:
+- `from`: Change the signer/sender for the transaction
+- `value`: ETH amount to send (for payable functions)
+- `gasLimit` / `gas`: Maximum gas to use
+- `gasPrice`: Legacy transaction gas price
+- `maxFeePerGas`: EIP-1559 max fee per gas
+- `maxPriorityFeePerGas`: EIP-1559 priority fee per gas
+- `nonce`: Transaction nonce for ordering
+- `chainId`: Network chain ID
+- `accessList`: EIP-2930 access list
+- `type`: Transaction type (0, 1, 2, or 3)
+- `customData`: Custom data for special networks (zkSync)
+
 ## 🎯 Complete Usage Example
 
 Here's a full workflow example:
@@ -367,21 +456,22 @@ EtherShell> compOpts(true, false, 1000)
 EtherShell> build()
 
 // 6. Deploy contract
-EtherShell> deploy('MyToken', ['TestToken', 'TEST', 1000000], 0)
+EtherShell> deploy('MyToken', ['TestToken', 'TEST', 1000000])
 
 // 7. Interact with contract
 EtherShell> MyToken.balanceOf('0x...')
+1000000000000000000000000n
 
-// 8. Transfer tokens
-EtherShell> tx = MyToken.transfer('0x...', 100)
-
-// 9. Wait for transaction
-EtherShell> receipt = tx.wait()
+// 8. Transfer tokens with custom options
+EtherShell> tx = MyToken.transfer('0x...', 100, {
+  gasLimit: 100000,
+  maxFeePerGas: 50000000000n
+})
 
-// 10. Check balance again
+// 9. Check balance again
 EtherShell> MyToken.balanceOf('0x...')
 
-// 11. View all contracts
+// 10. View all contracts
 EtherShell> contracts()
 ```
 
@@ -391,7 +481,7 @@ EtherShell> contracts()
 | Command | Description |
 |---------|-------------|
 | `chain(url)` | Connect to blockchain network |
-| `chain()` | Get current network info |
+| `chainInfo()` | Get current network info |
 | `defaultChain()` | Get default network URL |
 
 ### Wallet Commands
@@ -406,6 +496,7 @@ EtherShell> contracts()
 | `hdWallets()` | View HD accounts |
 | `allWallets()` | View all accounts |
 | `walletInfo(index\|address\|[indices])` | Get wallet details (balance, nonce) |
+| `changeDefWallet(pointer)` | Set default account |
 | `removeWallet(pointer)` | Delete account(s) |
 
 ### Compiler Commands
@@ -415,13 +506,16 @@ EtherShell> contracts()
 | `compUpdate(version)` | Load specific Solidity version |
 | `compOpts(gasOpt, viaIR, runs)` | Configure optimization |
 | `compInfo()` | Get current compiler options |
+| `configInfo()` | Get all configuration info |
+| `defWallet()` | Get default account |
+| `compPath(newPath)` | Change build output path |
 | `build([path], [contracts], [output])` | Compile contracts |
 | `clean([path])` | Delete build directory |
 
 ### Contract Commands
 | Command | Description |
 |---------|-------------|
-| `deploy(name, args, index)` | Deploy new contract |
+| `deploy(name, [args], [index], [chainURL], [abiLocation], [bytecodeLocation])` | Deploy new contract |
 | `addContract(name, address, index, abiPath)` | Add existing contract |
 | `contracts([pointer])` | List contracts or get specific one |
 
@@ -457,15 +551,22 @@ ethershell/
 │   │   ├── wallet.js         # Wallet management
 │   │   ├── network.js        # Network provider
 │   │   ├── addContracts.js   # Contract deployment
-│   │   └── contracts.js      # Contract retrieval
+│   │   ├── contracts.js      # Contract retrieval
+│   │   ├── config.js         # Configuration
+│   │   └── files.js          # File utilities
 │   └── utils/
 │       ├── builder.js        # Compilation engine
 │       ├── dir.js            # Directory utilities
 │       ├── accounter.js      # Account utilities
+│       ├── contractProxy.js  # Contract proxy wrapper
 │       ├── contractLister.js # Contract formatting
-│       └── replHelper.js     # REPL customization
+│       ├── typeGenerator.js  # TypeScript type generation
+│       ├── replHelper.js     # REPL customization
+│       ├── serialize.js      # BigInt serialization
+│       └── configFileUpdate.js # Config utilities
 ├── contracts/                 # Your Solidity contracts
 ├── build/                      # Compiled artifacts
+├── localStorage/              # Persistent config and wallet storage
 └── package.json
 ```
 
@@ -508,7 +609,7 @@ contract MyToken {
 EtherShell> build('./contracts/MyToken.sol')
 
 // 2. Deploy
-EtherShell> deploy('MyToken', [], 0)
+EtherShell> deploy('MyToken')
 
 // 3. Interact
 EtherShell> MyToken.balanceOf('0x...')
@@ -520,7 +621,39 @@ EtherShell> MyToken.transfer('0x...', 100)
 
 ## ⚙️ Configuration
 
-### Environment Variables
+### Persistent Storage
+
+EtherShell stores configuration in the `localStorage` directory:
+
+```
+localStorage/
+├── config.json          # Compiler and network settings
+├── wallets.json         # Imported/generated wallets
+```
+
+### Configuration File
+
+The `config.json` file contains:
+
+```json
+{
+  "providerEndpoint": "http://127.0.0.1:8545",
+  "defaultWallet": {
+    "index": 0,
+    "address": "0x...",
+    "type": "user-generated"
+  },
+  "compiler": {
+    "version": "v0.8.20+commit.a1b79de6",
+    "optimizer": false,
+    "viaIR": false,
+    "optimizerRuns": 200,
+    "compilePath": "./build"
+  }
+}
+```
+
+### Environment Variables (Optional)
 
 Create a `.env` file (optional):
 
@@ -538,6 +671,7 @@ CONTRACTS_PATH=./contracts
 COMPILER_VERSION=0.8.20+commit.a1b79de6
 OPTIMIZER_ENABLED=true
 OPTIMIZER_RUNS=200
+VIAIR_ENABLED=false
 ```
 
 ## 🔒 Security Warnings
@@ -548,6 +682,7 @@ OPTIMIZER_RUNS=200
 2. **Keep private keys safe** - Don't commit `.env` files or private keys to git
 3. **Use read-only RPCs** - For production, use read-only endpoints
 4. **Test on testnet first** - Always test contracts on Sepolia before mainnet
+5. **Verify contracts on Etherscan** - Always verify production contracts
 
 ```bash
 # Add to .gitignore
@@ -589,6 +724,20 @@ Solution: npm install
 - Verify .sol file exists in ./contracts
 ```
 
+**Issue: `Cannot use 'from' option with node-managed account`**
+```bash
+- Node-managed accounts cannot be used with the 'from' option
+- Only imported/generated wallets with private keys support 'from'
+- Use .connect() method for node-managed accounts
+```
+
+**Issue: `TypeScript types not generated`**
+```bash
+- Ensure contracts compiled successfully with build()
+- Check ABIs exist in build/abis/ directory
+- Look for error messages in the build() output
+```
+
 ## 📖 API Documentation
 
 Full JSDoc documentation is available in the source files. Each file includes:
@@ -640,4 +789,4 @@ This project is licensed under the BUSL-1.1 License - see LICENSE file for detai
 
 **Made with ❤️ for Ethereum developers**
 
-Happy coding! 🚀
+Happy coding! 🚀

package/bin/cli.js

@@ -16,7 +16,8 @@ import {
     currentCompiler,
     compilerOptions,
     getCompilerOptions,
-    compile
+    compile,
+    changeCompPath
 } from '../src/services/build.js';
 import { set, get, getDefault } from '../src/services/network.js';
 import { deleteDirectory } from '../src/services/files.js';
@@ -30,11 +31,13 @@ import {
     addHD,
     getAllAccounts,
     connectWallet,
-    getWalletInfo
+    getWalletInfo,
+    changeDefaultAccount
     } from '../src/services/wallet.js';
 
 import { deploy, add } from '../src/services/addContracts.js';
 import { getContracts } from '../src/services/contracts.js';
+import { getConfigInfo, getDefaultAccount } from '../src/services/config.js';
 
 /**
  * REPL instance for EtherShell interactive environment
@@ -53,7 +56,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
@@ -61,8 +64,14 @@ r.context.compiler = currentCompiler;
 r.context.compUpdate = updateCompiler;
 r.context.compInfo = getCompilerOptions;
 r.context.compOpts = compilerOptions;
+r.context.compPath = changeCompPath;
 r.context.build = compile;
 
+// Config commands
+r.context.configInfo = getConfigInfo;
+r.context.changeDefWallet = changeDefaultAccount;
+r.context.defWallet = getDefaultAccount;
+
 // Clean build folder
 r.context.clean = deleteDirectory;
 

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "ethershell",
-  "version": "0.1.0-alpha.8",
+  "license": "MIT",
+  "version": "0.1.0-beta.0",
   "description": "Interactive JavaScript console for Ethereum smart contract management",
-  "license": "BUSL-1.1",
   "author": "Alireza Kiakojouri (alirezaethdev@gmail.com)",
   "repository": {
     "type": "git",
@@ -34,6 +34,7 @@
     "blockchain"
   ],
   "dependencies": {
+    "commander": "^12.1.0",
     "ethers": "^6.13.0",
     "node-localstorage": "^3.0.5",
     "solc": "^0.8.29",
@@ -45,5 +46,11 @@
     "src/",
     "LICENSE",
     "README.md"
-  ]
+  ],
+  "devDependencies": {
+    "@typechain/ethers-v6": "^0.5.1",
+    "@types/node": "^24.10.2",
+    "typechain": "^8.3.2",
+    "typescript": "^5.9.3"
+  }
 }