# @gnosis\.pm/dex-contracts 中文文档

规范地址：https://npmcn.com/package/%40gnosis.pm/dex-contracts/

版本：0\.5\.1-beta
npm 元数据更新时间：2022-04-05T14:47:52.126Z
中文译文更新时间：2026-11-16T17:25:08.338Z
软件包许可：LGPL-3\.0

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

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

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

- 包体积（解压后）：20.9 MB，212 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2019-11-26T15:13:49.763Z
- 最新版本发布：2020-11-19T14:48:32.020Z
- 近 30 天下载量：5086（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：35（近 12 个月 0 个）

## 中文简介

DFUST 分批拍卖交易合同

## 安装

```sh
npm install @gnosis.pm/dex-contracts
```

也可以使用：`pnpm add @gnosis.pm/dex-contracts`、`yarn add @gnosis.pm/dex-contracts`、`bun add @gnosis.pm/dex-contracts`

## README

[![Build Status](https://travis-ci.org/gnosis/dex-contracts.svg?branch=master)](https://travis-ci.org/gnosis/dex-contracts?branch=master) [![Coverage Status](https://coveralls.io/repos/github/gnosis/dex-contracts/badge.svg?branch=master)](https://coveralls.io/github/gnosis/dex-contracts?branch=master)

# Gnosis协议 - 智能合同

这个 **Gnosis 协议交换** 这是一种完全分散化的贸易协议,它通过若干企业之间的独立拍卖促进环状交易 [ERC20 红十字](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-20.md) 符号对相.

它利用批次拍卖进行无套利交易,同时使贸易商的盈余最大化,为所有人建立一个更公平的Web3生态系统提供便利.

# 文档

检查 [智能合同文档](https://docs.google.com/document/d/1OfT83TcmwGeAPoQcg1aAt7_CiSskGpftBZgYmk0xIag)。 。 。 .

# 审计报告

审计报告可见 [这里](https://github.com/gnosis/dex-contracts/blob/master/Exchange_audit_report.pdf)。 。 。 .

# CLI 实例

离职 [维基百科](https://github.com/gnosis/dex-contracts/wiki/Script-Usage-Examples)

# 部署进程

为将合同部署到一个正式网络,请遵循以下步骤:

1.  确保所有依赖的合同和库 -- -- 如字节Lib -- -- 已部署到预定网络,其网络信息可在npm模块中获取
    
2.  运行以下命令
    

```sh
yarn install                        # This installs all dependencies
npx truffle build                   # This builds the contracts
npx truffle migrate --network $NETWORKNAME --reset
yarn run networks-extract           # extracts deployed addresses to networks.json
```

如果你正在建立一个本地开发网络, 甘纳奇必须在当地运行。 为此,您可以在单独的外壳运行时使用

```sh
yarn run ganache # start a development network (blocking)
```

如果您想要使用已有的收费符( tokenId 0) 来部署合同, 您可以设置嵌入变量

```
export FEE_TOKEN_ADDRESS=...
```

在运行迁移脚本之前.

3.  验证一些凉爽的 Etherscan.io goodies 的合同(更多帮助见下文)

```sh
npx truffle run verify BatchExchange --network $NETWORKNAME
```

4.  在 StableX 交换器上列出一些默认符号

```sh
npx truffle exec scripts/add_token_list.js --network $NETWORKNAME
```

## 核查合同

为了在 Etherscan.io 上验证合同, 您需要先创建账户和 API 密钥

1.  导航到 [https://etherscan.io/myapikey (英语)](https://etherscan.io/myapikey)
2.  登录或创建账户
3.  生成新的 API 密钥
4.  添加 `export MY_ETHERSCAN_API_KEY="..."` 给您的 `~/.zshrc`, (中文(简体) ), `~/.bash_profile`,或类似

说明,如果您有特定的合同地址(即未在 `networks.json`地址可以指:

```sh
npx truffle run verify $CONTRACT_NAME@$CONTRACT_ADDRESS --network $NETWORKNAME
```

# 获取以前的部署

为了使用在网络中记录的先前部署的合同. json 文件,需要下列步骤:

1.  构建合同:

```
npx truffle compile
```

2.  从 network.json 输入地址到构建 :

```
yarn run networks-inject
```

# 给林克比一个简单的市场制造方案:

以下脚本部署一个简单的市场制造者订单和必要的猫头鹰订单,以允许交易: 1

```sh
# Get token ID of DAI
npx truffle exec scripts/invokeViewFunction.js 'tokenAddressToIdMap' '0x5592EC0cfb4dbc12D3aB100b257153436a1f0FEa' --network rinkeby

# Export the resulting token ID
export TOKEN_ID_DAI=[Result from last call]

# Get token ID of TrueUSD
npx truffle exec scripts/invokeViewFunction.js 'tokenAddressToIdMap' '0x0000000000085d4780B73119b644AE5ecd22b376' --network rinkeby

# Export the resulting token ID
export TOKEN_ID_TUSD=[Result from last call]

# Make sure that the users have deposited sufficient funds into the exchange
# Please be aware that the specified amounts are multiples of 10**18
npx truffle exec scripts/deposit.js --accountId=0 --tokenId=0 --amount=30 --network rinkeby&& \
npx truffle exec scripts/deposit.js --accountId=0 --tokenId=$TOKEN_ID_TUSD --amount=100 --network rinkeby

# Place  market-maker order in current auction
# This simulates a strategy expected from market makers: trading stable coins against each other
# with a spread of 0.02 percent
npx truffle exec scripts/place_order.js --accountId=0 --buyToken=$TOKEN_ID_DAI --sellToken=$TOKEN_ID_TUSD --minBuy=1000 --maxSell=998 --validFor=20 --network rinkeby

# Place owl token order for the fee mechanism
npx truffle exec scripts/place_order.js --accountId=0 --buyToken=$TOKEN_ID_DAI --sellToken=0 --minBuy=1000 --maxSell=1000 --validFor=20 --network rinkeby

```

之后,市场秩序可以在切换到另一个账户后成为地方. 通常,通过UI预计会发生这种情况. 如果通过控制台完成,可使用下列命令:

```sh
# Deposit funds into exchange:
npx truffle exec scripts/deposit.js --accountId=0 --tokenId=$TOKEN_ID_DAI --amount=100 --network rinkeby

# Place market order with 1/2 limit-price
npx truffle exec scripts/place_order.js --accountId=1 --buyToken=$TOKEN_ID_TUSD --sellToken=$TOKEN_ID_DAI --minBuy=500 --maxSell=1000 --validFor=5 --network rinkeby
```

现在,市场可以检查:

```sh
# view the market status:
npx truffle exec scripts/get_auction_elements.js --network rinkeby

```

输出应该是这样的:

```sh
[ { user: '0x740a98f8f4fae0986fb3264fe4aacf94ac1ee96f',
    sellTokenBalance: 100000000000000000000,
    buyToken: 7,
    sellToken: 3,
    validFrom: 5247563,
    validUntil: 5247583,
    priceNumerator: 1e+21,
    priceDenominator: 998000000000000000000,
    remainingAmount: 998000000000000000000 },
  { user: '0x740a98f8f4fae0986fb3264fe4aacf94ac1ee96f',
    sellTokenBalance: 30000000000000000000,
    buyToken: 7,
    sellToken: 0,
    validFrom: 5247563,
    validUntil: 5247583,
    priceNumerator: 1e+21,
    priceDenominator: 1e+21,
    remainingAmount: 1e+21 },
  { user: 'account',
    sellTokenBalance: 100000000000000000000,
    buyToken: 3,
    sellToken: 7,
    validFrom: 5247750,
    validUntil: 5247755,
    priceNumerator: 500000000000000000000,
    priceDenominator: 1e+21,
    remainingAmount: 1e+21 } ]
```

# 在批量交换之上建起

兹将Gnosis协议合同纳入你们自己的松露项目: [https://github.com/gnosis/dex-contracts-集成-实例](https://github.com/gnosis/dex-contracts-integration-example)。此寄存器包含最小值 松露项目允许在合同之外继续发展. 详情请查阅其网页.

# 捐款

连续的整合正在运行若干个插座,必须经过这些插座才能为这种再投资作出贡献。 为了方便,有一个 `pre-commit` 工程根目录中包含的钩子文件 。 您可以在克隆此工程后执行以下命令( 它将确保您的更改在允许执行前通过内衣) , 从而让生活更加轻松 .

```bash
cp pre-commit .git/hooks/
chmod +x .git/hooks/pre-commit
```

对于任何其他问题、评论或关切,请随时与项目管理员联系:

-   亚历克斯(签名)[乔索乔](https://github.com/josojo)(中文(简体) )
-   宾( Ben)[bh2smith (英语)](https://github.com/bh2smith)(中文(简体) )
-   费利克斯(签名)[抛出](https://github.com/fleupold)(中文(简体) )

## 常见问题

### @gnosis\.pm/dex-contracts 是什么？

DFUST 分批拍卖交易合同

### 如何安装 @gnosis\.pm/dex-contracts？

在项目目录运行 npm install @gnosis\.pm/dex-contracts，或使用 pnpm add / yarn add / bun add。

### @gnosis\.pm/dex-contracts 支持 TypeScript 吗？

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

### @gnosis\.pm/dex-contracts 支持 ESM 还是 CommonJS？

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

### @gnosis\.pm/dex-contracts 可以商用吗？

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

### @gnosis\.pm/dex-contracts 的下载量有多少？

根据 npm 官方下载统计，@gnosis\.pm/dex-contracts 在 2026/10/17 – 2026/11/15 这 30 天内被下载 5,086 次，日均约 170 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @gnosis\.pm/dex-contracts 还在维护吗？

最新版本 0\.5\.1-beta 发布于 2020/11/19（5 年前）；至今共发布 35 个版本，其中过去 12 个月发布了 0 个；首次发布于 2019/11/26。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

