Akash API 类型脚本绑定
弃: 此套件不再被维护,也不支持Akash Network v1. 请迁移到 链条sdk,它提供了更方便开发者的API,并配备了完整的IDE自动完成和TypeScript支持.
这个包提供了由原生取出定义的Akash API的TypeScript绑定.
安装
要安装软件包, 请运行 :
npm install @akashnetwork/akash-api
使用量
您可以从软件包中导入生成的命名空间 :
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 文件中,添加以下内容:
{
"extends": "@akashnetwork/akash-api/tsconfig.paths.json"
}
捐款
欢迎捐款。 请提交拉动请求或创建一个问题来讨论您想要做出的修改 .
向生成的文件贡献
数据中的文件 src/generated 目录是自动生成的,不应直接修改。 如果您需要修改这些文件, 请遵循以下步骤 :
-
在其中创建新文件
src/patch目录的路径与要修改的文件相同。 例如,如果想要修改src/generated/cosmos/base/v1beta1/coin.ts,您应当创建目录src/patch/cosmos/base/v1beta1/coin.ts。 。 。 . -
将您的更改添加到新文件中
src/patch目录。 新文件应该与要修改的文件同名. -
重命名原文件
src/generated附加目录.original.ts以它的名义 譬如说,src/generated/cosmos/base/v1beta1/coin.ts应更名为src/generated/cosmos/base/v1beta1/coin.original.ts。 。 。 . -
在其中创建新文件
src/generated与原始文件同名的目录。 此新文件应该重新导出全部文件src/patch目录。 例如:src/generated/cosmos/base/v1beta1/coin.ts应:
export * from '../../../../patch/cosmos/base/v1beta1/coin';
注:命名和路径对于防止原始文件在代码再生成时被覆盖很重要. 见 script/preserve-ts-patches.sh 财务报告和审定财务报表 script/restore-ts-patches.sh 详细情况.
许可证
这个包在Apache-2.0下获得许可.