diff options
author | Leonid Logvinov <logvinov.leon@gmail.com> | 2018-12-04 22:40:25 +0800 |
---|---|---|
committer | Leonid Logvinov <logvinov.leon@gmail.com> | 2018-12-04 23:07:59 +0800 |
commit | 9e01f4c9a30a0fd06c105222abfa1ab09e8fec3a (patch) | |
tree | 4e484dfdb0aebc96ddb4cfd7154352144b92bd0a /contracts/libs/README.md | |
parent | 18489161c6871ad7e76967644f91cad2a9be1e85 (diff) | |
download | dexon-0x-contracts-9e01f4c9a30a0fd06c105222abfa1ab09e8fec3a.tar dexon-0x-contracts-9e01f4c9a30a0fd06c105222abfa1ab09e8fec3a.tar.gz dexon-0x-contracts-9e01f4c9a30a0fd06c105222abfa1ab09e8fec3a.tar.bz2 dexon-0x-contracts-9e01f4c9a30a0fd06c105222abfa1ab09e8fec3a.tar.lz dexon-0x-contracts-9e01f4c9a30a0fd06c105222abfa1ab09e8fec3a.tar.xz dexon-0x-contracts-9e01f4c9a30a0fd06c105222abfa1ab09e8fec3a.tar.zst dexon-0x-contracts-9e01f4c9a30a0fd06c105222abfa1ab09e8fec3a.zip |
Refactor out libs into @0x/contracts-libs
Diffstat (limited to 'contracts/libs/README.md')
-rw-r--r-- | contracts/libs/README.md | 70 |
1 files changed, 70 insertions, 0 deletions
diff --git a/contracts/libs/README.md b/contracts/libs/README.md new file mode 100644 index 000000000..42548f7c3 --- /dev/null +++ b/contracts/libs/README.md @@ -0,0 +1,70 @@ +## Contracts libs + +Smart contracts libs used in the 0x protocol. + +## Usage + +Contracts 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 libs used by protocol contracts. +* [test](./contracts/test) + * This directory contains mocks and other contracts that are used solely for testing contracts within the other directories. + +## 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-libs yarn build +``` + +Or continuously rebuild on change: + +```bash +PKG=@0x/contracts-libs 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). |