# @apibara/protocol 中文文档

规范地址：https://npmcn.com/package/%40apibara/protocol/

版本：2\.1\.3
npm 元数据更新时间：2026-05-11T19:20:05.730Z
中文译文更新时间：2026-11-06T10:13:54.559Z
软件包许可：未声明

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40apibara/protocol
原文对照：https://npmcn.com/package/%40apibara/protocol/?lang=original
项目主页：https://github.com/apibara/typescript-sdk#readme
源码仓库：https://github.com/apibara/typescript-sdk

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：892 kB，66 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：7 个
- 首次发布：2022-11-07T20:38:01.728Z
- 最新版本发布：2026-05-11T19:20:05.379Z
- 近 30 天下载量：3772（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：123（近 12 个月 24 个）

## 中文简介

此软件包提供了一个 gRPC 客户端可以与 an [Apibara 流媒体服务器](https://www.apibara.com/docs/streaming-protocol)。 。 。 .

## 安装

```sh
npm install @apibara/protocol
```

也可以使用：`pnpm add @apibara/protocol`、`yarn add @apibara/protocol`、`bun add @apibara/protocol`

## README

# `@apibara/protocol`

此软件包提供了一个 gRPC 客户端可以与 an [Apibara 流媒体服务器](https://www.apibara.com/docs/streaming-protocol)。 。 。 .

## 安装

```bash
npm add @apibara/protocol
```

## 使用量

包输出 a `NodeClient` 用于与服务器交互. 客户有两种方法:

-   `status`:返回节点的索引状态.
-   `streamMessages`: 返回节点.js `Stream` 与服务器的消息.

```ts
import { NodeClient, credentials } from '@apibara/protocol'

async function main() {
  // create client connected to the StarkNet Goerli stream
  // the server uses ssl
  const node = new NodeClient(
    'goerli.starknet.stream.apibara.com:443',
    credentials.createSsl()
  )

  // check server status
  const status = await node.status()

  // stream all messages from the server
  // returns a promise resolved when it finishes
  // streaming from the server
  const messages = node.streamMessages()
  return new Promise((resolve, reject) => {
    messages.on('end', resolve)
    messages.on('error', reject)
    messages.on('data', (data) => {
      console.log(data)
    })
  })
}
```

## 许可证

版权 2022 GNC Labs Limited

根据Apache许可证第2.0版("License"); 您不得使用此文件,除非符合许可证. 您可在下列地点获得许可证副本:

```
http://www.apache.org/licenses/LICENSE-2.0
```

除非适用的法律要求或书面同意,否则软件 根据许可证发放的是在“AS IS”BASIS上发放的, 没有任何明示或暗示的警告或条件. 有关许可的特定语言的许可证 许可证的限制.

## 常见问题

### @apibara/protocol 是什么？

此软件包提供了一个 gRPC 客户端可以与 an Apibara 流媒体服务器。 。 。 \.

### 如何安装 @apibara/protocol？

在项目目录运行 npm install @apibara/protocol，或使用 pnpm add / yarn add / bun add。

### @apibara/protocol 支持 TypeScript 吗？

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

### @apibara/protocol 支持 ESM 还是 CommonJS？

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

### @apibara/protocol 可以商用吗？

@apibara/protocol 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @apibara/protocol 的下载量有多少？

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

### @apibara/protocol 还在维护吗？

最新版本 2\.1\.3 发布于 2026/05/12（5 个月前）；至今共发布 123 个版本，其中过去 12 个月发布了 24 个；首次发布于 2022/11/08。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。