# @knirv/sdk 中文文档

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

版本：0\.2\.0
npm 元数据更新时间：2026-11-01T14:11:25.127Z
中文译文更新时间：2026-11-01T15:58:43.770Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：3.2 MB，44 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=18
- 运行依赖：0 个
- 首次发布：2026-08-21T20:57:59.976Z
- 最新版本发布：2026-11-01T14:11:24.970Z
- 已发布版本数：5（近 12 个月 5 个）

## 中文简介

浏览器和边缘WebAssembly SDK核心的KNIRV网络

## 安装

```sh
npm install @knirv/sdk
```

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

## README

# @knirv / sdk

浏览器和边缘分发的便携式KNIRV Rust核心。包 交付生成的wasm- binding glue、声明和 `*.wasm` 二进制文件。

```js
import { SdkClient } from "@knirv/sdk";
const sdk = await SdkClient.init(); // uses the bundled inline fallback
const response = await sdk.sha256("knirv");
console.log(response.payload.digest);
```

对于CDN、打包器资产或Cloudflare Worker模块绑定，避免使用inline 明确地复制并提供资产：

```js
import { SdkClient } from "@knirv/sdk/slim";
const sdk = await SdkClient.init(new URL("./knirv_sdk_core_bg.wasm", import.meta.url));
```

运行 `npm run build`,然后 `npm run pack:check` 之前出版。后者 必须列表 `wasm/knirv_sdk_core_bg.wasm`.

网络操作(`transaction.chain`， `gateway.health`， `transmission.*`， `wallet.account`)运行在Rust核心，它拥有请求构造， 重试、故障转移和错误映射。主机只移动字节：pass `SdkClient.init(source, { http, config })` 供应你自己的 `{ http_request(json): Promise<string>, sleep(ms): Promise<void> }` (默认值: 全球 `fetch`)和默认的客户端设置。 `SdkClient.create` 和 `BindingTransport` 都被移开了，只留下一条缝。

## 初始化核心

签名、URI、中继、模型和框架函数都在Rust核心中运行 必须实例化一次的WebAssembly模块。

-   **浏览器主线程：** `await initLocal()` 一旦启动（浏览器拒绝） 同步编译这个大小的模块)。KNIRVARENA和控制器来做 前呈现;钱包模块在签名之前执行此操作。
-   **节点，web工作者，大多数边缘运行时：** 无事可做；第一个调用编译 捆绑模块。调用 `await initLocal()` 反正是无害的，幂等的 （KNIRV.COM的注册路线可以）。
-   **Cloudflare工人:** `await initLocal(wasmModule)` 使用预编译模块。
-   `SdkClient.init()` 和 `ModelsClient.advise()` 为你初始化它。

## 钱包协议

`@knirv/sdk/wallet` 携带KNIRV钱包扩展的消息协议： 请求类型，成功/失败/拒绝结果及其代码和 消息(`WalletMessageInfo`)， `WalletResponse`，和 `KnirvWalletProvider` 接口将扩展注入 `window.knirv`． 协议只写一次，在 `core/data/wallet_protocol.json`;构建过程生成TypeScript常量和 核心提供与组件相同的数据 `wallet.protocol` 操作。

## 签名和uri（从0.2.0开始由rust支持）

`@knirv/sdk/signing` 和 `@knirv/sdk/uri` 是Rust核心上的类型包装器， 哪一个是签名、地址、消息/中继/WASM的单一实现 信封, `knirv://` uri和权限记录。没有写密码 该包没有JS加密依赖项。函数名和 类型从0.1.x开始没有变化：

```js
import { signMessageEnvelope, verifyMessage } from "@knirv/sdk/signing";

const signed = await signMessageEnvelope(privateKey, envelope);
await verifyMessage(signed, envelope.domain, envelope.purpose, envelope.chainId, envelope.nonce, new Date());
```

### 打破了0.1的变化。X：初始化内核一次

核心是一个WebAssembly模块，因此必须在第一个模块之前实例化它 呼叫。这取决于平台：

| 平台 | 该怎么做 |
| --- | --- |
| 节点，web工作者，大多数边缘运行时 | 什么都没有。第一个调用同步编译绑定的模块。 |
| 浏览器主线程 | `await initLocal()` 刚开始的时候。浏览器拒绝在主线程上同步编译这种大小的模块。 |
| Cloudflare工人 | `import wasm from "@knirv/sdk/wasm/knirv_sdk_core_bg.wasm"; await initLocal(wasm);` 工人禁止从字节编译WASM，所以传递预编译模块。 |

`initLocal` 导出自 `@knirv/sdk/signing` 和 `@knirv/sdk/uri`,是 幂等的，与之共享 `SdkClient.init()`． 在核心之前的呼叫 可以实例化抛出吗 `LocalCoreNotInitializedError` 与这些 指令。

其他不同之处：失败是 `BindingOperationError`S携带核心 消息(他们还在 `Error`年代), `verifyMessage` 接受以下信封： `address` 字段为空（地址是从公钥派生的），并且 WASM二进制文件大约是0.7 MB，而不是28 KB。

## 核心WASM模块

这三个核心模块是单独发布的 `modules/*.wasm` 资产 digest-pinned `modules/manifest.json`;它们没有嵌套在SDK WASM中 运行时。初始化后，加载一个默认资产或提供一个CDN/Worker 资产明确:

```js
const { bytes, metadata } = await sdk.moduleBytes("crypto-core");
// or: await sdk.moduleBytes("crypto-core", myWorkerModuleBytes)
```

`moduleBytes` 复制字节并根据已发布的验证它们的SHA-256 在退货前先列单。 `wasmModuleURL` 和 `wasmModulesManifest` 是 也从 `@knirv/sdk/modules` 对于直接管理加载的主机。

## 常见问题

### @knirv/sdk 是什么？

浏览器和边缘WebAssembly SDK核心的KNIRV网络

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

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

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

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

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

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @knirv/sdk 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

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

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

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

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