feat(wallet-cli): Add multisig commands (#54)

* feat(wallet-cli): Add multisig commands

* Update util

Author: rohanjadvani

package.json

@@ -24,22 +24,22 @@
   "devDependencies": {
     "@types/blessed": "0.1.22",
     "@types/node": "18.11.16",
+    "@types/yup": "0.29.10",
     "@typescript-eslint/eslint-plugin": "5.62.0",
     "@typescript-eslint/parser": "5.62.0",
     "eslint": "8.46.0",
     "eslint-config-prettier": "9.0.0",
+    "eslint-plugin-deprecation": "2.0.0",
     "eslint-plugin-header": "3.1.1",
     "eslint-plugin-jest": "27.2.3",
     "eslint-plugin-prettier": "4.2.1",
     "eslint-plugin-simple-import-sort": "10.0.0",
-    "eslint-plugin-deprecation": "2.0.0",
     "jest": "29.3.1",
     "jest-jasmine2": "29.3.1",
     "oclif": "2.6.0",
     "prettier": "2.8.8",
-    "typescript": "4.3.4",
-    "yarn": "1.22.10",
-    "@types/yup": "0.29.10"
+    "typescript": "5.0.4",
+    "yarn": "1.22.10"
   },
   "scripts": {
     "build": "tsc -b",
@@ -55,8 +55,8 @@
     "oclif:version": "oclif readme && git add README.md"
   },
   "dependencies": {
-    "@ironfish/rust-nodejs": "2.0.0",
-    "@ironfish/sdk": "2.0.0",
+    "@ironfish/rust-nodejs": "2.1.0",
+    "@ironfish/sdk": "2.1.0",
     "@oclif/core": "1.23.1",
     "@oclif/plugin-help": "5.1.12",
     "@oclif/plugin-not-found": "2.3.1",

src/commands/config/get.ts

@@ -45,7 +45,11 @@ export class GetCommand extends IronfishCommand {
     const { args, flags } = await this.parse(GetCommand)
     const name = (args.name as string).trim()
 
-    const client = await connectRpcConfig(this.sdk, this.walletConfig, flags.local)
+    const client = await connectRpcConfig(
+      this.sdk,
+      this.walletConfig,
+      flags.local,
+    )
 
     const response = await client.config.getConfig({
       user: flags.user,

src/commands/config/index.ts

@@ -26,7 +26,11 @@ export class ShowCommand extends IronfishCommand {
   async start(): Promise<void> {
     const { flags } = await this.parse(ShowCommand)
 
-    const client = await connectRpcConfig(this.sdk, this.walletConfig, flags.local)
+    const client = await connectRpcConfig(
+      this.sdk,
+      this.walletConfig,
+      flags.local,
+    )
     const response = await client.config.getConfig({ user: flags.user })
 
     let output = JSON.stringify(response.content, undefined, '   ')

src/commands/config/set.ts

@@ -41,7 +41,11 @@ export class SetCommand extends IronfishCommand {
     const name = args.name as string
     const value = args.value as string
 
-    const client = await connectRpcConfig(this.sdk, this.walletConfig, flags.local)
+    const client = await connectRpcConfig(
+      this.sdk,
+      this.walletConfig,
+      flags.local,
+    )
     await client.config.setConfig({ name, value })
 
     this.exit(0)

src/commands/config/unset.ts

@@ -32,7 +32,11 @@ export class UnsetCommand extends IronfishCommand {
     const { args, flags } = await this.parse(UnsetCommand)
     const name = args.name as string
 
-    const client = await connectRpcConfig(this.sdk, this.walletConfig, flags.local)
+    const client = await connectRpcConfig(
+      this.sdk,
+      this.walletConfig,
+      flags.local,
+    )
     await client.config.unsetConfig({ name })
 
     this.exit(0)

src/commands/multisig/commitment/aggregate.ts

@@ -0,0 +1,85 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * 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 { Flags } from '@oclif/core'
+import { IronfishCommand } from '../../../command'
+import { RemoteFlags } from '../../../flags'
+import { longPrompt } from '../../../utils/longPrompt'
+import { MultisigTransactionJson } from '../../../utils/multisig'
+
+export class CreateSigningPackage extends IronfishCommand {
+  static description = `Creates a signing package for a given transaction for a multisig account`
+
+  static flags = {
+    ...RemoteFlags,
+    account: Flags.string({
+      char: 'f',
+      description: 'The account to use when creating the signing package',
+      required: false,
+    }),
+    unsignedTransaction: Flags.string({
+      char: 'u',
+      description:
+        'The unsigned transaction for which the signing share will be created',
+    }),
+    commitment: Flags.string({
+      char: 'c',
+      description:
+        'The signing commitments from participants to be used for creating the signing package',
+      multiple: true,
+    }),
+    path: Flags.string({
+      description: 'Path to a JSON file containing multisig transaction data',
+    }),
+  }
+
+  async start(): Promise<void> {
+    const { flags } = await this.parse(CreateSigningPackage)
+
+    const loaded = await MultisigTransactionJson.load(
+      this.sdk.fileSystem,
+      flags.path,
+    )
+    const options = MultisigTransactionJson.resolveFlags(flags, loaded)
+
+    let unsignedTransaction = options.unsignedTransaction
+    if (!unsignedTransaction) {
+      unsignedTransaction = await longPrompt('Enter the unsigned transaction', {
+        required: true,
+      })
+    }
+
+    let commitments = options.commitment
+    if (!commitments) {
+      const input = await longPrompt(
+        'Enter the signing commitments separated by commas',
+        {
+          required: true,
+        },
+      )
+      commitments = input.split(',')
+    }
+    commitments = commitments.map((s) => s.trim())
+
+    const client = await this.sdk.connectRpc()
+
+    const signingPackageResponse =
+      await client.wallet.multisig.createSigningPackage({
+        account: flags.account,
+        unsignedTransaction,
+        commitments,
+      })
+
+    this.log(
+      `Signing Package for commitments from ${commitments.length} participants:\n`,
+    )
+    this.log(signingPackageResponse.content.signingPackage)
+
+    this.log()
+    this.log('Next step:')
+    this.log(
+      'Send the signing package to all of the participants who provided a commitment.',
+    )
+  }
+}

src/commands/multisig/commitment/create.ts

@@ -0,0 +1,112 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * 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 { UnsignedTransaction } from '@ironfish/sdk'
+import { CliUx, Flags } from '@oclif/core'
+import { IronfishCommand } from '../../../command'
+import { RemoteFlags } from '../../../flags'
+import { longPrompt } from '../../../utils/longPrompt'
+import { MultisigTransactionJson } from '../../../utils/multisig'
+import { renderUnsignedTransactionDetails } from '../../../utils/transaction'
+
+export class CreateSigningCommitmentCommand extends IronfishCommand {
+  static description =
+    'Create a signing commitment from a participant for a given transaction'
+
+  static flags = {
+    ...RemoteFlags,
+    account: Flags.string({
+      char: 'f',
+      description:
+        'The account to use for generating the commitment, must be a multisig participant account',
+      required: false,
+    }),
+    unsignedTransaction: Flags.string({
+      char: 'u',
+      description: 'The unsigned transaction that needs to be signed',
+    }),
+    identity: Flags.string({
+      char: 'i',
+      description:
+        'The identity of the participants that will sign the transaction (may be specified multiple times to add multiple signers)',
+      multiple: true,
+    }),
+    confirm: Flags.boolean({
+      default: false,
+      description: 'Confirm creating signing commitment without confirming',
+    }),
+    path: Flags.string({
+      description: 'Path to a JSON file containing multisig transaction data',
+    }),
+  }
+
+  async start(): Promise<void> {
+    const { flags } = await this.parse(CreateSigningCommitmentCommand)
+
+    const loaded = await MultisigTransactionJson.load(
+      this.sdk.fileSystem,
+      flags.path,
+    )
+    const options = MultisigTransactionJson.resolveFlags(flags, loaded)
+
+    let identities = options.identity
+    if (!identities || identities.length < 2) {
+      const input = await longPrompt(
+        'Enter the identities separated by commas',
+        {
+          required: true,
+        },
+      )
+      identities = input.split(',')
+
+      if (identities.length < 2) {
+        this.error('Minimum number of identities must be at least 2')
+      }
+    }
+    identities = identities.map((i) => i.trim())
+
+    let unsignedTransactionInput = options.unsignedTransaction
+    if (!unsignedTransactionInput) {
+      unsignedTransactionInput = await longPrompt(
+        'Enter the unsigned transaction',
+        {
+          required: true,
+        },
+      )
+    }
+
+    const client = await this.sdk.connectRpc()
+    const unsignedTransaction = new UnsignedTransaction(
+      Buffer.from(unsignedTransactionInput, 'hex'),
+    )
+
+    await renderUnsignedTransactionDetails(
+      client,
+      unsignedTransaction,
+      flags.account,
+      this.logger,
+    )
+
+    if (!flags.confirm) {
+      const confirmed = await CliUx.ux.confirm(
+        'Confirm signing commitment creation (Y/N)',
+      )
+      if (!confirmed) {
+        this.error('Creating signing commitment aborted')
+      }
+    }
+
+    const response = await client.wallet.multisig.createSigningCommitment({
+      account: flags.account,
+      unsignedTransaction: unsignedTransactionInput,
+      signers: identities.map((identity) => ({ identity })),
+    })
+
+    this.log('\nCommitment:\n')
+    this.log(response.content.commitment)
+
+    this.log()
+    this.log('Next step:')
+    this.log('Send the commitment to the multisig account coordinator.')
+  }
+}