# @ariestools/chain-serve-local-s3 中文文档

规范地址：https://npmcn.com/package/%40ariestools/chain-serve-local-s3/

版本：0\.3\.0
npm 元数据更新时间：2026-10-30T18:12:55.877Z
中文译文更新时间：2026-11-06T21:12:36.786Z
软件包许可：LGPL-3\.0-only

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

原始 npm 页面：https://www.npmjs.com/package/%40ariestools/chain-serve-local-s3
原文对照：https://npmcn.com/package/%40ariestools/chain-serve-local-s3/?lang=original
项目主页：https://ariestools.ai/

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

- 包体积（解压后）：65.1 kB，24 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=26
- 运行依赖：4 个
- 首次发布：2026-07-22T19:58:19.376Z
- 最新版本发布：2026-10-30T18:12:55.700Z
- 近 30 天下载量：2331（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：11（近 12 个月 11 个）

## 中文简介

单调本地 XL1 测试用具:已发布-链 S3 版式 (s3rver) + xl1-cli(api/出品人/定品人/mempool/indexer)

## 安装

```sh
npm install @ariestools/chain-serve-local-s3
```

也可以使用：`pnpm add @ariestools/chain-serve-local-s3`、`yarn add @ariestools/chain-serve-local-s3`、`bun add @ariestools/chain-serve-local-s3`

## README

# @ riestools/ chain- serve- local- s3

> **仅限Dev/测试.** Boots 本地 XL1 融合环境 e2e测试。 不为出产.

一个函数调用开始 :

1.  **`@ariestools/aries-chain-serve`** ——S3兼容的出版链布局 (单位:千美元)`/blocks`, (中文(简体) ), `/state`, (中文(简体) ), `/indexes`(通过 s3rver
2.  **`@xyo-network/xl1-cli`** —— 说 `api` + 键 `producer` + 键 `finalizer` + 键 `mempool` + 键 `indexer`,将最后确定的块和索引发布到该布局中

## 安装

```sh
pnpm add -D @ariestools/chain-serve-local-s3
```

停车 `@ariestools/aries-chain-serve`, (中文(简体) ), `@xyo-network/xl1-cli`,以及 `@xyo-network/xl1-sdk` 作为运行时间的依赖.

## 单调使用

```ts
import { startLocalS3Chain } from '@ariestools/chain-serve-local-s3'

const chain = await startLocalS3Chain()

// chain.rpcUrl              http://127.0.0.1:<port>/rpc
// chain.apiPort
// chain.chainId
// chain.blockProducerWallet // path 0 of the insecure test mnemonic
// chain.s3Endpoint          s3rver origin
// chain.s3ReadUrls          { finalized, chainState, index }

await chain.stop()
```

## Vitest setupFile (lishash- system Globals) (英语)

```ts
// test/setup/api-local-s3.ts
import { afterAll, beforeAll } from 'vitest'
import { registerLocalS3Chain } from '@ariestools/chain-serve-local-s3'

registerLocalS3Chain(
  { beforeAll, afterAll },
  { assignGlobals: true },
)
```

与 `assignGlobals: true`,字符可读取:

| 全球 | 说明 |
| --- | --- |
| `apiPort` | XL1 API 端口 |
| `rpcUrl` | `http://127.0.0.1:<port>/rpc` |
| `chainId` | 本地链 ID |
| `blockProducerWallet` | 创世纪/ 生产者路径-0 账户 |
| `s3ReadUrls` | `{ finalized, chainState, index }` 读取基准 URL |
| `s3Endpoint` | s3rver 基础 URL |

## 选项

| 选项 | 默认 |
| --- | --- |
| `apiPort` | `8080 + VITEST_WORKER_ID` (或自由倒计时) |
| `chainId` | 本地化固定标识 |
| `mnemonic` | 不安全 `test test … junk` 语句 |
| `healthTimeoutMs` | `120_000` |
| `assignGlobals` | `false` |
| `silent` | `true` (s3rver) (韩语) |
| `logXl1` | `true` (儿童日志) |

## 页:1

-   当地API服务 `/rpc` 仅( 没有 REST datalake) 。 作家通常运行在 内线模式;读取侧面的体分辨率可达测试.
-   S3 证书被布局接受 : `S3RVER` 编号 : `S3RVER` (以 `S3_CREDENTIALS`) (中文(简体) ).
-   平行工人通过 `VITEST_WORKER_ID`; Prometheus 和健康检查端口在 儿童配置以避免冲突.
-   如果 xl1 在其 API 答案之前退出, 抛出的错误会带有尾端 它的结晶,即使 `logXl1: false`。 。 。 .

## 常见问题

### @ariestools/chain-serve-local-s3 是什么？

单调本地 XL1 测试用具:已发布-链 S3 版式 \(s3rver\) \+ xl1-cli\(api/出品人/定品人/mempool/indexer\)

### 如何安装 @ariestools/chain-serve-local-s3？

在项目目录运行 npm install @ariestools/chain-serve-local-s3，或使用 pnpm add / yarn add / bun add。

### @ariestools/chain-serve-local-s3 支持 TypeScript 吗？

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

### @ariestools/chain-serve-local-s3 支持 ESM 还是 CommonJS？

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

### @ariestools/chain-serve-local-s3 需要什么版本的 Node\.js？

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

### @ariestools/chain-serve-local-s3 可以商用吗？

@ariestools/chain-serve-local-s3 使用 LGPL-3\.0-only 许可。弱 Copyleft：作为库被调用时通常不要求开源你自己的代码，但修改库本身需以 LGPL 开源；前端打包合并后的适用边界存在不同理解。以上为概括，不构成法律意见，请以许可原文为准。

### @ariestools/chain-serve-local-s3 的下载量有多少？

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

### @ariestools/chain-serve-local-s3 还在维护吗？

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