Skip to content

API.md

Latest commit

 

History

History
20 lines (15 loc) · 1.33 KB

API.md

File metadata and controls

20 lines (15 loc) · 1.33 KB

API

class EIP712Struct

Primary Methods

  • .from_message(message_dict: dict) (class method) - Given a standard EIP-712 message dictionary (such as produced from .to_message), returns a NamedTuple containing the message and domain EIP712Structs.
  • .to_message(domain: EIP712Struct) - Convert the struct (and given domain struct) into the standard EIP-712 message structure.
  • .signable_bytes(domain: EIP712Struct) - Get the standard EIP-712 bytes hash, suitable for signing.

Secundary Methods

  • .data_dict() - Returns a dictionary with all data in this struct. Includes nested struct data, if exists.
  • .encode_type() (class method) - Gets the "signature" of the struct class. Includes nested structs too!
  • .encode_value() - Returns a bytes object containing the ordered concatenation of each members bytes32 representation.
  • .hash_struct() - Gets the keccak256 hash of the concatenation of .type_hash() and .encode_value()
  • .get_data_value(member_name: str) - Get the value of the given struct member
  • .set_data_value(member_name: str, value: Any) - Set the value of the given struct member
  • .get_members() (class method) - Returns a dictionary mapping each data member's name to it's type.
  • .type_hash() (class method) - The keccak256 hash of the result of .encode_type().