Ethers.js中TypedDataEncoder.hashDomain的正确使用方法

概述

在使用区块链EIP-712标准进行结构化数据签名时，TypedDataEncoder.hashDomain方法是一个关键工具。本文将深入探讨如何正确使用ethers.js库中的这一功能，避免常见的错误用法。

EIP-712域哈希原理

EIP-712标准定义了一种结构化数据的签名方法，其中域哈希(Domain Hash)是整个签名过程的基础部分。正确的域哈希应该包含以下步骤：

1. 定义EIP712Domain类型字符串并计算其类型哈希
2. 对域中的每个字符串字段(如name和version)进行单独哈希
3. 将所有字段按特定顺序编码并计算最终哈希

常见错误分析

许多开发者在使用TypedDataEncoder.hashDomain时会犯一个典型错误：直接传入已经哈希过的字符串值。例如：

const domain = {
    name: "0x03c299...", // 已经是哈希值
    version: "0xf9446b...", // 已经是哈希值
    chainId: 31337,
    verifyingContract: "0x0B306BF915C4d645ff596e518fAf3F9669b97016"
};

这种用法会导致TypedDataEncoder对这些已经哈希的值再次进行哈希，从而得到错误的域哈希结果。

正确使用方法

正确的做法是直接传入原始字符串值，让TypedDataEncoder内部处理哈希过程：

const domain = {
    name: "MyDApp", // 原始字符串
    version: "1.0", // 原始字符串
    chainId: 31337,
    verifyingContract: "0x0B306BF915C4d645ff596e518fAf3F9669b97016"
};

const hashDomain = ethers.TypedDataEncoder.hashDomain(domain);

手动计算域哈希

如果需要手动计算域哈希以验证TypedDataEncoder的结果，可以按照以下步骤：

1. 计算EIP712Domain类型哈希：

const TYPE_HASH = ethers.keccak256(
    ethers.toUtf8Bytes(
        "EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)"
    )
);

2. 对每个字符串字段单独哈希：

const nameHash = ethers.keccak256(ethers.toUtf8Bytes(domain.name));
const versionHash = ethers.keccak256(ethers.toUtf8Bytes(domain.version));

3. 编码并计算最终哈希：

const hash = ethers.keccak256(
    coder.encode(
        ["bytes32", "bytes32", "bytes32", "uint256", "address"],
        [TYPE_HASH, nameHash, versionHash, domain.chainId, domain.verifyingContract]
    )
);

总结

使用ethers.js的TypedDataEncoder.hashDomain方法时，务必注意：

1. 直接传入原始字符串值，而非哈希值
2. 库会自动处理所有必要的哈希计算
3. 手动计算时需确保每个步骤与库的实现一致

正确理解和使用这些工具对于实现安全的EIP-712签名流程至关重要。开发者应当避免预处理哈希值，而是让库函数完成标准规定的所有哈希步骤。