Michael.W基于Foundry精读Openzeppelin第33期——EIP712.sol

news2025/1/6 19:32:58

Michael.W基于Foundry精读Openzeppelin第33期——EIP712.sol

      • 0. 版本
        • 0.1 EIP712.sol
      • 1. 目标合约
      • 2. 代码精读
        • 2.1 constructor(string memory name, string memory version)
        • 2.2 _domainSeparatorV4()
        • 2.3 _hashTypedDataV4(bytes32 structHash)

0. 版本

[openzeppelin]：v4.8.3，[forge-std]：v1.5.6

0.1 EIP712.sol

Github: https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.3/contracts/utils/cryptography/EIP712.sol

EIP-712是一个专门用于对结构化数据求hash值以及签名的标准，主要解决了数据“链下签名+链上验证”并提高了链上消息签名的可用性。EIP712合约提供了EIP 712 domain separator的定义与获取——是结构化数据完整编码的一部分。

EIP712中对domain separator的实现支持动态更新链chain id，这样可防止由链硬分叉而引起的重放攻击。并且本库实现的整体编码规则为v4版本，匹配Metamask中的JSON RPC方法 ——eth_signTypedDataV4。细节参见：https://docs.metamask.io/guide/signing-data.html

注：EIP-712细节参见：https://eips.ethereum.org/EIPS/eip-712

1. 目标合约

继承EIP712合约成为一个可调用合约：

Github: https://github.com/RevelationOfTuring/foundry-openzeppelin-contracts/blob/master/src/utils/cryptography/MockEIP712.sol

// SPDX-License-Identifier: UNLICENSED
pragma solidity ^0.8.0;

import "openzeppelin-contracts/contracts/utils/cryptography/EIP712.sol";
import "openzeppelin-contracts/contracts/utils/cryptography/ECDSA.sol";

contract MockEIP712 is EIP712 {
    using ECDSA for bytes32;

    constructor(string memory name, string memory version) EIP712(name, version) {}

    function verify(
        string memory name,
        uint salary,
        address personalAddress,
        address signer,
        bytes memory signature
    ) external view {
    	// hashing the typed data
        bytes32 structHash = keccak256(
            abi.encode(
                keccak256("NameCard(string name,uint256 salary,address personalAddress)"),
                keccak256(bytes(name)),
                salary,
                personalAddress
            )
        );
				
		// build fully encoded EIP712 message for this domain
        bytes32 digest = _hashTypedDataV4(structHash);
        // signature verification
        require(signer == digest.recover(signature), "invalid signature");
    }

    function getDomainSeparator() external view returns (bytes32) {
        return _domainSeparatorV4();
    }
}

全部foundry测试合约：

Github: https://github.com/RevelationOfTuring/foundry-openzeppelin-contracts/blob/master/test/utils/cryptography/EIP712.t.sol

测试数据：

Github: https://github.com/RevelationOfTuring/foundry-openzeppelin-contracts/blob/master/test/utils/cryptography/data/EIP712_test.json

测试数据的生成脚本：

Github: https://github.com/RevelationOfTuring/foundry-openzeppelin-contracts/blob/master/test/utils/cryptography/EIP712_test.ts

import {ethers} from 'ethers'
import type {TypedDataDomain} from 'ethers'
import {writeFileSync} from 'fs'

const domain: TypedDataDomain = {
    name: 'mock name',
    version: '1',
    chainId: 1024,
    verifyingContract: '0xfc1a36B3eF056c2eC89FdeB4251e90F7935F1b51'
}

const types = {
    'NameCard': [
        {'name': 'name', 'type': 'string'},
        {'name': 'salary', 'type': 'uint256'},
        {'name': 'personalAddress', 'type': 'address'},
    ]
}

// typed data
const value = {
    name: 'Michael.W',
    salary: 1024,
    personalAddress: '0x0000000000000000000000000000000000000400',
}

