Merge pull request #906 from 0xProject/refactor/contracts/examples

[contracts] Add `examples` directory

7 files changed, 64 insertions, 359 deletions

diff --git a/packages/contracts/src/2.0.0/test/DummyERC20Token/DummyERC20Token.sol b/packages/contracts/src/2.0.0/test/DummyERC20Token/DummyERC20Token.sol
index 97801166a..9272b18a8 100644
--- a/packages/contracts/src/2.0.0/test/DummyERC20Token/DummyERC20Token.sol
+++ b/packages/contracts/src/2.0.0/test/DummyERC20Token/DummyERC20Token.sol
@@ -22,7 +22,10 @@ import "../Mintable/Mintable.sol";
 import "../../utils/Ownable/Ownable.sol";
 
 
-contract DummyERC20Token is Mintable, Ownable {
+contract DummyERC20Token is 
+    Mintable,
+    Ownable
+{
     string public name;
     string public symbol;
     uint256 public decimals;
diff --git a/packages/contracts/src/2.0.0/test/ExchangeWrapper/ExchangeWrapper.sol b/packages/contracts/src/2.0.0/test/ExchangeWrapper/ExchangeWrapper.sol
deleted file mode 100644
index 2fa0e3c5e..000000000
--- a/packages/contracts/src/2.0.0/test/ExchangeWrapper/ExchangeWrapper.sol
+++ /dev/null
@@ -1,100 +0,0 @@
-/*
-
-  Copyright 2018 ZeroEx Intl.
-
-  Licensed under the Apache License, Version 2.0 (the "License");
-  you may not use this file except in compliance with the License.
-  You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-  Unless required by applicable law or agreed to in writing, software
-  distributed under the License is distributed on an "AS IS" BASIS,
-  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-  See the License for the specific language governing permissions and
-  limitations under the License.
-
-*/
-
-pragma solidity 0.4.24;
-pragma experimental ABIEncoderV2;
-
-import "../../protocol/Exchange/interfaces/IExchange.sol";
-import "../../protocol/Exchange/libs/LibOrder.sol";
-
-
-contract ExchangeWrapper {
-
-    // Exchange contract.
-    // solhint-disable-next-line var-name-mixedcase
-    IExchange internal EXCHANGE;
-
-    constructor (address _exchange)
-        public
-    {
-        EXCHANGE = IExchange(_exchange);
-    }
-
-    /// @dev Cancels all orders created by sender with a salt less than or equal to the targetOrderEpoch
-    ///      and senderAddress equal to this contract.
-    /// @param targetOrderEpoch Orders created with a salt less or equal to this value will be cancelled.
-    /// @param salt Arbitrary value to gaurantee uniqueness of 0x transaction hash.
-    /// @param makerSignature Proof that maker wishes to call this function with given params.
-    function cancelOrdersUpTo(
-        uint256 targetOrderEpoch,
-        uint256 salt,
-        bytes makerSignature
-    )
-        external
-    {
-        address makerAddress = msg.sender;
-
-        // Encode arguments into byte array.
-        bytes memory data = abi.encodeWithSelector(
-            EXCHANGE.cancelOrdersUpTo.selector,
-            targetOrderEpoch
-        );
-
-        // Call `cancelOrdersUpTo` via `executeTransaction`.
-        EXCHANGE.executeTransaction(
-            salt,
-            makerAddress,
-            data,
-            makerSignature
-        );
-    }
-
-    /// @dev Fills an order using `msg.sender` as the taker.
-    /// @param order Order struct containing order specifications.
-    /// @param takerAssetFillAmount Desired amount of takerAsset to sell.
-    /// @param salt Arbitrary value to gaurantee uniqueness of 0x transaction hash.
-    /// @param orderSignature Proof that order has been created by maker.
-    /// @param takerSignature Proof that taker wishes to call this function with given params.
-    function fillOrder(
-        LibOrder.Order memory order,
-        uint256 takerAssetFillAmount,
-        uint256 salt,
-        bytes memory orderSignature,
-        bytes memory takerSignature
-    )
-        public
-    {
-        address takerAddress = msg.sender;
-
-        // Encode arguments into byte array.
-        bytes memory data = abi.encodeWithSelector(
-            EXCHANGE.fillOrder.selector,
-            order,
-            takerAssetFillAmount,
-            orderSignature
-        );
-
-        // Call `fillOrder` via `executeTransaction`.
-        EXCHANGE.executeTransaction(
-            salt,
-            takerAddress,
-            data,
-            takerSignature
-        );
-    }
-}
diff --git a/packages/contracts/src/2.0.0/test/TestAssetProxyDispatcher/TestAssetProxyDispatcher.sol b/packages/contracts/src/2.0.0/test/TestAssetProxyDispatcher/TestAssetProxyDispatcher.sol
index 07986f4bb..ad71fc9a1 100644
--- a/packages/contracts/src/2.0.0/test/TestAssetProxyDispatcher/TestAssetProxyDispatcher.sol
+++ b/packages/contracts/src/2.0.0/test/TestAssetProxyDispatcher/TestAssetProxyDispatcher.sol
@@ -21,7 +21,9 @@ pragma solidity 0.4.24;
 import "../../protocol/Exchange/MixinAssetProxyDispatcher.sol";
 
 
-contract TestAssetProxyDispatcher is MixinAssetProxyDispatcher {
+contract TestAssetProxyDispatcher is 
+    MixinAssetProxyDispatcher
+{
     function publicDispatchTransferFrom(
         bytes memory assetData,
         address from,
diff --git a/packages/contracts/src/2.0.0/test/TestConstants/TestConstants.sol b/packages/contracts/src/2.0.0/test/TestConstants/TestConstants.sol
new file mode 100644
index 000000000..1275d007b
--- /dev/null
+++ b/packages/contracts/src/2.0.0/test/TestConstants/TestConstants.sol
@@ -0,0 +1,57 @@
+/*
+
+  Copyright 2018 ZeroEx Intl.
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+
+*/
+
+pragma solidity 0.4.24;
+
+import "../../utils/LibBytes/LibBytes.sol";
+
+
+// solhint-disable max-line-length
+contract TestConstants {
+   
+    using LibBytes for bytes;
+
+    bytes4 constant internal ERC20_PROXY_ID = bytes4(keccak256("ERC20Token(address)"));
+    
+    address constant internal KOVAN_ZRX_ADDRESS = 0x6Ff6C0Ff1d68b964901F986d4C9FA3ac68346570;
+    bytes constant internal KOVAN_ZRX_ASSET_DATA = "\xf4\x72\x61\xb0\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x6f\xf6\xc0\xff\x1d\x68\xb9\x64\x90\x1f\x98\x6d\x4c\x9f\xa3\xac\x68\x34\x65\x70";
+    
+    address constant internal MAINNET_ZRX_ADDRESS = 0xE41d2489571d322189246DaFA5ebDe1F4699F498;
+    bytes constant public MAINNET_ZRX_ASSET_DATA = "\xf4\x72\x61\xb0\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\xe4\x1d\x24\x89\x57\x1d\x32\x21\x89\x24\x6d\xaf\xa5\xeb\xde\x1f\x46\x99\xf4\x98";
+    
+    function assertValidZrxAssetData()
+        public
+        pure
+        returns (bool)
+    {
+        bytes memory kovanZrxAssetData = abi.encodeWithSelector(ERC20_PROXY_ID, KOVAN_ZRX_ADDRESS);
+        require(
+            kovanZrxAssetData.equals(KOVAN_ZRX_ASSET_DATA),
+            "INVALID_KOVAN_ZRX_ASSET_DATA"
+        );
+
+        bytes memory mainetZrxAssetData = abi.encodeWithSelector(ERC20_PROXY_ID, MAINNET_ZRX_ADDRESS);
+        require(
+            mainetZrxAssetData.equals(MAINNET_ZRX_ASSET_DATA),
+            "INVALID_MAINNET_ZRX_ASSET_DATA"
+        );
+
+        return true;
+    }
+}
+// solhint-enable max-line-length
\ No newline at end of file
diff --git a/packages/contracts/src/2.0.0/test/TestValidator/TestValidator.sol b/packages/contracts/src/2.0.0/test/TestValidator/TestValidator.sol
deleted file mode 100644
index 6278aede0..000000000
--- a/packages/contracts/src/2.0.0/test/TestValidator/TestValidator.sol
+++ /dev/null
@@ -1,56 +0,0 @@
-/*
-
-  Copyright 2018 ZeroEx Intl.
-
-  Licensed under the Apache License, Version 2.0 (the "License");
-  you may not use this file except in compliance with the License.
-  You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-  Unless required by applicable law or agreed to in writing, software
-  distributed under the License is distributed on an "AS IS" BASIS,
-  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-  See the License for the specific language governing permissions and
-  limitations under the License.
-
-*/
-
-pragma solidity 0.4.24;
-
-import "../../protocol/Exchange/interfaces/IValidator.sol";
-
-
-contract TestValidator is 
-    IValidator
-{
-
-    // The single valid signer for this wallet.
-    // solhint-disable-next-line var-name-mixedcase
-    address internal VALID_SIGNER;
-
-    /// @dev constructs a new `TestValidator` with a single valid signer.
-    /// @param validSigner The sole, valid signer.
-    constructor (address validSigner) public {
-        VALID_SIGNER = validSigner;
-    }
-
-    /// @dev Verifies that a signature is valid. `signer` must match `VALID_SIGNER`.
-    /// @param hash Message hash that is signed.
-    /// @param signerAddress Address that should have signed the given hash.
-    /// @param signature Proof of signing.
-    /// @return Validity of signature.
-    // solhint-disable no-unused-vars
-    function isValidSignature(
-        bytes32 hash,
-        address signerAddress,
-        bytes signature
-    )
-        external
-        view
-        returns (bool isValid)
-    {
-        return (signerAddress == VALID_SIGNER);
-    }
-    // solhint-enable no-unused-vars
-}
diff --git a/packages/contracts/src/2.0.0/test/TestWallet/TestWallet.sol b/packages/contracts/src/2.0.0/test/TestWallet/TestWallet.sol
deleted file mode 100644
index 0415823e3..000000000
--- a/packages/contracts/src/2.0.0/test/TestWallet/TestWallet.sol
+++ /dev/null
@@ -1,65 +0,0 @@
-/*
-
-  Copyright 2018 ZeroEx Intl.
-
-  Licensed under the Apache License, Version 2.0 (the "License");
-  you may not use this file except in compliance with the License.
-  You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-  Unless required by applicable law or agreed to in writing, software
-  distributed under the License is distributed on an "AS IS" BASIS,
-  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-  See the License for the specific language governing permissions and
-  limitations under the License.
-
-*/
-
-pragma solidity 0.4.24;
-
-import "../../protocol/Exchange/interfaces/IWallet.sol";
-import "../../utils/LibBytes/LibBytes.sol";
-
-
-contract TestWallet is 
-    IWallet
-{
-    using LibBytes for bytes;
-
-    // The owner of this wallet.
-    // solhint-disable-next-line var-name-mixedcase
-    address internal WALLET_OWNER;
-
-    /// @dev constructs a new `TestWallet` with a single owner.
-    /// @param walletOwner The owner of this wallet.
-    constructor (address walletOwner) public {
-        WALLET_OWNER = walletOwner;
-    }
-
-    /// @dev Validates an EIP712 signature.
-    ///      The signer must match the owner of this wallet.
-    /// @param hash Message hash that is signed.
-    /// @param eip712Signature Proof of signing.
-    /// @return Validity of signature.
-    function isValidSignature(
-        bytes32 hash,
-        bytes eip712Signature
-    )
-        external
-        view
-        returns (bool isValid)
-    {
-        require(
-            eip712Signature.length == 65,
-            "LENGTH_65_REQUIRED"
-        );
-
-        uint8 v = uint8(eip712Signature[0]);
-        bytes32 r = eip712Signature.readBytes32(1);
-        bytes32 s = eip712Signature.readBytes32(33);
-        address recoveredAddress = ecrecover(hash, v, r, s);
-        isValid = WALLET_OWNER == recoveredAddress;
-        return isValid;
-    }
-}
diff --git a/packages/contracts/src/2.0.0/test/Whitelist/Whitelist.sol b/packages/contracts/src/2.0.0/test/Whitelist/Whitelist.sol
deleted file mode 100644
index 60cac26ea..000000000
--- a/packages/contracts/src/2.0.0/test/Whitelist/Whitelist.sol
+++ /dev/null
@@ -1,136 +0,0 @@
-/*
-
-  Copyright 2018 ZeroEx Intl.
-
-  Licensed under the Apache License, Version 2.0 (the "License");
-  you may not use this file except in compliance with the License.
-  You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-  Unless required by applicable law or agreed to in writing, software
-  distributed under the License is distributed on an "AS IS" BASIS,
-  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-  See the License for the specific language governing permissions and
-  limitations under the License.
-
-*/
-
-pragma solidity 0.4.24;
-pragma experimental ABIEncoderV2;
-
-import "../../protocol/Exchange/interfaces/IExchange.sol";
-import "../../protocol/Exchange/libs/LibOrder.sol";
-import "../../utils/Ownable/Ownable.sol";
-
-
-contract Whitelist is
-    Ownable
-{
-
-    // Mapping of address => whitelist status.
-    mapping (address => bool) public isWhitelisted;
-
-    // Exchange contract.
-    // solhint-disable var-name-mixedcase
-    IExchange internal EXCHANGE;
-    bytes internal TX_ORIGIN_SIGNATURE;
-    // solhint-enable var-name-mixedcase
-
-    byte constant internal VALIDATOR_SIGNATURE_BYTE = "\x06";
-
-    constructor (address _exchange)
-        public
-    {
-        EXCHANGE = IExchange(_exchange);
-        TX_ORIGIN_SIGNATURE = abi.encodePacked(address(this), VALIDATOR_SIGNATURE_BYTE);
-    }
-
-    /// @dev Adds or removes an address from the whitelist.
-    /// @param target Address to add or remove from whitelist.
-    /// @param isApproved Whitelist status to assign to address.
-    function updateWhitelistStatus(
-        address target,
-        bool isApproved
-    )
-        external
-        onlyOwner
-    {
-        isWhitelisted[target] = isApproved;
-    }
-
-    /// @dev Verifies signer is same as signer of current Ethereum transaction.
-    ///      NOTE: This function can currently be used to validate signatures coming from outside of this contract.
-    ///      Extra safety checks can be added for a production contract.
-    /// @param signerAddress Address that should have signed the given hash.
-    /// @param signature Proof of signing.
-    /// @return Validity of order signature.
-    // solhint-disable no-unused-vars
-    function isValidSignature(
-        bytes32 hash,
-        address signerAddress,
-        bytes signature
-    )
-        external
-        view
-        returns (bool isValid)
-    {
-        // solhint-disable-next-line avoid-tx-origin
-        return signerAddress == tx.origin;
-    }
-    // solhint-enable no-unused-vars
-
-    /// @dev Fills an order using `msg.sender` as the taker.
-    ///      The transaction will revert if both the maker and taker are not whitelisted.
-    ///      Orders should specify this contract as the `senderAddress` in order to gaurantee
-    ///      that both maker and taker have been whitelisted.
-    /// @param order Order struct containing order specifications.
-    /// @param takerAssetFillAmount Desired amount of takerAsset to sell.
-    /// @param salt Arbitrary value to gaurantee uniqueness of 0x transaction hash.
-    /// @param orderSignature Proof that order has been created by maker.
-    function fillOrderIfWhitelisted(
-        LibOrder.Order memory order,
-        uint256 takerAssetFillAmount,
-        uint256 salt,
-        bytes memory orderSignature
-    )
-        public
-    {
-        address takerAddress = msg.sender;
-
-        // This contract must be the entry point for the transaction.
-        require(
-            // solhint-disable-next-line avoid-tx-origin
-            takerAddress == tx.origin,
-            "INVALID_SENDER"
-        );
-
-        // Check if maker is on the whitelist.
-        require(
-            isWhitelisted[order.makerAddress],
-            "MAKER_NOT_WHITELISTED"
-        );
-
-        // Check if taker is on the whitelist.
-        require(
-            isWhitelisted[takerAddress],
-            "TAKER_NOT_WHITELISTED"
-        );
-
-        // Encode arguments into byte array.
-        bytes memory data = abi.encodeWithSelector(
-            EXCHANGE.fillOrder.selector,
-            order,
-            takerAssetFillAmount,
-            orderSignature
-        );
-
-        // Call `fillOrder` via `executeTransaction`.
-        EXCHANGE.executeTransaction(
-            salt,
-            takerAddress,
-            data,
-            TX_ORIGIN_SIGNATURE
-        );
-    }
-}