@bitski/provider-engine

中文文档
0.8.0发布于 2022/08/29MITTypeScriptESM + CJS近 30 天下载 2616

Bitski的"提供商Engine"是Metamask原版提供商引擎库的再造版本. 这是Bitski Javascript SDKs(既是浏览器又是节点)的基础.

中文使用文档
文档目录6 节
  1. 安装
  2. 与原始软件包的差异
  3. 待执行
  4. 可编曲
  5. 写入您的子提供者
  6. 承认

Bitski 提供引擎

Bitski的"提供商Engine"是Metamask原版提供商引擎库的再造版本. 这是Bitski Javascript SDKs(既是浏览器又是节点)的基础.

安装

npm install @bitski/provider-engine

与原始软件包的差异

  • 用打字符写
  • 先为浏览器设计的ES6标准模块
  • 设计以适当导出子提供者接口来扩展
  • 基础类执行新的 Ethereum 提供标准
  • 与最新版本的web3.js相兼容
  • 清除重度依赖度以保持基包光度(主要是依赖于椭圆值的所有依赖度)
  • 许多小错误修正和改进

待执行

  • 作为单独软件包的 HookedWallet 子提供商
  • 将 VmSub 提供者作为单独的软件包
  • 将非跟踪器作为单独的软件包
  • 提高测试覆盖率

可编曲

构建为模块化的 - 通过一叠“ 子提供者” 工作, 类似普通的 Web3 提供者, 但只处理一组 rpc 方法 .

子提供者可以发出新的rpc请求,以便处理自己的请求;例如. eth_call 可能触发 eth_getAccountBalance, (中文(简体) ), eth_getCode还有其他. 供应商引擎还处理缓存的rpc请求结果.

import {
  default as ProviderEngine,
  BlockCacheSubprovider,
  FixtureSubprovider,
  FilterSubprovider,
  FetchSubprovider
} from '@bitski/provider-engine';

const engine = new ProviderEngine();
const web3 = new Web3(engine);

// static results
engine.addProvider(new FixtureSubprovider({
  web3_clientVersion: 'ProviderEngine/v0.0.0/javascript',
  net_listening: true,
  eth_hashrate: '0x00',
  eth_mining: false,
  eth_syncing: true,
}));

// cache layer
engine.addProvider(new BlockCacheSubprovider());

// filters
engine.addProvider(new FilterSubprovider());

// data source
engine.addProvider(new FetchSubprovider({
  rpcUrl: 'https://testrpc.metamask.io/',
}));

// log new blocks
engine.on('block', (block) => {
  console.log('================================')
  console.log('BLOCK CHANGED:', '#'+block.number.toString('hex'), '0x'+block.hash.toString('hex'))
  console.log('================================')
});

// network connectivity error
engine.on('error', (err) => {
  // report connectivity errors
  console.error(err.stack);
});

// start polling for blocks
engine.start();

写入您的子提供者

通过写出自己的子提供者实例来扩展此模块的功能是很容易的.

见 src/子提供者.ts 用于完整的接口.

import { Subprovider } from '@bitski/provider-engine';

export default class MySubprovider extends Subprovider {

  // Only requirement is to implement handleRequest
  public handleRequest(payload, next, end) {
    // The payload includes the original JSON RPC request
    if (payload.method === 'eth_helloWorld') {
      // Call end() to handle the request in this subprovider
      end('hello world!');
    } else {
      // Call next() to fall-through to the next request in the stack
      next();
    }
  }

}

承认

特别感谢Metamask的朋友们 构思并撰写了原始图书馆.

版本与发布记录

@bitski/provider-engine 共发布 29 个版本,首次发布于 2019/05/18;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.8.0latest2022/08/294 年前
0.7.0-beta.52022/06/304 年前
0.7.0-beta.42022/06/294 年前
0.7.0-beta.32022/06/284 年前
0.7.0-beta.22021/04/175 年前
0.7.0-beta.1beta2020/09/186 年前

关于 @bitski/provider-engine 的常见问题

@bitski/provider-engine 是什么?

Bitski的"提供商Engine"是Metamask原版提供商引擎库的再造版本. 这是Bitski Javascript SDKs(既是浏览器又是节点)的基础.

如何安装 @bitski/provider-engine?

在项目目录运行 npm install @bitski/provider-engine,或使用 pnpm add / yarn add / bun add。

@bitski/provider-engine 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@bitski/provider-engine 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@bitski/provider-engine 可以商用吗?

@bitski/provider-engine 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@bitski/provider-engine 的下载量有多少?

根据 npm 官方下载统计,@bitski/provider-engine 在 2026/10/08 – 2026/11/06 这 30 天内被下载 2,616 次,日均约 87 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@bitski/provider-engine 还在维护吗?

最新版本 0.8.0 发布于 2022/08/29(4 年前);至今共发布 29 个版本,其中过去 12 个月发布了 0 个;首次发布于 2019/05/18。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。