eip712

Documentation

Index

• Constants
• func EncodeTypedDataV4(ctx context.Context, payload *TypedData) (encoded ethtypes.HexBytes0xPrefix, err error)
• func HashStruct(ctx context.Context, typeName string, v interface{}, allTypes TypeSet) (result ethtypes.HexBytes0xPrefix, err error)
• type Type
  • func (t Type) Encode(name string) string
• type TypeMember
  • func (tm *TypeMember) Encode() string
• type TypeSet
  • func ABItoTypedDataV4(ctx context.Context, tc abi.TypeComponent) (primaryType string, typeSet TypeSet, err error)
  • func (ts TypeSet) Encode(primaryType string) string
• type TypedData

Constants

const EIP712Domain = "EIP712Domain"

Functions

func EncodeTypedDataV4

func EncodeTypedDataV4(ctx context.Context, payload *TypedData) (encoded ethtypes.HexBytes0xPrefix, err error)

func HashStruct

func HashStruct(ctx context.Context, typeName string, v interface{}, allTypes TypeSet) (result ethtypes.HexBytes0xPrefix, err error)

HashStruct allows hashing of an individual structure, without the EIP-712 domain

Types

type Type

type Type []*TypeMember

func (Type) Encode

func (t Type) Encode(name string) string

A type is encoded as:

> name ‖ "(" ‖ member₁ ‖ "," ‖ member₂ ‖ "," ‖ … ‖ memberₙ ")"

type TypeMember

type TypeMember struct {
	Name string
	Type string
}

func (*TypeMember) Encode

func (tm *TypeMember) Encode() string

An individual member is encoded as:

> type ‖ " " ‖ name

type TypeSet

type TypeSet map[string]Type

func ABItoTypedDataV4

func ABItoTypedDataV4(ctx context.Context, tc abi.TypeComponent) (primaryType string, typeSet TypeSet, err error)

Convert an ABI tuple definition, into the EIP-712 structure that's embedded into the "eth_signTypedData" signing request payload. It's a much simpler structure that flattens out a map of types (requiring each type to be named by a struct definition)

func (TypeSet) Encode

func (ts TypeSet) Encode(primaryType string) string

A map from type names to types is encoded per encodeType:

> If the struct type references other struct types (and these in turn reference even more struct types), > then the set of referenced struct types is collected, sorted by name and appended to the encoding.

type TypedData

type TypedData struct {
	Types       TypeSet                `ffstruct:"TypedData" json:"types"`
	PrimaryType string                 `ffstruct:"TypedData" json:"primaryType"`
	Domain      map[string]interface{} `ffstruct:"TypedData" json:"domain"`
	Message     map[string]interface{} `ffstruct:"TypedData" json:"message"`
}