soluser 1.0.8 → 1.0.9

package/README.md

@@ -3,11 +3,23 @@
 ```shell
 npm install -g soluser@latest
 ```
+### 通过下载代码做本地安装的方法
+```
+git clone git@github.com:nextuser/soluser.git
+cd soluser
+npm link
+```
+
+## 查看版本
+```shell
+$ soluser --version
+```
+
 ## 新建账号
 ```shell
-$ soluser new charlie
-$ soluser new  alice --word-length 12
-$ soluser new  bob --word-length 24 --without-passphrase
+$ soluser new  alice 
+$ soluser new  bob --word-length 12
+$ soluser new  charlie --word-length 24 --without-passphrase
 ```
 
 ## 切换账号

package/bin/index.js

@@ -5,6 +5,10 @@ const newAccount = require('../src/commands/new');
 const switchAccount = require('../src/commands/switch');
 const listAccounts = require('../src/commands/list');
 const removeAccount = require('../src/commands/remove');
+const { showExamples } = require('../src/utils/example');
+const pruneAccount = require('../src/commands/prune');
+const clear = require('../src/commands/clear');
+
 
 // 导入地址查询命令
 const showAddress = require('../src/commands/address');
@@ -15,12 +19,14 @@ const requestAirdrop = require('../src/commands/airdrop');
 
 // Get version from package.json
 const packageJson = require('../package.json');
+const version = packageJson.version;
 // Set program version
-program.version(packageJson.version);
+program.version(version);
 
 // 定义地址查询命令
 program
   .command('address')
