Wagmi库中交易回执等待函数的一个边界情况处理

问题背景

在使用Wagmi库的waitForTransactionReceipt函数时，当交易被回滚(revert)时，函数会抛出code.substring is not a function的错误。这个错误发生在尝试解析交易回滚原因的过程中。

问题分析

在交易被回滚的情况下，Wagmi库会尝试从错误信息中提取回滚原因。原始代码假设错误代码(code)是一个可以直接调用substring方法的字符串。然而在实际场景中，code可能是一个包含data属性的对象，如{ data: undefined }。

技术细节

错误发生在以下处理逻辑中：

const reason = hexToString(`0x${code.data.substring(138)}`)

当code是一个对象而非字符串时，直接调用substring方法会导致运行时错误。正确的做法应该是先检查code.data是否存在，并且是一个字符串。

解决方案

改进后的代码应该包含防御性检查：

const reason = code?.data ? hexToString(`0x${code.data.substring(138)}`) : "unknown reason"

这种修改确保了：

1. 只有当code.data存在时才尝试解析
2. 提供了默认的"unknown reason"作为回退值
3. 避免了在非字符串类型上调用字符串方法

影响范围

这个问题会影响所有使用waitForTransactionReceipt函数并遇到交易回滚的场景。开发者可能无法正确获取交易回滚的原因，而是得到一个意外的运行时错误。

最佳实践

在处理区块链交易时，建议开发者：

1. 总是为交易失败的情况做好准备
2. 使用try-catch块包裹交易相关操作
3. 不要假设错误对象的结构，应该进行类型检查
4. 为用户提供友好的错误信息，而不是原始错误

总结

Wagmi库的这个边界情况处理提醒我们，在区块链开发中，错误处理需要格外谨慎。交易可能因为各种原因失败，而良好的错误处理机制可以显著改善开发者和最终用户的体验。这个问题的修复虽然简单，但对于库的健壮性有着重要意义。