@yerofey/cryptowallet-cli 1.7.5 → 1.8.0

package/README.md

@@ -1,5 +1,4 @@
 # cryptowallet-cli
-
 > Crypto wallet generator CLI tool (currently works only on Mac and Linux, sorry Windows users)
 
 ![Screenshot](https://i.imgur.com/uWuT4lF.png)
@@ -7,7 +6,6 @@
 ---
 
 ## Install
-
 ```bash
 # via NPM
 $ npm i -g @yerofey/cryptowallet-cli
@@ -20,7 +18,6 @@ $ yarn global add @yerofey/cryptowallet-cli
 ```
 
 ## Usage
-
 ```bash
 # generate random ERC-like wallet (ETH, BNB, POLYGON, ...)
 $ cw
@@ -58,8 +55,11 @@ $ cw -c BNB -f BEP2 -m "radio bright pizza pluck family crawl palm flame forget
 # generate BNB (BEP20) wallet from mnemonic string
 $ cw -c BNB -f BEP20 -m "radio bright pizza pluck family crawl palm flame forget focus stock stadium"
 
-# generate few wallets and save the output into a file
-$ cw -c btc -n 10 -o csv -F out.csv
+# generate wallet and save the output into CSV file ("cw-output.csv" by default)
+$ 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
@@ -69,77 +69,70 @@ $ cw -l
 ```
 
 ## Blockchains supported
-
--   `BTC` (Bitcoin) [legacy, segwit, bech32]
--   `ETH` (Ethereum)
--   `BNB` (Binance Coin) [BEP2, BEP20, ERC20]
--   `DOGE` (Dogecoin) [legacy, segwit, bech32]
--   `BCH` (Bitcoin Cash)
--   `LTC` (Litecoin) [legacy, segwit, bech32]
--   `POLYGON` (Polygon)
--   `TRX` (Tron)
--   `XTZ` (Tezos)
--   `DASH` (Dash)
--   `DCR` (Decred)
--   `ZEC` (Zcash)
--   `QTUM` (Qtum)
--   `BTG` (Bitcoin Gold)
--   `ONE` (Harmony)
--   `DGB` (DigiByte)
--   `RDD` (ReddCoin)
--   `VTC` (Vertcoin)
--   `MONA` (MonaCoin)
--   `NMC` (NameCoin)
--   `PPC` (PeerCoin)
--   `BLK` (BlackCoin)
--   `VIA` (Viacoin)
--   `NBT` (NIX Bridge Token)
-
+- `BTC` (Bitcoin) [legacy, segwit, bech32]
+- `ETH` (Ethereum)
+- `BNB` (Binance Coin) [BEP2, BEP20, ERC20]
+- `DOGE` (Dogecoin) [legacy, segwit, bech32]
+- `BCH` (Bitcoin Cash)
+- `LTC` (Litecoin) [legacy, segwit, bech32]
+- `POLYGON` (Polygon)
+- `TRX` (Tron)
+- `XTZ` (Tezos)
+- `DASH` (Dash)
+- `DCR` (Decred)
+- `ZEC` (Zcash)
+- `QTUM` (Qtum)
+- `BTG` (Bitcoin Gold)
+- `ONE` (Harmony)
+- `DGB` (DigiByte)
+- `RDD` (ReddCoin)
+- `VTC` (Vertcoin)
+- `MONA` (MonaCoin)
+- `NMC` (NameCoin)
+- `PPC` (PeerCoin)
+- `BLK` (BlackCoin)
+- `VIA` (Viacoin)
+- `NBT` (NIX Bridge Token)
 _\*all other cryptos that are tokens in the ecosystems like Ethereum, Binance Smart Chain or Polygon and others (EVM compatible) are supported too, you just need to create ERC wallet (that is set by default)_
 
 ## Options
-
--   `-b` or `-c` or `--chain`: Specify the blockchain ticker to generate a wallet for
--   `-f` or `--format`: Specify the blockchain wallet format (for BTC: legacy, segwit, bech32)
--   `-F` or `--filename`: Specify a filename (without extension) to output the data (works only with `-o` argument)
--   `-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
--   `-n` or `--number`: Specify number of wallets to display (works for HD wallets only, like BTC/LTC/DOGE)
--   `-o` or `--output`: Specify a file format (currently only `csv` supported) to output the generated data
--   `-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**)
--   `-s` or `--suffix`: Specify desired suffix for the wallet address (**case-insensitive**)
--   `-S` or `--suffix-sensitive`: Specify desired suffix for the wallet address (**case-sensitive**)
--   `-v` or `--version`: Display current version of CW tool
-
-## Tested setups
-
--   Node.js
-
-*   [x] v16.12.0
-*   [x] v16.16.0
+- `-b` or `-c` or `--chain`: Specify the blockchain ticker to generate a wallet for
+- `-f` or `--format`: Specify the blockchain wallet format (for BTC: legacy, segwit, bech32)
+- `-F` or `--filename`: Specify a filename (without extension) to output the data (works only with `-o` argument)
+- `-D` or `--csv`: Save output into CSV file with custom or default name ("`cw-output.csv`") - this is a shorthand for `-o csv -F filename`
+- `-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
+- `-n` or `--number`: Specify number of wallets to display (works for HD wallets only, like BTC/LTC/DOGE)
+- `-o` or `--output`: Specify a file format (currently only `csv` supported) to output the generated data
+- `-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**)
+- `-s` or `--suffix`: Specify desired suffix for the wallet address (**case-insensitive**)
+- `-S` or `--suffix-sensitive`: Specify desired suffix for the wallet address (**case-sensitive**)
+- `-v` or `--version`: Display current version of CW tool
+
+## Node.js supported versions
+- ✅ v16.0-v16.x
+- ⛔ v17.x-v18.x
 
 ## Highlights
