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

fix CI failures

2019-12-10 00:32:48 -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

First pass contracts-* separation of test and publish artifacts/wrappers

2019-11-10 17:22:29 +00:00

DEPLOYS.json

Update DEPLOYS and READMEs within each package

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

package.json

Publish

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

README.md

Merge development into 3.0 (#2170 )

2019-09-19 19:43:08 -07:00

truffle-config.js

Add truffle compile option to contract packages

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

tsconfig.json

Refactor integrations directory structure; move core.ts, balance stores, and FillOrderWrapper to integrations

2019-11-15 09:49:20 -08:00

tslint.json

`@0x/contracts-exchange-libs: Appease the linter and prettier gods.

2019-08-06 15:30:59 -04:00

typedoc-tsconfig.json

Add doc generation to several more packages and fix up their index.ts files so all public interface types are exported

2019-11-18 10:29:25 +00:00

README.md

Exchange

This package contains the implementation of the Exchange. This contract is responsible for settling trades and is typically the entry point for all transactions that interact with the 0x protocol. Lightweight examples of how external contracts can interct with the Exchange contract can be found in the examples directory. Addresses of the deployed contracts can be found in this 0x guide or the DEPLOYS file within this package.

Installation

Install

npm install @0x/contracts-exchange --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-exchange yarn build

Or continuously rebuild on change:

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