async function main() {
    const domainSeparator = ethers.TypedDataEncoder.hashDomain(domain)
    const wallet = new ethers.Wallet(ethers.toBeHex(1024, 32))
    const signature = await wallet.signTypedData(domain, types, value)

    // generate domain separator with chain id changed
    domain.chainId = 2048
    const domainSeparatorWithChainIdChanged = ethers.TypedDataEncoder.hashDomain(domain)

    const output = {
        domain_separator: domainSeparator,
        domain_separator_with_chain_id_changed: domainSeparatorWithChainIdChanged,
        value,
        signature,
        signer_address: wallet.address
    }

    writeFileSync('test/utils/cryptography/data/EIP712_test.json', JSON.stringify(output))
}

main().catch((error) => {
    console.error(error)
    process.exitCode = 1
})

2. 代码精读

2.1 constructor(string memory name, string memory version)

constructor函数中初始化了domain separator以及将一些相关的参数cached到immutable常量中。

传参：

  • name：签名域EIP712Domain中的一个成员变量，为用户可读的name。通常传入DApp或协议的名字；

  • version：签名域EIP712Domain中的一个成员变量，为当前签名域EIP712Domain的主版本号。

签名域EIP712Domain的具体说明参见：https://eips.ethereum.org/EIPS/eip-712#definition-of-domainseparator

注：constructor中将参数初始化到immutable常量，后续无法修改，除非依靠合约升级。

    // 将domain separator cache到一个immutable常量中，这样会减少每次使用domain separator的gas消耗
    bytes32 private immutable _CACHED_DOMAIN_SEPARATOR;
    // 将当前的chain id也cache到一个immutable常量中，这样做的目的是：以后一旦该链的chain id改变，_CACHED_DOMAIN_SEPARATOR理应作废。而_CACHED_CHAIN_ID则用于判断chain id是否改变
    uint256 private immutable _CACHED_CHAIN_ID;
    // 将本合约地址cache到一个immutable常量中
    address private immutable _CACHED_THIS;
	// 将name的hash值cache到一个immutable常量中
    bytes32 private immutable _HASHED_NAME;
    // 将version的hash值cache到一个immutable常量中
    bytes32 private immutable _HASHED_VERSION;
    // 将EIP712Domain的hash值cache到一个immutable常量中
    bytes32 private immutable _TYPE_HASH;

    constructor(string memory name, string memory version) {
        // 计算name的hash值
        bytes32 hashedName = keccak256(bytes(name));
        // 计算version的hash值
        bytes32 hashedVersion = keccak256(bytes(version));
        // 计算签名域EIP712Domain的type hash
        bytes32 typeHash = keccak256(
            "EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)"
        );
        // 将name的hash值cache到_HASHED_NAME中
        _HASHED_NAME = hashedName;
        // 将version的hash值cache到_HASHED_VERSION中
        _HASHED_VERSION = hashedVersion;
        // 将当前的链chain id cache到_CACHED_CHAIN_ID
        _CACHED_CHAIN_ID = block.chainid;
        // 计算domain separator并cache到_CACHED_DOMAIN_SEPARATOR
        _CACHED_DOMAIN_SEPARATOR = _buildDomainSeparator(typeHash, hashedName, hashedVersion);
        // 将本合约地址cache到_CACHED_THIS
        _CACHED_THIS = address(this);
        // 将签名域EIP712Domain的type hash cache到_TYPE_HASH
        _TYPE_HASH = typeHash;
    }
    
    // 计算domain separator
	// 输入参数为：
	// typeHash：签名域EIP712Domain的type hash；
	// nameHash：签名域EIP712Domain中成员变量name的hash值；
	// versionHash：签名域EIP712Domain中成员变量version的hash值
    function _buildDomainSeparator(
        bytes32 typeHash,
        bytes32 nameHash,
        bytes32 versionHash
    ) private view returns (bytes32) {
    	// 连接type hash + name hash + version hash + 当前链的chain id + 本合约地址，并取hash值返回
        return keccak256(abi.encode(typeHash, nameHash, versionHash, block.chainid, address(this)));
    }

2.2 _domainSeparatorV4()

