diff options
author | Amir Bandeali <abandeali1@gmail.com> | 2019-01-22 06:20:33 +0800 |
---|---|---|
committer | Amir Bandeali <abandeali1@gmail.com> | 2019-01-22 13:41:21 +0800 |
commit | 0758f231e21e9b9d3c3ca21ea639b0d8d9acf2f1 (patch) | |
tree | d5afc5124cd49a361bf282df0255e8b122459373 /contracts/erc721/README.md | |
parent | 9fa86195900383640f382850f6fe0d827d48bb9b (diff) | |
download | dexon-0x-contracts-0758f231e21e9b9d3c3ca21ea639b0d8d9acf2f1.tar dexon-0x-contracts-0758f231e21e9b9d3c3ca21ea639b0d8d9acf2f1.tar.gz dexon-0x-contracts-0758f231e21e9b9d3c3ca21ea639b0d8d9acf2f1.tar.bz2 dexon-0x-contracts-0758f231e21e9b9d3c3ca21ea639b0d8d9acf2f1.tar.lz dexon-0x-contracts-0758f231e21e9b9d3c3ca21ea639b0d8d9acf2f1.tar.xz dexon-0x-contracts-0758f231e21e9b9d3c3ca21ea639b0d8d9acf2f1.tar.zst dexon-0x-contracts-0758f231e21e9b9d3c3ca21ea639b0d8d9acf2f1.zip |
Split tokens package into erc20 and erc721
Diffstat (limited to 'contracts/erc721/README.md')
-rw-r--r-- | contracts/erc721/README.md | 74 |
1 files changed, 74 insertions, 0 deletions
diff --git a/contracts/erc721/README.md b/contracts/erc721/README.md new file mode 100644 index 000000000..2d1db92f0 --- /dev/null +++ b/contracts/erc721/README.md @@ -0,0 +1,74 @@ +## Token contracts + +Token smart contracts that are used in the 0x protocol. Addresses of the deployed contracts can be found in the 0x [wiki](https://0xproject.com/wiki#Deployed-Addresses) or the [CHANGELOG](./CHANGELOG.json) of this package. + +## Usage + +Token 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: + +- [tokens](./contracts/tokens) + - This directory contains implementations of different tokens and token standards, including [wETH](https://weth.io/), ZRX, [ERC20](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-20.md), and [ERC721](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-721.md). +- [test](./contracts/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](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-tokens yarn build +``` + +Or continuously rebuild on change: + +```bash +PKG=@0x/contracts-tokens 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). |