Merge pull request #85 from shapeshift/rfox-dir-flag

cli/MultiSig.md

@@ -21,50 +21,50 @@ TAG=mainnet,cgo,ledger make install
 
 - Add your key:
   ```bash
-  ./thornode keys add {person1} --ledger
+  thornode keys add {person1} --ledger
   ```
 - Export pubkey:
   ```bash
-  ./thornode keys show {person1} --pubkey
+  thornode keys show {person1} --pubkey
   ```
 - Import signer pubkeys (ex. `'{"@type":"/cosmos.crypto.secp256k1.PubKey","key":"someKeyValue}'`):
   ```bash
-  ./thornode keys add {person2} --pubkey '{person2_pubkey}'
-  ./thornode keys add {person3} --pubkey '{person3_pubkey}'
+  thornode keys add {person2} --pubkey '{person2_pubkey}'
+  thornode keys add {person3} --pubkey '{person3_pubkey}'
   ```
 - View keys:
   ```bash
-  ./thornode keys list
+  thornode keys list
   ```
 - Add multisig key:
   ```bash
-  ./thornode keys add multisig --multisig {person1},{person2},{person3} --multisig-threshold 2
+  thornode keys add multisig --multisig {person1},{person2},{person3} --multisig-threshold 2
   ```
 - Validate multisig address:
   ```bash
-  ./thornode keys show multisig --address
+  thornode keys show multisig --address
   ```
 
 ## Sign Transaction
 
 - Person 1 signs:
   ```bash
-  ./thornode tx sign --from {person1} --multisig multisig ~/rfox/unsignedTx_epoch-{N}.json --chain-id thorchain-mainnet-v1 --node https://daemon.thorchain.shapeshift.com:443/rpc --ledger --sign-mode amino-json > ~/rfox/signedTx_epoch-{N}_{person1}.json
+  thornode tx sign --from {person1} --multisig multisig ~/rfox/unsignedTx_epoch-{N}.json --chain-id thorchain-mainnet-v1 --node https://daemon.thorchain.shapeshift.com:443/rpc --ledger --sign-mode amino-json > ~/rfox/signedTx_epoch-{N}_{person1}.json
   ```
 - Person 2 signs:
   ```bash
-  ./thornode tx sign --from {person2} --multisig multisig ~/rfox/unsignedTx_epoch-{N}.json --chain-id thorchain-mainnet-v1 --node https://daemon.thorchain.shapeshift.com:443/rpc --ledger --sign-mode amino-json > ~/rfox/signedTx_epoch-{N}_{person2}.json
+  thornode tx sign --from {person2} --multisig multisig ~/rfox/unsignedTx_epoch-{N}.json --chain-id thorchain-mainnet-v1 --node https://daemon.thorchain.shapeshift.com:443/rpc --ledger --sign-mode amino-json > ~/rfox/signedTx_epoch-{N}_{person2}.json
   ```
 - Multisign:
   ```bash
-  ./thornode tx multisign ~/rfox/unsignedTx_epoch-{N}.json multisig ~/rfox/signedTx_epoch-{N}_{person1}.json ~/rfox/signedTx_epoch-{N}_{person2}.json --from multisig --chain-id thorchain-mainnet-v1 --node https://daemon.thorchain.shapeshift.com:443/rpc > ~/rfox/signedTx_epoch-{N}_multisig.json
+  thornode tx multisign ~/rfox/unsignedTx_epoch-{N}.json multisig ~/rfox/signedTx_epoch-{N}_{person1}.json ~/rfox/signedTx_epoch-{N}_{person2}.json --from multisig --chain-id thorchain-mainnet-v1 --node https://daemon.thorchain.shapeshift.com:443/rpc > ~/rfox/signedTx_epoch-{N}_multisig.json
   ```
 
 ## Send Transaction
 
 - Broadcast transaction:
   ```bash
-  ./thornode tx broadcast ~/rfox/signedTx_epoch-{N}_multisig.json --chain-id thorchain-mainnet-v1 --node https://daemon.thorchain.shapeshift.com:443/rpc --gas auto > tx.json
+  thornode tx broadcast ~/rfox/signedTx_epoch-{N}_multisig.json --chain-id thorchain-mainnet-v1 --node https://daemon.thorchain.shapeshift.com:443/rpc --gas auto > tx.json
   ```
 
 At this point, the cli should pick up the funding transaction and continue running the distribution from the hot wallet.