获取针对于当前链的domain separator

    function _domainSeparatorV4() internal view returns (bytes32) {
        if (address(this) == _CACHED_THIS && block.chainid == _CACHED_CHAIN_ID) {
            // 如果当前合约地址和当前链chain id都与之前cached的值一样，直接返回cached的domain separator值
            return _CACHED_DOMAIN_SEPARATOR;
        } else {
        	// 否则表明domain separator照比原来cached已经发生改变（chain id或verifying contract地址变了），利用_TYPE_HASH、 _HASHED_NAME和_HASHED_VERSION重新计算domain separator并返回
            return _buildDomainSeparator(_TYPE_HASH, _HASHED_NAME, _HASHED_VERSION);
        }
    }

foundry代码验证

contract EIP712Test is Test {
    using stdJson for string;

    // fix the contract address with salt 'Michael.W'
    MockEIP712 me = new MockEIP712{salt : 'Michael.W'}("mock name", "1");
    string jsonTestData = vm.readFile("test/utils/cryptography/data/EIP712_test.json");

    function setUp() external {
        // fix chain id to 1024
        vm.chainId(1024);
    }

    function test_DomainSeparator() external {
        // case 1: right domain separator
        bytes32 expectedDomainSeparator = jsonTestData.readBytes32(".domain_separator");
        assertEq(expectedDomainSeparator, me.getDomainSeparator());

        // case 2: domain separator changed with the chain id
        vm.chainId(2048);
        expectedDomainSeparator = jsonTestData.readBytes32(".domain_separator_with_chain_id_changed");
        assertEq(expectedDomainSeparator, me.getDomainSeparator());
    }
}

2.3 _hashTypedDataV4(bytes32 structHash)

返回基于本domain的结构化数据的完整EIP712的编码信息。该编码信息往往用作对结构化数据签名的摘要。

structHash为具体的结构化数据的hash值，具体说明参见：https://eips.ethereum.org/EIPS/eip-712#definition-of-hashstruct

    function _hashTypedDataV4(bytes32 structHash) internal view virtual returns (bytes32) {
    	// 使用ECDSA库中的toTypedDataHash方法，传入本domain separator以及结构化数据的hash计算整个摘要并返回
        return ECDSA.toTypedDataHash(_domainSeparatorV4(), structHash);
    }

foundry代码验证

contract EIP712Test is Test {
    using stdJson for string;

    // fix the contract address with salt 'Michael.W'
    MockEIP712 me = new MockEIP712{salt : 'Michael.W'}("mock name", "1");
    string jsonTestData = vm.readFile("test/utils/cryptography/data/EIP712_test.json");

    function setUp() external {
        // fix chain id to 1024
        vm.chainId(1024);
    }

    // typed data
    struct NameCard {
        string name;
        uint salary;
        address personAddress;
    }

    function test_Verify() external {
        // case 1: pass verify
        bytes memory signature = jsonTestData.readBytes(".signature");
        address signerAddress = jsonTestData.readAddress(".signer_address");
        bytes memory encodedBytes = jsonTestData.parseRaw(".value");
        NameCard memory nameCard = abi.decode(encodedBytes, (NameCard));

        me.verify(
            nameCard.name,
            nameCard.salary,
            nameCard.personAddress,
            signerAddress,
            signature
        );

        // case 2: fail to pass verify with value changed
        vm.expectRevert("invalid signature");
        me.verify(
            nameCard.name,
            nameCard.salary + 1,
            nameCard.personAddress,
            signerAddress,
            signature
        );
    }
}

ps:
本人热爱图灵，热爱中本聪，热爱V神。
以下是我个人的公众号，如果有技术问题可以关注我的公众号来跟我交流。
同时我也会在这个公众号上每周更新我的原创文章，喜欢的小伙伴或者老伙计可以支持一下！
如果需要转发，麻烦注明作者。十分感谢！

在这里插入图片描述

公众号名称：后现代泼痞浪漫主义奠基人

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/946138.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

OpenVINO2023使用简介

