1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947
use crate::{
abi,
abi::{HumanReadableParser, ParamType, Token},
types::{serde_helpers::StringifiedNumeric, Address, Bytes, U256},
utils::keccak256,
};
use ethabi::encode;
use serde::{Deserialize, Deserializer, Serialize};
use std::{
collections::{BTreeMap, HashSet},
iter::FromIterator,
};
/// Custom types for `TypedData`
pub type Types = BTreeMap<String, Vec<Eip712DomainType>>;
/// Pre-computed value of the following expression:
///
/// `keccak256("EIP712Domain(string name,string version,uint256 chainId,address
/// verifyingContract)")`
pub const EIP712_DOMAIN_TYPE_HASH: [u8; 32] = [
139, 115, 195, 198, 155, 184, 254, 61, 81, 46, 204, 76, 247, 89, 204, 121, 35, 159, 123, 23,
155, 15, 250, 202, 169, 167, 93, 82, 43, 57, 64, 15,
];
/// Pre-computed value of the following expression:
///
/// `keccak256("EIP712Domain(string name,string version,uint256 chainId,address
/// verifyingContract,bytes32 salt)")`
pub const EIP712_DOMAIN_TYPE_HASH_WITH_SALT: [u8; 32] = [
216, 124, 214, 239, 121, 212, 226, 185, 94, 21, 206, 138, 191, 115, 45, 181, 30, 199, 113, 241,
202, 46, 220, 207, 34, 164, 108, 114, 154, 197, 100, 114,
];
/// An EIP-712 error.
#[derive(Debug, thiserror::Error)]
pub enum Eip712Error {
#[error("Failed to serialize serde JSON object")]
SerdeJsonError(#[from] serde_json::Error),
#[error("Failed to decode hex value")]
FromHexError(#[from] hex::FromHexError),
#[error("Failed to make struct hash from values")]
FailedToEncodeStruct,
#[error("Failed to convert slice into byte array")]
TryFromSliceError(#[from] std::array::TryFromSliceError),
#[error("Nested Eip712 struct not implemented. Failed to parse.")]
NestedEip712StructNotImplemented,
#[error("Error from Eip712 struct: {0:?}")]
Message(String),
}
/// Helper methods for computing the typed data hash used in `eth_signTypedData`.
///
/// The ethers-rs `derive_eip712` crate provides a derive macro to
/// implement the trait for a given struct. See documentation
/// for `derive_eip712` for more information and example usage.
///
/// For those who wish to manually implement this trait, see:
/// <https://eips.ethereum.org/EIPS/eip-712>
///
/// Any rust struct implementing Eip712 must also have a corresponding
/// struct in the verifying ethereum contract that matches its signature.
pub trait Eip712 {
/// User defined error type;
type Error: std::error::Error + Send + Sync + std::fmt::Debug;
/// Default implementation of the domain separator;
fn domain_separator(&self) -> Result<[u8; 32], Self::Error> {
Ok(self.domain()?.separator())
}
/// 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 domain(&self) -> Result<EIP712Domain, Self::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 type_hash() -> Result<[u8; 32], Self::Error>;
/// Hash of the struct, according to EIP-712 definition of `hashStruct`
fn struct_hash(&self) -> Result<[u8; 32], Self::Error>;
/// When using the derive macro, this is the primary method used for computing the final
/// EIP-712 encoded payload. This method relies on the aforementioned methods for computing
/// the final encoded payload.
fn encode_eip712(&self) -> Result<[u8; 32], Self::Error> {
// encode the digest to be compatible with solidity abi.encodePacked()
// See: https://github.com/gakonst/ethers-rs/blob/master/examples/permit_hash.rs#L72
let domain_separator = self.domain_separator()?;
let struct_hash = self.struct_hash()?;
let digest_input = [&[0x19, 0x01], &domain_separator[..], &struct_hash[..]].concat();
Ok(keccak256(digest_input))
}
}
/// Eip712 Domain attributes used in determining the domain separator;
/// Unused fields are left out of the struct type.
///
/// Protocol designers only need to include the fields that make sense for their signing domain.
/// Unused fields are left out of the struct type.
#[derive(Debug, Default, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct EIP712Domain {
/// The user readable name of signing domain, i.e. the name of the DApp or the protocol.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
/// The current major version of the signing domain. Signatures from different versions are not
/// compatible.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub version: Option<String>,
/// The EIP-155 chain id. The user-agent should refuse signing if it does not match the
/// currently active chain.
#[serde(
default,
skip_serializing_if = "Option::is_none",
deserialize_with = "crate::types::serde_helpers::deserialize_stringified_numeric_opt"
)]
pub chain_id: Option<U256>,
/// The address of the contract that will verify the signature.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub verifying_contract: Option<Address>,
/// A disambiguating salt for the protocol. This can be used as a domain separator of last
/// resort.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub salt: Option<[u8; 32]>,
}
impl EIP712Domain {
// Compute the domain separator;
// See: https://github.com/gakonst/ethers-rs/blob/master/examples/permit_hash.rs#L41
pub fn separator(&self) -> [u8; 32] {
// full name is `EIP712Domain(string name,string version,uint256 chainId,address
// verifyingContract,bytes32 salt)`
let mut ty = "EIP712Domain(".to_string();
let mut tokens = Vec::new();
let mut needs_comma = false;
if let Some(ref name) = self.name {
ty += "string name";
tokens.push(Token::Uint(U256::from(keccak256(name))));
needs_comma = true;
}
if let Some(ref version) = self.version {
if needs_comma {
ty.push(',');
}
ty += "string version";
tokens.push(Token::Uint(U256::from(keccak256(version))));
needs_comma = true;
}
if let Some(chain_id) = self.chain_id {
if needs_comma {
ty.push(',');
}
ty += "uint256 chainId";
tokens.push(Token::Uint(chain_id));
needs_comma = true;
}
if let Some(verifying_contract) = self.verifying_contract {
if needs_comma {
ty.push(',');
}
ty += "address verifyingContract";
tokens.push(Token::Address(verifying_contract));
needs_comma = true;
}
if let Some(salt) = self.salt {
if needs_comma {
ty.push(',');
}
ty += "bytes32 salt";
tokens.push(Token::Uint(U256::from(salt)));
}
ty.push(')');
tokens.insert(0, Token::Uint(U256::from(keccak256(ty))));
keccak256(encode(&tokens))
}
}
#[derive(Debug, Clone)]
pub struct EIP712WithDomain<T>
where
T: Clone + Eip712,
{
pub domain: EIP712Domain,
pub inner: T,
}
impl<T: Eip712 + Clone> EIP712WithDomain<T> {
pub fn new(inner: T) -> Result<Self, Eip712Error> {
let domain = inner.domain().map_err(|e| Eip712Error::Message(e.to_string()))?;
Ok(Self { domain, inner })
}
#[must_use]
pub fn set_domain(self, domain: EIP712Domain) -> Self {
Self { domain, inner: self.inner }
}
}
impl<T: Eip712 + Clone> Eip712 for EIP712WithDomain<T> {
type Error = Eip712Error;
fn domain(&self) -> Result<EIP712Domain, Self::Error> {
Ok(self.domain.clone())
}
fn type_hash() -> Result<[u8; 32], Self::Error> {
let type_hash = T::type_hash().map_err(|e| Self::Error::Message(e.to_string()))?;
Ok(type_hash)
}
fn struct_hash(&self) -> Result<[u8; 32], Self::Error> {
let struct_hash =
self.inner.clone().struct_hash().map_err(|e| Self::Error::Message(e.to_string()))?;
Ok(struct_hash)
}
}
/// Represents the [EIP-712](https://eips.ethereum.org/EIPS/eip-712) typed data object.
///
/// Typed data is a JSON object containing type information, domain separator parameters and the
/// message object which has the following schema
///
/// ```json
/// {
/// "type": "object",
/// "properties": {
/// "types": {
/// "type": "object",
/// "properties": {
/// "EIP712Domain": { "type": "array" }
/// },
/// "additionalProperties": {
/// "type": "array",
/// "items": {
/// "type": "object",
/// "properties": {
/// "name": { "type": "string" },
/// "type": { "type": "string" }
/// },
/// "required": ["name", "type"]
/// }
/// },
/// "required": ["EIP712Domain"]
/// },
/// "primaryType": { "type": "string" },
/// "domain": { "type": "object" },
/// "message": { "type": "object" }
/// },
/// "required": ["types", "primaryType", "domain", "message"]
/// }
/// ```
#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
#[serde(deny_unknown_fields)]
pub struct TypedData {
/// 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.
pub domain: EIP712Domain,
/// The custom types used by this message.
pub types: Types,
#[serde(rename = "primaryType")]
/// The type of the message.
pub primary_type: String,
/// The message to be signed.
pub message: BTreeMap<String, serde_json::Value>,
}
/// 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.
impl<'de> Deserialize<'de> for TypedData {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: Deserializer<'de>,
{
#[derive(Deserialize)]
struct TypedDataHelper {
domain: EIP712Domain,
types: Types,
#[serde(rename = "primaryType")]
primary_type: String,
message: BTreeMap<String, serde_json::Value>,
}
#[derive(Deserialize)]
#[serde(untagged)]
enum Type {
Val(TypedDataHelper),
String(String),
}
match Type::deserialize(deserializer)? {
Type::Val(v) => {
let TypedDataHelper { domain, types, primary_type, message } = v;
Ok(TypedData { domain, types, primary_type, message })
}
Type::String(s) => {
let TypedDataHelper { domain, types, primary_type, message } =
serde_json::from_str(&s).map_err(serde::de::Error::custom)?;
Ok(TypedData { domain, types, primary_type, message })
}
}
}
}
// === impl TypedData ===
impl Eip712 for TypedData {
type Error = Eip712Error;
fn domain(&self) -> Result<EIP712Domain, Self::Error> {
Ok(self.domain.clone())
}
fn type_hash() -> Result<[u8; 32], Self::Error> {
Err(Eip712Error::Message("dynamic type".to_string()))
}
fn struct_hash(&self) -> Result<[u8; 32], Self::Error> {
let tokens = encode_data(
&self.primary_type,
&serde_json::Value::Object(serde_json::Map::from_iter(self.message.clone())),
&self.types,
)?;
Ok(keccak256(encode(&tokens)))
}
/// 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.
fn encode_eip712(&self) -> Result<[u8; 32], Self::Error> {
let domain_separator = self.domain.separator();
let mut digest_input = [&[0x19, 0x01], &domain_separator[..]].concat().to_vec();
if self.primary_type != "EIP712Domain" {
// compatibility with <https://github.com/MetaMask/eth-sig-util>
digest_input.extend(&self.struct_hash()?[..])
}
Ok(keccak256(digest_input))
}
}
/// Represents the name and type pair
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct Eip712DomainType {
pub name: String,
#[serde(rename = "type")]
pub r#type: String,
}
/// Encodes an object by encoding and concatenating each of its members.
///
/// The encoding of a struct instance is `enc(value₁) ‖ enc(value₂) ‖ … ‖ enc(valueₙ)`, i.e. the
/// concatenation of the encoded member values in the order that they appear in the type. Each
/// encoded member value is exactly 32-byte long.
///
/// - `primaryType`: The root type.
/// - `data`: The object to encode.
/// - `types`: Type definitions for all types included in the message.
///
/// Returns an encoded representation of an object
pub fn encode_data(
primary_type: &str,
data: &serde_json::Value,
types: &Types,
) -> Result<Vec<Token>, Eip712Error> {
let hash = hash_type(primary_type, types)?;
let mut tokens = vec![Token::Uint(U256::from(hash))];
if let Some(fields) = types.get(primary_type) {
for field in fields {
// handle recursive types
if let Some(value) = data.get(&field.name) {
let field = encode_field(types, &field.name, &field.r#type, value)?;
tokens.push(field);
} else if types.contains_key(&field.r#type) {
tokens.push(Token::Uint(U256::zero()));
} else {
return Err(Eip712Error::Message(format!("No data found for: `{}`", field.name)))
}
}
}
Ok(tokens)
}
/// Hashes an object
///
/// - `primary_type`: The root type to encode.
/// - `data`: The object to hash.
/// - `types`: All type definitions.
///
/// Returns the hash of the `primary_type` object
pub fn hash_struct(
primary_type: &str,
data: &serde_json::Value,
types: &Types,
) -> Result<[u8; 32], Eip712Error> {
let tokens = encode_data(primary_type, data, types)?;
let encoded = encode(&tokens);
Ok(keccak256(encoded))
}
/// Returns the hashed encoded type of `primary_type`
pub fn hash_type(primary_type: &str, types: &Types) -> Result<[u8; 32], Eip712Error> {
encode_type(primary_type, types).map(keccak256)
}
/// Encodes the type of an object by encoding a comma delimited list of its members.
///
/// - `primary_type`: The root type to encode.
/// - `types`: All type definitions.
///
/// Returns the encoded representation of the field.
pub fn encode_type(primary_type: &str, types: &Types) -> Result<String, Eip712Error> {
let mut names = HashSet::new();
find_type_dependencies(primary_type, types, &mut names);
// need to ensure primary_type is first in the list
names.remove(primary_type);
let mut deps: Vec<_> = names.into_iter().collect();
deps.sort_unstable();
deps.insert(0, primary_type);
let mut res = String::new();
for dep in deps.into_iter() {
let fields = types.get(dep).ok_or_else(|| {
Eip712Error::Message(format!("No type definition found for: `{dep}`"))
})?;
res += dep;
res.push('(');
res += &fields
.iter()
.map(|ty| format!("{} {}", ty.r#type, ty.name))
.collect::<Vec<_>>()
.join(",");
res.push(')');
}
Ok(res)
}
/// Returns all the custom types used in the `primary_type`
fn find_type_dependencies<'a>(
primary_type: &'a str,
types: &'a Types,
found: &mut HashSet<&'a str>,
) {
if found.contains(primary_type) {
return
}
if let Some(fields) = types.get(primary_type) {
found.insert(primary_type);
for field in fields {
// need to strip the array tail
let ty = field.r#type.split('[').next().unwrap();
find_type_dependencies(ty, types, found)
}
}
}
/// Encode a single field.
///
/// - `types`: All type definitions.
/// - `field`: The name and type of the field being encoded.
/// - `value`: The value to encode.
///
/// Returns the encoded representation of the field.
pub fn encode_field(
types: &Types,
_field_name: &str,
field_type: &str,
value: &serde_json::Value,
) -> Result<Token, Eip712Error> {
let token = {
// check if field is custom data type
if types.contains_key(field_type) {
let tokens = encode_data(field_type, value, types)?;
let encoded = encode(&tokens);
encode_eip712_type(Token::Bytes(encoded.to_vec()))
} else {
match field_type {
s if s.contains('[') => {
let (stripped_type, _) = s.rsplit_once('[').unwrap();
// ensure value is an array
let values = value.as_array().ok_or_else(|| {
Eip712Error::Message(format!(
"Expected array for type `{s}`, but got `{value}`",
))
})?;
let tokens = values
.iter()
.map(|value| encode_field(types, _field_name, stripped_type, value))
.collect::<Result<Vec<_>, _>>()?;
let encoded = encode(&tokens);
encode_eip712_type(Token::Bytes(encoded))
}
s => {
// parse as param type
let param = HumanReadableParser::parse_type(s).map_err(|err| {
Eip712Error::Message(format!("Failed to parse type {s}: {err}",))
})?;
match param {
ParamType::Address => {
Token::Address(serde_json::from_value(value.clone())?)
}
ParamType::Bytes => {
let data: Bytes = serde_json::from_value(value.clone())?;
encode_eip712_type(Token::Bytes(data.to_vec()))
}
ParamType::Int(_) => Token::Uint(serde_json::from_value(value.clone())?),
ParamType::Uint(_) => {
// uints are commonly stringified due to how ethers-js encodes
let val: StringifiedNumeric = serde_json::from_value(value.clone())?;
let val = val.try_into().map_err(|err| {
Eip712Error::Message(format!("Failed to parse uint {err}"))
})?;
Token::Uint(val)
}
ParamType::Bool => {
encode_eip712_type(Token::Bool(serde_json::from_value(value.clone())?))
}
ParamType::String => {
let s: String = serde_json::from_value(value.clone())?;
encode_eip712_type(Token::String(s))
}
ParamType::FixedArray(_, _) | ParamType::Array(_) => {
unreachable!("is handled in separate arm")
}
ParamType::FixedBytes(_) => {
let data: Bytes = serde_json::from_value(value.clone())?;
encode_eip712_type(Token::FixedBytes(data.to_vec()))
}
ParamType::Tuple(_) => {
return Err(Eip712Error::Message(format!("Unexpected tuple type {s}",)))
}
}
}
}
}
};
Ok(token)
}
/// Convert hash map of field names and types into a type hash corresponding to enc types;
pub fn make_type_hash(primary_type: String, fields: &[(String, ParamType)]) -> [u8; 32] {
let parameters =
fields.iter().map(|(k, v)| format!("{v} {k}")).collect::<Vec<String>>().join(",");
let sig = format!("{primary_type}({parameters})");
keccak256(sig)
}
/// Parse token into Eip712 compliant ABI encoding
pub fn encode_eip712_type(token: Token) -> Token {
match token {
Token::Bytes(t) => Token::Uint(U256::from(keccak256(t))),
Token::FixedBytes(t) => Token::Uint(U256::from(&t[..])),
Token::String(t) => Token::Uint(U256::from(keccak256(t))),
Token::Bool(t) => {
// Boolean false and true are encoded as uint256 values 0 and 1 respectively
Token::Uint(U256::from(t as i32))
}
Token::Int(t) => {
// Integer values are sign-extended to 256-bit and encoded in big endian order.
Token::Uint(t)
}
Token::Array(tokens) => Token::Uint(U256::from(keccak256(abi::encode(
&tokens.into_iter().map(encode_eip712_type).collect::<Vec<Token>>(),
)))),
Token::FixedArray(tokens) => Token::Uint(U256::from(keccak256(abi::encode(
&tokens.into_iter().map(encode_eip712_type).collect::<Vec<Token>>(),
)))),
Token::Tuple(tuple) => {
let tokens = tuple.into_iter().map(encode_eip712_type).collect::<Vec<Token>>();
let encoded = encode(&tokens);
Token::Uint(U256::from(keccak256(encoded)))
}
_ => {
// Return the ABI encoded token;
token
}
}
}
// Adapted tests from <https://github.com/MetaMask/eth-sig-util/blob/main/src/sign-typed-data.test.ts>
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_full_domain() {
let json = serde_json::json!({
"types": {
"EIP712Domain": [
{
"name": "name",
"type": "string"
},
{
"name": "version",
"type": "string"
},
{
"name": "chainId",
"type": "uint256"
},
{
"name": "verifyingContract",
"type": "address"
},
{
"name": "salt",
"type": "bytes32"
}
]
},
"primaryType": "EIP712Domain",
"domain": {
"name": "example.metamask.io",
"version": "1",
"chainId": 1,
"verifyingContract": "0x0000000000000000000000000000000000000000"
},
"message": {}
});
let typed_data: TypedData = serde_json::from_value(json).unwrap();
let hash = typed_data.encode_eip712().unwrap();
assert_eq!(
"122d1c8ef94b76dad44dcb03fa772361e20855c63311a15d5afe02d1b38f6077",
hex::encode(&hash[..])
);
}
#[test]
fn test_minimal_message() {
let json = serde_json::json!( {"types":{"EIP712Domain":[]},"primaryType":"EIP712Domain","domain":{},"message":{}});
let typed_data: TypedData = serde_json::from_value(json).unwrap();
let hash = typed_data.encode_eip712().unwrap();
assert_eq!(
"8d4a3f4082945b7879e2b55f181c31a77c8c0a464b70669458abbaaf99de4c38",
hex::encode(&hash[..])
);
}
#[test]
fn test_encode_custom_array_type() {
let json = serde_json::json!({"domain":{},"types":{"EIP712Domain":[],"Person":[{"name":"name","type":"string"},{"name":"wallet","type":"address[]"}],"Mail":[{"name":"from","type":"Person"},{"name":"to","type":"Person[]"},{"name":"contents","type":"string"}]},"primaryType":"Mail","message":{"from":{"name":"Cow","wallet":["0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826","0xDD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826"]},"to":[{"name":"Bob","wallet":["0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB"]}],"contents":"Hello, Bob!"}});
let typed_data: TypedData = serde_json::from_value(json).unwrap();
let hash = typed_data.encode_eip712().unwrap();
assert_eq!(
"80a3aeb51161cfc47884ddf8eac0d2343d6ae640efe78b6a69be65e3045c1321",
hex::encode(&hash[..])
);
}
#[test]
fn test_hash_typed_message_with_data() {
let json = serde_json::json!( {
"types": {
"EIP712Domain": [
{
"name": "name",
"type": "string"
},
{
"name": "version",
"type": "string"
},
{
"name": "chainId",
"type": "uint256"
},
{
"name": "verifyingContract",
"type": "address"
}
],
"Message": [
{
"name": "data",
"type": "string"
}
]
},
"primaryType": "Message",
"domain": {
"name": "example.metamask.io",
"version": "1",
"chainId": "1",
"verifyingContract": "0x0000000000000000000000000000000000000000"
},
"message": {
"data": "Hello!"
}
});
let typed_data: TypedData = serde_json::from_value(json).unwrap();
let hash = typed_data.encode_eip712().unwrap();
assert_eq!(
"232cd3ec058eb935a709f093e3536ce26cc9e8e193584b0881992525f6236eef",
hex::encode(&hash[..])
);
}
#[test]
fn test_hash_custom_data_type() {
let json = serde_json::json!( {"domain":{},"types":{"EIP712Domain":[],"Person":[{"name":"name","type":"string"},{"name":"wallet","type":"address"}],"Mail":[{"name":"from","type":"Person"},{"name":"to","type":"Person"},{"name":"contents","type":"string"}]},"primaryType":"Mail","message":{"from":{"name":"Cow","wallet":"0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826"},"to":{"name":"Bob","wallet":"0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB"},"contents":"Hello, Bob!"}});
let typed_data: TypedData = serde_json::from_value(json).unwrap();
let hash = typed_data.encode_eip712().unwrap();
assert_eq!(
"25c3d40a39e639a4d0b6e4d2ace5e1281e039c88494d97d8d08f99a6ea75d775",
hex::encode(&hash[..])
);
}
#[test]
fn test_hash_recursive_types() {
let json = serde_json::json!( {
"domain": {},
"types": {
"EIP712Domain": [],
"Person": [
{
"name": "name",
"type": "string"
},
{
"name": "wallet",
"type": "address"
}
],
"Mail": [
{
"name": "from",
"type": "Person"
},
{
"name": "to",
"type": "Person"
},
{
"name": "contents",
"type": "string"
},
{
"name": "replyTo",
"type": "Mail"
}
]
},
"primaryType": "Mail",
"message": {
"from": {
"name": "Cow",
"wallet": "0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826"
},
"to": {
"name": "Bob",
"wallet": "0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB"
},
"contents": "Hello, Bob!",
"replyTo": {
"to": {
"name": "Cow",
"wallet": "0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826"
},
"from": {
"name": "Bob",
"wallet": "0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB"
},
"contents": "Hello!"
}
}
});
let typed_data: TypedData = serde_json::from_value(json).unwrap();
let hash = typed_data.encode_eip712().unwrap();
assert_eq!(
"0808c17abba0aef844b0470b77df9c994bc0fa3e244dc718afd66a3901c4bd7b",
hex::encode(&hash[..])
);
}
#[test]
fn test_hash_nested_struct_array() {
let json = serde_json::json!({
"types": {
"EIP712Domain": [
{
"name": "name",
"type": "string"
},
{
"name": "version",
"type": "string"
},
{
"name": "chainId",
"type": "uint256"
},
{
"name": "verifyingContract",
"type": "address"
}
],
"OrderComponents": [
{
"name": "offerer",
"type": "address"
},
{
"name": "zone",
"type": "address"
},
{
"name": "offer",
"type": "OfferItem[]"
},
{
"name": "startTime",
"type": "uint256"
},
{
"name": "endTime",
"type": "uint256"
},
{
"name": "zoneHash",
"type": "bytes32"
},
{
"name": "salt",
"type": "uint256"
},
{
"name": "conduitKey",
"type": "bytes32"
},
{
"name": "counter",
"type": "uint256"
}
],
"OfferItem": [
{
"name": "token",
"type": "address"
}
],
"ConsiderationItem": [
{
"name": "token",
"type": "address"
},
{
"name": "identifierOrCriteria",
"type": "uint256"
},
{
"name": "startAmount",
"type": "uint256"
},
{
"name": "endAmount",
"type": "uint256"
},
{
"name": "recipient",
"type": "address"
}
]
},
"primaryType": "OrderComponents",
"domain": {
"name": "Seaport",
"version": "1.1",
"chainId": "1",
"verifyingContract": "0x00000000006c3852cbEf3e08E8dF289169EdE581"
},
"message": {
"offerer": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
"offer": [
{
"token": "0xA604060890923Ff400e8c6f5290461A83AEDACec"
}
],
"startTime": "1658645591",
"endTime": "1659250386",
"zone": "0x004C00500000aD104D7DBd00e3ae0A5C00560C00",
"zoneHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
"salt": "16178208897136618",
"conduitKey": "0x0000007b02230091a7ed01230072f7006a004d60a8d4e71d599b8104250f0000",
"totalOriginalConsiderationItems": "2",
"counter": "0"
}
}
);
let typed_data: TypedData = serde_json::from_value(json).unwrap();
let hash = typed_data.encode_eip712().unwrap();
assert_eq!(
"0b8aa9f3712df0034bc29fe5b24dd88cfdba02c7f499856ab24632e2969709a8",
hex::encode(&hash[..])
);
}
}