@onekeyfe/hd-core 1.2.10-alpha.2 → 1.2.10-alpha.3

package/src/data/messages/messages-protocol-v2.json

@@ -11034,94 +11034,6 @@
         }
       }
     },
-    "ZcashAddressType": {
-      "values": {
-        "UNIFIED_ORCHARD_P2PKH": 0,
-        "TRANSPARENT_P2PKH": 1,
-        "UNIFIED_ORCHARD": 2
-      }
-    },
-    "ZcashAddressScope": {
-      "values": {
-        "EXTERNAL": 0,
-        "INTERNAL": 1
-      }
-    },
-    "ZcashGetAddress": {
-      "fields": {
-        "address_n": {
-          "rule": "repeated",
-          "type": "uint32",
-          "id": 1,
-          "options": {
-            "packed": false
-          }
-        },
-        "show_display": {
-          "type": "bool",
-          "id": 2
-        },
-        "include_seed_fingerprint": {
-          "type": "bool",
-          "id": 3
-        },
-        "diversifier_index": {
-          "type": "uint32",
-          "id": 5,
-          "options": {
-            "default": 0
-          }
-        },
-        "address_type": {
-          "type": "ZcashAddressType",
-          "id": 6,
-          "options": {
-            "default": "UNIFIED_ORCHARD_P2PKH"
-          }
-        },
-        "scope": {
-          "type": "ZcashAddressScope",
-          "id": 7,
-          "options": {
-            "default": "EXTERNAL"
-          }
-        }
-      }
-    },
-    "ZcashAddress": {
-      "fields": {
-        "address": {
-          "rule": "required",
-          "type": "string",
-          "id": 1
-        },
-        "seed_fingerprint": {
-          "type": "bytes",
-          "id": 3
-        }
-      }
-    },
-    "ZcashGetFullViewingKey": {
-      "fields": {
-        "address_n": {
-          "rule": "repeated",
-          "type": "uint32",
-          "id": 1,
-          "options": {
-            "packed": false
-          }
-        }
-      }
-    },
-    "ZcashFullViewingKey": {
-      "fields": {
-        "ufvk": {
-          "rule": "required",
-          "type": "string",
-          "id": 1
-        }
-      }
-    },
     "ZcashSignPczt": {
       "fields": {
         "pczt_length": {
@@ -11602,15 +11514,11 @@
         "MessageType_NeoAddress": 12302,
         "MessageType_NeoSignTx": 12303,
         "MessageType_NeoSignedTx": 12304,
-        "MessageType_ZcashGetAddress": 12400,
-        "MessageType_ZcashAddress": 12401,
         "MessageType_ZcashSignPczt": 12402,
         "MessageType_ZcashSignedPczt": 12403,
         "MessageType_ZcashPcztChunkRequest": 12404,
         "MessageType_ZcashPcztChunkAck": 12405,
         "MessageType_ZcashSignedPcztChunkRequest": 12406,
-        "MessageType_ZcashGetFullViewingKey": 12407,
-        "MessageType_ZcashFullViewingKey": 12408,
         "MessageType_DeviceFactoryInfoSet": 60000,
         "MessageType_DeviceFactoryInfoGet": 60001,
         "MessageType_DeviceFactoryInfo": 60002,
@@ -11663,7 +11571,9 @@
         "MessageType_PortfolioUpdate": 61400,
         "MessageType_NftUpdate": 61500,
         "MessageType_OnboardingStatusGet": 61600,
-        "MessageType_OnboardingStatus": 61601
+        "MessageType_OnboardingStatus": 61601,
+        "MessageType_ZcashGetAddress": 12400,
+        "MessageType_ZcashAddress": 12401
       },
       "reserved": [
         [90, 92],
@@ -13882,6 +13792,81 @@
           }
         }
       }
