619123720c
* development: (31 commits) Publish Update CHANGELOG Fix the typos Added PR number to web3 typings changelog Update the CHANGELOG Fix fillOrdersUpTo balances validation Add a regression test for fillUpToValidation Fix web3 typing defaultAccount not allowing `undefined` Sort packages alphabetically in README Add postpublish scripts Return after checking for an error and add an explanatory comment Stop appending /v0 to HttpClient api endpoint urls Add chai-as-promised-typescript-typings Remove redundant type refs Improve HttpClient errors Add web3-typescript-typings and chai-as-promised-typescript-typings to the main monorepo Import chai-as-promised-typescript-typings Fix @bmilman linkedin link Add new team photos Add a CHANGELOG to a website ...
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 contains all the 0x developer tools written in TypeScript. Our hope is that these tools make it easy to build Relayers and other DApps that use the 0x protocol.
Published Packages
| Package | Version | Description |
|---|---|---|
0x.js |
 |
A Javascript library for interacting with the 0x protocol |
chai-as-promised-typescript-typings |
 |
Chai as promised typescript typings |
chai-typescript-typings |
 |
Chai typescript typings |
web3-typescript-typings |
 |
Web3 typescript typings |
@0xproject/abi-gen |
 |
Tool to generate TS wrappers from smart contract ABIs |
@0xproject/assert |
 |
Type and schema assertions used by our packages |
@0xproject/connect |
 |
A Javascript library for interacting with the standard relayer api |
@0xproject/json-schemas |
 |
0x-related json schemas |
@0xproject/subproviders |
 |
Useful web3 subproviders (e.g LedgerSubprovider) |
@0xproject/tslint-config |
 |
Custom 0x development TSLint rules |
@0xproject/types |
 |
Shared type declarations |
@0xproject/utils |
 |
Shared utilities |
@0xproject/web3-wrapper |
 |
Web3 wrapper |
Private Packages
| Package | Description |
|---|---|
@0xproject/contracts |
0x solidity smart contracts & tests |
@0xproject/kovan_faucets |
A faucet micro-service that dispenses test ERC20 tokens or Ether |
@0xproject/monorepo-scripts |
Shared monorepo scripts |
@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
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