* development: (94 commits) Update CHANGELOG Add solc 0.4.20 and 0.4.21 Prettier sra-report README Add new packages to top level README Updated @0xproject/utils in top level package.json Publish Updated CHANGELOGs Detail tests in the README Add support for ropsten and rinkeby Fix yarn.lock Update list of packages and organize them alphabetically Fix prettier issues Add support for going back to previous hashes via the browser back button to wiki Scroll to previous hashed elements when user clicks back button Add back strict null checks to react-shared package and fix issues remove ability to have implicit dependencies and add missing deps update license remove no-implicit-this Add example & screenshot to npmignore Remove `;` to be nice to windows users ...

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.
Published Packages
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 to derive all auto-generated wrappers from | |
chai-as-promised-typescript-typings |
Chai as promised typescript typings | |
chai-typescript-typings |
Chai typescript typings | |
@0xproject/connect |
A Javascript library for interacting with the standard relayer api | |
@0xproject/deployer |
Smart contract deployer | |
@0xproject/dev-utils |
Dev utils to be shared across 0x projects and packages | |
ethers-typescript-typings |
Ethers.js typescript typings | |
@0xproject/json-schemas |
0x-related json schemas | |
@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/subproviders |
Useful web3 subproviders (e.g LedgerSubprovider) | |
@0xproject/tslint-config |
Custom 0x development TSLint rules | |
@0xproject/types |
Shared type declarations | |
@0xproject/utils |
Shared utilities | |
web3-typescript-typings |
Web3 typescript typings | |
@0xproject/web3-wrapper |
Web3 wrapper |
Private Packages
Package | Description |
---|---|
@0xproject/contracts |
0x solidity smart contracts & tests |
@0xproject/monorepo-scripts |
Shared monorepo scripts |
@0xproject/testnet-faucets |
A faucet micro-service that dispenses test ERC20 tokens or Ether |
@0xproject/website |
0x website & Portal DApp |
Usage
Dedicated documentation pages:
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.
Please read our contribution guidelines before getting started.
Install dependencies
If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:
yarn config set workspaces-experimental true
Then install dependencies
yarn install
Build
Build all packages
yarn lerna:run build
Continuously rebuild on exchange
yarn dev
Lint
Lint all packages
yarn lerna:run lint
Run Tests
Before running the tests, you will need to spin up a TestRPC instance and deploy all the 0x smart contracts.
In a separate terminal, start TestRPC (a convenience command is provided as part of this repo)
yarn testrpc
Then in your main terminal run
cd packages/contracts
yarn migrate
cd ..
And finally from the root project directory run
yarn lerna:run test