0x 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.
This repository is a monorepo including the 0x protocol smart contracts and numerous developer tools. Each public sub-package is independently published to NPM.
Visit our developer portal for a comprehensive list of core & community maintained packages. All packages maintained with this monorepo are listed below.
These packages are all under development. See /contracts/README.md for a list of deployed packages.
||The contracts used for settling trades within the protocol|
||Implementations of various ERC20 tokens|
||Generic libraries and utilities used throughout all of the contracts|
||A set of utilities for generating, parsing, signing and validating 0x orders|
||A tiny utility library for getting known deployed contract addresses for a particular network.|
||JS/TS wrappers for interacting with the 0x smart contracts|
||0x smart contract compilation artifacts|
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": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"],
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.
contribution guidelines.Read our
Make sure you are using Yarn v1.9.4. To install using brew:
brew install firstname.lastname@example.org
Then install dependencies
To build all packages:
To build a specific package:
PKG=@0x/protocol-utils yarn build
To build all contracts packages:
To re-build all packages on change:
To watch a specific package and all it's dependent packages:
PKG=[NPM_PACKAGE_NAME] yarn watch e.g PKG=@0x/protocol-utils yarn watch
Clean all packages:
Clean a specific package
PKG=@0x/protocol-utils yarn clean
To re-build (clean & build) all packages:
To re-build (clean & build) a specific package & it's deps:
PKG=@0x/protocol-utils yarn rebuild
Lint all packages:
Lint a specific package:
PKG=@0x/protocol-utils yarn lint
Run all tests:
Run a specific package's test:
PKG=@0x/protocol-utils yarn test
Run all contracts packages tests: