@yerofey/cryptowallet-cli 1.16.2 → 1.17.1

package/README.md

@@ -43,6 +43,16 @@ $ cw
 # generate random BTC wallet (default format: bech32 - "bc1q...")
 $ cw -c btc
 
+# generate random mnemonic string (12 words) to import in any wallet app
+$ cw -m
+
+# generate random mnemonic string of a specific length (12, 18, or 24 words)
+$ cw -m 18
+$ cw -m 24
+
+# generate a wallet from a given mnemonic string
+$ cw -m "radio bright pizza pluck family crawl palm flame forget focus stock stadium"
+
 # generate N random wallets (default coin is ETH/ERC-like)
 $ cw -n 10
 
@@ -88,9 +98,6 @@ $ cw -c btc --csv
 # generate few wallets and save the output into CSV file with custom name "new.csv"
 $ cw -c btc -n 10 -D new
 
-# generate just a mnemonic string (12 words) to import in any wallet app
-$ cw -m
-
 # list all supported blockchains
 $ cw -l
 ```
@@ -133,7 +140,12 @@ $ cw -l
 - `-f` or `--format`: Specify the blockchain wallet format (for BTC: legacy, segwit, bech32)
 - `-g` or `--geek`: Display some additional "geeky" info
 - `-l` or `--list`: List all supported blockchains
-- `-m` or `--mnemonic`: Use a bip39 mnemonic phrase (if is set) to generate wallet, or leave it empty to generate new one
+- `-m` or `--mnemonic [value]`: If used without a value or with `12`, `18`, or `24`, it generates a mnemonic string of that length. If a mnemonic string is provided, it generates a wallet from the given mnemonic. For example:
+  - `$ cw -m`: Generates a default 12-word mnemonic string.
+  - `$ cw -m 12`: Generates a 12-word mnemonic string.
+  - `$ cw -m 18`: Generates an 18-word mnemonic string.
+  - `$ cw -m 24`: Generates a 24-word mnemonic string.
+  - `$ cw -m "your mnemonic phrase here"`: Generates a wallet from the provided mnemonic string.
 - `-n` or `--number`: Specify number of wallets to display (works for HD wallets only, like BTC/LTC/DOGE)
 - `-p` or `--prefix`: Specify desired prefix for the wallet address (**case-insensitive**)
 - `-P` or `--prefix-sensitive`: Specify desired prefix of the wallet address (**case-sensitive**)

package/cli.js

@@ -11,8 +11,9 @@ import Method from './src/Method.js';
     return new Method('list').init();
   }
 
-  if (options.mnemonic == true) {
-    return new Method('mnemonic').init();
+  // generate mnemonic string if no argument is passed or only the mnemonic length is passed
+  if (options.mnemonic === true || options.mnemonic === '' || options.mnemonic.split(' ').length === 1) {
+    return new Method('mnemonic').init({ mnemonic: options.mnemonic });
   }
 
   if (options.version) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yerofey/cryptowallet-cli",
-  "version": "1.16.2",
+  "version": "1.17.1",
   "description": "Crypto wallet generator CLI tool",
   "type": "module",
   "homepage": "https://github.com/yerofey/cryptowallet-cli",
@@ -19,7 +19,6 @@
   },
   "scripts": {
     "lint": "pnpm exec eslint src/*.js",
-    "postinstall": "cw --donate",
     "test": "ava"
   },
   "files": [

package/src/Method.js

@@ -19,6 +19,7 @@ class Method {
     this.name = name;
     this.params = params;
     this.callMethods = this._initializeMethods();
+    this.inputOptions = {};
   }
 
   _initializeMethods() {
@@ -61,16 +62,23 @@ class Method {
   }
 
   _mnemonic() {
+    const mnemonic = this.inputOptions.mnemonic || '12';
+    const mnemonicLength = ['12', '18', '24'].includes(mnemonic)
+      ? parseInt(mnemonic, 10)
+      : 12;
+
     log(
       `✨  ${green('Done!')} ${blueBright(
-        'Here is your randomly generated 12 words mnemonic string:'
+        `Here is your randomly generated ${
+          mnemonicLength || 12
+        } words mnemonic string:`
       )}\n`
     );
-    log(`📄  ${generateMnemonicString()}`);
+    log(`📄  ${generateMnemonicString(mnemonicLength)}`);
     log();
     log(
       greenBright(
-        'ℹ️   You can import this wallet into MetaMask, Trust Wallet and many other wallet apps'
+        'ℹ️   You can import it into your favorite wallet app or use it to generate a wallet with "-m" flag'
       )
     );
   }
@@ -349,7 +357,7 @@ class Method {
       if (cw.row.network == 'EVM' || false) {
         log(
           yellow(
-            '🆒  You can use this wallet in Ethereum, Binance Smart Chain, Polygon and few more networks (EVM compatible)'
+            '🆒  You can use this wallet in Ethereum, Binance Smart Chain, Polygon and many others networks (EVM compatible)'
           )
         );
       }
@@ -381,7 +389,11 @@ class Method {
 
       // donation
       log();
-      log(blueBright('🙏  Consider supporting the project - see donation options with: cw --donate'));
+      log(
+        blueBright(
+          '🙏  Consider supporting the project - see donation options with: cw --donate'
+        )
+      );
     }
   }
 
@@ -409,7 +421,8 @@ class Method {
     `);
   }
 
