Skip to content

jmpmonteagudo/contracts

 
 

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 contains the system of Ethereum smart contracts comprising 0x protocol's shared on-chain settlement layer, native token (ZRX) and decentralized governance structure. Truffle is used for deployment. Mocha is used for unit tests.

Slack Status Join the chat at https://gitter.im/0xProject/contracts License

Table of Contents

Architecture

Contracts

Descriptions

Exchange contains all business logic associated with executing trades and cancelling orders. Exchange accepts orders that conform to 0x message format, allowing for off-chain order relay with on-chain settlement. Exchange is designed to be replaced as protocol improvements are adopted over time. It follows that Exchange does not have direct access to ERC20 token allowances; instead, all transfers are carried out by Proxy on behalf of Exchange.

Proxy is analagous to a valve that may be opened or shut by MultiSigWalletWithTimeLock, either allowing or preventing Exchange from executing trades. Proxy plays a key role in 0x protocol's update mechanism: old versions of the Exchange contract may be deprecated, preventing them from executing further trades. New and improved versions of the Exchange contract are given permission to execute trades through decentralized governance implemented within a DAO (for now we use MultiSigWallet as a placeholder for DAO).

MultiSigWalletWithTimeLock is a temporary placeholder contract that will be replaced by a thoroughly researched, tested and audited DAO. MultiSigWalletWithTimeLock is based upon the MultiSigWallet contract developed by the Gnosis team, but with an added mandatory time delay between when a proposal is approved and when that proposal may be executed. This speed bump ensures that the multi sig owners cannot conspire to push through a change to 0x protocol without end users having sufficient time to react. MultiSigWalletWithTimeLock is the only entity with permission to grant or revoke access to the Proxy and, by extension, ERC20 token allowances. MultiSigWalletWithTimeLock is assigned as the owner of Proxy and, once a suitable DAO is developed, MultiSigWalletWithTimeLock will call Proxy.transferOwnership(DAO) to transfer permissions to the DAO.

TokenRegistry stores metadata associated with ERC20 tokens. TokenRegistry entries may only be created/modified/removed by MultiSigWallet (until it is replaced by a suitable DAO), meaning that information contained in the registry will generally be trustworthy. 0x message format is not human-readable making it difficult to visually verify order parameters (token addresses and exchange rates); the TokenRegistry can be used to quickly verify order parameters against audited metadata.

Deployed Addresses

Kovan

Protocol Specification

Message Format

Each order is a data packet containing order parameters and an associated signature. Order parameters are concatenated and hashed to 32 bytes via the Keccak SHA3 function. The order originator signs the order hash with their private key to produce an ECDSA signature.

Name Data Type Description
version address Address of the Exchange contract. This address will change each time the protocol is updated.
maker address Address originating the order.
taker address Address permitted to fill the order (optional).
tokenM address Address of an ERC20 Token contract.
tokenT address Address of an ERC20 Token contract.
valueM uint256 Total units of tokenM offered by maker.
valueT uint256 Total units of tokenT requested by maker.
expiration uint256 Time at which the order expires (seconds since unix epoch).
salt uint256 Arbitrary number that allows for uniqueness of the order's Keccak SHA3 hash.
feeRecipient address Address that recieves transaction fees (optional).
feeM uint256 Total units of ZRX paid to feeRecipient by maker.
feeT uint256 Total units of ZRX paid to feeRecipient by taker.
v uint8 ECDSA signature of the above arguments.
r bytes32 ECDSA signature of the above arguments.
s bytes32 ECDSA signature of the above arguments.

Setup

Installing Dependencies

Install Node v6.9.1

Install ethereumjs-testrpc

npm i -g ethereumjs-testrpc@^3.0.2

Install project dependencies:

npm install

Running Tests

Start Testrpc

testrpc --networkId 50

Compile contracts

npm run compile

Run tests

npm run test

Contributing

Coding conventions

We use a custom set of TSLint rules to enforce our coding conventions.

In order to see style violation errors, install a tslinter for your text editor. e.g Atom's atom-typescript.

About

0x smart contracts and tests.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 99.6%
  • JavaScript 0.4%