Feature/27989 Ledger tx signature

Makefile

@@ -12,7 +12,7 @@ install:
 	go install github.com/onsi/ginkgo/v2/ginkgo
 
 build_js:
-	yarn install --frozen-lockfile && yarn bundle
+	yarn install --frozen-lockfile
 
 build_contracts:
 	./scripts/build-contracts.sh

go.mod

@@ -12,8 +12,8 @@ require (
 	github.com/satori/go.uuid v1.2.0
 	github.com/smartcontractkit/chainlink v1.0.1-0.20220114200720-95a78cb9fc2b
 	github.com/smartcontractkit/chainlink-relay v0.0.0-20220208185145-f90ff8f9d79a
-	github.com/smartcontractkit/helmenv v1.0.32
-	github.com/smartcontractkit/integrations-framework v1.0.46
+	github.com/smartcontractkit/helmenv v1.0.35
+	github.com/smartcontractkit/integrations-framework v1.0.47
 	github.com/smartcontractkit/libocr v0.0.0-20220121130134-5d2b1d5f424b
 	github.com/smartcontractkit/terra.go v1.0.3-0.20220108002221-62b39252ee16
 	github.com/stretchr/testify v1.7.0

go.sum

@@ -2391,6 +2391,8 @@ github.com/smartcontractkit/helmenv v1.0.20/go.mod h1:oFDq/QeOcHMJ8Cl+UEOA3tAmYM
 github.com/smartcontractkit/helmenv v1.0.27/go.mod h1:ef0doolSZf8ckqaWMIK2M+EPXdIKYVzttd6EXaCgCK4=
 github.com/smartcontractkit/helmenv v1.0.32 h1:CX8bcmZOsAPbhwdUbaD4AJxqgJV6R1CfgEb0YjT8CAc=
 github.com/smartcontractkit/helmenv v1.0.32/go.mod h1:ef0doolSZf8ckqaWMIK2M+EPXdIKYVzttd6EXaCgCK4=
+github.com/smartcontractkit/helmenv v1.0.35 h1:WwSRfWK5VKE9NdarlbjG+fq31YEhoxvImOSgSJmwQEw=
+github.com/smartcontractkit/helmenv v1.0.35/go.mod h1:pkScfFRZM9UhMAqeG+Bfxyy7YjLWh8pY6vmNGdTpKJs=
 github.com/smartcontractkit/integrations-framework v1.0.21/go.mod h1:mceWG89OYgDkqIVD64Ocp2pn1utqoHAC4ycVV33JOTo=
 github.com/smartcontractkit/integrations-framework v1.0.24/go.mod h1:yFgbE88F6+om0jo5mFskgKEQBnxqfYg6H1OL2dCIekk=
 github.com/smartcontractkit/integrations-framework v1.0.44 h1:/2lAuWN5ELKFb36NIM++49ktXKLHJMfppB1cA78mn0c=
@@ -2399,6 +2401,8 @@ github.com/smartcontractkit/integrations-framework v1.0.45 h1:HP3f6sYgz4n1i1fqBM
 github.com/smartcontractkit/integrations-framework v1.0.45/go.mod h1:p4uumn3/C/96UNFzKQZcThJ0uhyUPUbXW0wkzO2PsGc=
 github.com/smartcontractkit/integrations-framework v1.0.46 h1:0v6H3K/EO7sfyqeHD/cgY6cxotOUUllgoi3BJn3gG1U=
 github.com/smartcontractkit/integrations-framework v1.0.46/go.mod h1:80yVYzfn5jz2ubPbDEuD7Kw0a55cS+o7tZlTHQu4VQc=
+github.com/smartcontractkit/integrations-framework v1.0.47 h1:cqTmqIEPRLXpfLrvhlOHl1nNZ9wFQuM/uPeazrvnDYw=
+github.com/smartcontractkit/integrations-framework v1.0.47/go.mod h1:vxO+yFQqnDh2Y707zensXk6JxJuRWrclJ/GdS/nS7jE=
 github.com/smartcontractkit/libocr v0.0.0-20201203233047-5d9b24f0cbb5/go.mod h1:bfdSuLnBWCkafDvPGsQ1V6nrXhg046gh227MKi4zkpc=
 github.com/smartcontractkit/libocr v0.0.0-20211117215336-6c9726817b2d/go.mod h1:nq3crM3wVqnyMlM/4ZydTuJ/WyCapAsOt7P94oRgSPg=
 github.com/smartcontractkit/libocr v0.0.0-20211202172717-e8b0536a572e/go.mod h1:nq3crM3wVqnyMlM/4ZydTuJ/WyCapAsOt7P94oRgSPg=

packages-ts/gauntlet-terra-contracts/package.json

@@ -29,7 +29,7 @@
   "dependencies": {
     "@chainlink/gauntlet-core": "0.0.7",
     "@chainlink/gauntlet-terra": "*",
-    "@terra-money/terra.js": "^3.0.4",
+    "@terra-money/terra.js": "^3.0.6",
     "ajv": "^8.6.3"
   }
 }

