Struct ethers_rs::TypedData

pub struct TypedData {
    pub domain: EIP712Domain,
    pub types: BTreeMap<String, Vec<Eip712DomainType, Global>, Global>,
    pub primary_type: String,
    pub message: BTreeMap<String, Value, Global>,
}

Typed data is a JSON object containing type information, domain separator parameters and the message object which has the following schema

{

Fields

domain: EIP712Domain

Signing domain metadata. The signing domain is the intended context for the signature (e.g. the dapp, protocol, etc. that it’s intended for). This data is used to construct the domain seperator of the message.

types: BTreeMap<String, Vec<Eip712DomainType, Global>, Global>

The custom types used by this message.

primary_type: String

The type of the message.

message: BTreeMap<String, Value, Global>

The message to be signed.

Trait Implementations

impl Clone for TypedData

fn clone(&self) -> TypedData

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TypedData

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TypedData

According to the MetaMask implementation, the message parameter may be JSON stringified in versions later than V1 See https://github.com/MetaMask/metamask-extension/blob/0dfdd44ae7728ed02cbf32c564c75b74f37acf77/app/scripts/metamask-controller.js#L1736 In fact, ethers.js JSON stringifies the message at the time of writing.

fn deserialize<D>(
    deserializer: D
) -> Result<TypedData, <D as Deserializer<'de>>::Error>where
    D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eip712 for TypedData

fn encode_eip712(&self) -> Result<[u8; 32], <TypedData as Eip712>::Error>

Hash a typed message according to EIP-712. The returned message starts with the EIP-712 prefix, which is “1901”, followed by the hash of the domain separator, then the data (if any). The result is hashed again and returned.

type Error = Eip712Error

User defined error type;

fn domain(&self) -> Result<EIP712Domain, <TypedData as Eip712>::Error>

Returns the current domain. The domain depends on the contract and unique domain for which the user is targeting. In the derive macro, these attributes are passed in as arguments to the macro. When manually deriving, the user will need to know the name of the domain, version of the contract, chain ID of where the contract lives and the address of the verifying contract.

fn type_hash() -> Result<[u8; 32], <TypedData as Eip712>::Error>

This method is used for calculating the hash of the type signature of the struct. The field types of the struct must map to primitive ethereum types or custom types defined in the contract.

fn struct_hash(&self) -> Result<[u8; 32], <TypedData as Eip712>::Error>

Hash of the struct, according to EIP-712 definition of hashStruct

fn domain_separator(&self) -> Result<[u8; 32], Self::Error>

Default implementation of the domain separator;

impl PartialEq<TypedData> for TypedData

fn eq(&self, other: &TypedData) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for TypedData

fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for TypedData

impl StructuralEq for TypedData

impl StructuralPartialEq for TypedData