Class TypedDataEncoder

constructor

• new TypedDataEncoder(_types: Record<string, TypedDataField[]>): TypedDataEncoder

• Create a new TypedDataEncoder for %%types%%.

  This performs all necessary checking that types are valid and do not violate the [[link-eip-712]] structural constraints as well as computes the [[primaryType]].

  Parameters

  • _types: Record<string, TypedDataField[]>

  Returns TypedDataEncoder

ReadonlyprimaryType

types

• get types(): Record<string, TypedDataField[]>

• The types.

  Returns Record<string, TypedDataField[]>

_visit

• _visit(
      type: string,
      value: any,
      callback: (type: string, data: any) => any,
  ): any

• @_ignore:

  Parameters

  • type: string
  • value: any
  • callback: (type: string, data: any) => any

  Returns any

encode

• encode(value: Record<string, any>): string

• Return the fulled encoded %%value%% for the [[types]].

  Parameters

  • value: Record<string, any>

  Returns string

encodeData

• encodeData(type: string, value: any): string

• Return the encoded %%value%% for the %%type%%.

  Parameters

  • type: string
  • value: any

  Returns string

encodeType

• encodeType(name: string): string

• Return the full type for %%name%%.

  Parameters

  • name: string

  Returns string

getEncoder

• getEncoder(type: string): (value: any) => string

• Returnthe encoder for the specific %%type%%.

  Parameters

  • type: string

  Returns (value: any) => string

hash

• hash(value: Record<string, any>): string

• Return the hash of the fully encoded %%value%% for the [[types]].

  Parameters

  • value: Record<string, any>

  Returns string

hashStruct

• hashStruct(name: string, value: Record<string, any>): string

• Returns the hash of %%value%% for the type of %%name%%.

  Parameters

  • name: string
  • value: Record<string, any>

  Returns string

visit

• visit(
      value: Record<string, any>,
      callback: (type: string, data: any) => any,
  ): any

• Call %%calback%% for each value in %%value%%, passing the type and component within %%value%%.

  This is useful for replacing addresses or other transformation that may be desired on each component, based on its type.

  Parameters

  • value: Record<string, any>
  • callback: (type: string, data: any) => any

  Returns any

Staticencode

• encode(
      domain: TypedDataDomain,
      types: Record<string, TypedDataField[]>,
      value: Record<string, any>,
  ): string

• Return the fully encoded [[link-eip-712]] %%value%% for %%types%% with %%domain%%.

  Parameters

  • domain: TypedDataDomain
  • types: Record<string, TypedDataField[]>
  • value: Record<string, any>

  Returns string

Staticfrom

• from(types: Record<string, TypedDataField[]>): TypedDataEncoder

• Create a new TypedDataEncoder for %%types%%.

  Parameters

  • types: Record<string, TypedDataField[]>

  Returns TypedDataEncoder

StaticgetPayload

• getPayload(
      domain: TypedDataDomain,
      types: Record<string, TypedDataField[]>,
      value: Record<string, any>,
  ): any

• Returns the JSON-encoded payload expected by nodes which implement the JSON-RPC [[link-eip-712]] method.

  Parameters

  • domain: TypedDataDomain
  • types: Record<string, TypedDataField[]>
  • value: Record<string, any>

  Returns any

StaticgetPrimaryType

• getPrimaryType(types: Record<string, TypedDataField[]>): string

• Return the primary type for %%types%%.

  Parameters

  • types: Record<string, TypedDataField[]>

  Returns string

Statichash

• hash(
      domain: TypedDataDomain,
      types: Record<string, TypedDataField[]>,
      value: Record<string, any>,
  ): string

• Return the hash of the fully encoded [[link-eip-712]] %%value%% for %%types%% with %%domain%%.

  Parameters

  • domain: TypedDataDomain
  • types: Record<string, TypedDataField[]>
  • value: Record<string, any>

  Returns string

StatichashDomain

• hashDomain(domain: TypedDataDomain): string

• Return the domain hash for %%domain%%.

  Parameters

  • domain: TypedDataDomain

  Returns string

StatichashStruct

• hashStruct(
      name: string,
      types: Record<string, TypedDataField[]>,
      value: Record<string, any>,
  ): string

• Return the hashed struct for %%value%% using %%types%% and %%name%%.

  Parameters

  • name: string
  • types: Record<string, TypedDataField[]>
  • value: Record<string, any>

  Returns string

StaticresolveNames

• resolveNames(
      domain: TypedDataDomain,
      types: Record<string, TypedDataField[]>,
      value: Record<string, any>,
      resolveName: (name: string) => Promise<string>,
  ): Promise<{ domain: TypedDataDomain; value: any }>

• Resolves to the value from resolving all addresses in %%value%% for %%types%% and the %%domain%%.

  Parameters

  • domain: TypedDataDomain
  • types: Record<string, TypedDataField[]>
  • value: Record<string, any>
  • resolveName: (name: string) => Promise<string>

  Returns Promise<{ domain: TypedDataDomain; value: any }>