9f30823d70
* Strip erc20 package of legacy nonsense and add foundry basics * Make foundry build * Remove obsoleted test/UntransferrableDummyERC20Token.sol contract * Remove obsoleted ERC20 lib variant contracts * Remove obsoleted DummyMultipleReturnERC20Token and DummyNoReturnERC20Token contracts * Move test contract to dedicated folder and remove obsoleted TypeScript contract wrappers * Remove src/interfaces/IEtherToken.sol only used in v3 staking which is being obsoleted [skip ci] * Add foundry test for token * Migrate ZRX token tests to foundry * Fix paths to erc20 contracts * Remove obsoleted references * Pin erc20-contracts package on treasury * Ignore foundry imports in link checker * Run only forge tests for erc20 contracts * Remove DummyERC20Token and its dependencies * Merge IERC20TokenV06 and IERC20TokenV08 into range pragma to cover solidity 0.6.5 to 0.8.x * Merge IEtherTokenV06 and IEtherTokenV08 into range pragma to cover solidity 0.6.5 to 0.8.x * Migrate weth9 tests to foundry * Upload code coverage for erc20 package * Update changelog * Fix review comments Co-authored-by: duncancmt <1207590+duncancmt@users.noreply.github.com> --------- Co-authored-by: duncancmt <1207590+duncancmt@users.noreply.github.com>
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.
Packages
Visit our developer portal for a comprehensive list of core & community maintained packages. All packages maintained with this monorepo are listed below.
Solidity Packages
These packages are all under development. See /contracts/README.md for a list of deployed packages.
| Package | Version | Description |
|---|---|---|
@0x/contracts-zero-ex |
 |
The contracts used for settling trades within the protocol |
@0x/contracts-erc20 |
 |
Implementations of various ERC20 tokens |
@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 |
TypeScript/Javascript Packages
0x-specific packages
| Package | Version | Description |
|---|---|---|
@0x/protocol-utils |
 |
A set of utilities for generating, parsing, signing and validating 0x orders |
@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/contract-artifacts |
 |
0x smart contract compilation artifacts |
Usage
Node version 6.x or 8.x 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/protocol-utils 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/protocol-utils yarn watch
Clean
Clean all packages:
yarn clean
Clean a specific package
PKG=@0x/protocol-utils 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/protocol-utils yarn rebuild
Lint
Lint all packages:
yarn lint
Lint a specific package:
PKG=@0x/protocol-utils yarn lint
Run Tests
Run all tests:
yarn test
Run a specific package's test:
PKG=@0x/protocol-utils yarn test
Run all contracts packages tests:
yarn test:contracts