+    },
+    "ZcashAddressType": {
+      "values": {
+        "UNIFIED_ORCHARD_P2PKH": 0,
+        "TRANSPARENT_P2PKH": 1,
+        "UNIFIED_ORCHARD": 2
+      }
+    },
+    "ZcashAddressScope": {
+      "values": {
+        "EXTERNAL": 0,
+        "INTERNAL": 1
+      }
+    },
+    "ZcashGetAddress": {
+      "fields": {
+        "address_n": {
+          "rule": "repeated",
+          "type": "uint32",
+          "id": 1,
+          "options": {
+            "packed": false
+          }
+        },
+        "show_display": {
+          "type": "bool",
+          "id": 2
+        },
+        "include_seed_fingerprint": {
+          "type": "bool",
+          "id": 3
+        },
+        "include_ufvk": {
+          "type": "bool",
+          "id": 4
+        },
+        "diversifier_index": {
+          "type": "uint32",
+          "id": 5,
+          "options": {
+            "default": 0
+          }
+        },
+        "address_type": {
+          "type": "ZcashAddressType",
+          "id": 6,
+          "options": {
+            "default": "UNIFIED_ORCHARD_P2PKH"
+          }
+        },
+        "scope": {
+          "type": "ZcashAddressScope",
+          "id": 7,
+          "options": {
+            "default": "EXTERNAL"
+          }
+        }
+      }
+    },
+    "ZcashAddress": {
+      "fields": {
+        "address": {
+          "rule": "required",
+          "type": "string",
+          "id": 1
+        },
+        "ufvk": {
+          "type": "string",
+          "id": 2
+        },
+        "seed_fingerprint": {
+          "type": "bytes",
+          "id": 3
+        }
+      }
     }
   }
 }

package/src/events/logBlockEvent.ts

