aa5af04447
* Refine Order for Web3 compat. & add conversions Changed some of the fields in the Order class so that it can be passed to our contracts via Web3. Added conversion utilities so that an Order can be easily converted to and from a JSON-compatible dict (specifically by encoding/decoding the `bytes` fields), to facilitate validation against the JSON schema. Also modified JSON order schema to accept integers in addition to stringified integers. * Fixes for json_schemas Has-types indicator file, py.typed, was not being included in package. Schemas were not being properly gathered into package installation. * Add test/demo of Exchange.getOrderInfo() * web3 bug workaround * Fix problem packaging contract artifacts * Move contract addresses to their own package * Move contract artifacts to their own package * Add scripts to install, test & lint all components * prettierignore files in local python dev env * Correct missing coverage analysis for sra_client * CI cache lint: don't save, re-use from test-python * tag hacks as hacks * correct merge mistake * remove local strip_0x() in favor of eth_utils * remove json schemas from old order_utils location * correct merge mistake * doctest json schemas via command-line, not code
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.
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.
Packages
Visit our developer portal for a comprehensive list of core & community maintained packages. All packages maintained with this monorepo are listed below.
Python Packages
| Package | Version | Description |
|---|---|---|
0x-contract-addresses |
 |
A tiny utility library for getting known deployed contract addresses for a particular network |
0x-contract-artifacts |
 |
0x smart contract compilation artifacts |
0x-json-schemas |
 |
0x-related JSON schemas |
0x-order-utils |
 |
A set of utilities for generating, parsing, signing and validating 0x orders |
0x-sra-client |
 |
A Python client for interacting with servers conforming to the Standard Relayer API specification |
Typescript/Javascript Packages
0x-specific packages
| Package | Version | Description |
|---|---|---|
0x.js |
 |
An aggregate package combining many smaller utility packages for interacting with the 0x protocol |
@0x/contract-addresses |
 |
A tiny utility library for getting known deployed contract addresses for a particular network. |
@0x/contract-wrappers |
 |
JS/TS wrappers for interacting with the 0x smart contracts |
@0x/order-utils |
 |
A set of utilities for generating, parsing, signing and validating 0x orders |
@0x/json-schemas |
 |
0x-related JSON schemas |
@0x/order-watcher |
 |
An order watcher daemon that watches for order validity |
@0x/migrations |
 |
Migration tool for deploying 0x smart contracts on private testnets |
@0x/contract-artifacts |
 |
0x smart contract compilation artifacts |
@0x/abi-gen-wrappers |
 |
Low-level 0x smart contract wrappers generated using @0x/abi-gen |
@0x/sra-spec |
 |
OpenAPI specification for the Standard Relayer API |
@0x/connect |
 |
An HTTP/WS client for interacting with the Standard Relayer API |
@0x/asset-buyer |
 |
Convenience package for discovering and buying assets with Ether |
Ethereum tooling
| Package | Version | Description |
|---|---|---|
@0x/web3-wrapper |
 |
An Ethereum JSON RPC client |
@0x/sol-compiler |
 |
A wrapper around solc-js that adds smart re-compilation, ability to compile an entire project, Solidity version specific compilation, standard input description support and much more. |
@0x/sol-cov |
 |
A solidity test coverage tool |
@0x/sol-resolver |
 |
Import resolver for smart contracts dependencies |
@0x/subproviders |
 |
Web3 provider middlewares (e.g. LedgerSubprovider) |
@0x/sol-doc |
 |
Solidity documentation generator |
Utilities
| Package | Version | Description |
|---|---|---|
@0x/abi-gen |
 |
Tool to generate TS wrappers from smart contract ABIs |
@0x/tslint-config |
 |
Custom TSLint rules used by the 0x core team |
@0x/types |
 |
Shared type declarations |
@0x/typescript-typings |
 |
Repository of types for external packages |
@0x/utils |
 |
Shared utilities |
@0x/react-docs |
 |
React documentation component for rendering TypeDoc & sol-doc generated JSON |
@0x/react-shared |
 |
0x shared react components |
@0x/assert |
 |
Type and schema assertions used by our packages |
@0x/base-contract |
 |
BaseContract used by auto-generated abi-gen wrapper contracts |
@0x/dev-utils |
 |
Dev utils to be shared across 0x packages |
@0x/fill-scenarios |
 |
0x order fill scenario generator |
Private Packages
| Package | Description |
|---|---|
@0x/contracts |
0x protocol solidity smart contracts & tests |
@0x/instant |
A free and flexible way to offer simple crypto purchasing in any app or website. |
@0x/testnet-faucets |
A faucet micro-service that dispenses test ERC20 tokens or Ether |
@0x/website |
0x website |
Usage
Node version >= 6.12 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"],
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:
brew install yarn@1.9.4
Then install dependencies
yarn install
Build
To build all packages:
yarn build
To build a specific package:
PKG=@0x/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=@0x/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=@0x/web3-wrapper yarn test