0de2b6983b
* Stop restarting node unnecesssarily during test * Add new, empty LibAssetData * Support encoding & decoding of ERC20 asset data * Support encoding & decoding of ERC721 asset data * Support encoding & decoding of ERC1155 asset data * Support encoding & decoding of multi-asset data * Support querying ERC20 balance from asset data * Support querying ERC721 balance from asset data * Support querying ERC1155 balance from asset data * Support querying balance from multi-asset data * Support querying ERC20 allowance from asset data * Support querying ERC721 allowance from asset data * Support querying ERC1155 allowance from asset data * In tests, wait for allowance set before checking * Introduce temporary variable `assetDataBody` * Handle edge case in multi-asset balance query * Support multi-asset allowance query by asset data * Move variable declaration up for readability. * Make all solhint-disable's cite specific rules And move the directives to the ends of lines whenever possible * Rename query tests to include " by asset data" * Extract test helper method * Extract another test helper method * Support batch queries of allowances & balances * In LibAssetData.sol, use IERC1155, not ...Mintable * Rename balance*() return vars: amount -> balance * Fix bug in ERC721 balance query Was using method balanceOf(), but needed to be using ownerOf(). getERC721TokenOwner() method lifted from @0x/extensions/contracts/src/OrderValidator/OrderValidator.sol * Reuse new en/decoders; avoid abi.decode(). * Start lowest allowance/balance from 0, not MAX_INT * Properly implement ERC1155 balance querying * Split lines for readability * Also check isApprovedForAll in 721 allowance query * Add neglected division of allowances by amounts * Rename methods: balanceOf -> getBalance * Rename methods: allowance -> getAllowance * Add methods: getBalanceAndAllowance() & batch...() * Rename return vars: amount -> allowance * Add devdoc comments * Rename batchGet* methods to getBatch* * Remove refactoring relic * Add revert messages to all require() calls * Reduce gas usage for ERC1155 asset data decoding * Don't use dockerized solc for ERC20 contracts Because they demand solc version 0.4.26, and it seems as though the tag for that version has been deleted from dockerhub. Without this, @0x/contracts-erc20 was failing to build. * Rename batch functions to use plurals * Skip dockerized solc for contracts needing 0.4.26 I seems as though the tag for that version has been deleted from dockerhub. Without this, these contracts were failing to build. * Make revert reasons follow snake case convention
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 |
Solidity Packages
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 |
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-coverage |
 |
A solidity test coverage tool |
@0x/sol-profiler |
 |
A solidity gas cost profiler |
@0x/sol-trace |
 |
A solidity stack trace 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/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
To build all contracts packages:
yarn build:contracts
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
Run all contracts packages tests:
yarn test:contracts