packages-ts/gauntlet-terra-contracts/src/commands/abstract/executionWrapper.ts

@@ -27,7 +27,7 @@ export const instructionToCommand = (instruction: AbstractInstruction<any, any>)
       instruction.validateInput(commandInput)
       const input = await instruction.makeContractInput(commandInput)
       const abstractCommand = await makeAbstractCommand(id, this.flags, this.args, input)
-      abstractCommand.invokeMiddlewares(abstractCommand, abstractCommand.middlewares)
+      await abstractCommand.invokeMiddlewares(abstractCommand, abstractCommand.middlewares)
       return abstractCommand.execute()
     }
   }

packages-ts/gauntlet-terra-contracts/src/commands/contracts/ocr2/setBilling.ts

@@ -52,8 +52,8 @@ const validateInput = (input: CommandInput): boolean => {
   }
 
   try {
-    observationPayment = BN(input.observationPaymentGjuels)
-    transmissionPayment = BN(input.transmissionPaymentGjuels) // parse as integers
+    observationPayment = new BN(input.observationPaymentGjuels)
+    transmissionPayment = new BN(input.transmissionPaymentGjuels) // parse as integers
   } catch {
     throw new Error(
       `observationPaymentGjuels=${input.observationPaymentGjuels} and ` +

packages-ts/gauntlet-terra/package.json

@@ -26,7 +26,10 @@
     "bundle": "yarn build && pkg ."
   },
   "dependencies": {
-    "@terra-money/terra.js": "^3.0.4",
-    "@chainlink/gauntlet-core": "0.0.7"
+    "@chainlink/gauntlet-core": "0.0.7",
+    "@ledgerhq/hw-transport-node-hid": "^6.20.0",
+    "@terra-money/ledger-terra-js": "^1.2.1",
+    "@terra-money/terra.js": "^3.0.6",
+    "secp256k1": "^4.0.3"
   }
 }

packages-ts/gauntlet-terra/src/commands/internal/terra.ts

@@ -1,6 +1,7 @@
 import { Result, WriteCommand } from '@chainlink/gauntlet-core'
 import { logger } from '@chainlink/gauntlet-core/dist/utils'
 import { MsgStoreCode } from '@terra-money/terra.js'