OpenVINO2023使用简介

1 下载安装 先在anaconda中创建一个虚拟环境，该环境的python版本为3.7，之所以使用python3.7，是因为我在3.9上安装过程中出现不少bug，后面新建了一个3.7的环境才解决，我不知道是否由于和我已有环境中某些包不兼容&…
阅读更多...
222. 完全二叉树的节点个数 Python

222. 完全二叉树的节点个数 Python

文章目录 一、题目描述示例 1![在这里插入图片描述](https://img-blog.csdnimg.cn/8c74d1b796b74286999e09d4c6b7682f.png#pic_center)示例 2示例 3 二、代码三、解题思路 一、题目描述 给你一棵 完全二叉树 的根节点 root ，求出该树的节点个数。 完全二叉树 的定…
阅读更多...
【无监督学习】压缩即预测——Kolmogorov 复杂度作为终极压缩器

【无监督学习】压缩即预测——Kolmogorov 复杂度作为终极压缩器

基于学习方法，机器学习大致可分为监督学习和无监督学习两种。在无监督学习中，我们需要用某种算法去训练无标签数据集，从而帮助模型找到这组数据的潜在结构。 为了进行无监督学习，在OpenAI成立早期，他们认为通过压缩可…
阅读更多...
go gin 自定义验证

go gin 自定义验证

我们上一篇已经提到了gin中binding时候可以指定json字段大小等限制，但是那个错误却是英文的，现在想搞成中文的，以便前端可读，demo如下 package mainimport ("net/http""reflect""github.com/gin-gonic/…
阅读更多...
知更鸟语音训练

知更鸟语音训练

现在哪还有人读小说、看视频，谁还用真人朗读呢？ 现在给大家介绍，假人朗读是怎么来的，提供一些音频，进行训练，然后就能合成属于自己的音频了。这里只讲训练部分，使用请自己看github知更鸟&#…
阅读更多...
javaee spring 静态代理

javaee spring 静态代理

静态代理 package com.test.staticProxy;public interface IUsersService {public void insert(); }package com.test.staticProxy;//目标类 public class UsersService implements IUsersService {Overridepublic void insert() {System.out.println("添加用户");…
阅读更多...
【C++作业】定义一个基类Animal，其中有一个虚函数Perform，用于在子类中实现不同的表演行为

【C++作业】定义一个基类Animal，其中有一个虚函数Perform，用于在子类中实现不同的表演行为

1 动物园的讲解员和动物表演 以下是一个简单的比喻，将多态概念与生活中的实际情况相联系： 比喻：动物园的讲解员和动物表演 想象一下你去了一家动物园，看到了许多不同种类的动物，如狮子、大象、猴子等。现在&#xff0c…
阅读更多...
让你成为室内渲染大师！别再犯这6大错误

让你成为室内渲染大师！别再犯这6大错误

你是不是经常感叹自己仿佛用了个假软件？ V-Ray室内渲染中这6个常见错误你一定不能犯，今天小编就带你逐一击破！ 案例项目为 Whistler House by SBD & Burgers Architecture 1.错误比例的纹理 材质纹理太小或太大都会让渲染看起来不真实…
阅读更多...
公园可视联网报警器怎么样

公园可视联网报警器怎么样

公园可视联网报警器怎么样 公园可视联网报警器是一种用于保障公园安全的设备，具有以下几个优点： 1. 实时监控：可视联网报警器可以实时监控公园的各个角落，一旦发现可疑情况，及时报警并提供现场视频。 2. 防止犯罪&am…
阅读更多...
前端基础1——HTML标记语言

前端基础1——HTML标记语言

文章目录 一、基本了解二、HTML常用标签2.1 文本格式化标签2.2 列表标签2.3 超链接标签2.4 图片标签2.5 表格标签2.6 表单标签2.6.1 提交表单2.6.2 下拉表单2.6.3 按钮标签 2.7 布局标签 一、基本了解 网页组成（index.html页面）： HTML标记语言…
阅读更多...
一次讲清楚Linux Cron和 Spring Cron

一次讲清楚Linux Cron和 Spring Cron

定时任务是我们日常开发中经常用到的一个功能点，无论是Linux服务器上Crontab还是Spring task schedule，都会使用到cron表达式去实现定时任务的配置。不过，一定要注意，Linux cron表达式和Spring的cron表达式不一样，下面…
阅读更多...
打开谷歌浏览器远程调试功能

打开谷歌浏览器远程调试功能

谷歌浏览器远程调试功能 首先我们来启动Chrome的远程调试端口。你需要找到Chrome的安装位置，在Chrome的地址栏输入chrome://version就能找到Chrome的安装路径 开启远程控制命令 文件路径/chrome.exe --remote-debugging-port9222开启后的样子(注意要关闭其他谷歌浏…
阅读更多...
你会使用druid数据库连接池吗？？？

你会使用druid数据库连接池吗？？？

1.下载架包。下载地址：https://note.youdao.com/ynoteshare/index.html?id61e2cc939390acc9c7e5017907e98044&typenote&_time1693296531722 2.将架包加入项目文件。 创建一个lib目录，将架包复制进去 右键点击lib目录，将其添加为库。…
阅读更多...
秋招面试总结

秋招面试总结

八股 C中传引用和传指针的区别：参考 指针传参： 本质是值传递，形参的指针变量是个临时局部变量，用来接收外部实参指针变量保存的地址值除了解引用对地址内存进行操作外，形参指针变量的其他任何操作都不会影响到外面的实…
阅读更多...
yolov5自定义模型训练一

yolov5自定义模型训练一

要拿yolo来用到自己希望使用的场合就需要自己来训练模型权重，要训练模型权重需要足够的训练数据集，数据越多训练后的模型权重越准确。 数据集需要按yolov5的格式进行收集，收集图片后需要用标注工具进行标注，常用的有LabelImg软件…
阅读更多...
Redis——》Pipeline

Redis——》Pipeline

推荐链接： 总结——》【Java】 总结——》【Mysql】 总结——》【Redis】 总结——》【Kafka】 总结——》【Spring】 总结——》【SpringBoot】 总结——》【MyBatis、MyBatis-Plus】 总结——》【Linux】 总结——》【MongoD…
阅读更多...
小学生演讲与口才教案设计

小学生演讲与口才教案设计

教案设计：小学生演讲与口才 教学目标： 1. 培养学生的演讲能力和口才表达能力。 2. 培养学生的自信心和沟通能力。 3. 提高学生的思维逻辑和语言组织能力。 教学重点： 教学重点一：演讲技巧的培养 演讲技巧是指在演讲过程中运…
阅读更多...
Python科研绘图--Task05

Python科研绘图--Task05

目录 SciencePlots 安装SciencePlots 安装LaTeX ① 安装 MikTex 和 Ghostscript ② 将软件的安装路径添加到系统环境变量中 SciencePlots 绘图示例 SciencePlots 虽然 Matplotlib 或 ProPlot 库能够绘制出插图结果，但用户还需要根据期刊的配图绘制要求进行…
阅读更多...
简易虚拟培训系统-UI控件的应用3

简易虚拟培训系统-UI控件的应用3

目录 Button组件的组成 Button组件方法1-在Button组件中设置OnClick()回调 Button组件方法2-在脚本中添加Button类的监听 上一篇使用了文件流读取硬盘数据并显示在Text组件中，本篇增加使用按钮来控制显示哪一篇文字信息。 Button组件的组成 1. 新建Button&#…
阅读更多...
由北京筑龙承建的“黔云招采—贵州高速板块”正式上线

由北京筑龙承建的“黔云招采—贵州高速板块”正式上线

8月28日，由北京筑龙承建的黔云招采电子招标采购交易平台首个行业板块——贵州高速板块正式上线运行。该板块实现了资源共享和数据隔离，提升了系统可扩展性和业务灵活性，切实满足了贵州高速集团交易业务独立运营的要求。 贵州高速板块由黔云招…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023