fixup! refactor(ethSignTypedData)!: Improve docs & types

Renames flow-type EthereumSignTypedHashOrData to EthereumSignTypedHashAndData. Adds the identical EthereumSignTypedHashAndData to typescript definitions.
trezor · Feb 4, 2022 · 7139d79 · 7139d79
1 parent 2fbfc67
commit 7139d79
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 9 deletions.
diff --git a/src/js/core/methods/EthereumSignTypedData.js b/src/js/core/methods/EthereumSignTypedData.js
@@ -9,15 +9,15 @@ import type { MessageResponse, EthereumTypedDataStructAck } from '../../types/tr
 import { ERRORS } from '../../constants';
 import type {
     EthereumSignTypedData as EthereumSignTypedDataParams,
-    EthereumSignTypedHashOrData as EthereumSignTypedHashOrDataParams,
+    EthereumSignTypedHashAndData as EthereumSignTypedHashAndDataParams,
 } from '../../types/networks/ethereum';
 import { getFieldType, parseArrayType, encodeData } from './helpers/ethereumSignTypedData';
 import { messageToHex } from '../../utils/formatUtils';
 
 type Params = $Diff<
     {
         address_n: number[],
-        ...$Exact<EthereumSignTypedDataParams> | $Exact<EthereumSignTypedHashOrDataParams>,
+        ...$Exact<EthereumSignTypedDataParams> | $Exact<EthereumSignTypedHashAndDataParams>,
     },
     { path: any }, // removes the "path" variable from this.params
 >;
@@ -104,7 +104,7 @@ export default class EthereumSignTypedData extends AbstractMethod<'ethereumSignT
 
             const { domain_separator_hash, message_hash } =
                 // $FlowIssue validateParams() confirms that these hashes exist
-                (this.params: EthereumSignTypedHashOrDataParams);
+                (this.params: EthereumSignTypedHashAndDataParams);
 
             // For Model 1 we use EthereumSignTypedHash
             const response = await cmd.typedCall(

diff --git a/src/js/types/api.js b/src/js/types/api.js
@@ -255,7 +255,7 @@ export type API = {
     ethereumSignTransaction: Method<Ethereum.EthereumSignTransaction, Ethereum.EthereumSignedTx>,
     ethereumSignMessage: Method<Ethereum.EthereumSignMessage, Protobuf.EthereumMessageSignature>,
     ethereumSignTypedData: Method<
-        Ethereum.EthereumSignTypedData | Ethereum.EthereumSignTypedHashOrData,
+        Ethereum.EthereumSignTypedData | Ethereum.EthereumSignTypedHashAndData,
         Protobuf.EthereumTypedDataSignature,
     >,
 

diff --git a/src/js/types/networks/ethereum.js b/src/js/types/networks/ethereum.js
@@ -125,7 +125,7 @@ export type EthereumSignTypedHash = {
  * Used for full EIP-712 signing or blind signing.
  * Supports both Trezor Model T and Trezor Model 1
  */
-export type EthereumSignTypedHashOrData = {
+export type EthereumSignTypedHashAndData = {
     ...$Exact<EthereumSignTypedData>,
     ...$Exact<EthereumSignTypedHash>,
 };

diff --git a/src/ts/types/api.d.ts b/src/ts/types/api.d.ts
@@ -310,10 +310,7 @@ export namespace TrezorConnect {
      */
     function ethereumSignTypedData<T extends Ethereum.EthereumSignTypedDataTypes>(
         params: P.CommonParams &
-            (
-                | Ethereum.EthereumSignTypedData<T>
-                | (Ethereum.EthereumSignTypedData<T> & Ethereum.EthereumSignTypedHash)
-            ),
+            (Ethereum.EthereumSignTypedData<T> | Ethereum.EthereumSignTypedHashAndData<T>),
     ): P.Response<Protobuf.EthereumTypedDataSignature>;
     function ethereumVerifyMessage(
         params: P.CommonParams & Ethereum.EthereumVerifyMessage,

diff --git a/src/ts/types/networks/ethereum.d.ts b/src/ts/types/networks/ethereum.d.ts
@@ -116,6 +116,13 @@ export interface EthereumSignTypedHash {
     message_hash?: string;
 }
 
+/**
+ * Used for full EIP-712 signing or blind signing.
+ * Supports both Trezor Model T and Trezor Model 1.
+ */
+export type EthereumSignTypedHashAndData<T extends EthereumSignTypedDataTypes> =
+    EthereumSignTypedData<T> & EthereumSignTypedHash;
+
 // verify message
 
 export interface EthereumVerifyMessage {