+import { SignMode } from '@terra-money/terra.proto/cosmos/tx/signing/v1beta1/signing'
 
 import { withProvider, withWallet, withCodeIds, withNetwork } from '../middlewares'
 import {
@@ -12,6 +13,7 @@ import {
   Wallet,
 } from '@terra-money/terra.js'
 import { TransactionResponse } from '../types'
+import { LedgerKey } from '../ledgerKey'
 
 type CodeIds = Record<string, number>
 
@@ -60,6 +62,9 @@ export default abstract class TerraCommand extends WriteCommand<TransactionRespo
 
     const tx = await this.wallet.createAndSignTx({
       msgs: [msg],
+      ...(this.wallet.key instanceof LedgerKey && {
+        signMode: SignMode.SIGN_MODE_LEGACY_AMINO_JSON,
+      }),
     })
 
     const res = await this.provider.tx.broadcast(tx)
@@ -78,6 +83,9 @@ export default abstract class TerraCommand extends WriteCommand<TransactionRespo
     const instantiateTx = await this.wallet.createAndSignTx({
       msgs: [instantiate],
       memo: 'Instantiating',
+      ...(this.wallet.key instanceof LedgerKey && {
+        signMode: SignMode.SIGN_MODE_LEGACY_AMINO_JSON,
+      }),
     })
     logger.loading(`Deploying contract...`)
     const res = await this.provider.tx.broadcast(instantiateTx)
@@ -91,6 +99,9 @@ export default abstract class TerraCommand extends WriteCommand<TransactionRespo
     const tx = await this.wallet.createAndSignTx({
       msgs: [code],
       memo: `Storing ${contractName}`,
+      ...(this.wallet.key instanceof LedgerKey && {
+        signMode: SignMode.SIGN_MODE_LEGACY_AMINO_JSON,
+      }),
     })
 
     logger.loading(`Uploading ${contractName} contract code...`)

packages-ts/gauntlet-terra/src/commands/ledgerKey.ts

@@ -0,0 +1,83 @@
+import { Key, SimplePublicKey, SignatureV2, SignDoc, SignerInfo, ModeInfo } from '@terra-money/terra.js'
+import LedgerTerraConnector, { ERROR_CODE, CommonResponse } from '@terra-money/ledger-terra-js'
+import TransportNodeHid from '@ledgerhq/hw-transport-node-hid'
+import { logger } from '@chainlink/gauntlet-core/dist/utils'
+import { signatureImport } from 'secp256k1'
+
+const BIP44_REGEX = /^(44)\'\s*\/\s*(\d+)\'\s*\/\s*([0,1]+)\'\s*\/\s*(\d+)\s*\/\s*(\d+)$/
+
+export class LedgerKey extends Key {
+  private path: Array<number>
+
+  private constructor(path: Array<number>) {
+    super()
+    this.path = path
+  }
+
+  public async initialize() {
+    const { ledgerConnector, terminateConnection } = await this.connectToLedger()
+
+    const response = await ledgerConnector.getPublicKey(this.path)
+    this.assertNoErrors(response)
+
+    this.publicKey = new SimplePublicKey(Buffer.from(response.compressed_pk.data).toString('base64'))
+    await terminateConnection()
+  }
+
+  public static async create(path: string): Promise<LedgerKey> {
+    const pathArr = this.bip44PathtoArray(path)
+    const ledgerKey = new LedgerKey(pathArr)
+    await ledgerKey.initialize()
+
+    return ledgerKey
+  }
+
+  public async sign(payload: Buffer): Promise<Buffer> {
+    const { ledgerConnector, terminateConnection } = await this.connectToLedger()
+    try {
+      logger.info('Approve tx on your Ledger device.')
+      const response = await ledgerConnector.sign(this.path, payload)
+      this.assertNoErrors(response)
+
+      const signature = signatureImport(Buffer.from(response.signature.data))
+      return Buffer.from(signature)
+    } catch (e) {
+      logger.error(`LedgerKey sign failed: ${e.message}`)
+      throw e
+    } finally {
+      await terminateConnection()
+    }
+  }
+
+  private async connectToLedger() {
+    const transport = await TransportNodeHid.create()
+    const ledgerConnector = new LedgerTerraConnector(transport)
+    const response = await ledgerConnector.initialize()
+    this.assertNoErrors(response)
+
+    return {
+      ledgerConnector,
+      terminateConnection: transport.close.bind(transport),
+    }
+  }
+
+  private static bip44PathtoArray(path: string): Array<number> {
+    const match = BIP44_REGEX.exec(path)
+    if (!match) throw new Error('Invalid BIP44 path!')
+
+    return match.slice(1).map(Number)
+  }
+
+  private assertNoErrors(response: CommonResponse) {
+    if (!response) return
+
+    const { error_message: ledgerError, return_code: returnCode, device_locked: isLocked } = response
+
+    if (returnCode === ERROR_CODE.NoError) return
+
+    if (isLocked) {
+      throw new Error('Is Ledger unlocked and Terra app open?')
+    }
+    throw new Error(ledgerError)
+  }
+}

packages-ts/gauntlet-terra/src/commands/middlewares.ts

@@ -1,9 +1,11 @@
-import { LCDClient, MnemonicKey } from '@terra-money/terra.js'
+import { LCDClient, Key, MnemonicKey } from '@terra-money/terra.js'
+import { LedgerKey } from './ledgerKey'
 import { Middleware, Next } from '@chainlink/gauntlet-core'
 import { assertions, io, logger } from '@chainlink/gauntlet-core/dist/utils'
 import TerraCommand from './internal/terra'
 import path from 'path'
 import { existsSync } from 'fs'
+import { BIP44_LUNA_PATH } from '../lib/constants'
 
 const isValidURL = (a) => true
 export const withProvider: Middleware = (c: TerraCommand, next: Next) => {
@@ -20,17 +22,22 @@ export const withProvider: Middleware = (c: TerraCommand, next: Next) => {
   return next()
 }
 
-export const withWallet: Middleware = (c: TerraCommand, next: Next) => {
-  const mnemonic = process.env.MNEMONIC
-  assertions.assert(!!mnemonic, `Missing MNEMONIC, please add one`)
+export const withWallet: Middleware = async (c: TerraCommand, next: Next) => {
+  let key: Key
+  if (c.flags.withLedger || !!process.env.WITH_LEDGER) {
+    const path = c.flags.ledgerPath || BIP44_LUNA_PATH
+    key = await LedgerKey.create(path)
+  } else {
+    const mnemonic = process.env.MNEMONIC
+    assertions.assert(!!mnemonic, `Missing MNEMONIC, please add one`)
 
-  const mk = new MnemonicKey({
-    mnemonic: mnemonic,
-  })
+    key = new MnemonicKey({
+      mnemonic: mnemonic,
+    })
+  }
 
-  const wallet = c.provider.wallet(mk)
-  c.wallet = wallet
-  logger.debug(`Operator address is ${wallet.key.accAddress}`)
+  c.wallet = c.provider.wallet(key)
+  logger.info(`Operator address is ${c.wallet.key.accAddress}`)
   return next()
 }
 

packages-ts/gauntlet-terra/src/lib/constants.ts

@@ -1 +1,2 @@
 export const ADDRESS_ZERO = 'terra000000000000000000000000000000000000000'
+export const BIP44_LUNA_PATH = "44'/330'/0'/0/0"

shell.nix

@@ -30,6 +30,7 @@ pkgs.mkShell {
     # Keep this nodejs version in sync with the version in .tool-versions please
     nodejs-14_x
     (yarn.override { nodejs = nodejs-14_x; })
+    libusb1
   ];
   RUST_BACKTRACE = "1";
   GOROOT="${pkgs.go_1_17}/share/go";

tests/e2e/smoke/gauntlet_test.go

@@ -1,10 +1,8 @@
 package smoke_test
 
 import (
-	"fmt"
 	"math/big"
 	"os"
-	"os/exec"
 	"path/filepath"
 
 	. "github.com/onsi/ginkgo/v2"
@@ -63,19 +61,11 @@ var _ = Describe("Terra Gauntlet @gauntlet", func() {
 		})
 		By("Setup Gauntlet", func() {
 			networkDirPath = filepath.Join(utils.ProjectRoot, "./packages-ts/gauntlet-terra-contracts/networks")
-			_, err := exec.LookPath("yarn")
-			Expect(err).ShouldNot(HaveOccurred())
-
 			cwd, _ := os.Getwd()
 			err = os.Chdir(filepath.Join(cwd + "../../../.."))
 			Expect(err).ShouldNot(HaveOccurred())
 
-			gauntletBin := fmt.Sprintf(
-				"%s%s",
-				filepath.Join(cwd, "../../../bin/gauntlet-terra-"),
-				gauntlet.GetOsVersion(),
-			)
-			g, err = gauntlet.NewGauntlet(gauntletBin)
+			g, err = gauntlet.NewGauntlet()
 			Expect(err).ShouldNot(HaveOccurred())
 
 			terraNodeUrl, err := e.Charts.Connections("localterra").LocalURLByPort("lcd", environment.HTTP)