eip_712

Documentation for eth_defi.eip_712 Python module.

EIP-712 signing.

  • Routines for EIP712 encoding and signing.

  • Based on Gnosis utilities.

  • Used in eth_defi.usdc module for crafting EIP-3009 messages

Example:

data = {
    "types": {
        "EIP712Domain": [
            {"name": "name", "type": "string"},
            {"name": "version", "type": "string"},
            {"name": "chainId", "type": "uint256"},
            {"name": "verifyingContract", "type": "address"},
        ],
        authorization_type.value: [
            {"name": "from", "type": "address"},
            {"name": "to", "type": "address"},
            {"name": "value", "type": "uint256"},
            {"name": "validAfter", "type": "uint256"},
            {"name": "validBefore", "type": "uint256"},
            {"name": "nonce", "type": "bytes32"},
        ],
    },
    # domainSeparator = makeDomainSeparator(
    #   "USD Coin",
    #   "2",
    #   1, // hardcoded to 1 because of ganache bug: https://github.com/trufflesuite/ganache/issues/1643
    #   getFiatToken().address
    # );
    "domain": {
        "name": token.name,
        "version": "2",  # TODO: Read from USDC contract?
        "chainId": chain_id,
        "verifyingContract": token.address,
    },
    "primaryType": authorization_type.value,
    "message": {"from": from_, "to": to, "value": value, "validAfter": valid_after, "validBefore": valid_before, "nonce": secrets.token_bytes(32)},  # 256-bit random nonce
}

message_hash = eip712_encode_hash(data)
signed_message = local_account.signHash(message_hash)

Past copyright:

Copyright (C) 2022 Judd Vinet <jvinet@zeroflux.org>
                   Uxío Fuentefría <uxio@safe.global>

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Functions

eip712_encode(typed_data)

Given a dict of structured data and types, return a 3-element list of the encoded, signable data.

eip712_encode_hash(typed_data)

param typed_data

EIP712 structured data and types

eip712_signature(payload, private_key)

Given a bytes object and a private key, return a signature suitable for EIP712 and EIP191 messages.

encode_data(primary_type, data, types)

Encode structured data as per Ethereum's signTypeData_v4.

encode_type(primary_type, types)

fast_keccak(value)

find_type_dependencies(primary_type, types)

hash_struct(primary_type, data, types)

hash_type(primary_type, types)