feat(wallet-cli): Catch up standalone wallet (#67)

* feat(wallet-cli): Catch up standalone wallet

* Properly close clients

* fix faucet

Author: rohanjadvani

package.json

@@ -22,8 +22,14 @@
     "node": ">=18"
   },
   "devDependencies": {
+    "@oclif/test": "4.0.4",
     "@types/blessed": "0.1.22",
+    "@types/cli-progress": "3.11.6",
+    "@types/inquirer": "9.0.3",
+    "@types/keccak": "3.0.4",
     "@types/node": "18.11.16",
+    "@types/tar": "6.1.13",
+    "@types/uuid": "10.0.0",
     "@types/yup": "0.29.10",
     "@typescript-eslint/eslint-plugin": "5.62.0",
     "@typescript-eslint/parser": "5.62.0",
@@ -36,7 +42,7 @@
     "eslint-plugin-simple-import-sort": "10.0.0",
     "jest": "29.3.1",
     "jest-jasmine2": "29.3.1",
-    "oclif": "2.6.0",
+    "oclif": "4.14.0",
     "prettier": "2.8.8",
     "typescript": "5.0.4",
     "yarn": "1.22.10"
@@ -55,18 +61,24 @@
     "oclif:version": "oclif readme && git add README.md"
   },
   "dependencies": {
-    "@ironfish/rust-nodejs": "2.3.0",
-    "@ironfish/sdk": "2.3.0",
-    "@oclif/core": "1.23.1",
-    "@oclif/plugin-help": "5.1.12",
-    "@oclif/plugin-not-found": "2.3.1",
-    "@oclif/plugin-warn-if-update-available": "2.0.40",
-    "@types/inquirer": "9.0.3",
+    "@ironfish/rust-nodejs": "2.6.0",
+    "@ironfish/sdk": "2.6.0",
+    "@ledgerhq/hw-transport-node-hid": "6.29.4",
+    "@oclif/core": "4.0.11",
+    "@oclif/plugin-help": "6.2.5",
+    "@oclif/plugin-not-found": "3.2.10",
+    "@oclif/plugin-warn-if-update-available": "3.1.8",
+    "@zondax/ledger-ironfish": "0.1.2",
     "blessed": "0.1.81",
+    "cli-progress": "3.12.0",
     "cross-env": "7.0.3",
     "inquirer": "8.2.5",
     "json-colorizer": "2.2.2",
+    "keccak": "3.0.4",
+    "natural-orderby": "4.0.0",
     "supports-hyperlinks": "2.2.0",
+    "tar": "7.4.3",
+    "uuid": "10.0.0",
     "yup": "0.29.3"
   },
   "oclif": {
@@ -83,7 +95,11 @@
       "@oclif/plugin-not-found",
       "@oclif/plugin-warn-if-update-available"
     ],
