eth-sig-util - npm Package Compare versions

Comparing version 2.4.1 to 2.4.2

index.d.ts

 type hexPrefixedHex = string;
 type MsgParams = { data: string, sig?: string };
 type SignedMsgParams = {data: string, sig: string };
-type ITypedEntry = {
-  type: string, // Ideally enumerate the valid types here.
-  name: string,
 
+export type ITypedField = {
+  name: string
+  type: string // Ethereum supported type strings: uint256, string, address, ClassName, etc.
 }
-type TypedData = ITypedEntry[];
+
+export interface ITypedValue {
+  [key: string]: string | number | ITypedValue | ITypedValue[]
+}
+
+export type ITypedData = {
+  types: {
+    EIP712Domain: { [typeName: string]: Array<ITypedField> }
+  }
+  domain?: {
+    name?: string
+    version?: string
+    chainId?: number
+    verifyingContract?: string
+  }
+  primaryType: string
+  message: ITypedValue
+}
+
+export type ITypedDataSignatureParams = {
+  from: string
+  data: ITypedData
+}
+
 type EthJsBinary = Buffer | Uint8Array;
@@ -17,5 +40,4 @@ type EthEncryptedData = {
 }
-
-interface TypedDataParam {
-  data: TypedData,
+export interface ISignedTypedData {
+  data: ITypedData,
   sig: string,
@@ -25,4 +47,2 @@ }
 declare module "eth-sig-util" {
-  import { Buffer } from "safe-buffer"
-
   export function concatSig(v: number, r: Buffer, s: Buffer): Buffer
@@ -33,3 +53,3 @@ export function normalize (input: number | string ): hexPrefixedHex
   export function extractPublicKey(msgParams: SignedMsgParams): hexPrefixedHex
-  export function typedSignatureHash(typedData: TypedData): EthJsBinary
+  export function typedSignatureHash(typedData: ITypedData): EthJsBinary
 
@@ -44,10 +64,10 @@ export function getEncryptionPublicKey (privateKey: string): string
 
-  export function signTypedDataLegacy(privateKey: EthJsBinary, msgParams: TypedDataParam): hexPrefixedHex
+  export function signTypedDataLegacy(privateKey: EthJsBinary, msgParams: ITypedDataSignatureParams): hexPrefixedHex
   export function recoverTypedSignatureLegacy(msgParams: SignedMsgParams): hexPrefixedHex;
 
-  export function signTypedData(privateKey: EthJsBinary, msgParams: TypedDataParam): hexPrefixedHex
+  export function signTypedData(privateKey: EthJsBinary, msgParams: ITypedDataSignatureParams): hexPrefixedHex
   export function recoverTypedSignature(msgParams: SignedMsgParams): hexPrefixedHex;
 
-  export function signTypedData_v4(privateKey: EthJsBinary, msgParams: TypedDataParam): hexPrefixedHex
+  export function signTypedData_v4(privateKey: EthJsBinary, msgParams: ITypedDataSignatureParams): hexPrefixedHex
   export function recoverTypedSignature_v4(msgParams: SignedMsgParams): hexPrefixedHex;
 }

package.json

 {
   "name": "eth-sig-util",
-  "version": "2.4.1",
+  "version": "2.4.2",
   "description": "A few useful functions for signing ethereum data",
@@ -5,0 +5,0 @@ "main": "index.js",

No alert changes

Improved metrics

Total package byte prevSize

51624

increased by0.87%

Lines of code

1200

increased by1.52%

No dependency changes