Ethers.js 中 Transaction.from 方法处理 TransactionRequest 的类型问题解析

背景介绍

在区块链开发中，ethers.js 是一个广泛使用的 JavaScript/TypeScript 库，用于与区块链网络交互。在最新版本的 ethers.js (v6.x) 中，开发者在使用 Transaction.from 方法处理 TransactionRequest 类型时可能会遇到类型不匹配的问题。

问题本质

当开发者尝试使用 ethers.Transaction.from 方法创建交易对象时，如果传入的参数是 ethers.TransactionRequest 类型，TypeScript 会报错。这是因为 TransactionRequest 允许 to 和 from 字段为异步可解析的值（如 ENS 名称或 Addressable 对象），而 Transaction.from 方法需要同步可访问的值。

技术细节

1. 类型系统差异：

   • TransactionRequest 是一个接口，设计用于描述交易请求，支持异步解析的地址
   • TransactionLike 是一个更严格的类型，要求所有字段都能同步访问

2. 运行时与编译时：

   • 虽然在运行时可能工作正常，但 TypeScript 在编译时会强制类型检查
   • 这种设计是为了防止开发者意外使用异步值导致运行时错误

解决方案

1. 使用 populateTransaction 方法：

   async signTransaction(txRequest: ethers.TransactionRequest): Promise<string> {
       let txLike = await this.populateTransaction(txRequest);
       let tx = ethers.Transaction.from(txLike);
       // 后续处理...
   }
   

2. 手动移除 from 字段：

   const tx = ethers.Transaction.from(Object.assign({}, txInfo, { from: undefined }));
   

3. 类型断言： 如果确定所有字段都是同步可访问的，可以使用类型断言：

   let tx = ethers.Transaction.from(txRequest as ethers.TransactionLike<string>);
   

最佳实践

1. 避免直接转换：不要直接使用类型断言忽略错误，这可能导致运行时问题
2. 使用 populateTransaction：这是最安全的方式，能确保所有异步值都被正确解析
3. 处理 from 字段：在创建 Transaction 对象前，确保移除了 from 字段或已正确解析

版本更新

在 ethers.js v6.12.0 及更高版本中，错误消息已经改进，现在会明确标识出问题的属性名，使调试更加容易。例如，错误消息会显示为 "from" 而不是简单的 from，避免了歧义。

总结

理解 ethers.js 中交易类型系统的设计理念对于正确使用库功能至关重要。TransactionRequest 和 TransactionLike 的区别反映了同步和异步操作的不同需求。开发者应该根据实际场景选择合适的处理方式，确保代码既类型安全又能在运行时正常工作。