@onekeyfe/hd-transport 0.1.38 → 0.1.41

package/dist/utils/index.d.ts

@@ -0,0 +1,3 @@
+declare const ByteBuffer: any;
+export { ByteBuffer };
+//# sourceMappingURL=index.d.ts.map

package/dist/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAGA,QAAA,MAAM,UAAU,KAAuD,CAAC;AAExE,OAAO,EAAE,UAAU,EAAE,CAAC"}

package/dist/utils/namespace.d.ts

@@ -0,0 +1,2 @@
+export declare function getDefaultExportFromNamespaceIfPresent(n: any): any;
+//# sourceMappingURL=namespace.d.ts.map

package/dist/utils/namespace.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"namespace.d.ts","sourceRoot":"","sources":["../../src/utils/namespace.ts"],"names":[],"mappings":"AAAA,wBAAgB,sCAAsC,CAAC,CAAC,EAAE,GAAG,OAE5D"}

package/jest.config.js

@@ -0,0 +1,7 @@
+module.exports = {
+  preset: '../../jest.config.js',
+  testEnvironment: 'node',
+  modulePathIgnorePatterns: ['node_modules', '<rootDir>/lib', '<rootDir>/libDev'],
+  collectCoverage: true,
+  // collectCoverageFrom: ['src/**/*.ts'],
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onekeyfe/hd-transport",
-  "version": "0.1.38",
+  "version": "0.1.41",
   "description": "> TODO: description",
   "author": "OneKey",
   "homepage": "https://github.com/OneKeyHQ/hardware-js-sdk#readme",
@@ -13,8 +13,10 @@
   "scripts": {
     "dev": "rimraf dist && rollup -c ../../build/rollup.config.js -w",
     "build": "rimraf dist && rollup -c ../../build/rollup.config.js",
+    "test": "jest",
     "lint": "eslint .",
-    "lint:fix": "eslint . --fix"
+    "lint:fix": "eslint . --fix",
+    "update:protobuf": "./scripts/protobuf-build.sh"
   },
   "devDependencies": {
     "@types/bytebuffer": "^5.0.42"
@@ -24,5 +26,5 @@
     "long": "^4.0.0",
     "protobufjs": "^6.11.2"
   },
-  "gitHead": "5828c78b10fca8604e158ef425a8c7314ece2bbf"
+  "gitHead": "0c5bf8f29b26ee02a5587aa716db4dfd7b17defd"
 }

package/scripts/protobuf-build.sh