@@ -19,7 +19,6 @@ const LogPayloadBlockMethod: Set<string> = new Set([
   'fileWrite',
   'fileRead',
   'zcashGetAddress',
-  'zcashGetFullViewingKey',
   'zcashSignPczt',
   'moneroGetAddress',
   'moneroGetWatchKey',

package/src/inject.ts

@@ -506,8 +506,6 @@ export const createCoreApi = (
     call({ ...params, connectId, deviceId, method: 'neoSignTransaction' }),
   zcashGetAddress: (connectId, deviceId, params) =>
     call({ ...params, connectId, deviceId, method: 'zcashGetAddress' }),
-  zcashGetFullViewingKey: (connectId, deviceId, params) =>
-    call({ ...params, connectId, deviceId, method: 'zcashGetFullViewingKey' }),
   zcashSignPczt: (connectId, deviceId, params) =>
     call({ ...params, connectId, deviceId, method: 'zcashSignPczt' }),
 

package/src/protocols/protocol-v2/uiInteraction.ts

@@ -71,7 +71,7 @@ const getDisplayState = (value: unknown) => {
   return { seen, enabled };
 };
 
-export const createMethodInteraction = (
+const createMethodInteraction = (
   reason: 'address-confirmation' | 'public-key-confirmation' | 'signing-confirmation',
   operation: string
 ): ProtocolV2InteractionDescriptor => ({

package/src/types/api/allNetworkGetAddress.ts

@@ -71,6 +71,7 @@ type AllNetworkAddressPayload =
   | {
       // Zcash
       address: string;
+      ufvk?: string;
       seedFingerprint?: string;
     }
   | {

package/src/types/api/export.ts

@@ -228,7 +228,6 @@ export type { BenfenPublicKey, BenfenGetPublicKeyParams } from './benfenGetPubli
 export type { BenfenSignMessageParams } from './benfenSignMessage';
 export type { BenfenSignedTx, BenfenSignTransactionParams } from './benfenSignTransaction';
 export type { ZcashAddress, ZcashGetAddressParams } from './zcashGetAddress';
-export type { ZcashFullViewingKey, ZcashGetFullViewingKeyParams } from './zcashGetFullViewingKey';
 export type { ZcashSignedPczt, ZcashSignPcztParams } from './zcashSignPczt';
 
 export type { MoneroAddress, MoneroGetAddressParams } from './moneroGetAddress';

package/src/types/api/index.ts

@@ -155,7 +155,6 @@ import type { benfenSignMessage } from './benfenSignMessage';
 import type { neoGetAddress } from './neoGetAddress';
 import type { neoSignTransaction } from './neoSignTransaction';
 import type { zcashGetAddress } from './zcashGetAddress';
-import type { zcashGetFullViewingKey } from './zcashGetFullViewingKey';
 import type { zcashSignPczt } from './zcashSignPczt';
 import type { moneroGetAddress } from './moneroGetAddress';
 import type { moneroGetWatchKey } from './moneroGetWatchKey';
@@ -484,7 +483,6 @@ export type CoreApi = {
    * Zcash
    */
   zcashGetAddress: typeof zcashGetAddress;
-  zcashGetFullViewingKey: typeof zcashGetFullViewingKey;
   zcashSignPczt: typeof zcashSignPczt;
 
   /**

package/src/types/api/zcashGetAddress.ts

@@ -5,6 +5,8 @@ export type ZcashAddress = {
   path: string;
   // ZIP-316 unified address or transparent P2PKH address
   address: string;
+  // ZIP-316 unified full viewing key, present when includeUfvk was requested
+  ufvk?: string;
   // ZIP-32 seed fingerprint (hex), present when includeSeedFingerprint was requested
   seedFingerprint?: string;
 };
@@ -16,6 +18,7 @@ export type ZcashGetAddressParams = {
   diversifierIndex?: number;
   addressType?: ZcashAddressType;
   scope?: ZcashAddressScope;
+  includeUfvk?: boolean;
   includeSeedFingerprint?: boolean;
 };
 

package/__tests__/allNetworkGetAddress-skippable.test.ts

@@ -1,41 +0,0 @@
-import { HardwareErrorCode } from '@onekeyfe/hd-shared';
-
-import { handleSkippableHardwareError } from '../src/api/allnetwork/AllNetworkGetAddressBase';
-
-jest.mock('../src/data/config', () => ({
-  getSDKVersion: jest.fn(() => '1.0.0'),
-  DEFAULT_DOMAIN: 'https://jssdk.onekey.so/1.0.0/',
-}));
-
-// Breaks the api/index -> AllNetworkGetAddress import cycle, as the tracing test does.
-jest.mock('../src/api/utils', () => ({
-  findMethod: jest.fn(),
-}));
-
-const device = {
-  getCurrentMethodVersionRange: jest.fn(() => undefined),
-  getCurrentFirmwareVersionString: jest.fn(() => '1.0.0'),
-  getCurrentFirmwareType: jest.fn(() => 'universal'),
-} as any;
-const method = { name: 'zcashGetAddress', getVersionRange: () => ({}) } as any;
-
-describe('all-network chains the firmware lacks', () => {
-  test.each([
-    'Failure_UnexpectedMessage,Unknown message',
-    'Failure_UnknownMessage,Unknown message',
-    // Pro 2's wording for a message type it has no handler for.
-    'Failure_ProcessError,Handler not found: No handler for type: 12400',
-  ])('skips the chain on %s', message => {
-    const error = handleSkippableHardwareError(new Error(message), device, method);
-    expect(error?.errorCode).toBe(HardwareErrorCode.DeviceNotSupportMethod);
-  });
-
-  test('still fails the request on any other device error', () => {
-    const error = handleSkippableHardwareError(
-      new Error('Failure_ProcessError,Cancelled'),
-      device,
-      method
-    );
-    expect(error).toBeUndefined();
-  });
-});

package/__tests__/protocol-v2-key-export-confirmation.test.ts

@@ -1,75 +0,0 @@
-import MoneroGetWatchKey from '../src/api/monero/MoneroGetWatchKey';
-import MoneroKeyImageSync from '../src/api/monero/MoneroKeyImageSync';
-import ZcashGetFullViewingKey from '../src/api/zcash/ZcashGetFullViewingKey';
-import { UI_REQUEST } from '../src/events';
-import {
-  ProtocolV2UiInteractionCoordinator,
-  resolveProtocolV2UiInteraction,
-} from '../src/protocols/protocol-v2/uiInteraction';
-
-import type { BaseMethod } from '../src/api/BaseMethod';
-
-jest.mock('../src/data/config', () => ({
-  getSDKVersion: jest.fn(() => '1.0.0'),
-  DEFAULT_DOMAIN: 'https://jssdk.onekey.so/1.0.0/',
-}));
-
-const key = (byte: number) => byte.toString(16).padStart(2, '0').repeat(32);
-
-// Protocol V2 firmware sends no ButtonRequest, so these exports declare the prompt they cause.
-test.each<[string, () => BaseMethod]>([
-  [
-    'zcashGetFullViewingKey',
-    () =>
-      new ZcashGetFullViewingKey({
-        id: 1,
-        payload: { method: 'zcashGetFullViewingKey', path: "m/32'/133'/0'" },
-      }),
-  ],
-  [
-    'moneroGetWatchKey',
-    () =>
-      new MoneroGetWatchKey({
-        id: 1,
-        payload: { method: 'moneroGetWatchKey', path: "m/44'/128'/0'", networkType: 0 },
-      }),
-  ],
-  [
-    'moneroKeyImageSync',
-    () =>
-      new MoneroKeyImageSync({
-        id: 1,
-        payload: {
-          method: 'moneroKeyImageSync',
-          path: "m/44'/128'/0'",
-          networkType: 0,
-          transfers: [{ outKey: key(1), txPubKey: key(2), internalOutputIndex: 0 }],
-        },
-      }),
-  ],
-])('%s asks the client to show the device confirmation', (name, createMethod) => {
-  const method = createMethod();
-  method.init();
-  const postMessage = jest.fn();
-  const device = {
-    isProtocolV2: () => true,
-    toMessageObject: () => ({ connectId: 'pro2-test', deviceType: 'pro2' }),
-  };
-
-  // The same call the unlock-policy runner makes before run().
-  new ProtocolV2UiInteractionCoordinator(device as never, postMessage).enterMethodInteraction(
-    resolveProtocolV2UiInteraction(method)
-  );
-
-  expect(postMessage).toHaveBeenCalledTimes(1);
-  expect(postMessage).toHaveBeenCalledWith(
-    expect.objectContaining({
-      type: UI_REQUEST.REQUEST_BUTTON,
-      payload: expect.objectContaining({
-        reason: 'public-key-confirmation',
-        completion: 'operation-completed',
-        operation: name,
-      }),
-    })
-  );
-});

package/dist/api/zcash/ZcashGetFullViewingKey.d.ts

@@ -1,12 +0,0 @@
-import { BaseMethod } from '../BaseMethod';
-import type { ZcashGetFullViewingKey as HardwareZcashGetFullViewingKey } from '@onekeyfe/hd-transport';
-import type { ZcashFullViewingKey } from '../../types/api/zcashGetFullViewingKey';
-import type { DeviceFirmwareRange } from '../../types';
-export default class ZcashGetFullViewingKey extends BaseMethod<HardwareZcashGetFullViewingKey[]> {
-    hasBundle: boolean;
-    getSupportedProtocols(): readonly ["V2"];
-    init(): void;
-    getVersionRange(): DeviceFirmwareRange;
-    run(): Promise<Partial<ZcashFullViewingKey> | Partial<ZcashFullViewingKey>[]>;
-}
-//# sourceMappingURL=ZcashGetFullViewingKey.d.ts.map

package/dist/api/zcash/ZcashGetFullViewingKey.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ZcashGetFullViewingKey.d.ts","sourceRoot":"","sources":["../../../src/api/zcash/ZcashGetFullViewingKey.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAO3C,OAAO,KAAK,EAAE,sBAAsB,IAAI,8BAA8B,EAAE,MAAM,wBAAwB,CAAC;AACvG,OAAO,KAAK,EACV,mBAAmB,EAEpB,MAAM,wCAAwC,CAAC;AAChD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAGvD,MAAM,CAAC,OAAO,OAAO,sBAAuB,SAAQ,UAAU,CAAC,8BAA8B,EAAE,CAAC;IAC9F,SAAS,UAAS;IAElB,qBAAqB;IAIrB,IAAI;IAsBJ,eAAe,IAAI,mBAAmB;IAQhC,GAAG;CAyBV"}

package/dist/api/zcash/helpers.d.ts

@@ -1,2 +0,0 @@
-export declare function validateZcashAccountPath(path: string | number[]): number[];
-//# sourceMappingURL=helpers.d.ts.map

package/dist/api/zcash/helpers.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../../src/api/zcash/helpers.ts"],"names":[],"mappings":"AAIA,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,CAW1E"}

package/dist/types/api/zcashGetFullViewingKey.d.ts

@@ -1,13 +0,0 @@
-import type { CommonParams, Response } from '../params';
-export type ZcashFullViewingKey = {
-    path: string;
-    ufvk: string;
-};
-export type ZcashGetFullViewingKeyParams = {
-    path: string | number[];
-};
-export declare function zcashGetFullViewingKey(connectId: string, deviceId: string, params: CommonParams & ZcashGetFullViewingKeyParams): Response<ZcashFullViewingKey>;
-export declare function zcashGetFullViewingKey(connectId: string, deviceId: string, params: CommonParams & {
-    bundle?: ZcashGetFullViewingKeyParams[];
-}): Response<Array<ZcashFullViewingKey>>;
-//# sourceMappingURL=zcashGetFullViewingKey.d.ts.map

package/dist/types/api/zcashGetFullViewingKey.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"zcashGetFullViewingKey.d.ts","sourceRoot":"","sources":["../../../src/types/api/zcashGetFullViewingKey.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAExD,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,MAAM,CAAC;IAEb,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IAEzC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;CACzB,CAAC;AAEF,MAAM,CAAC,OAAO,UAAU,sBAAsB,CAC5C,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,YAAY,GAAG,4BAA4B,GAClD,QAAQ,CAAC,mBAAmB,CAAC,CAAC;AAEjC,MAAM,CAAC,OAAO,UAAU,sBAAsB,CAC5C,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,YAAY,GAAG;IAAE,MAAM,CAAC,EAAE,4BAA4B,EAAE,CAAA;CAAE,GACjE,QAAQ,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC,CAAC"}

package/src/api/zcash/ZcashGetFullViewingKey.ts

@@ -1,78 +0,0 @@
-import { BaseMethod } from '../BaseMethod';
-import { serializedPath } from '../helpers/pathUtils';
-import { validateParams, validateResult } from '../helpers/paramsValidator';
-import { UI_REQUEST } from '../../constants/ui-request';
-import { createMethodInteraction } from '../../protocols/protocol-v2/uiInteraction';
-import { validateZcashAccountPath } from './helpers';
-
-import type { ZcashGetFullViewingKey as HardwareZcashGetFullViewingKey } from '@onekeyfe/hd-transport';
-import type {
-  ZcashFullViewingKey,
-  ZcashGetFullViewingKeyParams,
-} from '../../types/api/zcashGetFullViewingKey';
-import type { DeviceFirmwareRange } from '../../types';
-
-// The device exports the UFVK only after the user confirms it on screen.
-export default class ZcashGetFullViewingKey extends BaseMethod<HardwareZcashGetFullViewingKey[]> {
-  hasBundle = false;
-
-  getSupportedProtocols() {
-    return ['V2'] as const;
-  }
-
-  init() {
-    this.checkDeviceId = true;
-    this.allowDeviceMode = [...this.allowDeviceMode, UI_REQUEST.NOT_INITIALIZE];
-    this.strictCheckDeviceSupport = true;
-    // The name matches no Protocol V2 confirmation rule, so the export prompt is declared here.
-    this.protocolV2UiInteraction = createMethodInteraction(
-      'public-key-confirmation',
-      'zcashGetFullViewingKey'
-    );
-
-    this.hasBundle = !!this.payload?.bundle;
-    const payload = this.hasBundle ? this.payload : { bundle: [this.payload] };
-
-    validateParams(payload, [{ name: 'bundle', type: 'array' }]);
-
-    this.params = [];
-    payload.bundle.forEach((batch: ZcashGetFullViewingKeyParams) => {
-      validateParams(batch, [{ name: 'path', required: true }]);
-      this.params.push({ address_n: validateZcashAccountPath(batch.path) });
-    });
-  }
-
-  getVersionRange(): DeviceFirmwareRange {
-    return {
-      model_pro2: {
-        min: '0.0.0',
-      },
-    };
-  }
-
-  async run() {
-    // Missing fields stay undefined so validateResult rejects them.
-    const responses: Partial<ZcashFullViewingKey>[] = [];
-
-    for (let i = 0; i < this.params.length; i++) {
-      const param = this.params[i];
-
-      const res = await this.device.commands.typedCall(
-        'ZcashGetFullViewingKey',
-        'ZcashFullViewingKey',
-        { ...param }
-      );
-
-      responses.push({
-        path: serializedPath(param.address_n),
-        ufvk: res.message.ufvk,
-      });
-    }
-
-    validateResult(responses, ['ufvk'], {
-      expectedLength: this.params.length,
-    });
-
-    return Promise.resolve(this.hasBundle ? responses : responses[0]);
-  }
-}

package/src/api/zcash/helpers.ts

@@ -1,16 +0,0 @@
-import { toHardened, validateStrictPath } from '../helpers/pathUtils';
-import { invalidParameter } from '../helpers/paramsValidator';
-
-// ZIP-32 account path: m/32'/133'/account'
-export function validateZcashAccountPath(path: string | number[]): number[] {
-  const addressN = validateStrictPath(path, 3);
-  if (
-    addressN.length !== 3 ||
-    addressN[0] !== toHardened(32) ||
-    addressN[1] !== toHardened(133) ||
-    addressN[2] < toHardened(0)
-  ) {
-    throw invalidParameter("Zcash requires a ZIP-32 account path m/32'/133'/account'");
-  }
-  return addressN;
-}

package/src/types/api/zcashGetFullViewingKey.ts

@@ -1,24 +0,0 @@
-import type { CommonParams, Response } from '../params';
-
-export type ZcashFullViewingKey = {
-  path: string;
-  // ZIP-316 unified full viewing key with transparent and Orchard components
-  ufvk: string;
-};
-
-export type ZcashGetFullViewingKeyParams = {
-  // ZIP-32 account path, m/32'/133'/account'
-  path: string | number[];
-};
-
-export declare function zcashGetFullViewingKey(
-  connectId: string,
-  deviceId: string,
-  params: CommonParams & ZcashGetFullViewingKeyParams
-): Response<ZcashFullViewingKey>;
-
-export declare function zcashGetFullViewingKey(
-  connectId: string,
-  deviceId: string,
-  params: CommonParams & { bundle?: ZcashGetFullViewingKeyParams[] }
-): Response<Array<ZcashFullViewingKey>>;