eb5f514d25
* development: (51 commits) [instant] Viewport specific errors (#1228) Added more comments Include wholeNumberSchema in sra-spec schemas chore(instant): fix linter Fix isNode fix(instant): update buy quote at start up in the case of default amount chore(instant): increase max bundle size for bundle watch Small code review tweaks fix: apply css reset to overlay as well fix(website): turn off production flag when building locally feat(instant): add Account to the ProviderState feat(instant): fallback to an empty wallet provider when none is injected [order_utils.py] is_signature_valid, via Exchange contract (#1216) chore: linter fix: progress bar fix: use fontSize prop in button feat: make instant resistant to external styles chore(instant): update OrderState enum to follow capitalization conventions feat: add faux externall css file Take out unneeded conditionals ...
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.
If you're developing on 0x now or are interested in using 0x infrastructure in the future, please join our developer mailing list for updates.
Published Packages
| Package | Version | Description |
|---|---|---|
0x.js |
 |
A Javascript library for interacting with the 0x protocol |
@0x/abi-gen |
 |
Tool to generate TS wrappers from smart contract ABIs |
@0x/abi-gen-wrappers |
 |
Low-level 0x smart contract wrappers generated using @0x/abi-gen |
@0x/assert |
 |
Type and schema assertions used by our packages |
@0x/asset-buyer |
 |
Convenience package for discovering and buying assets with Ether |
@0x/base-contract |
 |
BaseContract used by auto-generated abi-gen wrapper contracts |
@0x/connect |
 |
A Javascript library for interacting with the Standard Relayer API |
@0x/contract-addresses |
 |
Used to get known addresses of deployed 0x contracts |
@0x/contract-artifacts |
 |
0x smart contract compilation artifacts |
@0x/contract-wrappers |
 |
Smart TS wrappers for 0x smart contracts |
@0x/dev-utils |
 |
Dev utils to be shared across 0x projects and packages |
@0x/fill-scenarios |
 |
0x order fill scenario generation |
@0x/json-schemas |
 |
0x-related json schemas |
@0x/migrations |
 |
0x smart contract migrations |
@0x/order-utils |
 |
A set of utilities for generating, parsing, signing and validating 0x orders |
@0x/order-watcher |
 |
An order watcher daemon that watches for order validity |
@0x/react-docs |
 |
React documentation component for rendering TypeDoc & Doxity generated JSON |
@0x/react-shared |
 |
0x shared react components |
@0x/sol-compiler |
 |
A thin wrapper around Solc.js that outputs artifacts, resolves imports, only re-compiles when needed, and other niceties |
@0x/sol-cov |
 |
Solidity test coverage tool |
@0x/sol-doc |
 |
Solidity documentation generator |
@0x/sol-resolver |
 |
Import resolver for smart contracts dependencies |
@0x/sra-spec |
 |
OpenAPI specification for the standard relayer API |
@0x/subproviders |
 |
Useful web3 subproviders (e.g. LedgerSubprovider) |
@0x/tslint-config |
 |
Custom 0x development TSLint rules |
@0x/types |
 |
Shared type declarations |
@0x/typescript-typings |
 |
Repository of types for external packages |
@0x/utils |
 |
Shared utilities |
@0x/web3-wrapper |
 |
Web3 wrapper |
Private Packages
| Package | Description |
|---|---|
@0x/contracts |
0x solidity smart contracts & tests |
@0x/react-docs-example |
Example documentation site created with @0x/react-docs |
@0x/testnet-faucets |
A faucet micro-service that dispenses test ERC20 tokens or Ether |
@0x/website |
0x website & Portal DApp |
Usage
Dedicated documentation pages:
- 0x.js Library
- 0x Connect
- Smart contracts
- Subproviders
- Sol Compiler
- Web3-wrapper
- JSON-schemas
- Sol-cov
- Standard Relayer API
Node version >= 6.12 is required.
Most of the packages require additional typings for external dependencies.
You can include those by prepending the @0x/typescript-typings package to your typeRoots config.
"typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"],
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.
Read our contribution guidelines.
Install dependencies
Make sure you are using Yarn v1.9.4. To install using brew:
brew install yarn@1.9.4
Then install dependencies
yarn install
Build
To build all packages:
yarn build
To build a specific package:
PKG=@0x/web3-wrapper yarn build
Watch
To re-build all packages on change:
yarn watch
To watch a specific package and all it's dependent packages:
PKG=[NPM_PACKAGE_NAME] yarn watch
e.g
PKG=@0x/web3-wrapper yarn watch
Clean
Clean all packages:
yarn clean
Clean a specific package
PKG=0x.js yarn clean
Rebuild
To re-build (clean & build) all packages:
yarn rebuild
To re-build (clean & build) a specific package & it's deps:
PKG=0x.js yarn rebuild
Lint
Lint all packages:
yarn lint
Lint a specific package:
PKG=0x.js yarn lint
Run Tests
Run all tests:
yarn test
Run a specific package's test:
PKG=@0x/web3-wrapper yarn test