Ethers.js 项目中 KZG 库兼容性问题解析与解决方案

背景介绍

在区块链生态系统中，Ethers.js 是一个广泛使用的 JavaScript 库，用于与区块链网络进行交互。随着 EIP-4844（Proto-Danksharding）的引入，KZG（Kate-Zaverucha-Goldberg）承诺方案成为处理 blob 交易的重要组成部分。近期，kzg-wasm 库从 0.4.x 升级到 0.5.0 版本时，由于 API 命名变更导致与 Ethers.js 的兼容性问题，这直接影响到了开发者处理 EIP-4844 交易的能力。

问题本质

kzg-wasm 0.5.0 版本对其 API 进行了重大变更，主要是将方法名从驼峰式命名改为全大写命名风格。例如：

• blobToKzgCommitmentWasm 改为 blobToKZGCommitmentWasm
• computeBlobKzgProof 改为 computeBlobKZGProof

这种变更导致 TypeScript 类型检查失败，因为 Ethers.js 的 Transaction 对象期望的 KzgLibrary 接口与新版 kzg-wasm 提供的接口不匹配。具体表现为当开发者尝试将 kzg 实例赋值给交易对象时，会出现类型不匹配的错误。

技术影响

这个问题的影响范围包括：

1. 所有使用 Ethers.js 处理 EIP-4844 blob 交易的开发者
2. 任何依赖 kzg-wasm 0.5.0 及以上版本的项目
3. 使用 TypeScript 进行开发的环境会立即出现编译错误

解决方案

Ethers.js 团队采取了向后兼容的解决方案，主要包括：

1. 接口适配层：在内部实现了 API 规范化层，将不同版本的 kzg-wasm 和纯 JavaScript 实现的 KZG 库统一转换为兼容的接口格式。

2. 多版本支持：现在 Transaction 对象可以接受以下三种形式的 KZG 库：

   • kzg-wasm 0.4.x 版本
   • kzg-wasm 0.5.x 版本
   • micro-eth-signer 提供的纯 JavaScript 实现

3. 使用示例：

// 使用 kzg-wasm (0.4 或 0.5 版本)
import { loadKZG } from "kzg-wasm";
tx.kzg = loadKSG();

// 使用 micro-ecc-signer 的纯 JS 实现
import { KZG } from 'micro-eth-signer/kzg';
import { trustedSetup } from '@paulmillr/trusted-setups/fast.js';
tx.kzg = new KZG(trustedSetup);

性能考虑

值得注意的是，纯 JavaScript 实现的 KZG 库（由 micro-eth-signer 提供）在某些情况下可能比 WASM 版本性能更好。开发者可以根据实际需求选择适合的实现方式：

• WASM 版本：可能更适合需要与现有 C++/Rust 代码库保持一致性的场景
• 纯 JS 版本：部署更简单，不需要处理 WASM 加载问题，且在某些情况下性能更优

最佳实践建议

1. 版本控制：明确指定依赖的 kzg-wasm 版本，避免意外升级导致兼容性问题。

2. 环境测试：在生产环境部署前，充分测试不同环境下的 KZG 库性能表现。

3. 错误处理：实现适当的错误处理机制，特别是对于 WASM 模块加载等可能失败的操作。

4. 文档参考：详细阅读 Ethers.js 最新文档中关于 KZG 集成的部分，了解最新的 API 变化和使用方式。

总结

Ethers.js 通过引入灵活的接口适配层，解决了 kzg-wasm 0.5.0 版本 API 变更带来的兼容性问题，同时保持了向后兼容性。这一改进不仅解决了眼前的问题，还为未来集成更多 KZG 实现提供了良好的扩展性。开发者现在可以根据项目需求，自由选择 WASM 或纯 JavaScript 实现的 KZG 库，享受更加灵活的开发体验。