protocol/packages/contract-artifacts
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-04-04 12:30:40 +01:00
2019-05-10 14:12:19 -03:00

@0x/contract-artifacts

Smart contract compilation artifacts for the latest version of the 0x Protocol.

Installation

yarn add @0x/contract-artifacts

Import

import * as artifacts from '@0x/contract-artifacts';

or

var artifacts = require('@0x/contract-artifacts');

Contributing

We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository.

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/contract-artifacts yarn build

Clean

yarn clean

Lint

yarn lint

Run Tests

yarn test