0x is an open protocol that facilitates trustless, low friction exchange of Ethereum-based assets. A full description of the protocol may be found in our whitepaper.
This repository is a monorepo including the 0x protocol smart contracts and numerous developer tools. Each public sub-package is independently published to NPM.
| Package | Version | Description |
|---|---|---|
0x.js |
 |
A Javascript library for interacting with the 0x protocol |
@0xproject/abi-gen |
 |
Tool to generate TS wrappers from smart contract ABIs |
@0xproject/assert |
 |
Type and schema assertions used by our packages |
@0xproject/base-contract |
 |
BaseContract used by auto-generated abi-gen wrapper contracts |
@0xproject/connect |
 |
A Javascript library for interacting with the Standard Relayer API |
@0xproject/deployer |
 |
Solidity project compiler and deployer framework |
@0xproject/dev-utils |
 |
Dev utils to be shared across 0x projects and packages |
@0xproject/json-schemas |
 |
0x-related json schemas |
@0xproject/monorepo-scripts |
 |
Monorepo scripts |
@0xproject/react-docs |
 |
React documentation component for rendering TypeDoc & Doxity generated JSON |
@0xproject/react-shared |
 |
0x shared react components |
@0xproject/sra-report |
 |
Generate reports for standard relayer API compliance |
@0xproject/sol-cov |
 |
Solidity test coverage tool |
@0xproject/subproviders |
 |
Useful web3 subproviders (e.g LedgerSubprovider) |
@0xproject/tslint-config |
 |
Custom 0x development TSLint rules |
@0xproject/types |
 |
Shared type declarations |
@0xproject/typescript-typings |
 |
Repository of types for external packages |
@0xproject/utils |
 |
Shared utilities |
@0xproject/web3-wrapper |
 |
Web3 wrapper |
| Package | Description |
|---|---|
@0xproject/contracts |
0x solidity smart contracts & tests |
@0xproject/react-docs-example |
Example documentation site created with @0xproject/react-docs |
@0xproject/testnet-faucets |
A faucet micro-service that dispenses test ERC20 tokens or Ether |
@0xproject/website |
0x website & Portal DApp |
Dedicated documentation pages:
- 0x.js Library
- 0x Connect
- Smart contracts
- Subproviders
- Deployer
- Web3-wrapper
- JSON-schemas
- Sol-cov
- Standard Relayer API
Most of the packages require additional typings for external dependencies.
You can include those by prepending @0xproject/typescript-typings package to your typeRoots config.
"typeRoots": ["node_modules/@0xproject/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.
If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:
yarn config set workspaces-experimental trueThen install dependencies
yarn installBuild all packages. You need to do this before working on any given package. Although these packages
as independent, when run from within the monorepo, they are internally symlinked, to make development
easier. You can change several packages and run the changes without publishing them first to NPM. When
running rebuild, Lerna will figure out the dependency order of all the packages, and build them in
this order.
yarn lerna:rebuildOr continuously rebuild on change:
yarn devLint all packages
yarn lerna:run lintyarn lerna:test