@@ -0,0 +1,57 @@
+#!/usr/bin/env bash
+
+set -euxo pipefail
+
+echo $#
+
+PARENT_PATH=$( cd "$(dirname "${BASH_SOURCE[0]}")" ; pwd -P )
+
+SRC="../../submodules/firmware/common/protob"
+DIST="."
+LANG="typescript"
+
+if [[ $# -ne 0 && $# -ne 3 ]]
+    then
+        echo "must provide either 3 or 0 arguments. $# provided"
+        exit 1
+fi
+
+if [[ $# -eq 3 ]]
+    then
+        SRC=$1
+        DIST=$2
+        LANG=$3
+fi
+
+if [[ "$LANG" != "typescript" && "$LANG" != "flow" ]];
+    then
+        echo "either typescript or flow must be specified as the third argument"
+        exit 1
+fi
+
+
+# BUILD combined messages.proto file from protobuf files
+# this code was copied from ./submodules/trezor-common/protob Makekile
+# clear protobuf syntax and remove unknown values to be able to work with proto2js
+echo 'syntax = "proto2";' > $DIST/messages.proto
+echo 'import "google/protobuf/descriptor.proto";' >> $DIST/messages.proto
+echo "Build proto file from $SRC"
+grep -hv -e '^import ' -e '^syntax' -e '^package' -e 'option java_' $SRC/messages*.proto \
+| sed 's/ hw\.trezor\.messages\.common\./ /' \
+| sed 's/ common\./ /' \
+| sed 's/ management\./ /' \
+| sed 's/^option /\/\/ option /' \
+| grep -v '    reserved '>> $DIST/messages.proto
+
+# BUILD messages.json from message.proto
+node_modules/.bin/pbjs -t json -p $DIST -o $DIST/messages.json --keep-case messages.proto
+rm $DIST/messages.proto
+
+echo "generating type definitions for: $LANG"
+
+cd "$PARENT_PATH"
+
+node ./protobuf-types.js $LANG
+
+yarn prettier --write messages.json
+yarn prettier --write **/messages.ts

package/scripts/protobuf-patches/TxAck.js

@@ -0,0 +1,44 @@
+// @flow
+
+// TxAck replacement
+// TxAck needs more exact types
+// PrevInput and TxInputType requires exact responses in TxAckResponse
+// main difference: PrevInput should not contain address_n (unexpected field by protobuf)
+
+// @overhead-start this will be removed during compilation
+type TxInputType = any;
+type PrevInput = any;
+type TxOutputBinType = any;
+type TxOutputType = any;
+// @overhead-end
+
+export type TxAckResponse =
+    | {|
+          inputs: Array<TxInputType | PrevInput>,
+      |}
+    | {|
+          bin_outputs: TxOutputBinType[],
+      |}
+    | {|
+          outputs: TxOutputType[],
+      |}
+    | {|
+          extra_data: string,
+      |}
+    | {|
+          version?: number,
+          lock_time?: number,
+          inputs_cnt: number,
+          outputs_cnt: number,
+          extra_data?: string,
+          extra_data_len?: number,
+          timestamp?: number,
+          version_group_id?: number,
+          expiry?: number,
+          branch_id?: number,
+      |};
+
+export type TxAck = {
+    tx: TxAckResponse,
+};
+// - TxAck replacement end

package/scripts/protobuf-patches/TxInputType.js

@@ -0,0 +1,49 @@
+// @flow
+// TxInputType replacement
+// TxInputType needs more exact types
+// differences: external input (no address_n + required script_pubkey)
+
+// @overhead-start
+// will be removed during compilation
+type UintType = any;
+type MultisigRedeemScriptType = any;
+type InternalInputScriptType = any;
+type DecredStakingSpendType = any;
+// @overhead-end
+
+// @flowtype-variant: export type InternalInputScriptType = $Keys<$Diff<typeof Enum_InputScriptType, { EXTERNAL: * }>>;
+// @typescript-variant: export type InternalInputScriptType = Exclude<InputScriptType, 'EXTERNAL'>;
+
+type CommonTxInputType = {|
+    prev_hash: string, // required: previous transaction hash (reversed)
+    prev_index: number, // required: previous transaction index
+    amount: UintType, // required
+    sequence?: number,
+    multisig?: MultisigRedeemScriptType,
+    decred_tree?: number,
+    orig_hash?: string, // RBF
+    orig_index?: number, // RBF
+    decred_staking_spend?: DecredStakingSpendType,
+    script_pubkey?: string, // required if script_type=EXTERNAL
+    script_sig?: string, // used by EXTERNAL, depending on script_pubkey
+    witness?: string, // used by EXTERNAL, depending on script_pubkey
+    ownership_proof?: string, // used by EXTERNAL, depending on script_pubkey
+    commitment_data?: string, // used by EXTERNAL, depending on ownership_proof
+|};
+
+export type TxInputType =
+    | {|
+          ...CommonTxInputType,
+          address_n: number[],
+          script_type?: InternalInputScriptType,
+      |}
+    | {|
+          ...CommonTxInputType,
+          address_n?: typeof undefined,
+          script_type: 'EXTERNAL',
+          script_pubkey: string,
+      |};
+
+export type TxInput = TxInputType;
+
+// TxInputType replacement end

package/scripts/protobuf-patches/TxOutputType.js

@@ -0,0 +1,50 @@
+// @flow
+// TxOutputType replacement
+// TxOutputType needs more exact types
+// differences: external output (no address_n), opreturn output (no address_n, no address)
+
+// @overhead-start
+// will be removed during compilation
+type UintType = any;
+type MultisigRedeemScriptType = any;
+type ChangeOutputScriptType = any;
+// @overhead-end
+
+// @typescript-variant: export type ChangeOutputScriptType = Exclude<OutputScriptType, 'PAYTOOPRETURN'>;
+// @flowtype-variant: export type ChangeOutputScriptType = $Keys<$Diff<typeof Enum_OutputScriptType, { PAYTOOPRETURN: * }>>;
+
+export type TxOutputType =
+    | {|
+          address: string,
+          address_n?: typeof undefined,
+          script_type: 'PAYTOADDRESS',
+          amount: UintType,
+          multisig?: MultisigRedeemScriptType,
+          orig_hash?: string,
+          orig_index?: number,
+          payment_req_index?: number,
+      |}
+    | {|
+          address?: typeof undefined,
+          address_n: number[],
+          script_type: ChangeOutputScriptType,
+          amount: UintType,
+          multisig?: MultisigRedeemScriptType,
+          orig_hash?: string,
+          orig_index?: number,
+          payment_req_index?: number,
+      |}
+    | {|
+          address?: typeof undefined,
+          address_n?: typeof undefined,
+          amount: '0',
+          op_return_data: string,
+          script_type: 'PAYTOOPRETURN',
+          orig_hash?: string,
+          orig_index?: number,
+          payment_req_index?: number,
+      |};
+
+export type TxOutput = TxOutputType;
+
+// - TxOutputType replacement end

package/scripts/protobuf-patches/index.js

@@ -0,0 +1,305 @@
+const fs = require('fs');
+const path = require('path');
+
+const UINT_TYPE = 'UintType';
+
+// type rule fixes, ideally it should not be here
+const RULE_PATCH = {
+    'MultisigRedeemScriptType.nodes': 'optional', // its valid to be undefined according to implementation/tests
+    'MultisigRedeemScriptType.address_n': 'optional', // its valid to be undefined according to implementation/tests
+    'TxRequestDetailsType.request_index': 'required',
+    'TxRequest.request_type': 'required',
+    'TxRequest.details': 'required',
+    'TxAckPaymentRequest.memos': 'optional', // protobuf repeated bytes are always optional (fallback to [])
+    'CardanoPoolOwnerType.staking_key_path': 'optional',
+    'CardanoPoolOwner.staking_key_path': 'optional',
+    'CardanoTxCertificateType.path': 'optional',
+    'CardanoTxCertificate.path': 'optional',
+    'CardanoTxInputType.address_n': 'optional',
+    'CardanoTxWithdrawal.path': 'optional',
+    'CardanoNativeScript.scripts': 'optional',
+    'CardanoNativeScript.key_path': 'optional',
+    'CardanoTxRequiredSigner.key_path': 'optional',
+    'Success.message': 'required', // didn't find use case where it's not sent
+    'SignedIdentity.address': 'required',
+    'EosAuthorizationKey.key': 'required', // its valid to be undefined according to implementation/tests
+    'EosAuthorizationKey.type': 'optional', // its valid to be undefined according to implementation/tests
+    'EosAuthorizationKey.address_n': 'optional', // its valid to be undefined according to implementation/tests
+    'EthereumAddress.address': 'required', // address is transformed from legacy type _old_address
+    // TODO: Features should be union: bootloader|normal
+    // fields below are marked as required because of backward compatibility (suite implementation)
+    'Features.vendor': 'required',
+    'Features.bootloader_mode': 'required',
+    'Features.device_id': 'required',
+    'Features.major_version': 'required',
+    'Features.minor_version': 'required',
+    'Features.patch_version': 'required',
+    'Features.pin_protection': 'required',
+    'Features.passphrase_protection': 'required',
+    'Features.language': 'required',
+    'Features.label': 'required',
+    'Features.initialized': 'required',
+    'Features.revision': 'required',
+    'Features.bootloader_hash': 'required',
+    'Features.imported': 'required',
+    'Features.unlocked': 'required',
+    'Features.firmware_present': 'required',
+    'Features.needs_backup': 'required',
+    'Features.flags': 'required',
+    'Features.fw_major': 'required',
+    'Features.fw_minor': 'required',
+    'Features.fw_patch': 'required',
+    'Features.fw_vendor': 'required',
+    'Features.model': 'required',
+    'Features.unfinished_backup': 'required',
+    'Features.no_backup': 'required',
+    'Features.recovery_mode': 'required',
+    'Features.backup_type': 'required',
+    'Features.sd_card_present': 'required',
+    'Features.sd_protection': 'required',
+    'Features.wipe_code_protection': 'required',
+    'Features.session_id': 'required',
+    'Features.passphrase_always_on_device': 'required',
+    'Features.safety_checks': 'required',
+    'Features.auto_lock_delay_ms': 'required',
+    'Features.display_rotation': 'required',
+    'Features.experimental_features': 'required',
+    'GetOwnershipProof.ownership_ids': 'optional', // protobuf repeated bytes are always optional (fallback to [])
+    'NEMTransactionCommon.address_n': 'optional', // no address_n in multisig
+    'NEMTransfer.mosaics': 'optional', // its valid to be undefined according to implementation/tests
+    'NEMMosaicDefinition.networks': 'optional', // never used according to implementation/tests
+    'NEMAggregateModification.modifications': 'optional', // its valid to be undefined according to implementation/tests
+    'StellarAssetType.code': 'required',
+    'StellarPathPaymentStrictReceiveOp.paths': 'optional', // its valid to be undefined according to implementation/tests
+    'StellarPathPaymentStrictSendOp.paths': 'optional', // its valid to be undefined according to implementation/tests
+};
+
+// custom types IN to trezor
+// protobuf lib will handle the translation to required type
+// connect or other 3rd party libs are using compatible types (string as number etc...)
+const TYPE_PATCH = {
+    'Features.bootloader_mode': 'boolean | null',
+    'Features.device_id': 'string | null',
+    'Features.pin_protection': 'boolean | null',
+    'Features.passphrase_protection': 'boolean | null',
+    'Features.language': 'string | null',
+    'Features.label': 'string | null',
+    'Features.initialized': 'boolean | null',
+    'Features.revision': 'string | null',
+    'Features.bootloader_hash': 'string | null',
+    'Features.imported': 'boolean | null',
+    'Features.unlocked': 'boolean | null',
+    'Features.firmware_present': 'boolean | null',
+    'Features.needs_backup': 'boolean | null',
+    'Features.flags': 'number | null',
+    'Features.fw_major': 'number | null',
+    'Features.fw_minor': 'number | null',
+    'Features.fw_patch': 'number | null',
+    'Features.fw_vendor': 'string | null',
+    'Features.unfinished_backup': 'boolean | null',
+    'Features.no_backup': 'boolean | null',
+    'Features.recovery_mode': 'boolean | null',
+    'Features.backup_type': 'BackupType | null',
+    'Features.sd_card_present': 'boolean | null',
+    'Features.sd_protection': 'boolean | null',
+    'Features.wipe_code_protection': 'boolean | null',
+    'Features.session_id': 'string | null',
+    'Features.passphrase_always_on_device': 'boolean | null',
+    'Features.safety_checks': 'SafetyCheckLevel | null',
+    'Features.auto_lock_delay_ms': 'number | null',
+    'Features.display_rotation': 'number | null',
+    'Features.experimental_features': 'boolean | null',
+    'HDNodePathType.node': 'HDNodeType | string',
+    'FirmwareUpload.payload': 'Buffer | ArrayBuffer',
+    'CardanoCatalystRegistrationParametersType.nonce': UINT_TYPE,
+    'CardanoPoolParametersType.pledge': UINT_TYPE,
+    'CardanoPoolParametersType.cost': UINT_TYPE,
+    'CardanoPoolParametersType.margin_numerator': UINT_TYPE,
+    'CardanoPoolParametersType.margin_denominator': UINT_TYPE,
+    'CardanoSignTx.ttl': UINT_TYPE,
+    'CardanoSignTx.validity_interval_start': UINT_TYPE,
+    'CardanoSignTxInit.ttl': UINT_TYPE,
+    'CardanoSignTxInit.validity_interval_start': UINT_TYPE,
+    'CardanoToken.mint_amount': UINT_TYPE,
+    'CardanoNativeScript.invalid_before': UINT_TYPE,
+    'CardanoNativeScript.invalid_hereafter': UINT_TYPE,
+    'EosAsset.symbol': 'string',
+    'EosPermissionLevel.actor': 'string',
+    'EosPermissionLevel.permission': 'string',
+    'EosAuthorizationKey.key': 'string',
+    'EosActionCommon.account': 'string',
+    'EosActionCommon.name': 'string',
+    'EosActionTransfer.sender': 'string',
+    'EosActionTransfer.receiver': 'string',
+    'EosActionDelegate.sender': 'string',
+    'EosActionDelegate.receiver': 'string',
+    'EosActionUndelegate.sender': 'string',
+    'EosActionUndelegate.receiver': 'string',
+    'EosActionRefund.owner': 'string',
+    'EosActionBuyRam.payer': 'string',
+    'EosActionBuyRam.receiver': 'string',
+    'EosActionBuyRamBytes.payer': 'string',
+    'EosActionBuyRamBytes.receiver': 'string',
+    'EosActionSellRam.account': 'string',
+    'EosActionVoteProducer.voter': 'string',
+    'EosActionVoteProducer.proxy': 'string',
+    'EosActionVoteProducer.producers': 'string',
+    'EosActionUpdateAuth.account': 'string',
+    'EosActionUpdateAuth.permission': 'string',
+    'EosActionUpdateAuth.parent': 'string',
+    'EosActionDeleteAuth.account': 'string',
+    'EosActionDeleteAuth.permission': 'string',
+    'EosActionLinkAuth.account': 'string',
+    'EosActionLinkAuth.code': 'string',
+    'EosActionLinkAuth.type': 'string',
+    'EosActionLinkAuth.requirement': 'string',
+    'EosActionUnlinkAuth.account': 'string',
+    'EosActionUnlinkAuth.code': 'string',
+    'EosActionUnlinkAuth.type': 'string',
+    'EosActionNewAccount.creator': 'string',
+    'EosActionNewAccount.name': 'string',
+    'ResetDevice.backup_type': 'string | number', // BackupType is a enum. in Features displayed as string, in resetDevice method param accepted as number
+    'StellarAssetType.type': '0 | 1 | 2',
+    'StellarSignTx.sequence_number': UINT_TYPE,
+    'StellarSignTx.memo_id': 'string',
+    'StellarSignTx.memo_hash': 'Buffer | string',
+    'StellarCreateAccountOp.starting_balance': UINT_TYPE,
+    'StellarPathPaymentStrictReceiveOp.send_max': UINT_TYPE,
+    'StellarPathPaymentStrictReceiveOp.destination_amount': UINT_TYPE,
+    'StellarPathPaymentStrictSendOp.send_amount': UINT_TYPE,
+    'StellarPathPaymentStrictSendOp.destination_min': UINT_TYPE,
+    'StellarManageSellOfferOp.offer_id': UINT_TYPE,
+    'StellarManageBuyOfferOp.offer_id': UINT_TYPE,
+    'StellarSetOptionsOp.master_weight': UINT_TYPE,
+    'StellarSetOptionsOp.low_threshold': UINT_TYPE,
+    'StellarSetOptionsOp.medium_threshold': UINT_TYPE,
+    'StellarSetOptionsOp.high_threshold': UINT_TYPE,
+    'StellarSetOptionsOp.signer_key': 'Buffer | string',
+    'StellarChangeTrustOp.limit': UINT_TYPE,
+    'StellarManageDataOp.value': 'Buffer | string',
+    'StellarBumpSequenceOp.bump_to': UINT_TYPE,
+    'TezosContractID.tag': 'number',
+    'TezosContractID.hash': 'Uint8Array',
+    'TezosRevealOp.source': 'Uint8Array',
+    'TezosRevealOp.public_key': 'Uint8Array',
+    'TezosParametersManager.set_delegate': 'Uint8Array',
+    'TezosTransactionOp.source': 'Uint8Array',
+    'TezosTransactionOp.parameters': 'number[]',
+    'TezosOriginationOp.source': 'Uint8Array',
+    'TezosOriginationOp.delegate': 'Uint8Array',
+    'TezosOriginationOp.script': 'string | number[]',
+    'TezosDelegationOp.source': 'Uint8Array',
+    'TezosDelegationOp.delegate': 'Uint8Array',
+    'TezosSignTx.branch': 'Uint8Array',
+};
+
+const DEFINITION_PATCH = {
+    TxInputType: fs.readFileSync(path.join(__dirname, './TxInputType.js'), 'utf8'),
+    TxOutputType: fs.readFileSync(path.join(__dirname, './TxOutputType.js'), 'utf8'),
+    TxAck: fs.readFileSync(path.join(__dirname, './TxAck.js'), 'utf8'),
+};
+
+// skip unnecessary types
+const SKIP = [
+    'MessageType', // connect uses custom definition
+    'TransactionType', // connect uses custom definition
+    'TxInput', // declared in TxInputType patch
+    'TxOutput', // declared in TxOutputType patch
+    // not implemented
+    'CosiCommit',
+    'CosiCommitment',
+    'CosiSign',
+    'CosiSignature',
+    'DebugSwipeDirection',
+    'DebugLinkDecision',
+    'DebugLinkLayout',
+    'DebugLinkReseedRandom',
+    'DebugLinkRecordScreen',
+    'DebugLinkGetState',
+    'DebugLinkState',
+    'DebugLinkStop',
+    'DebugLinkLog',
+    'DebugLinkMemoryRead',
+    'DebugLinkMemory',
+    'DebugLinkMemoryWrite',
+    'DebugLinkFlashErase',
+    'DebugLinkEraseSdCard',
+    'DebugLinkWatchLayout',
+    'LoadDevice',
+    'MoneroRctKeyPublic',
+    'MoneroOutputEntry',
+    'MoneroMultisigKLRki',
+    'MoneroTransactionSourceEntry',
+    'MoneroAccountPublicAddress',
+    'MoneroTransactionDestinationEntry',
+    'MoneroTransactionRsigData',
+    'MoneroGetAddress',
+    'MoneroAddress',
+    'MoneroGetWatchKey',
+    'MoneroWatchKey',
+    'MoneroTransactionData',
+    'MoneroTransactionInitRequest',
+    'MoneroTransactionInitAck',
+    'MoneroTransactionSetInputRequest',
+    'MoneroTransactionSetInputAck',
+    'MoneroTransactionInputsPermutationRequest',
+    'MoneroTransactionInputsPermutationAck',
+    'MoneroTransactionInputViniRequest',
+    'MoneroTransactionInputViniAck',
+    'MoneroTransactionAllInputsSetRequest',
+    'MoneroTransactionAllInputsSetAck',
+    'MoneroTransactionSetOutputRequest',
+    'MoneroTransactionSetOutputAck',
+    'MoneroTransactionAllOutSetRequest',
+    'MoneroRingCtSig',
+    'MoneroTransactionAllOutSetAck',
+    'MoneroTransactionSignInputRequest',
+    'MoneroTransactionSignInputAck',
+    'MoneroTransactionFinalRequest',
+    'MoneroTransactionFinalAck',
+    'MoneroSubAddressIndicesList',
+    'MoneroKeyImageExportInitRequest',
+    'MoneroKeyImageExportInitAck',
+    'MoneroTransferDetails',
+    'MoneroKeyImageSyncStepRequest',
+    'MoneroExportedKeyImage',
+    'MoneroKeyImageSyncStepAck',
+    'MoneroKeyImageSyncFinalRequest',
+    'MoneroKeyImageSyncFinalAck',
+    'MoneroGetTxKeyRequest',
+    'MoneroGetTxKeyAck',
+    'MoneroLiveRefreshStartRequest',
+    'MoneroLiveRefreshStartAck',
+    'MoneroLiveRefreshStepRequest',
+    'MoneroLiveRefreshStepAck',
+    'MoneroLiveRefreshFinalRequest',
+    'MoneroLiveRefreshFinalAck',
+    'DebugMoneroDiagRequest',
+    'DebugMoneroDiagAck',
+    'WebAuthnListResidentCredentials',
+    'WebAuthnAddResidentCredential',
+    'WebAuthnRemoveResidentCredential',
+    'WebAuthnCredential',
+    'WebAuthnCredentials',
+    'wire_in',
+    'wire_out',
+    'wire_debug_in',
+    'wire_debug_out',
+    'wire_tiny',
+    'wire_bootloader',
+    'wire_no_fsm',
+    'bitcoin_only',
+    'has_bitcoin_only_values',
+    'unstable',
+    'wire_type',
+    'experimental',
+    'include_in_bitcoin_only',
+];
+
+module.exports = {
+    RULE_PATCH,
+    TYPE_PATCH,
+    DEFINITION_PATCH,
+    SKIP,
+    UINT_TYPE,
+};