feat: add support to unified full viewing keys instruction (Zondax#127)

* feat: add support to unified full view keys method

* chore: add snapshots

* feat: add test case for non expert mode

js/src/consts.ts

@@ -22,6 +22,7 @@ export const INS = {
   GET_ADDR_SECP256K1: 0x01,
   SIGN_SECP256K1: 0x02,
   SIGN_SAPLING: 0x12,
+  GET_UNIFIED_ADDR_SECP256K1: 0x13,
 
   GET_DIV_LIST: 0x09,
   GET_ADDR_SAPLING_DIV: 0x10,

js/src/index.ts

@@ -33,7 +33,8 @@ import {
   TRANSPARENT_PK_LEN,
 } from './consts'
 import {
-  AddressResponse, DfvkResponse,
+  AddressResponse,
+  DfvkResponse,
   DiversifierListResponse,
   ExtractSpendResponse,
   FvkResponse,
@@ -45,6 +46,7 @@ import {
   SignResponse,
   SpendSignatureResponse,
   TransaparentSignatureResponse,
+  UfvkResponse,
 } from './types'
 import { signSendChunkv1 } from './utils'
 
@@ -70,6 +72,7 @@ export default class ZCashApp extends GenericApp {
   ////////////////////////////////////////////
   ////////////////////////////////////////////
 
+
   async getAddressTransparent(path: string, showInScreen = true): Promise<AddressResponse> {
     try {
       const sentToDevice = serializePath(path)
@@ -328,6 +331,45 @@ export default class ZCashApp extends GenericApp {
     }
   }
 
+  async getUfvk(zip32Account: number): Promise<UfvkResponse> {
+    try {
+      const serializedZip32Acc = Buffer.alloc(4)
+      serializedZip32Acc.writeUInt32LE(zip32Account + 0x80000000, 0)
+      let responseBuffer = await this.transport.send(CLA, INS.GET_DFVK_SAPLING, 0, 0, serializedZip32Acc, [0x9000])
+      let response = processResponse(responseBuffer)
+
+      console.log(response.length())
+
+      const akRaw = response.readBytes(SAPLING_AK_LEN)
+      const nkRaw = response.readBytes(SAPLING_NK_LEN)
+      const ovkRaw = response.readBytes(SAPLING_OVK_LEN)
+      const dkRaw = response.readBytes(SAPLING_DK_LEN)
+
+      const serializedUnifiedTransparentAcc = serializePath(`m/44'/133'/${zip32Account}'`, [3])
+      responseBuffer = await this.transport.send(CLA, INS.GET_UNIFIED_ADDR_SECP256K1, 0, 0, serializedUnifiedTransparentAcc, [0x9000])
+      response = processResponse(responseBuffer)
+
+      console.log(response.length())
+
+      const pkRaw = response.readBytes(TRANSPARENT_PK_LEN)
+
+      return {
+        sapling: {
+          akRaw,
+          nkRaw,
+          ovkRaw,
+          dkRaw
+        },
+        transparent: {
+          pkRaw
+        },
+        orchard: null
+      }
+    } catch (error) {
+      throw processErrorResponse(error)
+    }
+  }
+
   ////////////////////////////////////
   ////////////////////////////////////
   ////////////////////////////////////

js/src/types.ts

@@ -41,6 +41,19 @@ export type DfvkResponse = {
   dkRaw: Buffer
 }
 
+export type UfvkResponse = {
+  sapling: {
+    akRaw: Buffer
+    nkRaw: Buffer
+    ovkRaw: Buffer
+    dkRaw: Buffer
+  },
+  transparent: {
+    pkRaw: Buffer
+  },
+  orchard: {} | null
+}
+
 export type DiversifierListResponse = {
   diversifiers: Buffer[]
 }

tests_zemu/tests/keys.test.ts

@@ -293,6 +293,52 @@ describe('Get_keys', function () {
         await sim.close()
       }
     })
+
+    test.concurrent.each(models)('Get ufvk', async function (m) {
+      const sim = new Zemu(m.path)
+      try {
+        await sim.start({
+          ...defaultOptions(m, true),
+          approveKeyword: isTouchDevice(m.name) ? 'Approve' : '',
+          approveAction: ButtonKind.ApproveTapButton
+        })
+
+        const app = new ZCashApp(sim.getTransport())
+
+        const account = 1000
+        const ufvkreq = app.getUfvk(account)
+
+        await sim.waitUntilScreenIsNot(sim.getMainMenuSnapshot())
+        await sim.compareSnapshotsAndApprove('.', `${m.prefix.toLowerCase()}-get-ufvk`)
+
+        const ufvk = await ufvkreq
+
+        console.log(ufvk)
+
+        const expected_akRaw = '0bbb1d4bfe70a4f4fc762e2f980ab7c600a060c28410ccd03972931fe310f2a5'
+        const akRaw = ufvk.sapling.akRaw?.toString('hex')
+        expect(akRaw).toEqual(expected_akRaw)
+
+        const expected_nkRaw = '9f552de44e5c38db16de3165aaa4627e352e00b6863dd627cc58df02a39deec7'
+        const nkRaw = ufvk.sapling.nkRaw?.toString('hex')
+        expect(nkRaw).toEqual(expected_nkRaw)
+
+        const expected_ovkRaw = '199be731acfa8bf5d525eade16451edf6e818f27db0164ff1f428bd8bf432f69'
+        const ovkRaw = ufvk.sapling.ovkRaw?.toString('hex')
+        expect(ovkRaw).toEqual(expected_ovkRaw)
+
+        const expected_dkRaw = '702c87a33c31670b463df27f43ad02942f68ef9071d5547b0ead7b5ae425b079'
+        const dkRaw = ufvk.sapling.dkRaw?.toString('hex')
+        expect(dkRaw).toEqual(expected_dkRaw)
+
+        const expected_pkRaw = '025b92d7edb1d5acaa9e4eafd9c220d0d4ca2d63fcfd464ca95b9329d91d98cb5b'
+        const pkRaw = ufvk.transparent.pkRaw?.toString('hex')
+        expect(pkRaw).toEqual(expected_pkRaw)
+
+      } finally {
+        await sim.close()
+      }
+    })
   })
 
 
@@ -443,6 +489,54 @@ describe('Get_keys', function () {
         await sim.close()
       }
     })
+
+    test.concurrent.each(models)('Get ufvk', async function (m) {
+      const sim = new Zemu(m.path)
+      try {
+        await sim.start({
+          ...defaultOptions(m, true),
+          approveKeyword: isTouchDevice(m.name) ? 'Approve' : '',
+          approveAction: ButtonKind.ApproveTapButton
+        })
+
+        await sim.toggleExpertMode()
+
+        const app = new ZCashApp(sim.getTransport())
+
+        const account = 1000
+        const ufvkreq = app.getUfvk(account)
+
+        await sim.waitUntilScreenIsNot(sim.getMainMenuSnapshot())
+        await sim.compareSnapshotsAndApprove('.', `${m.prefix.toLowerCase()}-get-ufvk-expert`)
+
+        const ufvk = await ufvkreq
+
+        console.log(ufvk)
+
+        const expected_akRaw = '0bbb1d4bfe70a4f4fc762e2f980ab7c600a060c28410ccd03972931fe310f2a5'
+        const akRaw = ufvk.sapling.akRaw?.toString('hex')
+        expect(akRaw).toEqual(expected_akRaw)
+
+        const expected_nkRaw = '9f552de44e5c38db16de3165aaa4627e352e00b6863dd627cc58df02a39deec7'
+        const nkRaw = ufvk.sapling.nkRaw?.toString('hex')
+        expect(nkRaw).toEqual(expected_nkRaw)
+
+        const expected_ovkRaw = '199be731acfa8bf5d525eade16451edf6e818f27db0164ff1f428bd8bf432f69'
+        const ovkRaw = ufvk.sapling.ovkRaw?.toString('hex')
+        expect(ovkRaw).toEqual(expected_ovkRaw)
+
+        const expected_dkRaw = '702c87a33c31670b463df27f43ad02942f68ef9071d5547b0ead7b5ae425b079'
+        const dkRaw = ufvk.sapling.dkRaw?.toString('hex')
+        expect(dkRaw).toEqual(expected_dkRaw)
+
+        const expected_pkRaw = '025b92d7edb1d5acaa9e4eafd9c220d0d4ca2d63fcfd464ca95b9329d91d98cb5b'
+        const pkRaw = ufvk.transparent.pkRaw?.toString('hex')
+        expect(pkRaw).toEqual(expected_pkRaw)
+
+      } finally {
+        await sim.close()
+      }
+    })
   })
 
 })