Skip to content

0x protocol monorepo - includes our smart contracts and many developer tools

License

Notifications You must be signed in to change notification settings

clu8/0x-monorepo

 
 

Repository files navigation


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
@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/base-contract npm BaseContract used by auto-generated abi-gen wrapper contracts
chai-as-promised-typescript-typings npm Chai as promised typescript typings
chai-typescript-typings npm Chai typescript typings
@0xproject/connect npm A Javascript library for interacting with the Standard Relayer API
@0xproject/deployer npm Solidity project compiler and deployer framework
@0xproject/dev-utils npm Dev utils to be shared across 0x projects and packages
ethers-typescript-typings npm Ethers.js typescript typings
@0xproject/json-schemas npm 0x-related json schemas
@0xproject/react-docs npm React documentation component for rendering TypeDoc & Doxity generated JSON
@0xproject/react-shared npm 0x shared react components
@0xproject/sra-report npm Generate reports for standard relayer API compliance
@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
web3-typescript-typings npm Web3 typescript typings
@0xproject/web3-wrapper npm Web3 wrapper

Private Packages

Package Description
@0xproject/contracts 0x solidity smart contracts & tests
@0xproject/react-docs-example Example documentation site created with @0xproject/react-docs
@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

About

0x protocol monorepo - includes our smart contracts and many developer tools

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 86.9%
  • Solidity 8.4%
  • CSS 2.4%
  • JavaScript 1.8%
  • HTML 0.5%