protocol

History

Lawrence Forman b7b457b076

Generate (complete) solidity docs (#2391 )

* `@0x/sol-doc`: New doc generator.

* `@0x/sol-compiler`: Be more tolerant of AST-only compilation targets.

* `@0x/contracts-exchange`: Add more devdoc comments.
`@0x/contracts-exchange-libs`: Add more devdoc comments.

* `@0x/sol-doc`: Update package script.

* `@0x/sol-doc`: Remove unused files and update package scripts to be easier to configure.

* Add more devdocs to contracts.

* `@0x/sol-doc`: Remove doc artifacts.

* `@0x/sol-doc`: Add `.gitignore` and `.npmignore`.

* `@0x/contracts-exchange`: Fix compilation errors.

* Fix more broken contracts.

* `@0x/contracts-erc20-bridge-sampler`: Fix failing tests.

* `@0x/contracts-asset-proxy`: Remove accidentally introduced hackathion file (lol).

* `@0x/sol-doc`: Prevent some inherited contracts from being included in docs unintentionally.

* `@0x/sol-doc`: Rename test file.

* `@0x/contracts-exchange`: Update `orderEpoch` devdoc.

* `@0x/sol-doc`: Tweak event and function docs.

* Update CODEOWNERS.

* `@0x/sol-doc` Tweak function md generation.

* `@0x/sol-doc`: add `transformDocs()` tests.

* `@0x/sol-doc`: add `extract_docs` tests.

* `@0x/sol-doc` Fix linter errors.

* `@0x/contracts-erc20-bridge-sampler`: Fix broken `ERC20BridgeSampler.sol` compile.

* `@0x/sol-doc` Fix mismatched `dev-utils` dep version.

* `@0x/sol-doc`: Add `gen_md` tests.

* `@0x/sol-doc`: Remove `fs.promises` calls.

* `@0x/sol-doc`: Fix linter errors.

* `@0x/sol-doc`: Export all relevant types and functions.

Co-authored-by: Lawrence Forman <me@merklejerk.com>

2020-01-03 22:59:18 -05:00

contracts

Generate (complete) solidity docs (#2391 )

2020-01-03 22:59:18 -05:00

src

Remove moved RevertErrors

2019-11-27 11:52:14 +11:00

test

Remove assetDataUtils everywhere (#2373 )

2019-12-04 13:08:08 -08:00

.npmignore

Improve comment in npmignores

2019-11-12 11:47:11 +00:00

CHANGELOG.json

Updated CHANGELOGS & MD docs

2019-12-16 16:05:03 -08:00

CHANGELOG.md

Updated CHANGELOGS & MD docs

2019-12-16 16:05:03 -08:00

compiler.json

Update all contracts-*is package.json, tsconfig.json, compiler.json, artifacts/ts and wrappers.js

2019-11-10 23:41:56 +00:00

package.json

Publish

2019-12-16 16:05:16 -08:00

README.md

Update DEPLOYS and READMEs within each package

2019-01-22 13:37:14 -08:00

truffle-config.js

Add truffle compile option to contract packages

2019-08-20 12:49:33 -07:00

tsconfig.json

Added unit tests for onlyAuthorized

2019-11-25 14:02:53 -06:00

tslint.json

Refactor @0x/contracts-utils from @0x/contracts-core

2018-12-04 14:41:18 +01:00

README.md

Contracts utils

This package contains smart contract utilities and libraries that are used throughout the entire codebase of smart contracts. These contracts are all generic and may helpful to use outside of the context of 0x protocol.

Installation

Install

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

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-utils yarn build

Or continuously rebuild on change:

PKG=@0x/contracts-utils 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.