typeddata

Documentation

Index

• Constants
• func HashTypedDataV4(typedData signercore.TypedData, chain *big.Int) (common.Hash, error)
• func Sign(typed TypedData, prv *ecdsa.PrivateKey, chain *big.Int) ([]byte, error)
• func SignTypedDataV4(typedData signercore.TypedData, prv *ecdsa.PrivateKey, chain *big.Int) (hexutil.Bytes, error)
• func ValidateAndHash(typed TypedData, chain *big.Int) (common.Hash, error)
• type Field
  • func (f Field) Validate() error
• type TypedData
  • func (t TypedData) Validate() error
  • func (t TypedData) ValidateChainID(chain *big.Int) error
• type Types

Constants

const (
	ChainIDKey = "chainId"
)

Functions

func HashTypedDataV4

func HashTypedDataV4(typedData signercore.TypedData, chain *big.Int) (common.Hash, error)

func Sign

func Sign(typed TypedData, prv *ecdsa.PrivateKey, chain *big.Int) ([]byte, error)

Sign TypedData with a given private key. Verify that chainId in the typed data matches currently selected chain.

func SignTypedDataV4

func SignTypedDataV4(typedData signercore.TypedData, prv *ecdsa.PrivateKey, chain *big.Int) (hexutil.Bytes, error)

func ValidateAndHash

func ValidateAndHash(typed TypedData, chain *big.Int) (common.Hash, error)

ValidateAndHash generates a hash of TypedData and verifies that chainId in the typed data matches currently selected chain.

Types

type Field

type Field struct {
	Name string `json:"name"`
	Type string `json:"type"`
}

Field stores name and solidity type of the field.

func (Field) Validate

func (f Field) Validate() error

Validate checks that both name and type are not empty.

type TypedData

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

TypedData defines typed data according to eip-712.

func (TypedData) Validate

func (t TypedData) Validate() error

Validate that required fields are defined. This method doesn't check if dependencies of the main type are defined, it will be validated when type string is computed.

func (TypedData) ValidateChainID

func (t TypedData) ValidateChainID(chain *big.Int) error

ValidateChainID accept chain as big integer and verifies if typed data belongs to the same chain.

type Types

type Types map[string][]Field

Types define fields for each composite type.