-    "topics": {}
+    "topics": {
+      "chainport": {
+        "description": "Commands for chainport"
+      }
+    }
   },
   "bin": {
     "ironfishw": "./bin/run"

src/args.ts

@@ -2,7 +2,24 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
 
-export function parseNumber(input: string): number | null {
-  const parsed = Number(input)
-  return isNaN(parsed) ? null : parsed
+import { parseUrl as parseUrlSdk } from '@ironfish/sdk'
+import { Args } from '@oclif/core'
+
+type Url = {
+  protocol: string | null
+  hostname: string
+  port: number | null
+}
+
+export function parseUrl(input: string): Promise<Url> {
+  const parsed = parseUrlSdk(input)
+  if (parsed.hostname != null) {
+    return Promise.resolve(parsed as Url)
+  } else {
+    return Promise.reject(new Error(`Invalid URL: ${input}`))
+  }
 }
+
+export const UrlArg = Args.custom<Url>({
+  parse: async (input: string) => parseUrl(input),
+})

src/command.ts

@@ -2,6 +2,7 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
 import {
+  ApiNamespace,
   Config as IronfishConfig,
   ConfigOptions,
   createRootLogger,
@@ -10,14 +11,16 @@ import {
   InternalOptions,
   IronfishSdk,
   Logger,
+  RpcClient,
   RpcConnectionError,
+  RpcMemoryClient,
 } from '@ironfish/sdk'
-import { Command, Config } from '@oclif/core'
-import { CLIError, ExitError } from '@oclif/core/lib/errors'
+import { Command, Config, Errors, ux } from '@oclif/core'
 import {
+  ConfigFlag,
   ConfigFlagKey,
+  DataDirFlag,
   DataDirFlagKey,
-  NetworkIdFlagKey,
   RpcAuthFlagKey,
   RpcHttpHostFlagKey,
   RpcHttpPortFlagKey,
@@ -42,15 +45,16 @@ import {
   WalletNodeUseTcpFlagKey,
 } from './flags'
 import { IronfishCliPKG } from './package'
+import * as ui from './ui'
 import { hasUserResponseError } from './utils'
 import { WalletConfig, WalletConfigOptions } from './walletConfig'
+import { walletNode } from './walletNode'
 
 export type SIGNALS = 'SIGTERM' | 'SIGINT' | 'SIGUSR2'
 
 export type FLAGS =
   | typeof DataDirFlagKey
   | typeof ConfigFlagKey
-  | typeof NetworkIdFlagKey
   | typeof RpcUseIpcFlagKey
   | typeof RpcUseTcpFlagKey
   | typeof RpcTcpHostFlagKey
@@ -75,8 +79,6 @@ export abstract class IronfishCommand extends Command {
   // run() is called and it provides a lot of value
   sdk!: IronfishSdk
 
-  walletConfig!: WalletConfig
-
   /**
    * Use this logger instance for debug/error output.
    * Actual command output should use `this.log` instead.
@@ -88,16 +90,26 @@ export abstract class IronfishCommand extends Command {
    */
   closing = false
 
+  client: RpcClient | null = null
+
+  walletConfig!: WalletConfig
+
+  public static baseFlags = {
+    [VerboseFlagKey]: VerboseFlag,
+    [ConfigFlagKey]: ConfigFlag,
+    [DataDirFlagKey]: DataDirFlag,
+  }
+
   constructor(argv: string[], config: Config) {
     super(argv, config)
     this.logger = createRootLogger().withTag(this.ctor.id)
   }
 
-  abstract start(): Promise<void> | void
+  abstract start(): Promise<unknown> | void
 
-  async run(): Promise<void> {
+  async run(): Promise<unknown> {
     try {
-      await this.start()
+      return await this.start()
     } catch (error: unknown) {
       if (hasUserResponseError(error)) {
         this.log(error.codeMessage)
@@ -107,9 +119,9 @@ export abstract class IronfishCommand extends Command {
         }
 
         this.exit(1)
-      } else if (error instanceof ExitError) {
+      } else if (error instanceof Errors.ExitError) {
         throw error
-      } else if (error instanceof CLIError) {
+      } else if (error instanceof Errors.CLIError) {
         throw error
       } else if (error instanceof RpcConnectionError) {
         this.log(`Cannot connect to your node, start your node first.`)
@@ -123,16 +135,15 @@ export abstract class IronfishCommand extends Command {
       } else {
         throw error
       }
+    } finally {
+      this.client?.close()
     }
 
     this.exit(0)
   }
 
   async init(): Promise<void> {
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-explicit-any
-    const commandClass = this.constructor as any
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
-    const { flags } = await this.parse(commandClass)
+    const { flags } = await this.parse(this.ctor)
 
     // Get the flags from the flag object which is unknown
     const dataDirFlag = getFlag(flags, DataDirFlagKey)
@@ -160,11 +171,13 @@ export abstract class IronfishCommand extends Command {
     const rpcTcpHostFlag = getFlag(flags, RpcTcpHostFlagKey)
     if (typeof rpcTcpHostFlag === 'string') {
       configOverrides.rpcTcpHost = rpcTcpHostFlag
+      configOverrides.enableRpcTcp = true
     }
 
     const rpcTcpPortFlag = getFlag(flags, RpcTcpPortFlagKey)
     if (typeof rpcTcpPortFlag === 'number') {
       configOverrides.rpcTcpPort = rpcTcpPortFlag
+      configOverrides.enableRpcTcp = true
     }
 
     const rpcConnectHttpFlag = getFlag(flags, RpcUseHttpFlagKey)
@@ -178,11 +191,13 @@ export abstract class IronfishCommand extends Command {
     const rpcHttpHostFlag = getFlag(flags, RpcHttpHostFlagKey)
     if (typeof rpcHttpHostFlag === 'string') {
       configOverrides.rpcHttpHost = rpcHttpHostFlag
+      configOverrides.enableRpcHttp = true
     }
 
     const rpcHttpPortFlag = getFlag(flags, RpcHttpPortFlagKey)
     if (typeof rpcHttpPortFlag === 'number') {
       configOverrides.rpcHttpPort = rpcHttpPortFlag
+      configOverrides.enableRpcHttp = true
     }
 
     const rpcTcpTlsFlag = getFlag(flags, RpcTcpTlsFlagKey)
@@ -206,11 +221,6 @@ export abstract class IronfishCommand extends Command {
       internalOverrides.rpcAuthToken = rpcAuthFlag
     }
 
-    const networkId = getFlag(flags, NetworkIdFlagKey)
-    if (typeof networkId === 'number') {
-      internalOverrides.networkId = networkId
-    }
-
     this.sdk = await IronfishSdk.init({
       pkg: IronfishCliPKG,
       configOverrides: configOverrides,
@@ -326,9 +336,111 @@ export abstract class IronfishCommand extends Command {
   closeFromSignal(signal: NodeJS.Signals): Promise<unknown> {
     throw new Error(`Not implemented closeFromSignal: ${signal}`)
   }
+
+  // Override the built-in logJson method to implement our own colorizer that
+  // works with default terminal colors instead of requiring a theme to be
+  // configured.
+  logJson(json: unknown): void {
+    ux.stdout(ui.json(json))
+  }
+
+  async connectRpcConfig(
+    forceLocal = false,
+    forceRemote = false,
+  ): Promise<Pick<RpcClient, 'config'>> {
+    forceRemote = forceRemote || this.sdk.config.get('enableRpcTcp')
+
+    if (!forceLocal) {
+      if (forceRemote) {
+        await this.sdk.client.connect()
+        return this.sdk.client
+      }
+
+      const connected = await this.sdk.client.tryConnect()
+      if (connected) {
+        return this.sdk.client
+      }
+    }
+
+    // This connection uses a wallet node since that is the most granular type
+    // of node available. This can be refactored in the future if needed.
+    const node = await walletNode({
+      connectNodeClient: false,
+      walletConfig: this.walletConfig,
+      sdk: this.sdk,
+    })
+
+    const clientMemory = new RpcMemoryClient(
+      this.sdk.logger,
+      node.rpc.getRouter([ApiNamespace.config]),
+    )
+    this.client = clientMemory
+    return clientMemory
+  }
+
+  async connectRpcWallet(
+    options: {
+      forceLocal?: boolean
+      forceRemote?: boolean
+      connectNodeClient?: boolean
+    } = {
+      forceLocal: false,
+      forceRemote: false,
+      connectNodeClient: false,
+    },
+  ): Promise<RpcClientWallet> {
+    const forceRemote =
+      options.forceRemote || this.sdk.config.get('enableRpcTcp')
+
+    if (!options.forceLocal) {
+      if (forceRemote) {
+        await this.sdk.client.connect()
+        this.client = this.sdk.client
+        return this.sdk.client
+      }
+
+      const connected = await this.sdk.client.tryConnect()
+      if (connected) {
+        this.client = this.sdk.client
+        return this.sdk.client
+      }
+    }
+
+    const namespaces = [
+      ApiNamespace.config,
+      ApiNamespace.faucet,
+      ApiNamespace.rpc,
+      ApiNamespace.wallet,
+      ApiNamespace.worker,
+    ]
+
+    const node = await walletNode({
+      connectNodeClient: !!options.connectNodeClient,
+      sdk: this.sdk,
+      walletConfig: this.walletConfig,
+    })
+
+    const clientMemory = new RpcMemoryClient(
+      this.sdk.logger,
+      node.rpc.getRouter(namespaces),
+    )
+
+    await node.waitForOpen()
+    if (options.connectNodeClient) {
+      await node.connectRpc()
+    }
+
+    this.client = clientMemory
+    return clientMemory
+  }
 }
 
-function getFlag(flags: unknown, flag: FLAGS): unknown | null {
+export type RpcClientWallet = Pick<
+  RpcClient,
+  'config' | 'rpc' | 'wallet' | 'worker' | 'faucet'
+>
+
+function getFlag(flags: unknown, flag: FLAGS): unknown {
   return typeof flags === 'object' && flags !== null && flag in flags
     ? // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-explicit-any
       (flags as any)[flag]