gsoc2013-evolution - Google Summer of Code 2013 - GNOME

0x is an open protocol that facilitates trustless, low friction exchange of Ethereum-based assets. For more information on how it works, check out the 0x protocol specification.

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.

Packages

Visit our developer portal for a comprehensive list of core & community maintained packages. All packages maintained with this monorepo are listed below.

Python Packages

Package	Version	Description
`0x-contract-addresses`		A tiny utility library for getting known deployed contract addresses for a particular network
`0x-contract-artifacts`		0x smart contract compilation artifacts
`0x-json-schemas`		0x-related JSON schemas
`0x-order-utils`		A set of utilities for generating, parsing, signing and validating 0x orders
`0x-sra-client`		A Python client for interacting with servers conforming to the Standard Relayer API specification

Typescript/Javascript Packages

0x-specific packages

Package	Version	Description
`0x.js`		An aggregate package combining many smaller utility packages for interacting with the 0x protocol
`@0x/contract-addresses`		A tiny utility library for getting known deployed contract addresses for a particular network.
`@0x/contract-wrappers`		JS/TS wrappers for interacting with the 0x smart contracts
`@0x/order-utils`		A set of utilities for generating, parsing, signing and validating 0x orders
`@0x/json-schemas`		0x-related JSON schemas
`@0x/order-watcher`		An order watcher daemon that watches for order validity
`@0x/migrations`		Migration tool for deploying 0x smart contracts on private testnets
`@0x/contract-artifacts`		0x smart contract compilation artifacts
`@0x/abi-gen-wrappers`		Low-level 0x smart contract wrappers generated using `@0x/abi-gen`
`@0x/sra-spec`		OpenAPI specification for the Standard Relayer API
`@0x/connect`		An HTTP/WS client for interacting with the Standard Relayer API
`@0x/asset-buyer`		Convenience package for discovering and buying assets with Ether

Ethereum tooling

Package	Version	Description
`@0x/web3-wrapper`		An Ethereum JSON RPC client
`@dexon-foundation/sol-compiler`		A wrapper around solc-js that adds smart re-compilation, ability to compile an entire project, Solidity version specific compilation, standard input description support and much more.
`@dexon-foundation/sol-coverage`		A solidity test coverage tool
`@dexon-foundation/sol-profiler`		A solidity gas cost profiler
`@0x/sol-trace`		A solidity stack trace tool
`@0x/sol-resolver`		Import resolver for smart contracts dependencies
`@dexon-foundation/subproviders`		Web3 provider middlewares (e.g. LedgerSubprovider)
`@dexon-foundation/sol-doc`		Solidity documentation generator

Utilities

Package	Version	Description
`@0x/abi-gen`		Tool to generate TS wrappers from smart contract ABIs
`@0x/tslint-config`		Custom TSLint rules used by the 0x core team
`@0x/types`		Shared type declarations
`@0x/typescript-typings`		Repository of types for external packages
`@0x/utils`		Shared utilities
`@0x/react-docs`		React documentation component for rendering TypeDoc & sol-doc generated JSON
`@0x/react-shared`		0x shared react components
`@0x/assert`		Type and schema assertions used by our packages
`@0x/base-contract`		BaseContract used by auto-generated `abi-gen` wrapper contracts
`@0x/dev-utils`		Dev utils to be shared across 0x packages
`@0x/fill-scenarios`		0x order fill scenario generator

Private Packages

Package	Description
`@0x/contracts`	0x protocol solidity smart contracts & tests
`@0x/instant`	A free and flexible way to offer simple crypto purchasing in any app or website.
`@0x/testnet-faucets`	A faucet micro-service that dispenses test ERC20 tokens or Ether
`@0x/website`	0x website

Usage

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"],

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

	Commit message (Expand)	Author	Age	Files	Lines
*	Remove 3 leftover references to non-existing libraries	Fridrich Štrba	2010-04-23	1	-4/+0
*	Make the gconf schemas installation rules consistent in all Makefiles.am	Fridrich Strba	2010-03-16	1	-10/+12
*	Actually respect the --disable-schemas-install configure option	Fridrich Strba	2010-03-15	1	-0/+4
*	Compiler and linker flag cleanups.	Matthew Barnes	2009-12-28	1	-20/+23
*	Bug 589153 - Use GtkBuilder instead of libglade	Matthew Barnes	2009-11-17	1	-5/+5
*	Bug 596848 - Use per-target CPPFLAGS in automake files	H.Habighorst	2009-10-01	1	-3/+4
*	Bug 593776 - Fix include of a11y/addressbook and a11y/calendar	H.Habighorst	2009-09-01	1	-1/+0
*	Simplify EPlugin loading at startup.	Matthew Barnes	2009-08-30	1	-0/+2
*	Add new preferences missed during the 2.27.90 merge.	Matthew Barnes	2009-08-13	1	-0/+2
*	Fix "make distcheck" errors and other build cleanups.	Matthew Barnes	2009-07-01	1	-1/+1
*	Radically reorganize source code.	Matthew Barnes	2009-06-25	1	-0/+129