diff options
author | Amir Bandeali <abandeali1@gmail.com> | 2018-10-20 04:29:04 +0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-10-20 04:29:04 +0800 |
commit | 2c308c0f4c172293e634d27f731d026e0361e639 (patch) | |
tree | 7ddd2404e536a42f8e7e3889f49e3f176ca16c50 /packages | |
parent | aeb607d485862fd44f846214d6d98058e30a19d7 (diff) | |
parent | d8001e696ecc1f1a51719fee372fcbf730f10b80 (diff) | |
download | dexon-sol-tools-2c308c0f4c172293e634d27f731d026e0361e639.tar dexon-sol-tools-2c308c0f4c172293e634d27f731d026e0361e639.tar.gz dexon-sol-tools-2c308c0f4c172293e634d27f731d026e0361e639.tar.bz2 dexon-sol-tools-2c308c0f4c172293e634d27f731d026e0361e639.tar.lz dexon-sol-tools-2c308c0f4c172293e634d27f731d026e0361e639.tar.xz dexon-sol-tools-2c308c0f4c172293e634d27f731d026e0361e639.tar.zst dexon-sol-tools-2c308c0f4c172293e634d27f731d026e0361e639.zip |
Merge pull request #1168 from 0xProject/feature/contracts/updateReadme
Update links, remove 1.0 from contracts README
Diffstat (limited to 'packages')
-rw-r--r-- | packages/contracts/README.md | 22 |
1 files changed, 8 insertions, 14 deletions
diff --git a/packages/contracts/README.md b/packages/contracts/README.md index 11579cf47..5aedb249f 100644 --- a/packages/contracts/README.md +++ b/packages/contracts/README.md @@ -4,29 +4,23 @@ Smart contracts that implement the 0x protocol. Addresses of the deployed contra ## Usage -### 2.0.0 +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: -Contracts that make up and interact with version 2.0.0 of the protocol can be found in the `src/2.0.0` directory. The contents of this directory are broken down into the following subdirectories: - -* protocol +* [protocol](./contracts/protocol) * This directory contains the contracts 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). -* extensions +* [extensions](./contracts/extensions) * This directory contains contracts that interact with the 2.0.0 contracts and will be used in production, such as the [Forwarder](https://github.com/0xProject/0x-protocol-specification/blob/master/v2/forwarder-specification.md) contract. -* examples +* [examples](./contracts/examples) * This directory contains example implementations of contracts that interact with the protocol but are _not_ intended for use in production. Examples include [filter](https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md#filter-contracts) contracts, a [Wallet](https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md#wallet) contract, and a [Validator](https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md#validator) contract, among others. -* tokens +* [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). -* multisig +* [multisig](./contracts/multisig) * This directory contains the [Gnosis MultiSigWallet](https://github.com/gnosis/MultiSigWallet) and a custom extension that adds a timelock to transactions within the MultiSigWallet. -* utils +* [utils](./contracts/utils) * This directory contains libraries and utils that are shared across all of the other directories. -* test +* [test](./contracts/test) * This directory contains mocks and other contracts that are used solely for testing contracts within the other directories. -### 1.0.0 - -Contracts that make up version 1.0.0 of the protocol can be found in `src/1.0.0`. These contracts are considered deprecated and will have limited support going forward. - ## Bug bounty A bug bounty for the 2.0.0 contracts is ongoing! Instructions can be found [here](https://0xproject.com/wiki#Bug-Bounty). |