EIP-712签名介绍以及使用hardhat实现

Posted 2023-03-31 涛行

文章目录

• 简介
• 结构解析
• 签名并验证
• 注意事项

简介

EIP-712是一种高级安全的交易签名方法。使用该标准不仅可以签署交易并且可以验证签名，而且可以将数据与签名以用户可见内容的方式一起传递到智能合约中，并且可以根据该数据验证签名以了解签名者是否是实际发送该签名的人要在交易中调用的数据。

EIP-712提出了数据的标准结构和从结构化消息生成散列的定义过程。然后使用此散列生成签名。通过这种方式，为发送交易生成的签名与为验证身份或任何其他目的生成的签名之间就有了明显的区别。EIP-712草案将签名方案背后的动机表述为:

提高链上使用的链下消息签名的可用性。我们看到越来越多的人采用链下消息签名，因为它节省了gas，减少了区块链上的交易数量。

结构解析

EIP712签名包含三个部分：domain，types和data，以下面的代码为例：其中domain主要用来区分针对不同合约的签名，共包含合约名称(name)、版本号(version)、链ID(chainId)、合约地址(verifyingContract)和盐(salt)五个可选择的部分，types部分限定了需要签名的函数为listNFTwithSig（注意合约中的函数名可以开头不大写，但是签名内容中的函数名必须开头大写）并限定了函数的五个参数与其数据类型，data部分给函数中的参数赋值

    const message = 
        domain: 
            name: "NFTMarket",
            version: "1.0",
            chainId: chainId,
            verifyingContract: marketContract.address
        ,
        types: 
            ListNFTwithSig: [
                name: "_NFTContract", type: "address",
                name: "_tokenId", type: "uint256",
                name: "_price", type: "uint256" ,
                name: "nonce", type: "uint256" ,
                name: "deadline", type: "uint256"
            ],
        ,
        data: 
            _NFTContract: nftContract.address,
            _tokenId: 4,
            _price: 100,
            nonce: 0,
            deadline: 100,
        
    ;

签名并验证

演示代码均在Ubuntu中实现，需要系统提前安装好最新版的node.js，如果没有安装或者版本低的话参照这篇博文安装或更新node.js
安装好之后，新建一个文件夹，在文件夹下新建终端，输入以下命令安装hardhat模块

npm install --save-dev hardhat

输入以下命令初始化hardhat环境

npx hardhat

按四次回车初始化js部署环境。

等所有模块下载好之后进入scripts文件夹下新建文件run.js，将以下代码输入其中

const main = async () => 
    const [guy, randomGuy] = await hre.ethers.getSigners();
    console.log('Guy\\'s address:', guy.address);

    const marketContractFactory = await hre.ethers.getContractFactory("NFTMarket");
    const marketContract = await marketContractFactory.deploy();
    console.log("Contract deployed to:", marketContract.address);
    const chainId = await guy.getChainId(); // 31337
    const nftContract = '0x5fbdb2315678afecb367f032d93f642f64180aa3';
    const message = 
        domain: 
            name: "NFTMarket",
            version: "1.0",
            chainId: chainId,
            verifyingContract: marketContract.address
        ,
        types: 
            ListNFTwithSig: [
                name: "_NFTContract", type: "address",
                name: "_tokenId", type: "uint256",
                name: "_price", type: "uint256" ,
                name: "nonce", type: "uint256" ,
                name: "deadline", type: "uint256"
            ],
        ,
        data: 
            _NFTContract: nftContract,
            _tokenId: 0,
            _price: 100,
            nonce: 0,
            deadline: 100,
        
    ;
	
    console.log(message.domain, message.data);

    // 得到一条哈希
    const sign = await guy._signTypedData(message.domain, message.types, message.data);
    console.log(sign);

    // 从哈希中提取v, r, s
    const sig = ethers.utils.splitSignature(sign);
    console.log(sig.v, sig.r, sig.s);
	
	// 在js中验证签名
    const recoveredAddress = ethers.utils.verifyTypedData(message.domain, message.types, message.data, sig);

    console.log('signer add in js file:', recoveredAddress);

	// 在合约中验证签名
    const _listWithSig = await marketContract.connect(randomGuy).listNFTwithSig(nftContract, 0, 100, 100, sig.v, sig.r, sig.s);
    await _listWithSig.wait();


const runMain = async () => 
    try 
        await main();
        process.exit(0);
    
    catch(error) 
        console.log(error);
        process.exit(1);
    


runMain();

再到contracts文件夹下新建文件起名eip712.sol，将以下代码输入其中：

//SPDX-License-Identifier: MIT
pragma solidity ^0.8.17;

import "hardhat/console.sol";

contract NFTMarket 
    mapping(address => uint256) nonces;
    string version = "1.0";
    string name = "NFTMarket";   //contract name 
    bytes32 public DOMAIN_SEPARATOR;
    // ！注意：参数之间只用逗号隔开，不要额外添加空格，否则会导致验签失败！以下domain separator相同！
    // keccak256("ListNFTwithSig(address _NFTContract,uint256 _tokenId,uint256 _price,uint256 nonce,uint256 deadline)")
    bytes32 public constant LIST_TYPEHASH = 0x6f8a295cea3edab22428a30506be6fb57d93dd2ba58973d57bb71c48af8fbc7e;

    constructor() 
        uint256 chainId;
        assembly     //buildin assembly to get chainID
            chainId := chainid()
        
        DOMAIN_SEPARATOR = keccak256(
            abi.encode(
                keccak256("EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)"),
                keccak256(bytes(name)),
                keccak256(bytes(version)),
                chainId,
                address(this)
            )
        );
        // console.log("constructor chainId:", chainId);  //1337
    

    function listNFTwithSig(address _NFTContract, uint256 _tokenId, uint256 _price, uint256 deadline, uint8 v, bytes32 r, bytes32 s) public 
       bytes32 digest = keccak256(
            abi.encodePacked(
                '\\x19\\x01',
                DOMAIN_SEPARATOR,
                keccak256(abi.encode(LIST_TYPEHASH, _NFTContract, _tokenId, _price, nonces[msg.sender]++, deadline))
            )
        );
        address owner = ecrecover(digest, v, r, s);  //获取消息签名者的地址
        console.log(owner);
    

保存好之后在根目录之下执行

npx hardhat run ./scripts/run.js 

输出结果为：
可以看到签名的地址、js中验签的结果和合约中验签的结果均为地址$0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266$

注意事项

1. 如果签名或验签过程中报错$Error:networkdoesnotsupportENS(operation="getResolver",network="unknown",code=UNSUPPORTE{D}_{O}PERATION,version=providers/5.7.2)$，则需要检查代码中地址的格式是否均为$string$；
2. 合约中LIST_TYPEHASH函数变量要和js中的types相吻合，否则会导致验签失败；
3. 合约代码中涉及到$keccak$加密的部分，函数参数之间只能用一个逗号隔开，不能加空格或者其他字符，否则会导致验签失败；
4. 使用内联汇编获取chainId注意格式，最新版本的solidity使用$chainId:=chainid()$而非旧版本的$chainId:=chainid$