-  async init() {
+  async init(inputOptions = {}) {
+    this.inputOptions = inputOptions;
     return (this.callMethods[this.name] || this.callMethods['_'])();
   }
 }

package/src/Wallet.js

@@ -18,12 +18,20 @@ import pkutils from 'ethereum-mnemonic-privatekey-utils';
 import bCrypto from '@binance-chain/javascript-sdk/lib/crypto/index.js';
 import tronWeb from 'tronweb';
 import tezos from 'tezos-sign';
-import { Keypair as SolanaKeypair, PublicKey as SolanaPublickey } from '@solana/web3.js';
+import {
+  Keypair as SolanaKeypair,
+  PublicKey as SolanaPublickey,
+} from '@solana/web3.js';
 import bs58 from 'bs58';
-import { TonClient, WalletContractV4, internal as TonInternal } from "@ton/ton";
-import { mnemonicNew as newTonMnemonic, mnemonicToPrivateKey as TonMnemonicToPrivateKey } from "@ton/crypto";
+import { TonClient, WalletContractV4, internal as TonInternal } from '@ton/ton';
+import {
+  mnemonicNew as newTonMnemonic,
+  mnemonicToPrivateKey as TonMnemonicToPrivateKey,
+} from '@ton/crypto';
 const { red } = chalk;
 
+const supportedMnemonicLengths = [12, 18, 24];
+
 class Wallet {
   constructor(cw) {
     this.cw = cw;
@@ -246,7 +254,17 @@ class Wallet {
     const options = cw.options;
 
     let format = options.format || '';
-    let mnemonicString = options.mnemonic || '';
+    const mnemonic = options.mnemonic || '';
+    let mnemonicLength = 12;
+    let mnemonicString = '';
+    const mnemonicWordsCount = (mnemonic.split(' ') || []).length || 0;
+    if (mnemonicWordsCount == 1) {
+      const mnemonicInput = parseInt(mnemonic.split(' ')[0], 10);
+      mnemonicLength = supportedMnemonicLengths.includes(mnemonicInput) ? mnemonicInput : 12;
+    } else {
+      mnemonicString = mnemonic;
+      mnemonicLength = mnemonicWordsCount;
+    }
     let number = options.number || 1;
     let result = {};
 
@@ -338,7 +356,7 @@ class Wallet {
       }
 
       let addresses = [];
-      const mnemonic = mnemonicString || bip39.generateMnemonic();
+      const mnemonic = mnemonicString || generateMnemonicString(mnemonicLength);
 
       if (number == 1) {
         const privateKey = bCrypto.getPrivateKeyFromMnemonic(mnemonic, true, 0);
@@ -375,7 +393,7 @@ class Wallet {
       }
 
       let addresses = [];
-      const mnemonic = mnemonicString || bip39.generateMnemonic();
+      const mnemonic = mnemonicString || generateMnemonicString(mnemonicLength);
       const privateKey = pkutils.getPrivateKeyFromMnemonic(mnemonic);
 
       if (number == 1) {
@@ -448,22 +466,25 @@ class Wallet {
         ],
       });
     } else if (chain == 'TON') {
-      // Create a new TON client
-      // const client = new TonClient({
-      //   endpoint: 'https://toncenter.com/api/v2/jsonRPC',
-      // });
       // Generate new mnemonics and derive key pair
-      const mnemonics = await newTonMnemonic();
+      let mnemonics;
+      if (mnemonicString != '' && !bip39.validateMnemonic(mnemonicString)) {
+        mnemonics = mnemonicString.split(' ');
+      } else {
+        mnemonics = await newTonMnemonic(); // array of 24 words
+        mnemonicString = mnemonics.join(' ');
+      }
       const keyPair = await TonMnemonicToPrivateKey(mnemonics);
       // Define the workchain (usually 0)
       const workchain = 0;
       // Create a new wallet contract instance
-      const wallet = WalletContractV4.create({ workchain, publicKey: keyPair.publicKey });
-      // const contract = client.open(wallet);
+      const wallet = WalletContractV4.create({
+        workchain,
+        publicKey: keyPair.publicKey,
+      });
       // Get the wallet address
       const address = wallet.address.toString();
 
-      // TODO: add support for multiple addresses
       // TODO: add support for new UQ address format
 
       Object.assign(result, {
@@ -473,7 +494,7 @@ class Wallet {
             address,
           },
         ],
-        mnemonic: mnemonics.join(' '),
+        mnemonic: mnemonicString,
       });
     } else if (chain == 'TRX') {
       try {
@@ -521,8 +542,27 @@ class Wallet {
   }
 }
 
-function generateMnemonicString() {
-  return bip39.generateMnemonic();
+function generateMnemonicString(length = 12) {
+  let entropy;
+  switch (length) {
+    case 12:
+      entropy = 128;
+      break;
+    case 18:
+      entropy = 192;
+      break;
+    case 24:
+      entropy = 256;
+      break;
+    default:
+      throw new Error(
+        'Invalid mnemonic length. Supported lengths are 12, 18, or 24.'
+      );
+  }
+
+  // Generate the mnemonic based on the specified entropy
+  const mnemonic = bip39.generateMnemonic(entropy);
+  return mnemonic;
 }
 
 export { generateMnemonicString, Wallet };