cli/package.json

@@ -22,6 +22,7 @@
     "bignumber.js": "^9.1.2",
     "bip39": "^3.1.0",
     "chalk": "^5.3.0",
+    "commander": "^12.1.0",
     "dotenv": "^16.4.5",
     "hash-wasm": "^4.11.0",
     "log-symbols": "^6.0.0",

cli/src/constants.ts

@@ -1,7 +1,3 @@
-import os from 'node:os'
-import path from 'node:path'
-
-export const RFOX_DIR = path.join(os.homedir(), 'rfox')
 export const RFOX_REWARD_RATE = 1n * 10n ** 27n
 
 export const MONTHS = [

cli/src/file.ts

@@ -1,6 +1,6 @@
 import fs from 'node:fs'
-import { RFOX_DIR } from './constants'
 import { error, info, warn } from './logging'
+import { RFOX_DIR } from '.'
 
 const deleteIfExists = (file: string) => {
   try {

cli/src/index.ts

@@ -2,16 +2,28 @@ import 'dotenv/config'
 import * as prompts from '@inquirer/prompts'
 import BigNumber from 'bignumber.js'
 import fs from 'node:fs'
+import os from 'node:os'
 import path from 'node:path'
 import ora from 'ora'
 import { Client } from './client'
-import { MONTHS, RFOX_DIR } from './constants'
+import { MONTHS } from './constants'
 import { isEpochDistributionStarted } from './file'
 import { IPFS } from './ipfs'
 import { error, info, success, warn } from './logging'
 import { create, recoverKeystore } from './mnemonic'
 import { Epoch, RFOXMetadata } from './types'
 import { Wallet } from './wallet'
+import { Command } from 'commander'
+
+const program = new Command()
+
+program.name('rFOX CLI')
+program.description('Here to help you do all things rFOX')
+program.option('--rfoxDir <path>', 'path to rfox directory', '~/rfox')
+program.parse(process.argv)
+
+const options = program.opts()
+export const RFOX_DIR = options.rfoxDir.replace(/^~(?=$|\/|\\)/, os.homedir())
 
 const processEpoch = async () => {
   const ipfs = await IPFS.new()

cli/src/mnemonic.ts

@@ -2,9 +2,9 @@ import * as prompts from '@inquirer/prompts'
 import { generateMnemonic, validateMnemonic } from 'bip39'
 import crypto from 'node:crypto'
 import path from 'node:path'
-import { RFOX_DIR } from './constants'
 import { read, write } from './file'
 import { error, info, success, warn } from './logging'
+import { RFOX_DIR } from '.'
 
 const recoveryChoices = [
   {

cli/src/wallet.ts

@@ -5,10 +5,10 @@ import chalk from 'chalk'
 import symbols from 'log-symbols'
 import path from 'node:path'
 import ora, { Ora } from 'ora'
-import { RFOX_DIR } from './constants'
 import { read, write } from './file'
 import { error, info, success } from './logging'
 import { Epoch } from './types'
+import { RFOX_DIR } from '.'
 
 const BIP32_PATH = `m/44'/931'/0'/0/0`
 const SHAPESHIFT_MULTISIG_ADDRESS = 'thor1xmaggkcln5m5fnha2780xrdrulmplvfrz6wj3l'

cli/yarn.lock

@@ -1928,6 +1928,11 @@ [email protected]:
   dependencies:
     graceful-readlink ">= 1.0.0"
 
+commander@^12.1.0:
+  version "12.1.0"
+  resolved "https://registry.yarnpkg.com/commander/-/commander-12.1.0.tgz#01423b36f501259fdaac4d0e4d60c96c991585d3"
+  integrity sha512-Vw8qHK3bZM9y/P10u3Vib8o/DdkvA2OtPtZvD871QKjy74Wj1WSKFILMPRPSdUSx5RFK1arlJzEtA4PkFgnbuA==
+
 [email protected]:
   version "1.2.1"
   resolved "https://registry.yarnpkg.com/component-type/-/component-type-1.2.1.tgz#8a47901700238e4fc32269771230226f24b415a9"