Skip to main content
Version: Next

Function: getStructHash()

getStructHash<T>(types, type, data, revision?): string

Defined in: src/utils/typedData.ts:528

Get encoded data as a hash. The data should be a key -> value object with all the required values. All dependent types are automatically encoded.

Type Parameters​

T​

T extends TypedData

Parameters​

types​

T["types"]

The types object containing all defined types.

type​

string

The name of the type to hash.

data​

T["message"]

The data to hash.

revision?​

TypedDataRevision = Revision.LEGACY

The revision of the TypedData.

Returns​

string

The hash of the encoded data.

Example​

import exampleBaseTypes from '../../__mocks__/typedData/example_baseTypes.json';

const result = getStructHash(
   exampleBaseTypes.types,
   'StarknetDomain',
   exampleBaseTypes.domain as StarknetDomain,
   TypedDataRevision.ACTIVE
 );
 // result = "0x555f72e550b308e50c1a4f8611483a174026c982a9893a05c185eeb85399657";