Move migrations into separate monorepo subpackage and hook it up to 0x.js and contracts

11 files changed, 321 insertions, 0 deletions

diff --git a/packages/migrations/README.md b/packages/migrations/README.md
new file mode 100644
index 000000000..15129ae85
--- /dev/null
+++ b/packages/migrations/README.md
@@ -0,0 +1,69 @@
+## Migrations
+
+Migrate the 0x system of smart contracts on the network of your choice using these migrations.
+
+## Contributing
+
+We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository.
+
+Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started.
+
+### Install dependencies
+
+If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:
+
+```bash
+yarn config set workspaces-experimental true
+```
+
+Then install dependencies
+
+```bash
+yarn install
+```
+
+### Build
+
+If this is your **first** time building this package, you must first build **all** packages within the monorepo. This is because packages that depend on other packages located inside this monorepo are symlinked when run from **within** the monorepo. This allows you to make changes across multiple packages without first publishing dependent packages to NPM. To build all packages, run the following from the monorepo root directory:
+
+```bash
+yarn lerna:rebuild
+```
+
+Or continuously rebuild on change:
+
+```bash
+yarn dev
+```
+
+You can also build this specific package by running the following from within its directory:
+
+```bash
+yarn build
+```
+
+or continuously rebuild on change:
+
+```bash
+yarn build:watch
+```
+
+### Clean
+
+```bash
+yarn clean
+```
+
+### Lint
+
+```bash
+yarn lint
+```
+
+### Migrate
+
+In order to migrate the 0x smart contracts to TestRPC/Ganache running at `http://localhost:8545`, run:
+
+```bash
+yarn migrate
+```
diff --git a/packages/migrations/package.json b/packages/migrations/package.json
new file mode 100644
index 000000000..65946aa71
--- /dev/null
+++ b/packages/migrations/package.json
@@ -0,0 +1,36 @@
+{
+    "private": true,
+    "name": "@0xproject/migrations",
+    "version": "0.0.1",
+    "description": "0x smart contract migrations",
+    "main": "lib/index.js",
+    "types": "lib/index.d.ts",
+    "scripts": {
+        "build:watch": "tsc -w",
+        "build": "tsc",
+        "clean": "shx rm -rf lib",
+        "lint": "tslint --project . 'src/**/*.ts'",
+        "migrate": "run-s build compile script:migrate",
+        "script:migrate": "node ./lib/migrate.js",
+        "copy_artifacts": "copyfiles 'src/artifacts/**/*' ./lib",
+        "compile": "node ../deployer/lib/src/cli.js compile --contracts ${npm_package_config_contracts} --contracts-dir ../contracts/src/contracts --artifacts-dir src/artifacts"
+    },
+    "config": {
+        "contracts": "Exchange,DummyToken,ZRXToken,Token,WETH9,TokenTransferProxy,MultiSigWallet,MultiSigWalletWithTimeLock,MultiSigWalletWithTimeLockExceptRemoveAuthorizedAddress,MaliciousToken,TokenRegistry,Arbitrage,EtherDelta,AccountLevels"
+    },
+    "license": "Apache-2.0",
+    "devDependencies": {
+        "@0xproject/tslint-config": "^0.4.14",
+        "@0xproject/dev-utils": "^0.3.4",
+        "npm-run-all": "^4.1.2",
+        "shx": "^0.2.2",
+        "tslint": "5.8.0",
+        "typescript": "2.7.1"
+    },
+    "dependencies": {
+        "@0xproject/deployer": "^0.3.5",
+        "@0xproject/utils": "^0.5.0",
+        "@0xproject/web3-wrapper": "^0.5.0",
+        "lodash": "^4.17.4"
+    }
+}
diff --git a/packages/migrations/src/globals.d.ts b/packages/migrations/src/globals.d.ts
new file mode 100644
index 000000000..94e63a32d
--- /dev/null
+++ b/packages/migrations/src/globals.d.ts
@@ -0,0 +1,6 @@
+declare module '*.json' {
+    const json: any;
+    /* tslint:disable */
+    export default json;
+    /* tslint:enable */
+}
diff --git a/packages/migrations/src/index.ts b/packages/migrations/src/index.ts
new file mode 100644
index 000000000..2a40f36bc
--- /dev/null
+++ b/packages/migrations/src/index.ts
@@ -0,0 +1,3 @@
+import { runMigrationsAsync } from './migration';
+
+export { runMigrationsAsync };
diff --git a/packages/migrations/src/migrate.ts b/packages/migrations/src/migrate.ts
new file mode 100644
index 000000000..76dcbd847
--- /dev/null
+++ b/packages/migrations/src/migrate.ts
@@ -0,0 +1,25 @@
+#!/usr/bin/env node
+import { Deployer } from '@0xproject/deployer';
+import { devConstants } from '@0xproject/dev-utils';
+import { logUtils } from '@0xproject/utils';
+import * as path from 'path';
+
+import { runMigrationsAsync } from './migration';
+
+(async () => {
+    const deployerOpts = {
+        jsonrpcUrl: 'http://localhost:8545',
+        artifactsDir: path.resolve('src', 'artifacts'),
+        networkId: 50,
+        defaults: {
+            gas: devConstants.GAS_ESTIMATE,
+        },
+    };
+
+    const deployer = new Deployer(deployerOpts);
+
+    await runMigrationsAsync(deployer);
+})().catch(err => {
+    logUtils.log(err);
+    process.exit(1);
+});
diff --git a/packages/migrations/src/migration.ts b/packages/migrations/src/migration.ts
new file mode 100644
index 000000000..be899cc65
--- /dev/null
+++ b/packages/migrations/src/migration.ts
@@ -0,0 +1,90 @@
+import { Deployer } from '@0xproject/deployer';
+import { BigNumber } from '@0xproject/utils';
+import { Web3Wrapper } from '@0xproject/web3-wrapper';
+import * as _ from 'lodash';
+
+import { constants } from './utils/constants';
+
+import { ContractName } from './types';
+import { tokenInfo } from './utils/token_info';
+
+/**
+ * Custom migrations should be defined in this function. This will be called with the CLI 'migrate' command.
+ * Migrations could be written to run in parallel, but if you want contract addresses to be created deterministically,
+ * the migration should be written to run synchronously.
+ * @param deployer Deployer instance.
+ */
+export const runMigrationsAsync = async (deployer: Deployer) => {
+    const web3Wrapper: Web3Wrapper = deployer.web3Wrapper;
+    const accounts: string[] = await web3Wrapper.getAvailableAddressesAsync();
+
+    const tokenTransferProxy = await deployer.deployAndSaveAsync(ContractName.TokenTransferProxy);
+    const zrxToken = await deployer.deployAndSaveAsync(ContractName.ZRXToken);
+    const etherToken = await deployer.deployAndSaveAsync(ContractName.WETH9);
+    const tokenReg = await deployer.deployAndSaveAsync(ContractName.TokenRegistry);
+
+    const exchangeArgs = [zrxToken.address, tokenTransferProxy.address];
+    const owners = [accounts[0], accounts[1]];
+    const confirmationsRequired = new BigNumber(2);
+    const secondsRequired = new BigNumber(0);
+    const multiSigArgs = [owners, confirmationsRequired, secondsRequired, tokenTransferProxy.address];
+    const exchange = await deployer.deployAndSaveAsync(ContractName.Exchange, exchangeArgs);
+    const multiSig = await deployer.deployAndSaveAsync(
+        ContractName.MultiSigWalletWithTimeLockExceptRemoveAuthorizedAddress,
+        multiSigArgs,
+    );
+
+    const owner = accounts[0];
+    await tokenTransferProxy.addAuthorizedAddress.sendTransactionAsync(exchange.address, { from: owner });
+    await tokenTransferProxy.transferOwnership.sendTransactionAsync(multiSig.address, { from: owner });
+    const addTokenGasEstimate = await tokenReg.addToken.estimateGasAsync(
+        zrxToken.address,
+        tokenInfo[0].name,
+        tokenInfo[0].symbol,
+        tokenInfo[0].decimals,
+        tokenInfo[0].ipfsHash,
+        tokenInfo[0].swarmHash,
+        { from: owner },
+    );
+    await tokenReg.addToken.sendTransactionAsync(
+        zrxToken.address,
+        '0x Protocol Token',
+        'ZRX',
+        18,
+        constants.NULL_BYTES,
+        constants.NULL_BYTES,
+        {
+            from: owner,
+            gas: addTokenGasEstimate,
+        },
+    );
+    await tokenReg.addToken.sendTransactionAsync(
+        etherToken.address,
+        'Ether Token',
+        'WETH',
+        18,
+        constants.NULL_BYTES,
+        constants.NULL_BYTES,
+        {
+            from: owner,
+            gas: addTokenGasEstimate,
+        },
+    );
+    for (const token of tokenInfo) {
+        const totalSupply = new BigNumber(0);
+        const args = [token.name, token.symbol, token.decimals, totalSupply];
+        const dummyToken = await deployer.deployAsync(ContractName.DummyToken, args);
+        await tokenReg.addToken.sendTransactionAsync(
+            dummyToken.address,
+            token.name,
+            token.symbol,
+            token.decimals,
+            token.ipfsHash,
+            token.swarmHash,
+            {
+                from: owner,
+                gas: addTokenGasEstimate,
+            },
+        );
+    }
+};
diff --git a/packages/migrations/src/types.ts b/packages/migrations/src/types.ts
new file mode 100644
index 000000000..1887bfd96
--- /dev/null
+++ b/packages/migrations/src/types.ts
@@ -0,0 +1,38 @@
+export interface MultiSigConfig {
+    owners: string[];
+    confirmationsRequired: number;
+    secondsRequired: number;
+}
+
+export interface MultiSigConfigByNetwork {
+    [networkName: string]: MultiSigConfig;
+}
+
+export interface Token {
+    address?: string;
+    name: string;
+    symbol: string;
+    decimals: number;
+    ipfsHash: string;
+    swarmHash: string;
+}
+
+export interface TokenInfoByNetwork {
+    development: Token[];
+    live: Token[];
+}
+
+export enum ContractName {
+    TokenTransferProxy = 'TokenTransferProxy',
+    TokenRegistry = 'TokenRegistry',
+    MultiSigWalletWithTimeLock = 'MultiSigWalletWithTimeLock',
+    Exchange = 'Exchange',
+    ZRXToken = 'ZRXToken',
+    DummyToken = 'DummyToken',
+    WETH9 = 'WETH9',
+    MultiSigWalletWithTimeLockExceptRemoveAuthorizedAddress = 'MultiSigWalletWithTimeLockExceptRemoveAuthorizedAddress',
+    MaliciousToken = 'MaliciousToken',
+    AccountLevels = 'AccountLevels',
+    EtherDelta = 'EtherDelta',
+    Arbitrage = 'Arbitrage',
+}
diff --git a/packages/migrations/src/utils/constants.ts b/packages/migrations/src/utils/constants.ts
new file mode 100644
index 000000000..8871a470d
--- /dev/null
+++ b/packages/migrations/src/utils/constants.ts
@@ -0,0 +1,3 @@
+export const constants = {
+    NULL_BYTES: '0x',
+};
diff --git a/packages/migrations/src/utils/token_info.ts b/packages/migrations/src/utils/token_info.ts
new file mode 100644
index 000000000..f2ca3e8b3
--- /dev/null
+++ b/packages/migrations/src/utils/token_info.ts
@@ -0,0 +1,41 @@
+import { Token } from '../types';
+
+import { constants } from './constants';
+
+export const tokenInfo: Token[] = [
+    {
+        name: 'Augur Reputation Token',
+        symbol: 'REP',
+        decimals: 18,
+        ipfsHash: constants.NULL_BYTES,
+        swarmHash: constants.NULL_BYTES,
+    },
+    {
+        name: 'Digix DAO Token',
+        symbol: 'DGD',
+        decimals: 18,
+        ipfsHash: constants.NULL_BYTES,
+        swarmHash: constants.NULL_BYTES,
+    },
+    {
+        name: 'Golem Network Token',
+        symbol: 'GNT',
+        decimals: 18,
+        ipfsHash: constants.NULL_BYTES,
+        swarmHash: constants.NULL_BYTES,
+    },
+    {
+        name: 'MakerDAO',
+        symbol: 'MKR',
+        decimals: 18,
+        ipfsHash: constants.NULL_BYTES,
+        swarmHash: constants.NULL_BYTES,
+    },
+    {
+        name: 'Melon Token',
+        symbol: 'MLN',
+        decimals: 18,
+        ipfsHash: constants.NULL_BYTES,
+        swarmHash: constants.NULL_BYTES,
+    },
+];
diff --git a/packages/migrations/tsconfig.json b/packages/migrations/tsconfig.json
new file mode 100644
index 000000000..f5f4b37c2
--- /dev/null
+++ b/packages/migrations/tsconfig.json
@@ -0,0 +1,7 @@
+{
+    "extends": "../../tsconfig",
+    "compilerOptions": {
+        "outDir": "lib"
+    },
+    "include": ["src/**/*"]
+}
diff --git a/packages/migrations/tslint.json b/packages/migrations/tslint.json
new file mode 100644
index 000000000..ffaefe83a
--- /dev/null
+++ b/packages/migrations/tslint.json
@@ -0,0 +1,3 @@
+{
+    "extends": ["@0xproject/tslint-config"]
+}