--- [0x][website-url] is an open protocol that facilitates trustless, low friction exchange of Ethereum-based assets. For more information on how it works, check out the [0x protocol specification](https://protocol.0x.org/). This repository is a monorepo including the 0x protocol smart contracts and numerous developer tools. Each public sub-package is independently published to NPM. [website-url]: https://0x.org [](https://circleci.com/gh/0xProject/protocool) [](https://coveralls.io/github/0xProject/0x-monorepo?branch=development) [](https://discordapp.com/invite/d3FTX3M) [](https://opensource.org/licenses/Apache-2.0) ## Packages Visit our [developer portal](https://0x.org/docs/) for a comprehensive list of core & community maintained packages. All packages maintained with this monorepo are listed below. ### Solidity Packages These packages are all under development. See [/contracts/README.md](/contracts/README.md) for a list of deployed packages. | Package | Version | Description | | --------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- | | [`@0x/contracts-zero-ex`](/contracts/zero-ex) | [](https://www.npmjs.com/package/@0x/contracts-zero-ex) | The contracts used for settling trades within the protocol | | [`@0x/contracts-erc20`](/contracts/erc20) | [](https://www.npmjs.com/package/@0x/contracts-erc20) | Implementations of various ERC20 tokens | | [`@0x/contracts-test-utils`](/contracts/test-utils) | [](https://www.npmjs.com/package/@0x/contracts-test-utils) | TypeScript/Javascript shared utilities used for testing contracts | | [`@0x/contracts-utils`](/contracts/utils) | [](https://www.npmjs.com/package/@0x/contracts-utils) | Generic libraries and utilities used throughout all of the contracts | ### TypeScript/Javascript Packages #### 0x-specific packages | Package | Version | Description | | -------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | | [`@0x/protocol-utils`](/packages/protocol-utils) | [](https://www.npmjs.com/package/@0x/protocol-utils) | A set of utilities for generating, parsing, signing and validating 0x orders | | [`@0x/contract-addresses`](/packages/contract-addresses) | [](https://www.npmjs.com/package/@0x/contract-addresses) | A tiny utility library for getting known deployed contract addresses for a particular network. | | [`@0x/contract-wrappers`](/packages/contract-wrappers) | [](https://www.npmjs.com/package/@0x/contract-wrappers) | JS/TS wrappers for interacting with the 0x smart contracts | | [`@0x/contract-artifacts`](/packages/contract-artifacts) | [](https://www.npmjs.com/package/@0x/contract-artifacts) | 0x smart contract compilation artifacts | | ## Usage Node version 6.x or 8.x is required. Most of the packages require additional typings for external dependencies. You can include those by prepending the `@0x/typescript-typings` package to your [`typeRoots`](http://www.typescriptlang.org/docs/handbook/tsconfig-json.html) config. ```json "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"], ``` ## 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. #### Read our [contribution guidelines](./CONTRIBUTING.md). ### Install dependencies Make sure you are using Yarn v1.9.4. To install using brew: ```bash brew install yarn@1.9.4 ``` Then install dependencies ```bash yarn install ``` ### Build To build all packages: ```bash yarn build ``` To build a specific package: ```bash PKG=@0x/protocol-utils yarn build ``` To build all contracts packages: ```bash yarn build:contracts ``` ### Watch To re-build all packages on change: ```bash yarn watch ``` To watch a specific package and all it's dependent packages: ```bash PKG=[NPM_PACKAGE_NAME] yarn watch e.g PKG=@0x/protocol-utils yarn watch ``` ### Clean Clean all packages: ```bash yarn clean ``` Clean a specific package ```bash PKG=@0x/protocol-utils yarn clean ``` ### Rebuild To re-build (clean & build) all packages: ```bash yarn rebuild ``` To re-build (clean & build) a specific package & it's deps: ```bash PKG=@0x/protocol-utils yarn rebuild ``` ### Lint Lint all packages: ```bash yarn lint ``` Lint a specific package: ```bash PKG=@0x/protocol-utils yarn lint ``` ### Run Tests Run all tests: ```bash yarn test ``` Run a specific package's test: ```bash PKG=@0x/protocol-utils yarn test ``` Run all contracts packages tests: ```bash yarn test:contracts ```