Merge pull request #1413 from 0xProject/feature/contracts-monorepo-7

Contracts monorepo 7

.circleci/config.yml

@@ -44,7 +44,8 @@ jobs:
             - run: yarn wsrun test:circleci @0x/contracts-utils
             - run: yarn wsrun test:circleci @0x/contracts-libs
             - run: yarn wsrun test:circleci @0x/contracts-tokens
-            - run: yarn wsrun test:circleci @0x/contracts-core
+            - run: yarn wsrun test:circleci @0x/contracts-extensions
+            - run: yarn wsrun test:circleci @0x/contracts-protocol
     test-contracts-geth:
         docker:
             - image: circleci/node:9
@@ -60,7 +61,8 @@ jobs:
             - run: TEST_PROVIDER=geth yarn wsrun test @0x/contracts-utils
             - run: TEST_PROVIDER=geth yarn wsrun test @0x/contracts-libs
             - run: TEST_PROVIDER=geth yarn wsrun test @0x/contracts-tokens
-            - run: TEST_PROVIDER=geth yarn wsrun test @0x/contracts-core
+            - run: TEST_PROVIDER=geth yarn wsrun test @0x/contracts-extensions
+            - run: TEST_PROVIDER=geth yarn wsrun test @0x/contracts-protocol
     test-publish:
         resource_class: medium+
         docker:

.gitignore

@@ -83,23 +83,27 @@ packages/react-docs/example/public/bundle*
 packages/testnet-faucets/server/
 
 # generated contract artifacts/
-contracts/core/generated-artifacts/
+contracts/protocol/generated-artifacts/
 contracts/multisig/generated-artifacts/
 contracts/utils/generated-artifacts/
 contracts/libs/generated-artifacts/
 contracts/interfaces/generated-artifacts/
 contracts/tokens/generated-artifacts/
+contracts/examples/generated-artifacts/
+contracts/extensions/generated-artifacts/
 packages/sol-cov/test/fixtures/artifacts/
 packages/metacoin/artifacts/
 
 # generated contract wrappers
 packages/abi-gen-wrappers/wrappers
-contracts/core/generated-wrappers/
+contracts/protocol/generated-wrappers/
 contracts/multisig/generated-wrappers/
 contracts/utils/generated-wrappers/
 contracts/libs/generated-wrappers/
 contracts/interfaces/generated-wrappers/
 contracts/tokens/generated-wrappers/
+contracts/examples/generated-wrappers/
+contracts/extensions/generated-wrappers/
 packages/metacoin/src/contract_wrappers
 
 # solc-bin in sol-compiler

.prettierignore

@@ -1,7 +1,7 @@
 lib
 .nyc_output
-/contracts/core/generated-wrappers
-/contracts/core/generated-artifacts
+/contracts/protocol/generated-wrappers
+/contracts/protocol/generated-artifacts
 /contracts/multisig/generated-wrappers
 /contracts/multisig/generated-artifacts
 /contracts/utils/generated-wrappers
@@ -12,6 +12,10 @@ lib
 /contracts/interfaces/generated-artifacts
 /contracts/tokens/generated-wrappers
 /contracts/tokens/generated-artifacts
+/contracts/examples/generated-wrappers
+/contracts/examples/generated-artifacts
+/contracts/extensions/generated-wrappers
+/contracts/extensions/generated-artifacts
 /packages/abi-gen-wrappers/src/generated-wrappers
 /packages/contract-artifacts/artifacts
 /python-packages/order_utils/src/zero_ex/contract_artifacts/artifacts

contracts/examples/README.md

@@ -0,0 +1,56 @@
+## Contract examples
+
+Example smart contracts that interact with 0x protocol.
+
+## Usage
+
+Contracts can be found in the [contracts](./contracts) directory.
+This package 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.
+
+## 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-examples yarn build
+```
+
+Or continuously rebuild on change:
+
+```bash
+PKG=@0x/contracts-examples yarn watch
+```
+
+### Clean
+
+```bash
+yarn clean
+```
+
+### Lint
+
+```bash
+yarn lint
+```