# @cowprotocol/sdk-app-data 中文文档

规范地址：https://npmcn.com/package/%40cowprotocol/sdk-app-data/

版本：6\.1\.1
npm 元数据更新时间：2026-11-04T11:31:38.355Z
中文译文更新时间：2026-11-10T21:08:32.977Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40cowprotocol/sdk-app-data
原文对照：https://npmcn.com/package/%40cowprotocol/sdk-app-data/?lang=original
源码仓库：https://github.com/cowprotocol/cow-sdk

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

- 包体积（解压后）：1.1 MB，63 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：4 个
- peer 依赖：ajv ^8\.x，multiformats ^9\.x
- 首次发布：2025-08-01T17:45:41.235Z
- 最新版本发布：2026-11-04T11:31:37.855Z
- 近 30 天下载量：102915（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：74（近 12 个月 54 个）

## 中文简介

CoW 协议 AppData 计划定义

## 安装

```sh
npm install @cowprotocol/sdk-app-data
```

也可以使用：`pnpm add @cowprotocol/sdk-app-data`、`yarn add @cowprotocol/sdk-app-data`、`bun add @cowprotocol/sdk-app-data`

## README

![](https://github.com/cowprotocol/cow-sdk/raw/main/docs/images/CoW.png)

# 牛 AppData SDK 软件

## 测试覆盖率

| 发言 | 分支 | 职能 | 行数 |
| --- | --- | --- | --- |
| ![Statements](https://img.shields.io/badge/statements-61.14%25-red.svg?style=flat) | ![Branches](https://img.shields.io/badge/branches-22%25-red.svg?style=flat) | ![Functions](https://img.shields.io/badge/functions-60.46%25-red.svg?style=flat) | ![Lines](https://img.shields.io/badge/lines-62.5%25-red.svg?style=flat) |

AppData 计划定义

这些计划被用于编码于 `appData` 字段用于牛协议命令.

详情请检查 [文档](https://docs.cow.fi/cow-protocol/reference/core/intents/app-data)。 。 。 .

## 安装

```bash
pnpm add @cowprotocol/sdk-app-data
```

## 使用量

```typescript
import { AppDataSdk } from '@cowprotocol/sdk-app-data'
import { EthersV6Adapter } from '@cowprotocol/sdk-ethers-v6-adapter'
import { JsonRpcProvider, Wallet } from 'ethers'

// Proper adapter initialization
const provider = new JsonRpcProvider('YOUR_RPC_URL')
const wallet = new Wallet('YOUR_PRIVATE_KEY', provider)
const adapter = new EthersV6Adapter({ provider, signer: wallet })

export const appDataSdk = new AppDataSdk(adapter)

const appCode = 'YOUR_APP_CODE'
const environment = 'prod'
const referrer = { address: `REFERRER_ADDRESS` }

const quote = { slippageBips: 1 } // Slippage percent, it's 0 to 100
const orderClass = { orderClass: 'market' } // "market" | "limit" | "liquidity"

const appDataDoc = await appDataSdk.generateAppDataDoc({
  appCode,
  environment,
  metadata: {
    referrer,
    quote,
    orderClass,
  },
})

// Get appData info
const { appDataContent, appDataHex, cid } = await appDataSdk.getAppDataInfo(appDataDoc)

// The app-data hex string (app-data part of the order struct)
console.log(appDataHex)

// Full appData content. It will be the exact string that if hashed using keccak-256 you would get the
// returned appDataHex (app-data hex part of the order struct).
console.log(appDataContent)

// IPFS's content identifier. Normally you don't need to use this.
// The app-data content can be uploaded to IPFS. If its uploaded, this CID will be the content identifier.
// This is a way to be able to connect the appDataHex (app-data hex part of the order struct) to its
// content using a decentralized system.
console.log(cid)
```

### 通过牛 SDK 使用

您也可以导入 `AppDataSdk` 直接从主 SDK :

```typescript
import { AppDataSdk } from '@cowprotocol/cow-sdk'
import { EthersV6Adapter } from '@cowprotocol/sdk-ethers-v6-adapter'
import { JsonRpcProvider, Wallet } from 'ethers'

// Proper adapter initialization
const provider = new JsonRpcProvider('YOUR_RPC_URL')
const wallet = new Wallet('YOUR_PRIVATE_KEY', provider)
const adapter = new EthersV6Adapter({ provider, signer: wallet })

export const appDataSdk = new AppDataSdk(adapter)
// ... rest of the usage remains the same
```

### 示马斯

Schemas作为json文件被曝光,其中版本是文件名:

```js
// Getting the version v0.4.0
// If you use TypeScript, enable `resolveJsonModule` in tsconfig.
const schema = require('@cowprotocol/sdk-app-data/schemas/v0.4.0.json')

// Now you can for example run validation against a schema
```

### 类型定义

还有类型定义

```js
import { v0_4_0 } from '@cowprotocol/sdk-app-data'

// Note: this example is
function createAppDataV0_4_0(appCode: v0_4_0.AppCode, metadata: v0_4_0.Metadata): v0_4_0.AppDataRootSchema {
  return {
    version: '0.4.0',
    appCode,
    metadata,
  }
}
```

### 常数

最新版本名称作为常数曝光

```js
import {
  LATEST_APP_DATA_VERSION,
  LATEST_QUOTE_METADATA_VERSION,
  LATEST_REFERRER_METADATA_VERSION,
} from '@cowprotocol/sdk-app-data'
```

### 用户

_获取应用数据计划_

要逐个版本得到一个计划定义

```js
import { getAppDataSchema } from '@cowprotocol/sdk-app-data'

const schema = getAppDataSchema('0.1.0')
```

如果版本不存在,它会扔出去的

_验证appDataDoc_

要验证文档,请交给 `validateAppDataDoc`。 。 。 . 它会返回一个有布尔指示的物体 `success` 财务报告和审定财务报表 `errors`如果有的话. 对照的版本将取自博士本身.

```js
import { validateAppDataDoc } from '@cowprotocol/sdk-app-data'

let doc = { version: '0.4.0', metadata: {} }

let result = await validateAppDataDoc(doc)
console.log(result) // { success: true }

doc = { version: '0.0.0', metadata: {} }

result = await validateAppDataDoc(doc)
// Contrary to `getAppDataSchema`, invalid or non-existing schemas won't throw
console.log(result) // { success: false, errors: 'AppData version 0.0.0 doesn\'t exist'}
```

# 贡献

叉出还款,这样你就可以创建出一个新的PR. 然后说:

1.  使用 [铸造](https://semver.org/) 公约

-   只要复制最新版本即:. `src/schemas/<old-version>.json` 改为 `src/schemas/<new-version>.json`

2.  如果您正在添加新的元数据

-   我们每个计划创建一个目录, 这样我们就可以跟踪所有版本。 创建目录和初始计划定义 : `<meta-data-name>/v0.1.0.json`
-   把它加入你刚创造的主要计划 步骤1: `"$ref": "<meta-data-name>/v0.1.0.json#"`。 。 。 .
-   示例 [https://github.com/cowprotocol/app-data/pull/44/files#diff-7f7a61b478245dfda004f64bd68ac55ef68cbeb5d6d90d77e1cdbd2b7e1212b8R56](https://github.com/cowprotocol/app-data/pull/44/files#diff-7f7a61b478245dfda004f64bd68ac55ef68cbeb5d6d90d77e1cdbd2b7e1212b8R56)

3.  如果您正在修改已有的元数据

-   使用 [铸造](https://semver.org/) 公约
-   您需要为元数据计划创建新文件 : `<meta-data-name>/<new-version>.json`
-   更新到您刚创建的主要计划 步骤1: 设置到 `"<meta-data-name>": { "$ref": "<meta-data-name>/<new-version>.json#" }`

4.  生成打字符类型

-   运行 `pnpm build`它自动检测每个 `src/schemas/v*.json` 文件并重生类型,最新的版本是自动生成的(最高级的semver),所以没有常数可以手动更新.

5.  以新的或修改过的元数据为重点的测试 :

-   [https://github.com/cowprotocol/app-data/pull/44/files#diff-e755a2ecce42f09829d5c7dc1de8853d1d00ef56eaadc2709601c87b9be8ddfbR556](https://github.com/cowprotocol/app-data/pull/44/files#diff-e755a2ecce42f09829d5c7dc1de8853d1d00ef56eaadc2709601c87b9be8ddfbR556)
-   别忘了在测试中用正确的版本 [https://github.com/cowprotocol/app-data/pull/44/files#diff-e755a2ecce42f09829d5c7dc1de8853d1d00ef56eaadc2709601c87b9be8ddfbR11](https://github.com/cowprotocol/app-data/pull/44/files#diff-e755a2ecce42f09829d5c7dc1de8853d1d00ef56eaadc2709601c87b9be8ddfbR11)

6.  创建 PR 并将其与修改动机一起记录

> **说明:** 上面的例子说明在适配器系统被引入之前遗留的应用数据存储器. 对于新的实施,如上文使用实例所示,请使用具有适当适配器初始化的当前存储器.

## 常见问题

### @cowprotocol/sdk-app-data 是什么？

CoW 协议 AppData 计划定义

### 如何安装 @cowprotocol/sdk-app-data？

在项目目录运行 npm install @cowprotocol/sdk-app-data，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：ajv（^8\.x）、multiformats（^9\.x）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @cowprotocol/sdk-app-data 支持 TypeScript 吗？

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

### @cowprotocol/sdk-app-data 支持 ESM 还是 CommonJS？

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

### @cowprotocol/sdk-app-data 可以商用吗？

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

### @cowprotocol/sdk-app-data 的下载量有多少？

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

### @cowprotocol/sdk-app-data 还在维护吗？

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