@avaprotocol/types

中文文档
5.2.4发布于 2026/11/07Apache-2.0TypeScriptESM + CJS构建来源已验证近 30 天下载 1729

Ava 协议的 AVS REST API (v4) 类型定义——由 api/openapi.yaml 生成.

中文使用文档
文档目录5 节
  1. 安装
  2. 开始
  3. 捐款
  4. 许可证
  5. 工作流程写结果(REST v4)

Ava SDK 用于 JavaScript/ TypeScript

@avaprotocol/types 是该程序的脚本类型 @avaprotocol/sdk-js 库并用于网络应用程序客户端,以解释数据.

安装

要安装 @avaprotocol/types,运行以下命令:

npm install @avaprotocol/types

或与雅尔曰:

yarn add @avaprotocol/types

开始

以下是如何使用类型库启动Ava协议的简单例子:

import { ExecutionErrorCode, type ExecutionStep } from "@avaprotocol/types";

function needsConfirmationCheck(step: ExecutionStep): boolean {
  return step.errorCode === ExecutionErrorCode.USER_OP_CONFIRMATION_UNRESOLVED;
}

捐款

我们欢迎捐款! 随意提交拉出请求或打开任何错误或特性请求的问题.

许可证

这个项目根据Apache 2.0许可证获得许可. 详见LICENSE文件.

工作流程写结果(REST v4)

ExecutionStep.errorCode 是一个打开的字符串. ExecutionErrorCode 出口这些 已知值;括号中的数字是网关的原生值, 不返回 REST 上的字符串 :

  • USER_OP_CONFIRMATION_UNRESOLVED (4006):提交,结果不详。 检查 存储 userOpHash ; 失败的工作流程不能证明没有转移任何资金.
  • USER_OP_EXECUTION_REVERTED (4007):确认用户操作或外出交易回放.
  • WRITE_PREREQUISITE_FAILED (4008年):这个依赖的书写从未提交.

元数据有四个形状,按节点类型和结果选择:

步骤metadata 形状相关领域
本地转移平面对象userOpHash, (中文(简体) ), transactionHash, (中文(简体) ), receiptStatus (单位:千美元)pending, (中文(简体) ), confirmed, (中文(简体) ), failed),可选 revertData
合同书写{ results: [...] }每种方法保留 methodName, (中文(简体) ), success, (中文(简体) ), error,以及 receipt 与操作/交易散列, status, (中文(简体) ), executionStatus选项 revertData
写入循环{ confirmationOutcomes: [...] } 当重复出现确认失败时每个结果都有 id, (中文(简体) ), error, (中文(简体) ), errorCode,及其原样 metadata;合同迭代元数据为内部结果阵列,本土元数据为平分. 其他循环元数据可能共存.
跳过写入{ skipped: true, prerequisiteNodeId, prerequisiteError }这一步骤没有提交任何交易或气体;最初的先决条件是保留其收据.

对于合同写道, receipt.status 描述 ethereum 外部交易。 。 。 . 内部用户操作可以在外部收到时返回 status: "0x1"。 。 。 . 使用步骤 success, (中文(简体) ), errorCode和收据 executionStatus 以确定是否 这一行动取得了成功。 在未解决的结果之后,仍可使用散列车. 天然气总量(gasUsed, (中文(简体) ), gasPrice, (中文(简体) ), totalGasCost)是顶级执行步骤 字段; 合同收件元数据不会平分这些字段. 报告和独立分支在被跳过之后继续.

版本与发布记录

@avaprotocol/types 共发布 108 个版本,首次发布于 2025/01/05;过去 12 个月发布了 31 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
5.2.4latest2026/11/073 天前
5.2.32026/11/063 天前
5.2.22026/11/054 天前
5.2.12026/11/045 天前
5.2.02026/11/045 天前
5.1.02026/10/2713 天前

其他发布通道:dev → 4.0.0-dev.0。

关于 @avaprotocol/types 的常见问题

@avaprotocol/types 是什么?

Ava 协议的 AVS REST API (v4) 类型定义——由 api/openapi.yaml 生成.

如何安装 @avaprotocol/types?

在项目目录运行 npm install @avaprotocol/types,或使用 pnpm add / yarn add / bun add。

@avaprotocol/types 支持 TypeScript 吗?

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

@avaprotocol/types 支持 ESM 还是 CommonJS?

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

@avaprotocol/types 需要什么版本的 Node.js?

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

@avaprotocol/types 可以商用吗?

@avaprotocol/types 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@avaprotocol/types 的下载量有多少?

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

@avaprotocol/types 还在维护吗?

最新版本 5.2.4 发布于 2026/11/07(3 天前);至今共发布 108 个版本,其中过去 12 个月发布了 31 个;首次发布于 2025/01/05。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。