diff options
author | Leonid Logvinov <logvinov.leon@gmail.com> | 2018-12-05 18:19:10 +0800 |
---|---|---|
committer | Leonid Logvinov <logvinov.leon@gmail.com> | 2018-12-05 20:13:35 +0800 |
commit | 48021a227f7034c2238c64146b2eb05eb8bfb687 (patch) | |
tree | c9fbfd03a6018ee7d36cf0db2766513ad17835d2 /contracts/interfaces/README.md | |
parent | b411e2250aed82b87d1cbebf5cf805d794ddbdb7 (diff) | |
download | dexon-0x-contracts-48021a227f7034c2238c64146b2eb05eb8bfb687.tar dexon-0x-contracts-48021a227f7034c2238c64146b2eb05eb8bfb687.tar.gz dexon-0x-contracts-48021a227f7034c2238c64146b2eb05eb8bfb687.tar.bz2 dexon-0x-contracts-48021a227f7034c2238c64146b2eb05eb8bfb687.tar.lz dexon-0x-contracts-48021a227f7034c2238c64146b2eb05eb8bfb687.tar.xz dexon-0x-contracts-48021a227f7034c2238c64146b2eb05eb8bfb687.tar.zst dexon-0x-contracts-48021a227f7034c2238c64146b2eb05eb8bfb687.zip |
Refactor our protocol interfaces into @0x/contracts-interfaces
Diffstat (limited to 'contracts/interfaces/README.md')
-rw-r--r-- | contracts/interfaces/README.md | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/contracts/interfaces/README.md b/contracts/interfaces/README.md new file mode 100644 index 000000000..7e1c42c7b --- /dev/null +++ b/contracts/interfaces/README.md @@ -0,0 +1,72 @@ +## Contracts interfaces + +Smart contract interfaces of the 0x protocol. + +## Usage + +Contracts that make up and interact with version 2.0.0 of the protocol can be found in the [contracts](./contracts) directory. The contents of this directory are broken down into the following subdirectories: + +* [protocol](./contracts/protocol) + * This directory contains the contract interfaces that make up version 2.0.0. A full specification can be found [here](https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md). + +## Bug bounty + +A bug bounty for the 2.0.0 contracts is ongoing! Instructions can be found [here](https://0xproject.com/wiki#Bug-Bounty). + +## 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)](https://github.com/0xProject/ZEIPs) repository and follow the contribution guidelines provided therein. + +Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started. + +### Install Dependencies + +If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them: + +```bash +yarn config set workspaces-experimental true +``` + +Then install dependencies + +```bash +yarn install +``` + +### Build + +To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory: + +```bash +PKG=@0x/contracts-interfaces yarn build +``` + +Or continuously rebuild on change: + +```bash +PKG=@0x/contracts-interfaces yarn watch +``` + +### Clean + +```bash +yarn clean +``` + +### Lint + +```bash +yarn lint +``` + +### Run Tests + +```bash +yarn test +``` + +#### Testing options + +Contracts testing options like coverage, profiling, revert traces or backing node choosing - are described [here](../TESTING.md). |