Fabio Berger 1817f6eaf6 Merge branch 'development' into extractDocs
* development: (22 commits)
  Fix bugs in postpublish_utils.js
  Update @0xproject/utils in top-level package.json
  Changelog tweaks
  Publish
  Updated CHANGELOGS
  Fix typo
  Add PR number to changelog entry
  Add changelog update to subproviders package
  Add `numberOfAccounts` param to `LedgerSubprovider` method `getAccountsAsync` and add tests
  Remove unnecessary type assertion
  Move web3 typings from devDeps to deps
  remove extrenuous comma
  Add PR number
  Add changelog entries from types and utils
  Add changelog entry to subproviders
  Remove extra comma
  Move web3 and ethers types to deps for utils package
  Make web3 typings a dep for web3Wrapper
  Make web3 typings a dep for subproviders
  reorder deps
  ...

# Conflicts:
#	packages/website/package.json
2018-03-05 06:20:15 +01:00
2018-01-18 14:34:35 +01:00
2018-03-04 21:24:47 +01:00
2018-02-05 10:25:05 -08:00
2018-02-20 13:42:35 -08:00
2018-01-03 11:37:38 +01:00
2017-05-23 19:17:35 +02:00
2018-02-27 15:08:52 -08:00
2018-01-10 11:24:37 +01:00
2018-03-03 20:09:09 +01:00


0x is an open protocol that facilitates trustless, low friction exchange of Ethereum-based assets. A full description of the protocol may be found in our whitepaper.

This repository is a monorepo including the 0x protocol smart contracts and numerous developer tools. Each public sub-package is independently published to NPM.

CircleCI Coverage Status Discord Join the chat at https://gitter.im/0xProject/Lobby License Greenkeeper badge

Published Packages

Package Version Description
0x.js npm A Javascript library for interacting with the 0x protocol
chai-as-promised-typescript-typings npm Chai as promised typescript typings
chai-typescript-typings npm Chai typescript typings
web3-typescript-typings npm Web3 typescript typings
@0xproject/abi-gen npm Tool to generate TS wrappers from smart contract ABIs
@0xproject/assert npm Type and schema assertions used by our packages
@0xproject/connect npm A Javascript library for interacting with the standard relayer api
@0xproject/dev-utils npm Dev utils to be shared across 0x projects and packages
@0xproject/json-schemas npm 0x-related json schemas
@0xproject/subproviders npm Useful web3 subproviders (e.g LedgerSubprovider)
@0xproject/tslint-config npm Custom 0x development TSLint rules
@0xproject/types npm Shared type declarations
@0xproject/utils npm Shared utilities
@0xproject/web3-wrapper npm Web3 wrapper

Private Packages

Package Description
@0xproject/contracts 0x solidity smart contracts & tests
@0xproject/monorepo-scripts Shared monorepo scripts
@0xproject/testnet-faucets A faucet micro-service that dispenses test ERC20 tokens or Ether
@0xproject/website 0x website & Portal DApp

Usage

Dedicated documentation pages:

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.

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

Build all packages

yarn lerna:run build

Continuously rebuild on exchange

yarn dev

Lint

Lint all packages

yarn lerna:run lint

Run Tests

Before running the tests, you will need to spin up a TestRPC instance and deploy all the 0x smart contracts.

In a separate terminal, start TestRPC (a convenience command is provided as part of this repo)

yarn testrpc

Then in your main terminal run

cd packages/contracts
yarn migrate
cd ..

And finally from the root project directory run

yarn lerna:run test
Description
protocol for MEV related stuff
Readme 166 MiB
Languages
TypeScript 59.4%
Solidity 31.6%
MDX 9%