# @akashnetwork/akash-api 中文文档

规范地址：https://npmcn.com/package/%40akashnetwork/akash-api/

版本：1\.4\.3
npm 元数据更新时间：2026-04-15T11:09:47.617Z
中文译文更新时间：2026-11-06T02:29:49.476Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：3.3 MB，519 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：@grpc/grpc-js ^1\.10\.6
- 首次发布：2024-04-12T14:02:45.762Z
- 最新版本发布：2026-04-15T11:09:21.080Z
- 近 30 天下载量：6362（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：13（近 12 个月 2 个）

## 中文简介

Akash API 类型脚本客户端

## 安装

```sh
npm install @akashnetwork/akash-api
```

也可以使用：`pnpm add @akashnetwork/akash-api`、`yarn add @akashnetwork/akash-api`、`bun add @akashnetwork/akash-api`

## README

# Akash API 类型脚本绑定

[![npm version](https://badge.fury.io/js/%40akashnetwork%2Fakash-api.svg)](https://badge.fury.io/js/%40akashnetwork%2Fakash-api) [![License: Apache-2.0](https://img.shields.io/badge/License-apache2.0-yellow.svg)](https://opensource.org/license/apache-2-0) [![semantic-release: conventionalcommits](https://img.shields.io/badge/semantic--release-conventionalcommits?logo=semantic-release)](https://github.com/semantic-release/semantic-release)

**弃:** 此套件不再被维护,也不支持Akash Network v1. 请迁移到 [链条sdk](https://github.com/akash-network/chain-sdk/tree/main/ts),它提供了更方便开发者的API,并配备了完整的IDE自动完成和TypeScript支持.

这个包提供了由原生取出定义的Akash API的TypeScript绑定.

## 安装

要安装软件包, 请运行 :

```bash
npm install @akashnetwork/akash-api
```

## 使用量

您可以从软件包中导入生成的命名空间 :

```typescript
import * as akashDeploymentV1beta1 from '@akashnetwork/akash-api/akash/deployment/v1beta1';
import * as akashDiscoveryV1 from '@akashnetwork/akash-api/akash/discovery/v1';
// ... and so on for other namespaces
```

### 类型脚本4.5及以上

如果您正在使用 TypeScript 4.5 或以上, 包会输出生成的命名空间的所有路径, 这样您就可以直接导入它们 .

### 4.5以下的脚本

如果使用4.5下方的TypeScript版本,则包提供tsconfig. 路径.json文件,您可以在本地类型脚本配置中扩展以解析路径。 这是你怎么做到的: 在您的 tsconfig.json 文件中,添加以下内容:

```json
{
  "extends": "@akashnetwork/akash-api/tsconfig.paths.json"
}
```

### 捐款

欢迎捐款。 请提交拉动请求或创建一个问题来讨论您想要做出的修改 .

### 向生成的文件贡献

数据中的文件 `src/generated` 目录是自动生成的,不应直接修改。 如果您需要修改这些文件, 请遵循以下步骤 :

1.  在其中创建新文件 `src/patch` 目录的路径与要修改的文件相同。 例如,如果想要修改 `src/generated/cosmos/base/v1beta1/coin.ts`,您应当创建目录 `src/patch/cosmos/base/v1beta1/coin.ts`。 。 。 .
    
2.  将您的更改添加到新文件中 `src/patch` 目录。 新文件应该与要修改的文件同名.
    
3.  重命名原文件 `src/generated` 附加目录 `.original.ts` 以它的名义 譬如说, `src/generated/cosmos/base/v1beta1/coin.ts` 应更名为 `src/generated/cosmos/base/v1beta1/coin.original.ts`。 。 。 .
    
4.  在其中创建新文件 `src/generated` 与原始文件同名的目录。 此新文件应该重新导出全部文件 `src/patch` 目录。 例如: `src/generated/cosmos/base/v1beta1/coin.ts` 应:
    

```typescript
export * from '../../../../patch/cosmos/base/v1beta1/coin';
```

注:命名和路径对于防止原始文件在代码再生成时被覆盖很重要. 见 `script/preserve-ts-patches.sh` 财务报告和审定财务报表 `script/restore-ts-patches.sh` 详细情况.

### 许可证

这个包在Apache-2.0下获得许可.

## 常见问题

### @akashnetwork/akash-api 是什么？

Akash API 类型脚本客户端

### 如何安装 @akashnetwork/akash-api？

在项目目录运行 npm install @akashnetwork/akash-api，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@grpc/grpc-js（^1\.10\.6）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @akashnetwork/akash-api 支持 TypeScript 吗？

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

### @akashnetwork/akash-api 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @akashnetwork/akash-api 可以商用吗？

@akashnetwork/akash-api 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @akashnetwork/akash-api 的下载量有多少？

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

### @akashnetwork/akash-api 还在维护吗？

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