You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
753 lines
27 KiB
753 lines
27 KiB
3 years ago
|
from common import *
|
||
|
|
|
||
|
|
from trezor import wire
|
||
|
|
from trezor.messages import EthereumTypedDataStructAck as ETDSA
|
||
|
|
from trezor.messages import EthereumStructMember as ESM
|
||
|
|
from trezor.messages import EthereumFieldType as EFT
|
||
|
|
from trezor.messages import EthereumTypedDataValueAck
|
||
|
|
from trezor.enums import EthereumDataType as EDT
|
||
|
|
|
||
|
|
|
||
|
|
if not utils.BITCOIN_ONLY:
|
||
|
|
from apps.ethereum.sign_typed_data import (
|
||
|
|
encode_field,
|
||
|
|
validate_value,
|
||
|
|
validate_field_type,
|
||
|
|
keccak256,
|
||
|
|
TypedDataEnvelope,
|
||
|
|
)
|
||
|
|
from apps.ethereum.helpers import (
|
||
|
|
get_type_name,
|
||
|
|
decode_typed_data,
|
||
|
|
)
|
||
|
|
|
||
|
|
|
||
|
|
class MockContext:
|
||
|
|
"""Simulating the client sending us data values."""
|
||
|
|
def __init__(self, message_contents: list):
|
||
|
|
# TODO: it could be worth (for better readability and quicker modification)
|
||
|
|
# to accept a whole EIP712 JSON object and create the list internally
|
||
|
|
self.message_contents = message_contents
|
||
|
|
|
||
|
|
async def call(self, request, _resp_type) -> bytes:
|
||
|
|
entry = self.message_contents
|
||
|
|
for index in request.member_path:
|
||
|
|
entry = entry[index]
|
||
|
|
|
||
|
|
if isinstance(entry, list):
|
||
|
|
value = len(entry).to_bytes(2, "big")
|
||
|
|
else:
|
||
|
|
value = entry
|
||
|
|
|
||
|
|
return EthereumTypedDataValueAck(value=value)
|
||
|
|
|
||
|
|
|
||
|
|
# Helper functions from trezorctl to build expected type data structures
|
||
|
|
# TODO: it could be better to group these functions into a class, to visibly differentiate it
|
||
|
|
def get_type_definitions(types: dict) -> dict:
|
||
|
|
result = {}
|
||
|
|
for struct, fields in types.items():
|
||
|
|
members = []
|
||
|
|
for name, type in fields:
|
||
|
|
field_type = get_field_type(type, types)
|
||
|
|
struct_member = ESM(
|
||
|
|
type=field_type,
|
||
|
|
name=name,
|
||
|
|
)
|
||
|
|
members.append(struct_member)
|
||
|
|
|
||
|
|
result[struct] = ETDSA(members=members)
|
||
|
|
|
||
|
|
return result
|
||
|
|
|
||
|
|
|
||
|
|
def get_field_type(type_name: str, types: dict) -> EFT:
|
||
|
|
data_type = None
|
||
|
|
size = None
|
||
|
|
entry_type = None
|
||
|
|
struct_name = None
|
||
|
|
|
||
|
|
if is_array(type_name):
|
||
|
|
data_type = EDT.ARRAY
|
||
|
|
array_size = parse_array_n(type_name)
|
||
|
|
size = None if array_size == "dynamic" else array_size
|
||
|
|
member_typename = typeof_array(type_name)
|
||
|
|
entry_type = get_field_type(member_typename, types)
|
||
|
|
elif type_name.startswith("uint"):
|
||
|
|
data_type = EDT.UINT
|
||
|
|
size = get_byte_size_for_int_type(type_name)
|
||
|
|
elif type_name.startswith("int"):
|
||
|
|
data_type = EDT.INT
|
||
|
|
size = get_byte_size_for_int_type(type_name)
|
||
|
|
elif type_name.startswith("bytes"):
|
||
|
|
data_type = EDT.BYTES
|
||
|
|
size = None if type_name == "bytes" else parse_type_n(type_name)
|
||
|
|
elif type_name == "string":
|
||
|
|
data_type = EDT.STRING
|
||
|
|
elif type_name == "bool":
|
||
|
|
data_type = EDT.BOOL
|
||
|
|
elif type_name == "address":
|
||
|
|
data_type = EDT.ADDRESS
|
||
|
|
elif type_name in types:
|
||
|
|
data_type = EDT.STRUCT
|
||
|
|
size = len(types[type_name])
|
||
|
|
struct_name = type_name
|
||
|
|
else:
|
||
|
|
raise ValueError(f"Unsupported type name: {type_name}")
|
||
|
|
|
||
|
|
return EFT(
|
||
|
|
data_type=data_type,
|
||
|
|
size=size,
|
||
|
|
entry_type=entry_type,
|
||
|
|
struct_name=struct_name,
|
||
|
|
)
|
||
|
|
|
||
|
|
|
||
|
|
def is_array(type_name: str) -> bool:
|
||
|
|
return type_name[-1] == "]"
|
||
|
|
|
||
|
|
|
||
|
|
def typeof_array(type_name: str) -> str:
|
||
|
|
return type_name[: type_name.rindex("[")]
|
||
|
|
|
||
|
|
|
||
|
|
def parse_type_n(type_name: str) -> int:
|
||
|
|
"""Parse N from type<N>.
|
||
|
|
|
||
|
|
Example: "uint256" -> 256
|
||
|
|
"""
|
||
|
|
# STRANGE: "ImportError: no module named 're'" in Micropython?
|
||
|
|
buf = ""
|
||
|
|
for char in reversed(type_name):
|
||
|
|
if char.isdigit():
|
||
|
|
buf += char
|
||
|
|
else:
|
||
|
|
return int("".join(reversed(buf)))
|
||
|
|
|
||
|
|
|
||
|
|
def parse_array_n(type_name: str) -> Union[int, str]:
|
||
|
|
"""Parse N in type[<N>] where "type" can itself be an array type."""
|
||
|
|
if type_name.endswith("[]"):
|
||
|
|
return "dynamic"
|
||
|
|
|
||
|
|
start_idx = type_name.rindex("[") + 1
|
||
|
|
return int(type_name[start_idx:-1])
|
||
|
|
|
||
|
|
|
||
|
|
def get_byte_size_for_int_type(int_type: str) -> int:
|
||
|
|
return parse_type_n(int_type) // 8
|
||
|
|
|
||
|
|
|
||
|
|
types_basic = {
|
||
|
|
"EIP712Domain": [
|
||
|
|
("name", "string"),
|
||
|
|
("version", "string"),
|
||
|
|
("chainId", "uint256"),
|
||
|
|
("verifyingContract", "address"),
|
||
|
|
],
|
||
|
|
"Person": [
|
||
|
|
("name", "string"),
|
||
|
|
("wallet", "address"),
|
||
|
|
],
|
||
|
|
"Mail": [
|
||
|
|
("from", "Person"),
|
||
|
|
("to", "Person"),
|
||
|
|
("contents", "string"),
|
||
|
|
],
|
||
|
|
}
|
||
|
|
TYPES_BASIC = get_type_definitions(types_basic)
|
||
|
|
|
||
|
|
types_complex = {
|
||
|
|
"EIP712Domain": [
|
||
|
|
("name", "string"),
|
||
|
|
("version", "string"),
|
||
|
|
("chainId", "uint256"),
|
||
|
|
("verifyingContract", "address"),
|
||
|
|
("salt", "bytes32"),
|
||
|
|
],
|
||
|
|
"Person": [
|
||
|
|
("name", "string"),
|
||
|
|
("wallet", "address"),
|
||
|
|
("married", "bool"),
|
||
|
|
("kids", "uint8"),
|
||
|
|
("karma", "int16"),
|
||
|
|
("secret", "bytes"),
|
||
|
|
("small_secret", "bytes16"),
|
||
|
|
("pets", "string[]"),
|
||
|
|
("two_best_friends", "string[2]"),
|
||
|
|
],
|
||
|
|
"Mail": [
|
||
|
|
("from", "Person"),
|
||
|
|
("to", "Person"),
|
||
|
|
("messages", "string[]"),
|
||
|
|
],
|
||
|
|
}
|
||
|
|
TYPES_COMPLEX = get_type_definitions(types_complex)
|
||
|
|
|
||
|
|
DOMAIN_VALUES = [
|
||
|
|
[
|
||
|
|
b"Ether Mail",
|
||
|
|
b"1",
|
||
|
|
# 1
|
||
|
|
b"\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01",
|
||
|
|
# 0x1e0Ae8205e9726E6F296ab8869160A6423E2337E
|
||
|
|
b"\x1e\n\xe8 ^\x97&\xe6\xf2\x96\xab\x88i\x16\nd#\xe23~",
|
||
|
|
]
|
||
|
|
]
|
||
|
|
MESSAGE_VALUES_BASIC = [
|
||
|
|
[
|
||
|
|
[
|
||
|
|
b"Cow",
|
||
|
|
b"\xc0\x00Kb\xc5\xa3\x9ar\x8eJ\xf5\xbe\xe0\xc6\xb4\xa4\xe5K\x15\xad",
|
||
|
|
],
|
||
|
|
[
|
||
|
|
b"Bob",
|
||
|
|
b"T\xb0\xfaf\xa0et\x8c@\xdc\xa2\xc7\xfe\x12Z (\xcf\x99\x82",
|
||
|
|
],
|
||
|
|
b"Hello, Bob!",
|
||
|
|
]
|
||
|
|
]
|
||
|
|
MESSAGE_VALUES_COMPLEX = [
|
||
|
|
[
|
||
|
|
[
|
||
|
|
b"Amy",
|
||
|
|
b"\xc0\x00Kb\xc5\xa3\x9ar\x8eJ\xf5\xbe\xe0\xc6\xb4\xa4\xe5K\x15\xad",
|
||
|
|
b"\x01",
|
||
|
|
b"\x02",
|
||
|
|
b"\x00\x04",
|
||
|
|
b"b\xc5\xa3\x9ar\x8eJ\xf5\xbe\xe0\xc6\xb4b\xc5\xa3\x9ar\x8eJ\xf5\xbe\xe0\xc6\xb4b\xc5\xa3\x9ar\x8eJ\xf5\xbe\xe0\xc6\xb4b\xc5\xa3\x9ar\x8eJ\xf5\xbe\xe0\xc6\xb4",
|
||
|
|
b"\\\xcf\x0eT6q\x04yZG\xbc\x04\x81d]\x9e",
|
||
|
|
[
|
||
|
|
b"parrot",
|
||
|
|
],
|
||
|
|
[
|
||
|
|
b"Carl",
|
||
|
|
b"Denis",
|
||
|
|
]
|
||
|
|
],
|
||
|
|
[
|
||
|
|
b"Bob",
|
||
|
|
b"T\xb0\xfaf\xa0et\x8c@\xdc\xa2\xc7\xfe\x12Z (\xcf\x99\x82",
|
||
|
|
b"\x00",
|
||
|
|
b"\x00",
|
||
|
|
b"\xff\xfc",
|
||
|
|
b"\x7f\xe1%\xa2\x02\x8c\xf9\x7f\xe1%\xa2\x02\x8c\xf9\x7f\xe1%\xa2\x02\x8c\xf9\x7f\xe1%\xa2\x02\x8c\xf9\x7f\xe1%\xa2\x02\x8c\xf9\x7f\xe1%\xa2\x02\x8c\xf9\x7f\xe1%\xa2\x02\x8c\xf9",
|
||
|
|
b"\xa5\xe5\xc4{dwZ\xbcGm)b@2X\xde",
|
||
|
|
[
|
||
|
|
b"dog",
|
||
|
|
b"cat",
|
||
|
|
],
|
||
|
|
[
|
||
|
|
b"Emil",
|
||
|
|
b"Franz",
|
||
|
|
]
|
||
|
|
],
|
||
|
|
[
|
||
|
|
b"Hello, Bob!",
|
||
|
|
b"How are you?",
|
||
|
|
b"Hope you're fine"
|
||
|
|
]
|
||
|
|
]
|
||
|
|
]
|
||
|
|
|
||
|
|
# Object for testing functionality not needing context
|
||
|
|
# (Each test needs to assign EMPTY_ENVELOPE.types as needed)
|
||
|
|
EMPTY_ENVELOPE = TypedDataEnvelope(
|
||
|
|
ctx=None,
|
||
|
|
primary_type="test",
|
||
|
|
metamask_v4_compat=True,
|
||
|
|
)
|
||
|
|
|
||
|
|
# TODO: validate it more by some third party app, like signing data by Metamask
|
||
|
|
# ??? How to approach the testing ???
|
||
|
|
# - we could copy the most important test cases testing important functionality
|
||
|
|
# - could also download the eth-sig-util package together witn node.js and validating it
|
||
|
|
# Testcases are at:
|
||
|
|
# https://github.com/MetaMask/eth-sig-util/blob/73ace3309bf4b97d901fb66cd61db15eede7afe9/src/sign-typed-data.test.ts
|
||
|
|
# Worth testing/implementing:
|
||
|
|
# should encode data with a recursive data type
|
||
|
|
# should ignore extra unspecified message properties
|
||
|
|
# should throw an error when an atomic property is set to null
|
||
|
|
# Missing custom type properties are omitted in V3, but encoded as 0 (bytes32) in V4
|
||
|
|
|
||
|
|
@unittest.skipUnless(not utils.BITCOIN_ONLY, "altcoin")
|
||
|
|
class TestEthereumSignTypedData(unittest.TestCase):
|
||
|
|
def test_hash_struct(self):
|
||
|
|
"""These final expected results should be generated by some third party"""
|
||
|
|
VECTORS = ( # primary_type, data, types, expected
|
||
|
|
(
|
||
|
|
# Generated by eth_account
|
||
|
|
"EIP712Domain",
|
||
|
|
[
|
||
|
|
[
|
||
|
|
b"Ether Mail",
|
||
|
|
b"1",
|
||
|
|
# 1
|
||
|
|
b"\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01",
|
||
|
|
# 0x1e0Ae8205e9726E6F296ab8869160A6423E2337E
|
||
|
|
b"\x1e\n\xe8 ^\x97&\xe6\xf2\x96\xab\x88i\x16\nd#\xe23~",
|
||
|
|
]
|
||
|
|
],
|
||
|
|
TYPES_BASIC,
|
||
|
|
b"\x97\xd6\xf57t\xb8\x10\xfb\xda'\xe0\x91\xc0<jmh\x15\xdd\x12p\xc2\xe6.\x82\xc6\x91|\x1e\xffwK",
|
||
|
|
),
|
||
|
|
(
|
||
|
|
# Taken from https://github.com/ethereum/EIPs/blob/master/assets/eip-712/Example.sol
|
||
|
|
"EIP712Domain",
|
||
|
|
[
|
||
|
|
[
|
||
|
|
b"Ether Mail",
|
||
|
|
b"1",
|
||
|
|
b"\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01",
|
||
|
|
# 0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC
|
||
|
|
b"\xcc\xcc\xcc\xcc\xcc\xcc\xcc\xcc\xcc\xcc\xcc\xcc\xcc\xcc\xcc\xcc\xcc\xcc\xcc\xcc",
|
||
|
|
]
|
||
|
|
],
|
||
|
|
TYPES_BASIC,
|
||
|
|
b"\xf2\xce\xe3u\xfaB\xb4!C\x80@%\xfcD\x9d\xea\xfdP\xcc\x03\x1c\xa2W\xe0\xb1\x94\xa6P\xa9\x12\t\x0f",
|
||
|
|
),
|
||
|
|
(
|
||
|
|
# Taken from https://github.com/ethereum/EIPs/blob/master/assets/eip-712/Example.sol
|
||
|
|
"Mail",
|
||
|
|
[
|
||
|
|
[
|
||
|
|
[
|
||
|
|
b"Cow",
|
||
|
|
# 0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826
|
||
|
|
b"\xcd*=\x9f\x93\x8e\x13\xcd\x94~\xc0Z\xbc\x7f\xe74\xdf\x8d\xd8&",
|
||
|
|
],
|
||
|
|
[
|
||
|
|
b"Bob",
|
||
|
|
# 0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB
|
||
|
|
b"\xbb\xbb\xbb\xbb\xbb\xbb\xbb\xbb\xbb\xbb\xbb\xbb\xbb\xbb\xbb\xbb\xbb\xbb\xbb\xbb",
|
||
|
|
],
|
||
|
|
b"Hello, Bob!"
|
||
|
|
],
|
||
|
|
],
|
||
|
|
TYPES_BASIC,
|
||
|
|
b"\xc5,\x0e\xe5\xd8BdG\x18\x06)\n?,L\xec\xfcT\x90bk\xf9\x12\xd0\x1f$\rz'K7\x1e",
|
||
|
|
),
|
||
|
|
(
|
||
|
|
# Generated by eth_account
|
||
|
|
"Mail",
|
||
|
|
MESSAGE_VALUES_BASIC,
|
||
|
|
TYPES_BASIC,
|
||
|
|
b"\xeae)\xf0\xee\x9e\xb0\xb2\x07\xb5\xa8\xb0\xeb\xfag=9\x8djx&(\x18\xda\x1d'\x0b\xd18\xf8\x1f\x03",
|
||
|
|
),
|
||
|
|
(
|
||
|
|
# Tested by Metamask's eth_signTypedData_v4
|
||
|
|
"Mail",
|
||
|
|
MESSAGE_VALUES_COMPLEX,
|
||
|
|
TYPES_COMPLEX,
|
||
|
|
b"\xdb\xaf\xe7F\xb1\xc4~Hp\xf6\xf7r\x05f\r<I\xa9M\xb9\xa8\t9\x80\x9b\xfc\xa7\xbfC\x91\x9d\xf5",
|
||
|
|
),
|
||
|
|
)
|
||
|
|
|
||
|
|
for primary_type, data, types, expected in VECTORS:
|
||
|
|
ctx = MockContext(data)
|
||
|
|
typed_data_envelope = TypedDataEnvelope(
|
||
|
|
ctx=ctx,
|
||
|
|
primary_type=primary_type,
|
||
|
|
metamask_v4_compat=True,
|
||
|
|
)
|
||
|
|
typed_data_envelope.types = types
|
||
|
|
|
||
|
|
res = await_result(
|
||
|
|
typed_data_envelope.hash_struct(
|
||
|
|
primary_type=primary_type,
|
||
|
|
member_path=[0],
|
||
|
|
show_data=False,
|
||
|
|
parent_objects=[primary_type],
|
||
|
|
)
|
||
|
|
)
|
||
|
|
self.assertEqual(res, expected)
|
||
|
|
|
||
|
|
def test_get_and_encode_data(self):
|
||
|
|
VECTORS = ( # primary_type, data, types, expected
|
||
|
|
(
|
||
|
|
"EIP712Domain",
|
||
|
|
DOMAIN_VALUES,
|
||
|
|
TYPES_BASIC,
|
||
|
|
b"\xc7\x0e\xf0f8S[H\x81\xfa\xfc\xac\x82\x87\xe2\x10\xe3v\x9f\xf1\xa8\xe9\x1f\x1b\x95\xd6$na\xe4\xd3\xc6\xc8\x9e\xfd\xaaT\xc0\xf2\x0cz\xdfa(\x82\xdf\tP\xf5\xa9Qc~\x03\x07\xcd\xcbLg/)\x8b\x8b\xc6\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x1e\n\xe8 ^\x97&\xe6\xf2\x96\xab\x88i\x16\nd#\xe23~",
|
||
|
|
),
|
||
|
|
(
|
||
|
|
"Mail",
|
||
|
|
MESSAGE_VALUES_BASIC,
|
||
|
|
TYPES_BASIC,
|
||
|
|
b"${\xf6.\x89\xe8\xab\xc6g\x02\x1e\xa5\xe4hf\xad\xbe\xf8\x0f\xb0\x01\xc2\x17-\xf9#\n0A/\x13\xa15'H\x1b_\xa5a5\x06\x04\xa6\rsOI\xee\x90\x7f\x17O[\xa6\xbby\x1a\xabAun\xce~\xd1\xb5\xaa\xdf1T\xa2a\xab\xdd\x90\x86\xfcb{a\xef\xca&\xaeW\x02p\x1d\x05\xcd#\x05\xf7\xc5*/\xc8",
|
||
|
|
),
|
||
|
|
(
|
||
|
|
"Mail",
|
||
|
|
MESSAGE_VALUES_COMPLEX,
|
||
|
|
TYPES_COMPLEX,
|
||
|
|
b"\xcaby\xe0T\nDc\x16\x1f\x8f\x019\x1d@\xbf/\xdb\xd3\xb3\xed\x16:p\xf2\x0c\xa5\xaa5\xd5\xfd.\xaa\xf1q\xbd\x91N\x93\xdfE\x88$o76WR\x9a\xe0\x17\xa6#\x9a6Jy\x94\x0c\xf2\xf8!\x97E.\xf5\xf3=3t\xf4\xb6%\xfd\x1bu\xba\xae\xb1\xfa\xbd\xa5%\x8a\xc2\xa3\x19\x0bbu\xf2\xadzkg\x93",
|
||
|
|
),
|
||
|
|
)
|
||
|
|
for primary_type, data, types, expected in VECTORS:
|
||
|
|
ctx = MockContext(data)
|
||
|
|
typed_data_envelope = TypedDataEnvelope(
|
||
|
|
ctx=ctx,
|
||
|
|
primary_type=primary_type,
|
||
|
|
metamask_v4_compat=True,
|
||
|
|
)
|
||
|
|
typed_data_envelope.types = types
|
||
|
|
|
||
|
|
w = bytearray()
|
||
|
|
await_result(
|
||
|
|
typed_data_envelope.get_and_encode_data(
|
||
|
|
w=w,
|
||
|
|
primary_type=primary_type,
|
||
|
|
member_path=[0],
|
||
|
|
show_data=False,
|
||
|
|
parent_objects=[primary_type],
|
||
|
|
)
|
||
|
|
)
|
||
|
|
self.assertEqual(w, expected)
|
||
|
|
|
||
|
|
def test_encode_type(self):
|
||
|
|
VECTORS = ( # primary_type, types, expected
|
||
|
|
(
|
||
|
|
"EIP712Domain",
|
||
|
|
TYPES_BASIC,
|
||
|
|
b"EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)",
|
||
|
|
),
|
||
|
|
("Person", TYPES_BASIC, b"Person(string name,address wallet)"),
|
||
|
|
(
|
||
|
|
"Mail",
|
||
|
|
TYPES_BASIC,
|
||
|
|
b"Mail(Person from,Person to,string contents)Person(string name,address wallet)",
|
||
|
|
),
|
||
|
|
(
|
||
|
|
"Person",
|
||
|
|
TYPES_COMPLEX,
|
||
|
|
b"Person(string name,address wallet,bool married,uint8 kids,int16 karma,bytes secret,bytes16 small_secret,string[] pets,string[2] two_best_friends)",
|
||
|
|
),
|
||
|
|
(
|
||
|
|
"Mail",
|
||
|
|
TYPES_COMPLEX,
|
||
|
|
b"Mail(Person from,Person to,string[] messages)Person(string name,address wallet,bool married,uint8 kids,int16 karma,bytes secret,bytes16 small_secret,string[] pets,string[2] two_best_friends)",
|
||
|
|
),
|
||
|
|
)
|
||
|
|
|
||
|
|
for primary_type, types, expected in VECTORS:
|
||
|
|
EMPTY_ENVELOPE.types = types
|
||
|
|
res = EMPTY_ENVELOPE.encode_type(primary_type=primary_type)
|
||
|
|
self.assertEqual(res, expected)
|
||
|
|
|
||
|
|
def test_hash_type(self):
|
||
|
|
VECTORS = ( # primary_type, expected
|
||
|
|
(
|
||
|
|
"EIP712Domain",
|
||
|
|
keccak256(
|
||
|
|
b"EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)"
|
||
|
|
),
|
||
|
|
),
|
||
|
|
("Person", keccak256(b"Person(string name,address wallet)")),
|
||
|
|
(
|
||
|
|
"Mail",
|
||
|
|
keccak256(
|
||
|
|
b"Mail(Person from,Person to,string contents)Person(string name,address wallet)"
|
||
|
|
),
|
||
|
|
),
|
||
|
|
)
|
||
|
|
|
||
|
|
for primary_type, expected in VECTORS:
|
||
|
|
w = bytearray()
|
||
|
|
EMPTY_ENVELOPE.types = TYPES_BASIC
|
||
|
|
EMPTY_ENVELOPE.hash_type(w=w, primary_type=primary_type)
|
||
|
|
self.assertEqual(w, expected)
|
||
|
|
|
||
|
|
def test_find_typed_dependencies(self):
|
||
|
|
# We need to be able to recognize dependency even as array of structs
|
||
|
|
types_dependency_only_as_array = {
|
||
|
|
"MAIN": [
|
||
|
|
("jkl", "SECONDARY[]"),
|
||
|
|
],
|
||
|
|
"SECONDARY": [
|
||
|
|
("abc", "string"),
|
||
|
|
("def", "TERNARY[][]"),
|
||
|
|
],
|
||
|
|
"TERNARY": [
|
||
|
|
("ghi", "string"),
|
||
|
|
],
|
||
|
|
}
|
||
|
|
types_dependency_only_as_array = get_type_definitions(types_dependency_only_as_array)
|
||
|
|
|
||
|
|
VECTORS = ( # primary_type, expected, types
|
||
|
|
(
|
||
|
|
"EIP712Domain",
|
||
|
|
{"EIP712Domain"},
|
||
|
|
TYPES_BASIC
|
||
|
|
),
|
||
|
|
(
|
||
|
|
"Person",
|
||
|
|
{"Person"},
|
||
|
|
TYPES_BASIC
|
||
|
|
),
|
||
|
|
(
|
||
|
|
"Mail",
|
||
|
|
{"Mail", "Person"},
|
||
|
|
TYPES_BASIC
|
||
|
|
),
|
||
|
|
(
|
||
|
|
"MAIN",
|
||
|
|
{"MAIN", "SECONDARY", "TERNARY"},
|
||
|
|
types_dependency_only_as_array
|
||
|
|
),
|
||
|
|
(
|
||
|
|
"UnexistingType",
|
||
|
|
set(),
|
||
|
|
TYPES_BASIC
|
||
|
|
),
|
||
|
|
)
|
||
|
|
|
||
|
|
for primary_type, expected, types in VECTORS:
|
||
|
|
res = set()
|
||
|
|
EMPTY_ENVELOPE.types = types
|
||
|
|
EMPTY_ENVELOPE.find_typed_dependencies(primary_type=primary_type, results=res)
|
||
|
|
self.assertEqual(res, expected)
|
||
|
|
|
||
|
|
def test_encode_field(self):
|
||
|
|
VECTORS = ( # field, value, expected
|
||
|
|
(
|
||
|
|
EFT(data_type=EDT.STRING, size=None),
|
||
|
|
b"Ether Mail",
|
||
|
|
keccak256(b"Ether Mail"),
|
||
|
|
),
|
||
|
|
(
|
||
|
|
EFT(data_type=EDT.STRING, size=None),
|
||
|
|
b"1",
|
||
|
|
keccak256(b"1"),
|
||
|
|
),
|
||
|
|
(
|
||
|
|
EFT(data_type=EDT.UINT, size=32),
|
||
|
|
b"\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01",
|
||
|
|
b"\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01",
|
||
|
|
),
|
||
|
|
(
|
||
|
|
EFT(data_type=EDT.UINT, size=4),
|
||
|
|
b"\x00\x00\x00\xde",
|
||
|
|
b"\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\xde",
|
||
|
|
),
|
||
|
|
(
|
||
|
|
EFT(data_type=EDT.INT, size=1),
|
||
|
|
b"\x05",
|
||
|
|
b"\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x05",
|
||
|
|
),
|
||
|
|
(
|
||
|
|
EFT(data_type=EDT.ADDRESS, size=None),
|
||
|
|
b"\x1e\n\xe8 ^\x97&\xe6\xf2\x96\xab\x88i\x16\nd#\xe23~",
|
||
|
|
b"\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x1e\n\xe8 ^\x97&\xe6\xf2\x96\xab\x88i\x16\nd#\xe23~",
|
||
|
|
),
|
||
|
|
(
|
||
|
|
EFT(data_type=EDT.BOOL, size=None),
|
||
|
|
b"\x01",
|
||
|
|
b"\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01",
|
||
|
|
),
|
||
|
|
(
|
||
|
|
EFT(data_type=EDT.BOOL, size=None),
|
||
|
|
b"\x00",
|
||
|
|
b"\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00",
|
||
|
|
),
|
||
|
|
)
|
||
|
|
|
||
|
|
for field, value, expected in VECTORS:
|
||
|
|
# metamask_v4_compat should not have any effect on the
|
||
|
|
# result for items outside of arrays
|
||
|
|
for metamask_v4_compat in [True, False]:
|
||
|
|
w = bytearray()
|
||
|
|
encode_field(
|
||
|
|
w=w,
|
||
|
|
field=field,
|
||
|
|
value=value,
|
||
|
|
)
|
||
|
|
self.assertEqual(w, expected)
|
||
|
|
|
||
|
|
def test_validate_value(self):
|
||
|
|
VECTORS_VALID_INVALID = ( # field, valid_values, invalid_values
|
||
|
|
(
|
||
|
|
EFT(data_type=EDT.UINT, size=1),
|
||
|
|
[b"\xff"],
|
||
|
|
[b"\xff\xee"],
|
||
|
|
),
|
||
|
|
(
|
||
|
|
EFT(data_type=EDT.BYTES, size=8),
|
||
|
|
[b"\xff" * 8],
|
||
|
|
[b"\xff" * 7, b"\xff" * 9],
|
||
|
|
),
|
||
|
|
(
|
||
|
|
EFT(data_type=EDT.BOOL, size=None),
|
||
|
|
[b"\x00", b"\x01"],
|
||
|
|
[b"0", b"\x00\x01"],
|
||
|
|
),
|
||
|
|
(
|
||
|
|
EFT(data_type=EDT.STRING, size=None),
|
||
|
|
[b"\x7f", b"a" * 1024],
|
||
|
|
[b"\x80", b"a" * 1025],
|
||
|
|
),
|
||
|
|
(
|
||
|
|
EFT(data_type=EDT.ADDRESS, size=None),
|
||
|
|
[b"T\xb0\xfaf\xa0et\x8c@\xdc\xa2\xc7\xfe\x12Z (\xcf\x99\x82"],
|
||
|
|
[b"T\xb0\xfaf\xa0et\x8c@\xdc\xa2\xc7\xfe\x12Z (\xcf\x99"],
|
||
|
|
),
|
||
|
|
)
|
||
|
|
|
||
|
|
for field, valid_values, invalid_values in VECTORS_VALID_INVALID:
|
||
|
|
for valid_value in valid_values:
|
||
|
|
validate_value(field=field, value=valid_value)
|
||
|
|
for invalid_value in invalid_values:
|
||
|
|
with self.assertRaises(wire.DataError):
|
||
|
|
validate_value(field=field, value=invalid_value)
|
||
|
|
|
||
|
|
def test_validate_field_type(self):
|
||
|
|
ET = EFT(data_type=EDT.BYTES, size=8)
|
||
|
|
VECTORS_VALID = ( # valid_field
|
||
|
|
(EFT(data_type=EDT.STRUCT, struct_name="Person", size=3)),
|
||
|
|
(EFT(data_type=EDT.ARRAY, entry_type=ET, size=None)),
|
||
|
|
(EFT(data_type=EDT.ARRAY, entry_type=ET, size=6)),
|
||
|
|
(EFT(data_type=EDT.BYTES, size=32)),
|
||
|
|
(EFT(data_type=EDT.BYTES, size=None)),
|
||
|
|
(EFT(data_type=EDT.UINT, size=8)),
|
||
|
|
(EFT(data_type=EDT.INT, size=16)),
|
||
|
|
(EFT(data_type=EDT.STRING)),
|
||
|
|
(EFT(data_type=EDT.BOOL)),
|
||
|
|
(EFT(data_type=EDT.ADDRESS)),
|
||
|
|
)
|
||
|
|
for valid_field in VECTORS_VALID:
|
||
|
|
validate_field_type(field=valid_field)
|
||
|
|
|
||
|
|
ET = EFT(data_type=EDT.BYTES, size=8)
|
||
|
|
ET_INVALID = EFT(data_type=EDT.BYTES, size=33)
|
||
|
|
VECTORS_INVALID = ( # invalid_field
|
||
|
|
(EFT(data_type=EDT.STRUCT, size=None)),
|
||
|
|
(EFT(data_type=EDT.STRUCT, struct_name=None)),
|
||
|
|
(EFT(data_type=EDT.STRUCT, entry_type=ET)),
|
||
|
|
(EFT(data_type=EDT.ARRAY, struct_name="Person")),
|
||
|
|
(EFT(data_type=EDT.ARRAY, entry_type=None)),
|
||
|
|
(EFT(data_type=EDT.ARRAY, entry_type=ET_INVALID)),
|
||
|
|
(EFT(data_type=EDT.BYTES, struct_name="Person")),
|
||
|
|
(EFT(data_type=EDT.BYTES, size=0)),
|
||
|
|
(EFT(data_type=EDT.BYTES, size=33)),
|
||
|
|
(EFT(data_type=EDT.BYTES, entry_type=ET)),
|
||
|
|
(EFT(data_type=EDT.UINT, struct_name="Person")),
|
||
|
|
(EFT(data_type=EDT.UINT, size=None)),
|
||
|
|
(EFT(data_type=EDT.UINT, size=0)),
|
||
|
|
(EFT(data_type=EDT.UINT, size=33)),
|
||
|
|
(EFT(data_type=EDT.UINT, entry_type=ET)),
|
||
|
|
(EFT(data_type=EDT.INT, struct_name="Person")),
|
||
|
|
(EFT(data_type=EDT.INT, size=None)),
|
||
|
|
(EFT(data_type=EDT.INT, size=0)),
|
||
|
|
(EFT(data_type=EDT.INT, size=33)),
|
||
|
|
(EFT(data_type=EDT.INT, entry_type=ET)),
|
||
|
|
(EFT(data_type=EDT.STRING, struct_name="Person")),
|
||
|
|
(EFT(data_type=EDT.STRING, size=3)),
|
||
|
|
(EFT(data_type=EDT.STRING, entry_type=ET)),
|
||
|
|
(EFT(data_type=EDT.BOOL, struct_name="Person")),
|
||
|
|
(EFT(data_type=EDT.BOOL, size=1)),
|
||
|
|
(EFT(data_type=EDT.BOOL, size=3)),
|
||
|
|
(EFT(data_type=EDT.BOOL, entry_type=ET)),
|
||
|
|
(EFT(data_type=EDT.ADDRESS, struct_name="Person")),
|
||
|
|
(EFT(data_type=EDT.ADDRESS, size=3)),
|
||
|
|
(EFT(data_type=EDT.ADDRESS, size=20)),
|
||
|
|
(EFT(data_type=EDT.ADDRESS, entry_type=ET)),
|
||
|
|
)
|
||
|
|
for invalid_field in VECTORS_INVALID:
|
||
|
|
with self.assertRaises(wire.DataError):
|
||
|
|
validate_field_type(field=invalid_field)
|
||
|
|
|
||
|
|
def test_get_type_name(self):
|
||
|
|
VECTORS = ( # field, expected
|
||
|
|
(
|
||
|
|
EFT(
|
||
|
|
data_type=EDT.ARRAY,
|
||
|
|
size=None,
|
||
|
|
entry_type=EFT(data_type=EDT.UINT, size=32),
|
||
|
|
),
|
||
|
|
"uint256[]",
|
||
|
|
),
|
||
|
|
(
|
||
|
|
EFT(
|
||
|
|
data_type=EDT.ARRAY,
|
||
|
|
size=None,
|
||
|
|
entry_type=EFT(
|
||
|
|
data_type=EDT.ARRAY,
|
||
|
|
size=None,
|
||
|
|
entry_type=EFT(
|
||
|
|
data_type=EDT.BYTES,
|
||
|
|
size=16
|
||
|
|
),
|
||
|
|
)
|
||
|
|
),
|
||
|
|
"bytes16[][]",
|
||
|
|
),
|
||
|
|
(
|
||
|
|
EFT(
|
||
|
|
data_type=EDT.ARRAY,
|
||
|
|
size=4,
|
||
|
|
entry_type=EFT(data_type=EDT.STRING, size=None),
|
||
|
|
),
|
||
|
|
"string[4]",
|
||
|
|
),
|
||
|
|
(
|
||
|
|
EFT(data_type=EDT.STRUCT, size=2, struct_name="Person"),
|
||
|
|
"Person",
|
||
|
|
),
|
||
|
|
(
|
||
|
|
EFT(data_type=EDT.STRING, size=None),
|
||
|
|
"string",
|
||
|
|
),
|
||
|
|
(
|
||
|
|
EFT(data_type=EDT.ADDRESS, size=None),
|
||
|
|
"address",
|
||
|
|
),
|
||
|
|
(
|
||
|
|
EFT(data_type=EDT.BOOL, size=None),
|
||
|
|
"bool",
|
||
|
|
),
|
||
|
|
(
|
||
|
|
EFT(data_type=EDT.UINT, size=20),
|
||
|
|
"uint160",
|
||
|
|
),
|
||
|
|
(
|
||
|
|
EFT(data_type=EDT.INT, size=8),
|
||
|
|
"int64",
|
||
|
|
),
|
||
|
|
(
|
||
|
|
EFT(data_type=EDT.BYTES, size=8),
|
||
|
|
"bytes8",
|
||
|
|
),
|
||
|
|
(
|
||
|
|
EFT(data_type=EDT.BYTES, size=None),
|
||
|
|
"bytes",
|
||
|
|
),
|
||
|
|
)
|
||
|
|
|
||
|
|
for field, expected in VECTORS:
|
||
|
|
res = get_type_name(field)
|
||
|
|
self.assertEqual(res, expected)
|
||
|
|
|
||
|
|
def test_decode_typed_data(self):
|
||
|
|
VECTORS = ( # data, type_name, expected
|
||
|
|
(b"\x4a\x56", "bytes", "4a56"),
|
||
|
|
(b"Hello, Bob!", "string", "Hello, Bob!"),
|
||
|
|
(
|
||
|
|
b"\x1e\n\xe8 ^\x97&\xe6\xf2\x96\xab\x88i\x16\nd#\xe23~",
|
||
|
|
"address",
|
||
|
|
"0x1e0Ae8205e9726E6F296ab8869160A6423E2337E",
|
||
|
|
),
|
||
|
|
(b"\x01", "bool", "true"),
|
||
|
|
(b"\x00", "bool", "false"),
|
||
|
|
(b"\x3f\x46\xaa", "uint", "4146858"),
|
||
|
|
(b"\x3f\x46\xaa", "int", "4146858"),
|
||
|
|
(b"\xff\xf1", "uint", "65521"),
|
||
|
|
(b"\xff\xf1", "int", "-15"),
|
||
|
|
)
|
||
|
|
|
||
|
|
for data, type_name, expected in VECTORS:
|
||
|
|
res = decode_typed_data(data, type_name)
|
||
|
|
self.assertEqual(res, expected)
|
||
|
|
|
||
|
|
|
||
|
|
if __name__ == "__main__":
|
||
|
|
unittest.main()
|