0x protocol monorepo - includes our smart contracts and many developer tools
Switch branches/tags
@0xproject/0x.js@0.24.0 @0xproject/website@0.0.54 @0xproject/website@0.0.53 @0xproject/website@0.0.52 @0xproject/website@0.0.51 @0xproject/website@0.0.50 @0xproject/website@0.0.49 @0xproject/website@0.0.48 @0xproject/website@0.0.47 @0xproject/website@0.0.46 @0xproject/website@0.0.45 @0xproject/website@0.0.43 @0xproject/website@0.0.42 @0xproject/website@0.0.41 @0xproject/website@0.0.39 @0xproject/website@0.0.38 @0xproject/website@0.0.37 @0xproject/website@0.0.36 @0xproject/website@0.0.32 @0xproject/website@0.0.31 @0xproject/website@0.0.30 @0xproject/website@0.0.29 @0xproject/website@0.0.28 @0xproject/website@0.0.27 @0xproject/website@0.0.26 @0xproject/website@0.0.25 @0xproject/website@0.0.24 @0xproject/website@0.0.23 @0xproject/website@0.0.22 @0xproject/website@0.0.21 @0xproject/website@0.0.20 @0xproject/website@0.0.19 @0xproject/website@0.0.18 @0xproject/website@0.0.17 @0xproject/website@0.0.16 @0xproject/website@0.0.15 @0xproject/website@0.0.14 @0xproject/website@0.0.13 @0xproject/website@0.0.12 @0xproject/website@0.0.11 @0xproject/website@0.0.10 @0xproject/website@0.0.9 @0xproject/website@0.0.7 @0xproject/website@0.0.6 @0xproject/website@0.0.5 @0xproject/website@0.0.4 @0xproject/website@0.0.3 @0xproject/web3-wrapper@3.0.3 @0xproject/web3-wrapper@3.0.2 @0xproject/web3-wrapper@3.0.1 @0xproject/web3-wrapper@3.0.0 @0xproject/web3-wrapper@2.0.3 @0xproject/web3-wrapper@2.0.2 @0xproject/web3-wrapper@2.0.1 @0xproject/web3-wrapper@2.0.0 @0xproject/web3-wrapper@1.2.0 @0xproject/web3-wrapper@1.1.2 @0xproject/web3-wrapper@1.1.1 @0xproject/web3-wrapper@1.1.0 @0xproject/web3-wrapper@1.0.1 @0xproject/web3-wrapper@1.0.0 @0xproject/web3-wrapper@0.7.3 @0xproject/web3-wrapper@0.7.2 @0xproject/web3-wrapper@0.7.1 @0xproject/web3-wrapper@0.7.0 @0xproject/web3-wrapper@0.6.5 @0xproject/web3-wrapper@0.6.4 @0xproject/web3-wrapper@0.6.3 @0xproject/web3-wrapper@0.6.2 @0xproject/web3-wrapper@0.6.1 @0xproject/web3-wrapper@0.6.0 @0xproject/web3-wrapper@0.5.0 @0xproject/web3-wrapper@0.4.0 @0xproject/web3-wrapper@0.3.1 @0xproject/web3-wrapper@0.3.0 @0xproject/web3-wrapper@0.2.1 @0xproject/web3-wrapper@0.2.0 @0xproject/web3-wrapper@0.1.14 @0xproject/web3-wrapper@0.1.13 @0xproject/web3-wrapper@0.1.12 @0xproject/web3-wrapper@0.1.11 @0xproject/web3-wrapper@0.1.10 @0xproject/web3-wrapper@0.1.9 @0xproject/web3-wrapper@0.1.8 @0xproject/web3-wrapper@0.1.7 @0xproject/web3-wrapper@0.1.6 @0xproject/web3-wrapper@0.1.5 @0xproject/web3-wrapper@0.1.4 @0xproject/web3-wrapper@0.1.3 @0xproject/web3-wrapper@0.1.2 @0xproject/web3-wrapper@0.1.1 @0xproject/web3-wrapper@0.1.0 @0xproject/utils@2.0.2 @0xproject/utils@2.0.0 @0xproject/utils@1.0.11 @0xproject/utils@1.0.10 @0xproject/utils@1.0.9 @0xproject/utils@1.0.8 @0xproject/utils@1.0.7 @0xproject/utils@1.0.6
Nothing to show
Clone or download
Fabio Berger
Latest commit 72f5719 Oct 16, 2018

README.md


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.

If you're developing on 0x now or are interested in using 0x infrastructure in the future, please join our developer mailing list for updates.

CircleCI Coverage Status Discord Join the chat at https://gitter.im/0xProject/Lobby License

Published Packages

Package Version Description
0x.js npm A Javascript library for interacting with the 0x protocol
@0xproject/abi-gen npm Tool to generate TS wrappers from smart contract ABIs
@0xproject/assert npm Type and schema assertions used by our packages
@0xproject/asset-buyer npm Convenience package for discovering and buying assets with Ether.
@0xproject/base-contract npm BaseContract used by auto-generated abi-gen wrapper contracts
@0xproject/connect npm A Javascript library for interacting with the Standard Relayer API
@0xproject/dev-utils npm Dev utils to be shared across 0x projects and packages
@0xproject/json-schemas npm 0x-related json schemas
@0xproject/monorepo-scripts npm Monorepo scripts
@0xproject/order-utils npm A set of utilities for generating, parsing, signing and validating 0x orders.
@0xproject/react-docs npm React documentation component for rendering TypeDoc & Doxity generated JSON
@0xproject/react-shared npm 0x shared react components
@0xproject/sol-compiler npm A thin wrapper around Solc.js that outputs artifacts, resolves imports, only re-compiles when needed, and other niceties.
@0xproject/sol-cov npm Solidity test coverage tool
@0xproject/sra-spec npm OpenAPI specification for the standard relayer API
@0xproject/sra-report npm Generate reports for standard relayer API compliance
@0xproject/subproviders npm Useful web3 subproviders (e.g LedgerSubprovider)
@0xproject/tslint-config npm Custom 0x development TSLint rules
@0xproject/types npm Shared type declarations
@0xproject/typescript-typings npm Repository of types for external packages
@0xproject/utils npm Shared utilities
@0xproject/web3-wrapper npm Web3 wrapper

Private Packages

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

Usage

Dedicated documentation pages:

Node version >= 6.12 is required.

Most of the packages require additional typings for external dependencies. You can include those by prepending the @0xproject/typescript-typings package to your typeRoots config.

"typeRoots": ["node_modules/@0xproject/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.

Install dependencies

Make sure you are using Yarn v1.9.4. To install using brew:

Then install dependencies

yarn install

Build

To build all packages:

yarn build

To build a specific package:

PKG=@0xproject/web3-wrapper yarn build

Watch

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=@0xproject/web3-wrapper yarn watch

Clean

Clean all packages:

yarn clean

Clean a specific package

PKG=0x.js yarn clean

Rebuild

To re-build (clean & build) all packages:

yarn rebuild

To re-build (clean & build) a specific package & it's deps:

PKG=0x.js yarn rebuild

Lint

Lint all packages:

yarn lint

Lint a specific package:

PKG=0x.js yarn lint

Run Tests

Run all tests:

yarn test

Run a specific package's test:

PKG=@0xproject/web3-wrapper yarn test