如何在ethers.js中覆写Provider的行为

前言

在使用ethers.js与区块链网络交互时，有时我们需要记录或修改Provider的默认行为。本文将介绍几种在ethers.js中覆写Provider行为的方法，特别是如何记录交易广播的日志。

为什么需要覆写Provider

在开发区块链应用时，我们可能需要：

1. 记录所有广播的交易以便后续审计
2. 修改某些方法的默认行为
3. 添加额外的日志记录
4. 实现特定的错误处理逻辑

方法一：使用Proxy代理

Proxy是JavaScript提供的一种元编程特性，可以拦截和自定义对象的基本操作。我们可以使用Proxy来拦截Provider的方法调用：

const ProviderRecorder = (provider, path = '/dev/stdout') => new Proxy(provider, {
  get(target, prop, receiver) {
    const value = target[prop];
    if (value instanceof Function) {
      return function (...args) {
        // 记录交易广播
        if (prop === 'broadcastTransaction') {
          const { hash, from, nonce, serialized } = ethers.Transaction.from(args[0]);
          fs.writeFileSync(
            path,
            JSON.stringify({ hash, from, nonce, serialized }) + '\n',
            { flag: 'a' }
          );
        }
        return value.apply(this === receiver ? target : this, args);
      };
    }
    return value;
  }
});

注意事项：

• 需要使用value.apply(this === receiver ? target : this, args)来确保私有成员访问正确
• Proxy可以拦截所有方法调用，灵活性高

方法二：继承并覆写方法

如果你使用的是特定的Provider类（如JsonRpcProvider），可以通过继承来覆写方法：

class RecorderProvider extends JsonRpcProvider {
  async broadcastTransaction(signedTx) {
    const { hash, from, nonce, serialized } = ethers.Transaction.from(signedTx);
    fs.writeFileSync(
      this.path,
      JSON.stringify({ hash, from, nonce, serialized }) + '\n',
      { flag: 'a' }
    );
    return super.broadcastTransaction(signedTx);
  }
}

或者更通用的perform方法：

class RecorderProvider extends JsonRpcProvider {
  async perform(method, params) {
    const result = await super.perform(method, params);
    if (method === "broadcastTransaction") {
      console.log({ method, params, result });
    }
    return result;
  }
}

优点：

• 代码结构清晰
• 可以访问父类的所有方法和属性
• 类型安全(TypeScript友好)

方法三：使用事件监听

ethers.js的Provider会发出各种事件，我们可以监听这些事件来记录信息：

provider.on("debug", (info) => {
  if (info.action === "sendRequest" && info.request.method === "eth_sendRawTransaction") {
    console.log("Broadcasting transaction:", info.request.params[0]);
  }
});

适用场景：

• 只需要记录信息，不需要修改行为
• 不想修改Provider实例

方法四：装饰器模式

创建一个包装类，将所有方法委托给原始Provider，只修改需要的方法：

class ProviderRecorder {
  constructor(provider, path = '/dev/stdout') {
    this.provider = provider;
    this.path = path;
  }

  // 只覆写需要的方法
  async broadcastTransaction(signedTx) {
    const { hash, from, nonce, serialized } = ethers.Transaction.from(signedTx);
    fs.writeFileSync(
      this.path,
      JSON.stringify({ hash, from, nonce, serialized }) + '\n',
      { flag: 'a' }
    );
    return this.provider.broadcastTransaction(signedTx);
  }

  // 其他方法直接委托
  getBlockNumber() {
    return this.provider.getBlockNumber();
  }
  // ...其他方法
}

优点：

• 明确控制哪些方法被覆写
• 不需要处理私有成员访问问题
• 适用于所有类型的Provider

最佳实践建议

1. 明确需求：根据具体需求选择合适的方法

   • 只需要记录日志 → 事件监听
   • 需要修改行为 → Proxy或继承
   • 需要兼容多种Provider → 装饰器模式

2. 错误处理：确保覆写的方法有适当的错误处理

3. 性能考虑：Proxy会有轻微性能开销，在性能敏感场景考虑其他方法

4. 类型安全：如果使用TypeScript，继承和装饰器模式能提供更好的类型支持

总结

ethers.js提供了多种方式来扩展和修改Provider的行为。选择哪种方法取决于你的具体需求和技术栈。Proxy提供了最大的灵活性，继承提供了最好的类型安全，而装饰器模式则提供了最好的兼容性。理解这些方法的优缺点将帮助你做出最适合的选择。