# @boostxyz/sdk 中文文档

规范地址：https://npmcn.com/package/%40boostxyz/sdk/

版本：8\.2\.1
npm 元数据更新时间：2026-10-22T23:01:40.126Z
中文译文更新时间：2026-11-08T11:26:00.424Z
软件包许可：GPL-3\.0-or-later

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

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

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

- 包体积（解压后）：9.4 MB，365 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：viem 2\.x，abitype 1，@wagmi/core 2\.x
- 首次发布：2024-09-10T23:52:00.543Z
- 最新版本发布：2026-10-22T23:01:39.877Z
- 近 30 天下载量：2943（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：89（近 12 个月 9 个）

## 中文简介

用于与 Boost V2 协议互动的打字符

## 安装

```sh
npm install @boostxyz/sdk
```

也可以使用：`pnpm add @boostxyz/sdk`、`yarn add @boostxyz/sdk`、`bun add @boostxyz/sdk`

## README

# 启动 SDK

用于与 Boost V2 协议互动的打字符

[![Documentation](https://img.shields.io/badge/documentation-typedoc-blue)](https://npmcn.com/package/%40boostxyz/sdk/boost-protocol.vercel.app)

## 访问 [https://docs.boost.xyz/v2/boost-sdk/overview 页面存档备份,存于互联网档案馆](https://docs.boost.xyz/) 对于文件,向导,API等等!

## 事件动作

### Tuple 处理

当一个字段在 `PrimitiveType` 一、导 言 `EventAction`我们拆开它的被打包的地盘 Index 钻出每个嵌入的地平面 每个分索引占用了6个比特(值为0-63),一个63分索引被作为终结者处理——表示进一步钻探的结束. 一旦我们把叶子定位在巢状结构中,代码通过在该叶节点读取ABI定义(地址,int256,字符串等),推断出最终(非图)的PrimitiveType.

1.  我们可以在一个字段Index中存储最多5个子索引(每个6位).
2.  当我们分析一个TUPLE时,我们逐个读取了这些子索引, 翻转了ABI中每个嵌入的Tuple参数.
3.  在最终的、非整体的成分中,我们通过检查ABI定义中该成分的类型来得出实际的先入道(例如ADRESS、UINT、BYTES或STRING).

## 常见问题

### @boostxyz/sdk 是什么？

用于与 Boost V2 协议互动的打字符

### 如何安装 @boostxyz/sdk？

在项目目录运行 npm install @boostxyz/sdk，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：viem（2\.x）、abitype（1）、@wagmi/core（2\.x）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @boostxyz/sdk 支持 TypeScript 吗？

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

### @boostxyz/sdk 支持 ESM 还是 CommonJS？

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

### @boostxyz/sdk 可以商用吗？

@boostxyz/sdk 使用 GPL-3\.0-or-later 许可。强 Copyleft：分发包含该代码的软件时，整个作品需以 GPL-3\.0 兼容许可开源，并附带专利与反锁定条款。仅内部使用不触发此义务。以上为概括，不构成法律意见，请以许可原文为准。

### @boostxyz/sdk 的下载量有多少？

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

### @boostxyz/sdk 还在维护吗？

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