@onekeyfe/hd-transport 1.1.34-alpha.3 → 1.1.34-alpha.4

package/__tests__/build-receive.test.js

@@ -1,5 +1,7 @@
 const { parseConfigure } = require('../src/serialization/protobuf/messages');
-const { ProtocolV1 } = require('../src/protocols');
+const { buildOne } = require('../src/serialization/send');
+const { receiveOne } = require('../src/serialization/receive');
+const { buildEncodeBuffers } = require('../src/serialization/send');
 
 const messages = {
   StellarPaymentOp: {
@@ -94,17 +96,17 @@ const parsedMessages = parseConfigure({
 describe('encoding json -> protobuf -> json', () => {
   fixtures.forEach(f => {
     describe(f.name, () => {
-      test('encodeEnvelope - decodeMessage', () => {
+      test('buildOne - receiveOne', () => {
         // encoded message
-        const encodedMessage = ProtocolV1.encodeEnvelope(parsedMessages, f.name, f.in);
+        const encodedMessage = buildOne(parsedMessages, f.name, f.in);
         // then decode message and check, whether decoded message matches original json
-        const decodedMessage = ProtocolV1.decodeMessage(parsedMessages, encodedMessage);
+        const decodedMessage = receiveOne(parsedMessages, encodedMessage);
         expect(decodedMessage.type).toEqual(f.name);
         expect(decodedMessage.message).toEqual(f.in);
       });
 
-      test('encodeMessageChunks - receiveAndParse', () => {
-        const result = ProtocolV1.encodeMessageChunks(parsedMessages, f.name, f.in);
+      test('buildBuffers - receiveAndParse', () => {
+        const result = buildEncodeBuffers(parsedMessages, f.name, f.in);
         result.forEach(r => {
           expect(r.byteLength).toBeLessThanOrEqual(63);
         });

package/__tests__/decode-features.test.js

@@ -1,9 +1,8 @@
-/* eslint-disable import/order */
 const ProtoBuf = require('protobufjs/light');
 const ByteBuffer = require('bytebuffer');
 
 const { decode } = require('../src/serialization/protobuf/decode');
-const { decodeEnvelope } = require('../src/protocols/v1/decode');
+const { decode: decodeProtocol } = require('../src/serialization/protocol/decode');
 
 // Reuse the messages.json already committed alongside @onekeyfe/hd-core
 // (runtime data for DataManager). hd-transport's own messages.json is
@@ -62,7 +61,7 @@ describe('Fix messages decode', () => {
       test('decode', () => {
         // deserialize
         const encoded = ByteBuffer.fromHex(f.encodeMessage);
-        const { buffer } = decodeEnvelope(encoded);
+        const { buffer } = decodeProtocol(encoded);
         const decoded = decode(Message, buffer);
 
         // filter null values

package/__tests__/messages.test.js

@@ -3,11 +3,6 @@ const {
   createMessageFromType,
   parseConfigure,
 } = require('../src/serialization/protobuf/messages');
-const v1Messages = require('../../core/src/data/messages/messages.json');
-const v2Messages = require('../messages-protocol-v2.json');
-const coreV2Messages = require('../../core/src/data/messages/messages-protocol-v2.json');
-const generatedTypes = require('../src/types/messages');
-
 // const json = require('./data/messages.json');
 
 const json = {
@@ -63,116 +58,6 @@ const json = {
 };
 
 describe('messages', () => {
-  test('V1 GetPassphraseState matches the current firmware schema', () => {
-    const { fields } = v1Messages.nested.GetPassphraseState;
-
-    expect(fields.passphrase_state).toMatchObject({ id: 1, type: 'string' });
-    expect(fields).not.toHaveProperty('_only_main_pin');
-    expect(fields).not.toHaveProperty('allow_create_attach_pin');
-  });
-
-  test('Protocol V2 firmware targets match the current firmware-pro2 enum', () => {
-    expect(v2Messages.nested.DeviceFirmwareTargetType.values).toEqual({
-      FW_MGMT_TARGET_INVALID: 0,
-      FW_MGMT_TARGET_CRATE: 1,
-      FW_MGMT_TARGET_ROMLOADER: 2,
-      FW_MGMT_TARGET_BOOTLOADER: 3,
-      FW_MGMT_TARGET_APPLICATION_P1: 4,
-      FW_MGMT_TARGET_APPLICATION_P2: 5,
-      FW_MGMT_TARGET_COPROCESSOR: 6,
-      FW_MGMT_TARGET_SE01: 7,
-      FW_MGMT_TARGET_SE02: 8,
-      FW_MGMT_TARGET_SE03: 9,
-      FW_MGMT_TARGET_SE04: 10,
-    });
-  });
-
-  test('Protocol V2 conflicting enums keep their own wire values', () => {
-    expect(generatedTypes.ProtocolV2FailureType).toMatchObject({
-      Failure_DataError: 4,
-      Failure_ProcessError: 5,
-    });
-    expect(generatedTypes.Enum_ProtocolV2Capability).toMatchObject({
-      Capability_AttachToPin: 18,
-    });
-  });
-
-  test('Protocol V2 device status and session messages match firmware-pro2', () => {
-    expect(v2Messages.nested.MessageType.values).toMatchObject({
-      MessageType_DeviceStatusGet: 60602,
-      MessageType_DeviceStatus: 60603,
-      MessageType_DeviceSessionOpen: 60606,
-      MessageType_DeviceSession: 60607,
-      MessageType_DeviceSessionAskPin: 60608,
-    });
-    expect(v2Messages.nested.DeviceStatusGet).toEqual({ fields: {} });
-    expect(v2Messages.nested.DeviceSessionResume.fields.session_id).toMatchObject({
-      id: 1,
-      type: 'bytes',
-    });
-    expect(v2Messages.nested.DeviceWalletSelect.oneofs.access.oneof).toEqual([
-      'host_passphrase',
-      'passphrase_on_device',
-      'attach_pin_on_device',
-    ]);
-    expect(v2Messages.nested.DeviceSessionOpen.oneofs.mode.oneof).toEqual(['resume', 'select']);
-    expect(v2Messages.nested).not.toHaveProperty('DeviceWalletType');
-    expect(v2Messages.nested).not.toHaveProperty('DeviceHiddenWalletSelect');
-    expect(v2Messages.nested.DeviceSession.fields).toMatchObject({
-      session_id: { id: 1, type: 'bytes' },
-      btc_test_address: { id: 2, type: 'string' },
-    });
-    expect(v2Messages.nested.DeviceSessionAskPin).toEqual({ fields: {} });
-    expect(v2Messages.nested.DeviceSessionAskPin_FailureSubCodes.values).toEqual({
-      UserCancel: 1,
-    });
-    expect(v2Messages.nested.MessageType.values).not.toHaveProperty(
-      'MessageType_DeviceSessionPinResult'
-    );
-    expect(v2Messages.nested.MessageType.values).not.toHaveProperty('MessageType_DeviceSessionGet');
-  });
-
-  test('Protocol V2 onboarding status matches the current firmware-pro2 schema', () => {
-    expect(v2Messages.nested.DevOnboardingStep.values).toMatchObject({
-      DEV_ONBOARDING_STEP_UNKNOWN: 0,
-      DEV_ONBOARDING_STEP_CHECKING: 1,
-      DEV_ONBOARDING_STEP_PERSONALIZATION: 2,
-      DEV_ONBOARDING_STEP_PIN: 3,
-      DEV_ONBOARDING_STEP_SETUP: 4,
-      DEV_ONBOARDING_STEP_DONE: 5,
-    });
-    expect(v2Messages.nested.DevOnboardingPhase.values).toBeDefined();
-    expect(v2Messages.nested.DevOnboardingSetupKind.values).toBeDefined();
-    expect(v2Messages.nested.DevOnboardingSetupMethod.values).toBeDefined();
-    expect(v2Messages.nested.DevOnboardingSetupStatus.fields).toMatchObject({
-      kind: { id: 1, type: 'DevOnboardingSetupKind' },
-      method: { id: 2, type: 'DevOnboardingSetupMethod' },
-    });
-    expect(v2Messages.nested.DevOnboardingStatus.fields).toMatchObject({
-      step: { id: 1, type: 'DevOnboardingStep' },
-      phase: { id: 2, type: 'DevOnboardingPhase' },
-      setup: { id: 3, type: 'DevOnboardingSetupStatus' },
-      pin_set: { id: 4, type: 'bool' },
-      wallet_initialized: { id: 5, type: 'bool' },
-    });
-    expect(v2Messages.nested).not.toHaveProperty('DevOnboardingStage');
-  });
-
-  test('Protocol V2 does not restore retired unlock or passphrase ids', () => {
-    expect(v2Messages.nested.MessageType.values).not.toHaveProperty('MessageType_UnLockDevice');
-    expect(v2Messages.nested.MessageType.values).not.toHaveProperty(
-      'MessageType_UnLockDeviceResponse'
-    );
-    expect(v2Messages.nested.MessageType.values).not.toHaveProperty(
-      'MessageType_GetPassphraseState'
-    );
-    expect(v2Messages.nested.MessageType.values).not.toHaveProperty('MessageType_PassphraseState');
-  });
-
-  test('Protocol V2 transport and core schemas stay identical', () => {
-    expect(coreV2Messages).toEqual(v2Messages);
-  });
-
   test('createMessageFromName (common case)', () => {
     const messages = parseConfigure(json);
     const name = 'Initialize';
@@ -185,14 +70,6 @@ describe('messages', () => {
     expect(() => createMessageFromType(messages, 0)).not.toThrow();
   });
 
-  test('createMessageFromType throws a readable error for unknown ids', () => {
-    const messages = parseConfigure(json);
-
-    expect(() => createMessageFromType(messages, 99999)).toThrow(
-      'MessageType id "99999" is not defined in protobuf schema'
-    );
-  });
-
   test('createMessageFromName (wire_type case)', () => {
     const messages = parseConfigure(json);
     const name = 'TxAckInput';
@@ -206,12 +83,4 @@ describe('messages', () => {
 
     expect(() => createMessageFromName(messages, name)).not.toThrow();
   });
-
-  test('createMessageFromName throws when message type id is missing', () => {
-    const messages = parseConfigure(json);
-
-    expect(() => createMessageFromName(messages, 'TxAckInputWrapper')).toThrow(
-      'MessageType for "TxAckInputWrapper" is not defined in protobuf schema'
-    );
-  });
 });

package/dist/constants.d.ts

@@ -1,17 +1,6 @@
-export declare const PROTOCOL_V1_REPORT_ID = 63;
-export declare const PROTOCOL_V1_HEADER_BYTE = 35;
-export declare const PROTOCOL_V1_CHUNK_PAYLOAD_SIZE = 63;
-export declare const PROTOCOL_V1_USB_PACKET_SIZE: number;
-export declare const PROTOCOL_V1_MESSAGE_HEADER_SIZE: number;
-export declare const PROTOCOL_V1_ENVELOPE_HEADER_SIZE: number;
-export declare const PROTOCOL_V2_FRAME_MAX_BYTES = 4608;
-export declare const PROTOCOL_V2_WEBUSB_FILE_CHUNK_SIZE = 4000;
-export declare const PROTOCOL_V2_BLE_FILE_CHUNK_SIZE = 1800;
-export declare const PROTOCOL_V2_BLE_FILE_READ_CHUNK_SIZE = 900;
-export declare const PROTOCOL_V2_BLE_FRAME_MAX_BYTES = 2048;
-export declare const PROTOCOL_V2_FILE_CHUNK_SIZE = 4000;
-export declare const PROTOCOL_V2_CHANNEL_USB = 0;
-export declare const PROTOCOL_V2_CHANNEL_BLE_UART = 1;
-export declare const PROTOCOL_V2_CHANNEL_SOCKET = 2;
-export declare const PROTOCOL_V2_PACKET_SRC_COMMAND = 0;
+export declare const MESSAGE_TOP_CHAR = 63;
+export declare const MESSAGE_HEADER_BYTE = 35;
+export declare const HEADER_SIZE: number;
+export declare const BUFFER_SIZE = 63;
+export declare const COMMON_HEADER_SIZE = 6;
 //# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,qBAAqB,KAAO,CAAC;AAG1C,eAAO,MAAM,uBAAuB,KAAO,CAAC;AAG5C,eAAO,MAAM,8BAA8B,KAAK,CAAC;AAGjD,eAAO,MAAM,2BAA2B,QAAqC,CAAC;AAG9E,eAAO,MAAM,+BAA+B,QAAQ,CAAC;AAGrD,eAAO,MAAM,gCAAgC,QAA0C,CAAC;AAKxF,eAAO,MAAM,2BAA2B,OAAO,CAAC;AAGhD,eAAO,MAAM,kCAAkC,OAAO,CAAC;AAGvD,eAAO,MAAM,+BAA+B,OAAO,CAAC;AAGpD,eAAO,MAAM,oCAAoC,MAAM,CAAC;AAGxD,eAAO,MAAM,+BAA+B,OAAO,CAAC;AAGpD,eAAO,MAAM,2BAA2B,OAAqC,CAAC;AAM9E,eAAO,MAAM,uBAAuB,IAAI,CAAC;AACzC,eAAO,MAAM,4BAA4B,IAAI,CAAC;AAC9C,eAAO,MAAM,0BAA0B,IAAI,CAAC;AAG5C,eAAO,MAAM,8BAA8B,IAAI,CAAC"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,gBAAgB,KAAS,CAAC;AACvC,eAAO,MAAM,mBAAmB,KAAO,CAAC;AACxC,eAAO,MAAM,WAAW,QAAgB,CAAC;AACzC,eAAO,MAAM,WAAW,KAAK,CAAC;AAI9B,eAAO,MAAM,kBAAkB,IAAI,CAAC"}