@0x/contracts-protocol 中文文档教程
Contracts
实现 0x 协议的智能合约。 已部署合约的地址可以在 0x wiki 或 中找到此包的变更日志。
Usage
可以在 contracts 目录中找到构成协议 2.0.0 版并与之交互的合约。 此目录的内容分为以下子目录：
- protocol
- This directory contains the contracts that make up version 2.0.0. A full specification can be found here.
- test
- This directory contains mocks and other contracts that are used solely for testing contracts within the other directories.
Bug bounty
2.0.0 合约的漏洞奖励正在进行中！ 说明可在此处找到。
Contributing
我们强烈建议社区帮助我们进行改进并确定协议的未来方向。 要报告此包中的错误，请在此存储库中创建一个问题。
有关 0x 协议的智能合约架构、消息格式或附加功能的建议，请转到 0x 改进建议 (ZEIPs) 存储库和遵循其中提供的贡献指南。
请在开始之前阅读我们的贡献指南。
Install Dependencies
如果您没有启用 yarn workspaces (Yarn < v1.0) - 启用它们：
yarn config set workspaces-experimental true
然后安装依赖
yarn install
Build
项 要构建此包和它所依赖的所有其他 monorepo 包，请从 monorepo 根目录运行以下命令：
PKG=@0x/contracts-protocol yarn build
或持续重建关于变化：
PKG=@0x/contracts-protocol yarn watch
Clean
yarn clean
Lint
yarn lint
Run Tests
yarn test
Testing options
此处描述了合约测试选项，例如覆盖率、分析、还原跟踪或支持节点选择。
Contracts
Smart contracts that implement the 0x protocol. Addresses of the deployed contracts can be found in the 0x wiki or the CHANGELOG of this package.
Usage
Contracts that make up and interact with version 2.0.0 of the protocol can be found in the contracts directory. The contents of this directory are broken down into the following subdirectories:
- protocol
- This directory contains the contracts that make up version 2.0.0. A full specification can be found here.
- test
- This directory contains mocks and other contracts that are used solely for testing contracts within the other directories.
Bug bounty
A bug bounty for the 2.0.0 contracts is ongoing! Instructions can be found here.
Contributing
We strongly recommend that the community help us make improvements and determine the future direction of the protocol. To report bugs within this package, please create an issue in this repository.
For proposals regarding the 0x protocol's smart contract architecture, message format, or additional functionality, go to the 0x Improvement Proposals (ZEIPs) repository and follow the contribution guidelines provided therein.
Please read our contribution guidelines before getting started.
Install Dependencies
If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:
yarn config set workspaces-experimental true
Then install dependencies
yarn install
Build
To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:
PKG=@0x/contracts-protocol yarn build
Or continuously rebuild on change:
PKG=@0x/contracts-protocol yarn watch
Clean
yarn clean
Lint
yarn lint
Run Tests
yarn test
Testing options
Contracts testing options like coverage, profiling, revert traces or backing node choosing - are described here.
