F. Eugene Aumson d1975bd5dd contract-artifacts: add devdoc to ERC20Token.json
Artifact changes crafted manually: re-generated artifacts from within
@0x/contracts-erc20, and then copied them into @0x/contract-artifacts,
but only committed the changes that added devdoc.

Modified @0x/contracts-erc20/compiler.json to include devdoc in the
hopes that next time contract-artifacts are re-generated en masse, the
devdoc output will just come along for the ride.

Compiling ERC20 TypeScript wrappers after adding devdoc to the artifacts
revealed some inconsistencies in the types.  ethereum-types'
DevdocOutput REQUIRED many fields which are not always present,
depending the devdoc contents itself.  Relaxing the requirement had some
ramifications.
2019-06-27 21:08:54 -07:00
..
2019-03-28 14:00:38 +01:00
2019-05-24 16:59:43 +01:00
2019-05-24 16:59:43 +01:00
2019-05-24 16:59:56 +01:00
2019-03-07 19:36:26 -08:00

ERC20 Tokens

This package contains implementations of various ERC20 tokens, including WETH (Wrapped Ether) and ZRX. Addresses of the deployed contracts can be found in the 0x wiki or the DEPLOYS file within this package.

Installation

Install

npm install @0x/contracts-erc20 --save

Bug bounty

A bug bounty for the 2.0.0 contracts is ongoing! Instructions can be found here.

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.

For proposals regarding the 0x protocol's smart contract architecture, message format, or additional functionality, go to the 0x Improvement Proposals (ZEIPs) repository and follow the contribution guidelines provided therein.

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

To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:

PKG=@0x/contracts-erc20 yarn build

Or continuously rebuild on change:

PKG=@0x/contracts-erc20 yarn watch

Clean

yarn clean

Lint

yarn lint

Run Tests

yarn test

Testing options

Contracts testing options like coverage, profiling, revert traces or backing node choosing - are described here.