+  .alias('a')
   .description('Output the base58 address of a Solana account')
   .argument('<alias>', 'Alias of the account to get address') // 接收别名作为位置参数
   .action((alias) => {
@@ -42,6 +48,7 @@ program
 // 定义余额查询命令
 program
   .command('balance')
+  .alias('b')
   .description('Check the SOL balance of a Solana account')
   .argument('<alias>', 'Alias of the account to check balance') // 接收别名作为位置参数
   .action((alias) => {
@@ -53,6 +60,7 @@ program
 // 定义新建账号命令（修改后）
 program
   .command('new')
+  .alias('add')
   .description('Create a new Solana account')
   .argument('<alias>', 'Alias for the new account (must start with a letter, contain letters, digits, hyphens, or underscores)') // 新增位置参数
   .option('--word-length <number>', 'Number of words in seed phrase (12,15,18,21,24)', 12)
@@ -73,6 +81,7 @@ program
 // 定义切换账号命令（修改后）
 program
   .command('switch')
+  .alias('s')
   .description('Switch active Solana account')
   .argument('<alias>', 'Alias of the account to switch to') // 新增位置参数
   .action((alias) => { // 直接使用位置参数 alias
@@ -83,18 +92,53 @@ program
 // 定义列出账号命令
 program
   .command('list')
+  .alias('l')
   .description('List all Solana accounts')
   .action(listAccounts);
 
   // 定义删除账号命令
 program
-  .command('remove <alias>') // <alias> 为必填参数
-  .description('Delete a Solana account (permanently removes the key file)')
+  .command('remove <alias>')
+  .alias('r')
+  .description('remove alias from list， Move a Solana account to backup directory with timestamp')
+  .action((alias) => {
+    removeAccount(alias); // 使用新的移动逻辑
+  });
+
+  program
+  .command('clear')
+  .alias('c')
+  .description('Move all Solana accounts to backup directory with timestamp')
+  .action(() => {
+    clear();
+  });
+
+    // 定义删除账号命令
+program
+  .command('prune <alias>') // <alias> 为必填参数
+  .alias('p')
+  .description('prune a Solana account (prune the private key file)')
   .action((alias) => {
-    removeAccount(alias);
+    pruneAccount(alias);
   });
 
 
+
+
+  program.on('--help', () => {
+    console.log("version:" ,version);
+    showExamples();
+    process.exit(1);
+  });
+
+
+
 // 解析命令行参数
 program.parse(process.argv);
 
+// 处理无参数情况（显示帮助）
+if (process.argv.length === 2) {
+  
+  program.help();//program.outputHelp();
+}
+

package/package.json

@@ -1,11 +1,16 @@
 {
   "name": "soluser",
-  "version": "1.0.8",
+  "version": "1.0.9",
   "description": "A CLI tool to manage Solana accounts (new, switch, list)",
   "main": "bin/index.js",
   "bin": {
     "soluser": "./bin/index.js"
   },
+  "scripts": {
+    "test": "mocha test/**/*.test.js --noparallel",
+    "test:watch": "mocha test/**/*.test.js --watch",
+    "test:coverage": "nyc mocha test/**/*.test.js"
+  },
   "keywords": [
     "solana",
     "cli",
@@ -15,9 +20,23 @@
   "author": "guahuzi",
   "license": "MIT",
   "dependencies": {
+    "chalk": "4.1.2",
     "cli-table3": "^0.6.5",
-    "commander": "^14.0.2"
+    "commander": "^14.0.2",
+    "readline": "^1.3.0"
+  },
+  "devDependencies": {
+    "chai": "^4.3.7",
+    "mocha": "^10.2.0",
+    "nyc": "^15.1.0"
   },
+  "files": [
+    "src",
+    "bin",
+    "package.json",
+    "package-lock.json",
+    "README.md"
+  ],
   "repository": {
     "type": "git",
     "url": "https://github.com/nextuser/soluser.git"

package/src/commands/clear.js

@@ -0,0 +1,83 @@
+// src/commands/clear.js
+const clear = async () => {
+  const fs = require('fs');
+  const path = require('path');
+  const readline = require('readline');
+
+  // 创建 readline 接口用于用户输入
+  const rl = readline.createInterface({
+    input: process.stdin,
+    output: process.stdout
+  });
+
+  // 显示警告并等待用户确认
+  console.log('\x1b[33m%s\x1b[0m', 'WARNING: This will move ALL Solana account files to backup directory!');
+  console.log('This operation affects all accounts in your keys directory.');
+  
+  let answer = await new Promise((resolve) => {
+    rl.question('Are you sure you want to continue? Type "yes" to proceed: ', (input) => {
+      resolve(input.trim().toLowerCase());
+    });
+  });
+  
+  rl.close();
+  if(answer) {
+    answer = answer.trim().toLowerCase();
+  }
+
+  if (answer !== 'yes' && answer !== 'y')  {
+    console.log('Operation cancelled.');
+    return;
+  }
+ 
+
+  // 获取当前时间戳为 YYMMDDHHMMSS 格式
+  const now = new Date();
+  const timestamp = `${now.getFullYear().toString().slice(-2)}${(now.getMonth() + 1).toString().padStart(2, '0')}${now.getDate().toString().padStart(2, '0')}${now.getHours().toString().padStart(2, '0')}${now.getMinutes().toString().padStart(2, '0')}${now.getSeconds().toString().padStart(2, '0')}`;
+  
+  // 定义密钥目录和备份目录
+  const keysDir = path.join(require('os').homedir(), '.config', 'solana', 'keys');
+  const backupDir = path.join(require('os').homedir(), '.config', 'solana', '.bak');
+  
+  // 确保备份目录存在
+  if (!fs.existsSync(backupDir)) {
+    fs.mkdirSync(backupDir, { recursive: true });
+  }
+  
+  // 读取密钥目录中的所有文件
+  if (fs.existsSync(keysDir)) {
+    const files = fs.readdirSync(keysDir);
+    
+    // 过滤出 .json 文件并移动
+    const jsonFiles = files.filter(file => path.extname(file) === '.json');
+    
+    if (jsonFiles.length > 0) {
+      let successCount = 0;
+      jsonFiles.forEach(file => {
+        const sourceFile = path.join(keysDir, file);
+        const fileNameWithoutExt = path.basename(file, '.json');
+        const destFile = path.join(backupDir, `${fileNameWithoutExt}_${timestamp}.json`);
+        
+        try {
+          fs.renameSync(sourceFile, destFile);
+          console.log(`Moved ${file} to backup directory as ${fileNameWithoutExt}_${timestamp}.json`);
+          console.log('All accounts have been removed.')
+          successCount++;
+        } catch (error) {
+          console.error(`Failed to move ${file}: ${error.message}`);
+        }
+      });
+      
+      console.log(`\nSuccessfully moved ${successCount}/${jsonFiles.length} account(s) to backup directory`);
+    } else {
+      
+      console.log('All accounts have been removed.')
+      console.log('No account files found to move');
+    }
+  } else {
+    console.error('Keys directory does not exist');
+    process.exit(1);
+  }
+};
+
+module.exports = clear;

package/src/commands/list.js

@@ -7,13 +7,13 @@ const { getAddress, getActiveKeyPath } = require('../utils/solana');
 function listAccounts() {
   // 1. 读取密钥目录下的所有 json 文件
   if (!fs.existsSync(KEYS_DIR)) {
-    console.log('No accounts found. Create one with "soluser new --alias <name>".');
+    console.log('No accounts found. Create one with "soluser new  <alias name>".');
     return;
   }
 
   const files = fs.readdirSync(KEYS_DIR).filter(file => file.endsWith('.json'));
   if (files.length === 0) {
-    console.log('No accounts found. Create one with "soluser new --alias <name>".');
+    console.log('No accounts found. Create one with "soluser new  <alias name>".');
     return;
   }
 

package/src/commands/prune.js

@@ -0,0 +1,63 @@
+const fs = require('fs');
+const { validateAlias, getKeyFilePath } = require('../utils/path');
+const { getActiveKeyPath } = require('../utils/solana');
+const path = require('path');
+const ThrowErorr = require('../utils/throw_error');
+const chalk = require('chalk');
+const { getAddress } = require('../utils/solana');
+
+async function pruneAccount(alias) {
+  // 1. 验证别名格式
+  validateAlias(alias);
+
+  // 2. 检查密钥文件是否存在
+  const keyPath = getKeyFilePath(alias);
+  if (!fs.existsSync(keyPath)) {
+    ThrowErorr(`Account "${alias}" not found. Use "soluser list" to check existing accounts.`);
+  }
+
+  // 3. 检查是否为当前活跃账号
+  const activeKeyPath = getActiveKeyPath();
+  const isActive = activeKeyPath === keyPath;
+  if (isActive) {
+    console.warn(`⚠️  Warning: "${alias}" is currently the active account. Deleting it will break current Solana config.`);
+  }
+
+ 
+
+  const address = getAddress(alias);
+
+  const prune_confirm = `
+  WARNING: This action will irreversibly erase your local Solana key file of user ${alias}, address(${address}). 
+  Without a valid backup, you will lose permanent access to all funds, assets, and permissions linked to the corresponding account. 
+  Confirm continuation? (yes/no)
+  `
+
+   // 4. 确认删除（简单交互提示）
+  const readline = require('readline').createInterface({
+    input: process.stdin,
+    output: process.stdout
+  });
+
+  let answer = await new Promise((resolve) => {
+    readline.question(chalk.red(prune_confirm), (input) => {
+        resolve(input.trim().toLowerCase());
+      });
+  });
+  readline.close();
+
+
+  if (answer === 'y' || answer === 'yes') {
+    // 执行删除
+    fs.unlinkSync(keyPath);
+    console.log(`✅ Successfully Deleted account: ${alias}`);
+    if (isActive) {
+      console.log('ℹ️  Tip: Use "soluser switch --address <alias>" to set a new active account.');
+    }
+  } else {
+    console.log('❌ Deletion cancelled.');
+  }
+ 
+}
+
+module.exports = pruneAccount;

package/src/commands/remove.js

@@ -1,44 +1,79 @@
-const fs = require('fs');
-const { validateAlias, getKeyFilePath } = require('../utils/path');
-const { getActiveKeyPath } = require('../utils/solana');
-const path = require('path');
-const ThrowErorr = require('../utils/throw_error');
-function removeAccount(alias) {
-  // 1. 验证别名格式
-  validateAlias(alias);
-
-  // 2. 检查密钥文件是否存在
-  const keyPath = getKeyFilePath(alias);
-  if (!fs.existsSync(keyPath)) {
-    ThrowErorr(`Account "${alias}" not found. Use "soluser list" to check existing accounts.`);
-  }
-
-  // 3. 检查是否为当前活跃账号
-  const activeKeyPath = getActiveKeyPath();
-  const isActive = activeKeyPath === keyPath;
-  if (isActive) {
-    console.warn(`⚠️  Warning: "${alias}" is currently the active account. Deleting it will break current Solana config.`);
-  }
-
-  // 4. 确认删除（简单交互提示）
-  const readline = require('readline').createInterface({
+async function confirm(alias){
+  const readline = require('readline');
+ 
+  // 创建 readline 接口用于用户输入
+  const rl = readline.createInterface({
     input: process.stdin,
     output: process.stdout
   });
 
-  readline.question(`Are you sure you want to delete "${alias}"? This will permanently remove the key file (y/N): `, (answer) => {
-    readline.close();
-    if (answer.trim().toLowerCase() === 'y') {
-      // 执行删除
-      fs.unlinkSync(keyPath);
-      console.log(`✅ Successfully deleted account: ${alias}`);
-      if (isActive) {
-        console.log('ℹ️  Tip: Use "soluser switch --address <alias>" to set a new active account.');
-      }
-    } else {
-      console.log('❌ Deletion cancelled.');
+  // 显示警告并等待用户确认
+  console.log(`\x1b[33mWARNING: You are about to remove account "${alias}"!\x1b[0m`);
+  console.log('This will move the account file to backup directory.');
+
+  // const answer = await new Promise((resolve) => {
+  //   rl.question('Are you sure you want to continue? (yes/no): ', (input) => {
+  //     resolve(input.trim().toLowerCase());
+  //   });
+  // });
+  // rl.close();
+
+  // if (answer !== 'yes' && answer !== 'y') {
+  //   console.log('Operation cancelled.');
+  //   return false;
+  // }
+  // return true;
+
+    let answer = await new Promise((resolve) => {
+      rl.question('Are you sure you want to continue? Type "yes" to proceed: ', (input) => {
+          resolve(input.trim().toLowerCase());
+        });
+    });
+    
+    rl.close();
+    if(answer) {
+      answer = answer.trim().toLowerCase();
     }
-  });
+
+    if (answer !== 'yes' && answer !== 'y')  {
+      
+      return false;
+    }
+    return true;
+
 }
 
-module.exports = removeAccount;
+const removeAccount = async (alias) => {
+  const fs = require('fs');
+  const path = require('path');
+ 
+  // 获取当前时间戳
+  const now = new Date();
+  const timestamp = `${now.getFullYear().toString().slice(-2)}${(now.getMonth() + 1).toString().padStart(2, '0')}${now.getDate().toString().padStart(2, '0')}${now.getHours().toString().padStart(2, '0')}${now.getMinutes().toString().padStart(2, '0')}${now.getSeconds().toString().padStart(2, '0')}`;
+  
+  
+  // 确保备份目录存在
+  const backupDir = path.join(require('os').homedir(), '.config', 'solana', 'keys', '.bak');
+  if (!fs.existsSync(backupDir)) {
+    fs.mkdirSync(backupDir, { recursive: true });
+  }
+  
+  // 构造源文件和目标文件路径
+  const sourceFile = path.join(require('os').homedir(), '.config', 'solana', 'keys', `${alias}.json`);
+  const destFile = path.join(backupDir, `${alias}_${timestamp}.json`);
+  
+  if (fs.existsSync(sourceFile)) {
+    const confirmed = await confirm(alias);
+    if (!confirmed) {
+      console.log('Operation cancelled.');
+      return;
+    }
+    fs.renameSync(sourceFile, destFile);
+    console.log(`Removed account "${alias}" from list`);
+  } else {
+    console.error(`Account "${alias}" not found`);
+    process.exit(1);
+  }
+};
+
+module.exports = removeAccount;

package/src/utils/debug.js

@@ -0,0 +1,26 @@
+//const {config}= require('dotenv');
+//config({debug:false});
+
+let debugEnable = false;
+if(process.env.DEBUG){
+    console.log("enable debug logging");
+    debugEnable = true;
+}
+function debug(...args ){
+    if(!debugEnable) return;
+
+    console.error(... args )
+}
+
+function handleError(err){
+    const chalk = require('chalk');
+    
+    console.error(chalk.red(err.message));
+    if(debugEnable) throw err;
+    process.exit(1);
+}
+
+module.exports = {
+    debug,
+    handleError
+}

package/src/utils/example.js

@@ -0,0 +1,60 @@
+const examples = `
+
+## 查看版本
+
+$ soluser --version
+
+
+## 新建账号
+
+$ soluser new  alice 
+$ soluser new  bob --word-length 12
+$ soluser new  charlie --word-length 24 --without-passphrase
+
+
+## 切换账号
+
+$ soluser switch  bob
+
+
+## 列出账号
+
+$ soluser list
+
+
+## 删除账号
+
+$ soluser remove alice
+
+## 查看alias对应的地址
+
+$ soluser address alice
+
+## 查看alias对应的余额
+
+$ soluser balance alice
+
+## airdrop 给alias
+
+$ soluser airdrop 5 alice
+`;
+
+const chalk = require('chalk');
+function getExamples() {
+    let msg = '';  
+    examples.split('\n').forEach(line => {
+        if(line.trim().startsWith('#')){
+            msg += chalk.gray(line.trim()) + '\n';
+        } else if(line.trim().startsWith('$')){
+            msg += chalk.cyan(line.trim()) + '\n';
+        }
+    })
+    console.log(msg);
+}
+
+function showExamples(){
+    console.log(getExamples());
+};
+
+//showExamples();
+module.exports = { getExamples, showExamples };

package/src/utils/execExpectInput.js

@@ -0,0 +1,104 @@
+const { expect } = require('chai');
+const { execSync, spawn } = require('child_process');
+const {debug} =require('./debug');
+const { stdout } = require('process');
+function execExpectInput(inputArgs, prompt , input,expectOut,done){
+
+   return new Promise((resolve, reject) => {
+    const child = spawn('node',inputArgs);
+    const command = "node " + inputArgs.join(" ");
+    debug("execExpectInput command:",command);
+    let output = '';
+    let errMsg = '';
+    
+    child.stdout.on('data', (data) => {
+      //debug("stdout:",data.toString());
+      output += data.toString();
+      if (output.includes(prompt)) {
+        //debug("incluse prompt:",prompt);
+        child.stdin.write( input + '\n');
+      }
+    });
+
+    child.stderr.on('data', (data) => {
+      errMsg += data.toString();
+      output += data.toString();
+    });
+
+    child.on('error', (err) => {
+      reject(err);
+    }); 
+    
+    child.on('close', (code) => {
+
+      try{
+          expect(output).to.include(expectOut);
+          if(done) done(output);
+          debug("execute sucessfuly,command:",command )
+          resolve(output);
+      } catch(err){
+        console.error("error to execute : node ", inputArgs, `output=${output},prompt=${prompt} expectOut: ${expectOut} errMsg=${errMsg}` );
+        reject(err);
+      }
+    });
+  });
+
+}
+
+
+function execExpectOutput(inputArgs, expectOut,finish_callback){
+
+  return new Promise((resolve, reject) => {
+    const child = spawn('node',inputArgs);
+
+    let output = '';
+    let errMsg = '';
+    child.stdout.resume();
+    child.stdout.on('data', (data) => {
+      output += data.toString();
+    });
+
+    child.stderr.on('data', (data) => {
+      errMsg += data.toString();
+      output += data.toString();
+    });
+
+    
+    
+    child.on('close', (code) => {
+      try{
+        //debug("output :",output);
+        //debug("code",code);
+        if(expectOut) expect(output).to.include(expectOut);
+        if(finish_callback) finish_callback(output);
+        debug("execute sucessfuly,command:",command )
+        
+        resolve(output);
+      } catch(err){
+        console.error("error to execute : node ", inputArgs, `output=${output}, expectOut: ${expectOut}  errMsg=${errMsg}` );
+        reject(err);
+      }
+    });
+    const command = "node " + inputArgs.join(" ");
+    debug("execExpectOutput command:",command);
+  });
+
+}
+
+
+function execExpectOutputOld(inputArgs, expectOut,finish_callback){
+    let command = "node " + inputArgs.join(" ");
+    debug("command:",command);
+    let out = execSync(command)
+    try{
+        if(expectOut) expect(output).to.include(expectOut);
+        if(finish_callback) finish_callback(output);
+    } catch(err){
+      console.error("error to execute : node ",  `command:${command}, expectOut: ${expectOut}` );
+      throw err;
+    }
+
+}
+
+
+module.exports =  {execExpectInput,execExpectOutput};