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.
Package | Version | Description |
---|---|---|
@0x/contracts-asset-proxy |
AssetProxy contracts used within the protocol |
|
@0x/contracts-erc20 |
Implementations of various ERC20 tokens | |
@0x/contracts-erc721 |
Implementations of various ERC721 tokens | |
@0x/contracts-erc1155 |
Implementations of various ERC1155 tokens | |
@0x/contracts-exchange |
The Exchange contract used for settling trades within the protocol |
|
@0x/contracts-exchange-forwarder |
A Forwarder contract used to simplify UX for interacting with the protocol |
|
@0x/contracts-exchange-libs |
Protocol specific libraries used within the Exchange contract |
|
@0x/contracts-extensions |
Contracts that interact with and extend the functionality of the core protocol | |
@0x/contracts-multisig |
Various implementations of multisignature wallets, including the AssetProxyOwner contract that has permissions to upgrade the protocol |
|
@0x/contracts-test-utils |
TypeScript/Javascript shared utilities used for testing contracts | |
@0x/contracts-utils |
Generic libraries and utilities used throughout all of the contracts | |
@0x/contracts-coordinator |
A contract that allows users to execute 0x transactions with permission from a Coordinator | |
@0x/contracts-dev-utils |
A contract contains utility functions for developers (such as validating many orders using a single eth_call) | |
@0x/contracts-staking |
Implements the stake-based liquidity incentives defined by ZEIP-31 |
Package | Version | Description |
---|---|---|
@emdx-dex/contract-addresses |
A tiny utility library for getting known deployed contract addresses for a particular network. | |
@emdx-dex/contract-wrappers |
JS/TS wrappers for interacting with the 0x smart contracts | |
@emdx-dex/order-utils |
A set of utilities for generating, parsing, signing and validating 0x orders | |
@0x/migrations |
Migration tool for deploying 0x smart contracts on private testnets | |
@0x/contract-artifacts |
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
config.
"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.
Read our contribution guidelines.
Make sure you are using Yarn v1.9.4. To install using brew:
brew install [email protected]
Then install dependencies
yarn install
To build all packages:
yarn build
To build a specific package:
PKG=@emdx-dex/contract-wrappers yarn build
To build all contracts packages:
yarn build:contracts
To re-build all packages on change:
yarn watch
To watch a specific package and all it's dependent packages:
PKG=[NPM_PACKAGE_NAME] yarn watch
e.g
PKG=@emdx-dex/contract-wrappers yarn watch
Clean all packages:
yarn clean
Clean a specific package
PKG=0x.js yarn clean
To re-build (clean & build) all packages:
yarn rebuild
To re-build (clean & build) a specific package & it's deps:
PKG=@emdx-dex/contract-wrappers yarn rebuild
Lint all packages:
yarn lint
Lint a specific package:
PKG=@emdx-dex/contract-wrappers yarn lint
Run all tests:
yarn test
Run a specific package's test:
PKG=@emdx-dex/contract-wrappers yarn test
Run all contracts packages tests:
yarn test:contracts