-
--   24+ blockchains supported
--   Generate wallet with desired prefix/suffix
--   Generate wallet from mnemonic
--   Generate just a mnemonic
--   Works fully offline
+- 24+ blockchains supported
+- Generate wallet with desired prefix/suffix
+- Generate wallet from mnemonic
+- Generate just a mnemonic
+- Works fully offline
 
 ## TODO
-
--   Windows support
--   Show SegWit Bech32 BTC change addresses with additional flag
--   SegWit Bech32 wallet address support for all Bitcoin forks
--   More EVM compatible cryptos
--   tests
+- Windows support
+- Show SegWit Bech32 BTC change addresses with additional flag
+- SegWit Bech32 wallet address support for all Bitcoin forks
+- More EVM compatible cryptos
+- tests
 
 ## Author
-
 [Yerofey S.](https://github.com/yerofey)
 
-## License
+Contact me: [Email](mailto:pm@yerofey.dev), [Telegram](https://t.me/cryptofey)
 
+## License
 [MIT](https://github.com/yerofey/cryptowallet-cli/blob/master/LICENSE)

package/cli.js

@@ -8,6 +8,10 @@ import Method from './src/Method.js';
 
 program.option('-b, --chain <ticker>', 'Wallet for specific blockchain', 'ERC');
 program.option('-c, --chain <ticker>', 'Wallet for specific blockchain', 'ERC');
+program.option(
+  '-D, --csv [filename]',
+  'Save result into CSV file'
+);
 program.option(
   '-f, --format <format>',
   'Wallet format type (for cryptos with multiple wallet formats)'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yerofey/cryptowallet-cli",
-  "version": "1.7.5",
+  "version": "1.8.0",
   "type": "module",
   "homepage": "https://github.com/yerofey/cryptowallet-cli",
   "author": "Yerofey S. <pm@yerofey.dev> (https://github.com/yerofey)",
@@ -10,10 +10,9 @@
     "cw": "cli.js"
   },
   "engines": {
-    "node": ">=14.13.1"
+    "node": ">=16.0.0 <17.0.0"
   },
   "scripts": {
-    "build:release": "./bin/generate.sh",
     "lint": "pnpm exec eslint src/*.js",
     "test": "ava"
   },
@@ -56,7 +55,10 @@
     "trust-wallet",
     "tronlink",
     "bip39",
-    "bip84"
+    "bip84",
+    "multiple wallets",
+    "crypto wallets",
+    "wallet generation"
   ],
   "dependencies": {
     "@binance-chain/javascript-sdk": "^4.2.0",

package/src/CW.js

@@ -3,9 +3,18 @@ import { Wallet } from './Wallet.js';
 
 class CW {
   constructor(chain, options = {}) {
+    const csvFilename = 'cw-output';
+    if (options.csv !== undefined) {
+      options.output = 'csv';
+
+      if (typeof options.csv === 'string' && (options.csv).length > 0) {
+        options.filename = options.csv;
+      }
+    }
+
     const defaultValues = {
       chain: chain || options.chain || '',
-      filename: 'output',
+      filename: csvFilename,
       format: '',
       geek: false,
       mnemonic: '',

package/src/Method.js

@@ -176,8 +176,8 @@ class Method {
             linesCount += 1;
           }
           // addresses
-          for (const item of cw.wallet.addresses) {
-            if (displayAsText) {
+          if (displayAsText) {
+            for (const item of cw.wallet.addresses) {
               if (cw.wallet.addresses.length > 1) {
                 log();
                 log(`🆔  ${item.index}`);
@@ -241,22 +241,9 @@ class Method {
                 log(`👛  ${item.address}`);
               }
               log(`🔑  ${item.privateKey}`);
-            } else {
-              // const createCsvWriter = csvWriter.createObjectCsvWriter;
-              // const csvWriter = createCsvWriter({
-              //     path: 'out.csv',
-              //     header: [
-              //       {id: 'name', title: 'Name'},
-              //       {id: 'surname', title: 'Surname'},
-              //       {id: 'age', title: 'Age'},
-              //       {id: 'gender', title: 'Gender'},
-              //     ]
-              //   });
-              // // TODO: build output into file
-              // log('TODO_BUILD_OUTPUT_INTO_FILE', item.address);
+
             }
-          }
-          if (!displayAsText) {
+          } else {
             outputData.wallets = cw.wallet.addresses;
           }
 
@@ -268,7 +255,7 @@ class Method {
 
           // generate csv
           if (!displayAsText) {
-            const filename = cw.options.filename.split('.')[0] || 'output';
+            const filename = cw.options.csvOutputFilename || cw.options.filename.split('.')[0] || 'cw-output';
             // eslint-disable-next-line no-undef
             const createCsvWriter = CsvWriter.createObjectCsvWriter;
             const csvWriter = createCsvWriter({
@@ -295,7 +282,7 @@ class Method {
                   `${linesCount > 0 ? '\n' : ''}🟠  ${yellow(
                     `Don't forget to save the data above manually, because it is not in the output file`
                   )} \n✨  ${green('Done!')} ${blueBright(
-                    `The output successfully saved into "${filename}.csv" file`
+                    `The output successfully saved into "./${filename}.csv" file`
                   )}`
                 )
               )