switch to JS

use truffle and web3 instead of @0x tooling
remove margin trading example

Author: merklejerk

.env.example

@@ -1,5 +1,3 @@
-generated-artifacts/*.json
-generated-wrappers/*.ts
-ganache.log
+build/*
+**.log
 node_modules
-.env

.gitignore

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 ZeroEx Labs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

LICENSE.md

@@ -2,41 +2,82 @@
 
 # Get started with 0x API
 
-This is a repo containing code snippets to interact with 0x API through smart contracts
-or with web3. A number of the code snippets have corresponding guides that provides
-color to what is happening in the snippets.
+This is a repo containing toy examples of filling 0x-API quotes either directly with web3 or through a smart contract.
 
-## Finding finished code snippets
-On `master` branch all of the snippets are empty and will require following the guides
-to complete them; to find the finished snippets, check out the `finished` branch. 
+## Installation
+Clone this repo then, from inside the project, run:
+```bash
+yarn -D
+# or
+npm install --dev
+```
+
+This will also compile the contracts in `contracts/` and produce artifacts in `build/`.
+
+## Examples
+The following example scripts are included:
+
+| Script | Guide | Description |
+|--------|-------|-------------|
+| `src/direct-swap.js` |  [Swap tokens with 0x API](https://0x.org/docs/guides/swap-tokens-with-0x-api) | Perform a token swap with web3. |
+| `src/swap-contract.js` | [Use 0x API liquidity in your smart contracts](https://0x.org/docs/guides/use-0x-api-liquidity-in-your-smart-contracts) | Perform a token swap in a smart contract. |
 
-## Running the snippets
-Before running the scripts run:
+### Running the examples locally (forked mainnet)
+The examples can be run locally (without actually mining transactions) through the magic of ganache forking. You will first need to start a forked ganache instance with the following command, replacing `ETHEREUM_RPC_URL` with the HTTP or websocket RPC URL of your mainnet ethereum node (e.g., Infura mainnet):
+
+```bash
+RPC_URL=ETHEREUM_RPC_URL npm run start-fork
+```
+
+#### Direct swap
+To run the direct swap example, in a separate terminal run:
+```bash
+npm run swap-fork
 ```
-$ yarn 
+
+#### Contract swap
+To run the contract swap example, in a seperate terminal run:
+```bash
+npm run deploy-fork # Only need to do this once per ganache instance.
+npm run swap-contract-fork
 ```
 
+### Running the examples on mainnet
+You can also run the examples and perform actual swaps that will get mined with a little effort:
+
+1. Modify the `mnemonic` in `package.json` to one only you know.
+2. Fund the first HD wallet account associated with that mnemonic with some ETH. You can run `npm run print-hd-wallet-accounts` to list the addresses associated with the configured mnemonic.
+
+#### Direct swap
+To run the direct swap example *live*, run the following:
+```bash
+# Replace ETHEREUM_RPC_URL with your mainnet node RPC endpoint.
+RPC_URL=ETHEREUM_RPC_URL npm run swap-live
+# You can also configure how much WETH is sold with the -a option, e.g.
+RPC_URL=ETHEREUM_RPC_URL npm run swap-live -a 0.1
 ```
-$ yarn build:contracts
+
+#### Contract swap
+To run the contract swap example *live*, first deploy the contract to mainnet.
+
+```bash
+# Replace ETHEREUM_RPC_URL with your mainnet node RPC endpoint.
+RPC_URL=ETHEREUM_RPC_URL npm run deploy-live --network main
 ```
 
-This codebase uses `ts-node` to run the typescript code-snippets.
+Note the address to which the contract has been deployed. You can now run the script to perform the swap.
 
-## Snippets
-All code snippets can be found in either `examples/` or `contracts/` (dependent to if there is any smart contract code needed for the snippet)
+```bash
+# Replace ETHEREUM_RPC_URL with your mainnet node RPC endpoint
+# and CONTRACT_ADDRESS with the deployed address of the contract.
+RPC_URL=ETHEREUM_RPC_URL npm run swap-contract-live CONTRACT_ADDRESS
+# You can also configure how much WETH is sold with the -a option, e.g.
+RPC_URL=ETHEREUM_RPC_URL npm run swap-contract-live -a 0.1 CONTRACT_ADDRESS
+```
+
+Keep in mind that tokens will remain in the contract after the swap and can only be retrieved by your first HD wallet account through `withdrawToken()` or `withdrawETH()`.
 
-| Main code script in `examples/`       | Corresponding Guide                                                                                                                       | Description                                                                                                                                                                                     |
-| ------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
-| `web3_simple_token_swap.ts`           | [Swap tokens with 0x API](https://0x.org/docs/guides/swap-tokens-with-0x-api)                                                             | Perform a token swap with web3.                                    |
-| `smart_contract_token_swap.ts`        | [Use 0x API liquidity in your smart contracts](https://0x.org/docs/guides/use-0x-api-liquidity-in-your-smart-contracts)                   | Perform a token swap in a smart contract.                          |
-| `smart_contract_margin_trading.ts`    | [Develop a margin trading smart contract with 0x API](https://0x.org/docs/guides/develop-a-margin-trading-smart-contract-with-0x-api)     | Develop a margin trading contract with Compound Finance + 0x.      |
- 
 ## Need help?
 * Refer to our [0x API specification](https://0x.org/docs/api) for detailed documentation.
 * 0x API is open source! Look through the [codebase](https://github.com/0xProject/0x-api) and deploy your own 0x API instance.
 * Don’t hesitate to reach out on [Discord](https://discordapp.com/invite/d3FTX3M) for help! The 0x Core team is active on Discord to help teams building with all things 0x.
-
-## Legal Disclaimer
-
-The laws and regulations applicable to the use and exchange of digital assets and blockchain-native tokens, including through any software developed using the licensed work created by ZeroEx Intl. as described here (the “Work”), vary by jurisdiction. As set forth in the Apache License, Version 2.0 applicable to the Work, developers are “solely responsible for determining the appropriateness of using or redistributing the Work,” which includes responsibility for ensuring compliance with any such applicable laws and regulations.
-See the Apache License, Version 2.0 for the specific language governing all applicable permissions and limitations: http://www.apache.org/licenses/LICENSE-2.0

README.md

@@ -0,0 +1,20 @@
+// SPDX-License-Identifier: MIT
+pragma solidity >=0.4.22 <0.8.0;
+
+// This contract has to exist or else truffle will complain.
+contract Migrations {
+  address public owner = msg.sender;
+  uint public last_completed_migration;
+
+  modifier restricted() {
+    require(
+      msg.sender == owner,
+      "This function is restricted to the contract's owner"
+    );
+    _;
+  }
+
+  function setCompleted(uint completed) public restricted {
+    last_completed_migration = completed;
+  }
+}