@yerofey/cryptowallet-cli 1.6.1 → 1.7.0

package/README.md

@@ -7,15 +7,24 @@
 ---
 
 ## Install
+
 ```bash
+# via NPM
+$ npm i -g @yerofey/cryptowallet-cli
+
+# via PNPM
+$ pnpm add -g @yerofey/cryptowallet-cli
+
 # via Yarn
 $ yarn global add @yerofey/cryptowallet-cli
 
-# or via NPM
-$ npm i -g @yerofey/cryptowallet-cli
+# via Homebrew
+$ brew tap yerofey/cryptowallet && brew install cryptowallet
+# (it is building from scratch, so might took a while - like a minute or so)
 ```
 
 ## Usage
+
 ```bash
 # generate random ERC-like wallet (ETH, BNB, POLYGON, ...)
 $ cw
@@ -64,72 +73,77 @@ $ 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)
-
-*\*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)*
+
+-   `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
+
+-   `-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
-- [x] v16.12.0
-* NPM
-- [x] v8.1.0
-* Yarn
-- [x] v1.23.0
+
+-   Node.js
+
+*   [x] v16.12.0
+*   [x] v16.16.0
 
 ## 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
+
 [MIT](https://github.com/yerofey/cryptowallet-cli/blob/master/LICENSE)

package/cli.js

@@ -1,49 +1,67 @@
 #!/usr/bin/env node
 'use strict';
 
-const { program } = require('commander');
-const chalk = require('chalk');
-const { log, supportedChains } = require('./src/utils');
-const Method = require('./src/Method');
+import { program } from 'commander';
+import chalk from 'chalk';
+import { log, supportedChains } from './src/utils.js';
+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('-f, --format <format>', 'Wallet format type (for cryptos with multiple wallet formats)');
-program.option('-F, --filename <filename>', 'Filename to output the data (works with -o argument)');
+program.option(
+  '-f, --format <format>',
+  'Wallet format type (for cryptos with multiple wallet formats)'
+);
+program.option(
+  '-F, --filename <filename>',
+  'Filename to output the data (works with -o argument)'
+);
 program.option('-g, --geek', 'Display some more info (geeky)');
 program.option('-l, --list', 'List all supported cryptos');
-program.option('-m, --mnemonic [mnemonic]', 'Generate wallet from mnemonic string OR just a mnemonic string');
-program.option('-n, --number <number>', 'Number of wallets to generate (if supported)');
+program.option(
+  '-m, --mnemonic [mnemonic]',
+  'Generate wallet from mnemonic string OR just a mnemonic string'
+);
+program.option(
+  '-n, --number <number>',
+  'Number of wallets to generate (if supported)'
+);
 program.option('-o, --output <format>', 'Return results into some file');
 program.option('-p, --prefix <prefix>', 'Desired wallet prefix');
-program.option('-P, --prefix-sensitive <prefix>', 'Desired wallet prefix (case-sensitive)');
+program.option(
+  '-P, --prefix-sensitive <prefix>',
+  'Desired wallet prefix (case-sensitive)'
+);
 program.option('-s, --suffix <suffix>', 'Desired wallet suffix');
-program.option('-S, --suffix-sensitive <suffix>', 'Desired wallet suffix (case-sensitive)');
+program.option(
+  '-S, --suffix-sensitive <suffix>',
+  'Desired wallet suffix (case-sensitive)'
+);
 program.option('-v, --version', 'Display cryptowallet version');
 program.parse();
 
 (async () => {
-    const options = program.opts();
-    
-    if (options.list !== undefined) {
-        return new Method('list').init();
-    }
-
-    if (options.mnemonic == true) {
-        return new Method('mnemonic').init();
-    }
-
-    if (options.version) {
-        return new Method('version').init();
-    }
-
-    const chain = (options.chain).toUpperCase() || '';
-    if (supportedChains.includes(chain)) {
-        return new Method('wallet', {
-            chain,
-            options,
-        }).init();
-    }
-
-    log(chalk.red('⛔️  Error: this blockchain is not supported!'));
+  const options = program.opts();
+
+  if (options.list !== undefined) {
+    return new Method('list').init();
+  }
+
+  if (options.mnemonic == true) {
+    return new Method('mnemonic').init();
+  }
+
+  if (options.version) {
+    return new Method('version').init();
+  }
+
+  const chain = options.chain.toUpperCase() || '';
+  if (supportedChains.includes(chain)) {
+    return new Method('wallet', {
+      chain,
+      options,
+    }).init();
+  }
+
+  log(chalk.red('⛔️  Error: this blockchain is not supported!'));
 })();

package/package.json

@@ -1,16 +1,20 @@
 {
   "name": "@yerofey/cryptowallet-cli",
-  "version": "1.6.1",
+  "version": "1.7.0",
+  "type": "module",
   "homepage": "https://github.com/yerofey/cryptowallet-cli",
   "author": "Yerofey S. <pm@yerofey.dev> (https://github.com/yerofey)",
+  "license": "MIT",
   "bin": {
     "cryptowallet": "cli.js",
     "cw": "cli.js"
   },
   "engines": {
-    "node": ">=6"
+    "node": ">=14.13.1"
   },
   "scripts": {
+    "build:release": "./bin/generate.sh",
+    "lint": "pnpm exec eslint src/*.js",
     "test": "ava"
   },
   "files": [
@@ -54,27 +58,27 @@
     "bip39",
     "bip84"
   ],
-  "license": "MIT",
   "dependencies": {
-    "@binance-chain/javascript-sdk": "^4.1.1",
+    "@binance-chain/javascript-sdk": "^4.2.0",
     "@harmony-js/account": "^0.1.57",
     "@yerofey/dogecoin-bip84": "^0.0.5",
     "@yerofey/litecoin-bip84": "^0.0.5",
     "bip39": "3.0.4",
-    "bip84": "0.2.6",
-    "chalk": "4.1.2",
-    "coininfo": "5.1.0",
+    "bip84": "0.2.7",
+    "chalk": "5.0.1",
+    "coininfo": "5.2.1",
     "coinkey": "3.0.0",
-    "columnify": "1.5.4",
-    "commander": "8.1.0",
+    "columnify": "1.6.0",
+    "commander": "9.4.0",
     "csv-writer": "^1.6.0",
     "eth-lib": "0.1.29",
     "ethereum-bip84": "0.0.3",
     "ethereum-mnemonic-privatekey-utils": "1.0.5",
     "tezos-sign": "1.4.1",
-    "tronweb": "4.0.0"
+    "tronweb": "4.4.0"
   },
   "devDependencies": {
-    "ava": "^3.15.0"
+    "ava": "^4.3.3",
+    "eslint": "^8.24.0"
   }
 }

package/src/CW.js

@@ -1,42 +1,45 @@
-const Chain = require('./Chain');
-const { Wallet } = require('./Wallet');
+import Chain from './Chain.js';
+import { Wallet } from './Wallet.js';
 
 class CW {
-    constructor(chain, options = {}) {
-        const defaultValues = {
-            chain: chain || options.chain || '',
-            filename: 'output',
-            format: '',
-            geek: false,
-            mnemonic: '',
-            number: 1,
-            output: undefined,
-            prefix: options.prefixSensitive || '',
-            prefixIsCaseSensitive: options.prefixSensitive !== undefined,
-            suffix: options.suffixSensitive || '',
-            suffixIsCaseSensitive: options.suffixSensitive !== undefined,
-        }
-
-        for (const key of Object.keys(defaultValues)) {
-            if (!options.hasOwnProperty(key)) {
-                options[key] = defaultValues[key];
-            }
-        }
-
-        this.chain = chain;
-        this.options = options;
-        this.row = new Chain(chain, options.format).row;
+  constructor(chain, options = {}) {
+    const defaultValues = {
+      chain: chain || options.chain || '',
+      filename: 'output',
+      format: '',
+      geek: false,
+      mnemonic: '',
+      number: 1,
+      output: undefined,
+      prefix: options.prefixSensitive || '',
+      prefixIsCaseSensitive: options.prefixSensitive !== undefined,
+      suffix: options.suffixSensitive || '',
+      suffixIsCaseSensitive: options.suffixSensitive !== undefined,
+    };
+
+    for (const key of Object.keys(defaultValues)) {
+      // eslint-disable-next-line no-prototype-builtins
+      if (!options.hasOwnProperty(key)) {
+        options[key] = defaultValues[key];
+      }
     }
 
-    async init() {
-        const w = await new Wallet(this).init();
-        
-        for (const key of Object.keys(w)) {
-            this[key] = w[key];
-        }
+    this.chain = chain;
+    this.options = options;
+  }
+
+  async init() {
+    const chainData = await new Chain(this.chain, this.options.format).init();
+    this.row = chainData.row || {};
 
-        return this;
+    const w = await new Wallet(this).init();
+
+    for (const key of Object.keys(w)) {
+      this[key] = w[key];
     }
+
+    return this;
+  }
 }
 
-module.exports = CW;
+export default CW;

package/src/Chain.js

@@ -1,28 +1,37 @@
+import { loadJson } from './utils.js';
+
 class Chain {
-    constructor(chain, format) {
-        const content = require('./chains/' + chain + '.json') || {};
-        const data = (() => {
-            if (content.formats !== undefined) {
-                if (format != '' && format != content.defaultFormat) {
-                    // case-insensitive format
-                    for (const key of Object.keys(content.formats)) {
-                        if (format.toLowerCase() == key.toLowerCase()) {
-                            return content.formats[key];
-                        }
-                    }
-                }
-    
-                return content.formats[content.defaultFormat];
-            }
+  constructor(chain, format) {
+    this.chain = chain;
+    this.format = format;
+  }
 
-            return content;
-        })();
-        
-        this.row = {
-            ...content,
-            ...data
+  async init() {
+    const content = await loadJson(`./chains/${this.chain}.json`);
+    const data = (() => {
+      if (content.formats !== undefined) {
+        if (this.format != '' && this.format != content.defaultFormat) {
+          // case-insensitive format
+          for (const key of Object.keys(content.formats)) {
+            if (this.format.toLowerCase() == key.toLowerCase()) {
+              return content.formats[key];
+            }
+          }
         }
-    }
+
+        return content.formats[content.defaultFormat];
+      }
+
+      return content;
+    })();
+
+    this.row = {
+      ...content,
+      ...data,
+    };
+
+    return this;
+  }
 }
 
-module.exports = Chain;
+export default Chain;