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

13 files changed, 18 insertions, 180 deletions

diff --git a/packages/0x.js/package.json b/packages/0x.js/package.json
index 0a91343c7..961a97d84 100644
--- a/packages/0x.js/package.json
+++ b/packages/0x.js/package.json
@@ -15,16 +15,16 @@
         "build:watch": "tsc -w",
         "prebuild": "run-s clean generate_contract_wrappers",
         "build": "run-p build:umd:prod build:commonjs; exit 0;",
-        "generate_contract_wrappers": "node ../abi-gen/lib/index.js --abis 'src/artifacts/@(Exchange|Token|TokenTransferProxy|EtherToken|TokenRegistry|DummyToken).json' --template ../contract_templates/contract.handlebars --partials '../contract_templates/partials/**/*.handlebars' --output src/contract_wrappers/generated --backend ethers && prettier --write 'src/contract_wrappers/generated/**.ts'",
+        "generate_contract_wrappers": "node ../abi-gen/lib/index.js --abis 'src/compact_artifacts/@(Exchange|Token|TokenTransferProxy|EtherToken|TokenRegistry|DummyToken).json' --template ../contract_templates/contract.handlebars --partials '../contract_templates/partials/**/*.handlebars' --output src/contract_wrappers/generated --backend ethers && prettier --write 'src/contract_wrappers/generated/**.ts'",
         "lint": "tslint --project . 'src/**/*.ts' 'test/**/*.ts'",
         "test:circleci": "run-s test:coverage",
         "test": "run-s clean test:commonjs",
         "test:coverage": "nyc npm run test --all && yarn coverage:report:lcov",
         "coverage:report:lcov": "nyc report --reporter=text-lcov > coverage/lcov.info",
-        "update_contracts": "for i in ${npm_package_config_artifacts}; do copyfiles -u 4 ../contracts/src/artifacts/$i.json test/artifacts; done;",
+        "update_artifacts": "for i in ${npm_package_config_compact_artifacts}; do copyfiles -u 4 ../migrations/src/artifacts/$i.json test/artifacts; done;",
         "clean": "shx rm -rf _bundles lib test_temp scripts",
         "build:umd:prod": "NODE_ENV=production webpack",
-        "build:commonjs": "tsc && copyfiles -u 2 './src/artifacts/**/*.json' ./lib/src/artifacts && copyfiles -u 3 './lib/src/monorepo_scripts/**/*' ./scripts",
+        "build:commonjs": "tsc && yarn update_artifacts && copyfiles -u 2 './src/compact_artifacts/**/*.json' ./lib/src/compact_artifacts && copyfiles -u 3 './lib/src/monorepo_scripts/**/*' ./scripts",
         "test:commonjs": "run-s build:commonjs run_mocha",
         "run_mocha": "mocha lib/test/**/*_test.js --timeout 10000 --bail --exit",
         "manual:postpublish": "yarn build; node ./scripts/postpublish.js",
@@ -33,7 +33,7 @@
         "upload_docs_json": "aws s3 cp generated_docs/index.json $S3_URL --profile 0xproject --grants read=uri=http://acs.amazonaws.com/groups/global/AllUsers --content-type application/json"
     },
     "config": {
-        "artifacts": "Exchange DummyToken ZRXToken Token WETH9 TokenTransferProxy MultiSigWallet MultiSigWalletWithTimeLock MultiSigWalletWithTimeLockExceptRemoveAuthorizedAddress MaliciousToken TokenRegistry Arbitrage EtherDelta AccountLevels",
+        "compact_artifacts": "Exchange DummyToken ZRXToken Token EtherToken TokenTransferProxy TokenRegistry",
         "postpublish": {
             "assets": [
                 "packages/0x.js/_bundles/index.js",
@@ -114,6 +114,9 @@
         "uuid": "^3.1.0",
         "web3": "^0.20.0"
     },
+    "optionalDependencies": {
+        "@0xproject/migrations": "^0.0.1"
+    },
     "publishConfig": {
         "access": "public"
     }
diff --git a/packages/0x.js/src/artifacts.ts b/packages/0x.js/src/artifacts.ts
index cbacd7d56..a91d9ae1f 100644
--- a/packages/0x.js/src/artifacts.ts
+++ b/packages/0x.js/src/artifacts.ts
@@ -1,10 +1,10 @@
-import * as DummyTokenArtifact from './artifacts/DummyToken.json';
-import * as EtherTokenArtifact from './artifacts/EtherToken.json';
-import * as ExchangeArtifact from './artifacts/Exchange.json';
-import * as TokenArtifact from './artifacts/Token.json';
-import * as TokenRegistryArtifact from './artifacts/TokenRegistry.json';
-import * as TokenTransferProxyArtifact from './artifacts/TokenTransferProxy.json';
-import * as ZRXArtifact from './artifacts/ZRX.json';
+import * as DummyTokenArtifact from './compact_artifacts/DummyToken.json';
+import * as EtherTokenArtifact from './compact_artifacts/EtherToken.json';
+import * as ExchangeArtifact from './compact_artifacts/Exchange.json';
+import * as TokenArtifact from './compact_artifacts/Token.json';
+import * as TokenRegistryArtifact from './compact_artifacts/TokenRegistry.json';
+import * as TokenTransferProxyArtifact from './compact_artifacts/TokenTransferProxy.json';
+import * as ZRXArtifact from './compact_artifacts/ZRX.json';
 import { Artifact } from './types';
 
 export const artifacts = {
diff --git a/packages/0x.js/src/artifacts/DummyToken.json b/packages/0x.js/src/compact_artifacts/DummyToken.json
index f64a8cd3d..f64a8cd3d 100644
--- a/packages/0x.js/src/artifacts/DummyToken.json
+++ b/packages/0x.js/src/compact_artifacts/DummyToken.json
diff --git a/packages/0x.js/src/artifacts/EtherToken.json b/packages/0x.js/src/compact_artifacts/EtherToken.json
index 26cca57cd..26cca57cd 100644
--- a/packages/0x.js/src/artifacts/EtherToken.json
+++ b/packages/0x.js/src/compact_artifacts/EtherToken.json
diff --git a/packages/0x.js/src/artifacts/Exchange.json b/packages/0x.js/src/compact_artifacts/Exchange.json
index af8db7360..af8db7360 100644
--- a/packages/0x.js/src/artifacts/Exchange.json
+++ b/packages/0x.js/src/compact_artifacts/Exchange.json
diff --git a/packages/0x.js/src/artifacts/Token.json b/packages/0x.js/src/compact_artifacts/Token.json
index 3b5a86ae0..3b5a86ae0 100644
--- a/packages/0x.js/src/artifacts/Token.json
+++ b/packages/0x.js/src/compact_artifacts/Token.json
diff --git a/packages/0x.js/src/artifacts/TokenRegistry.json b/packages/0x.js/src/compact_artifacts/TokenRegistry.json
index 0f583628c..0f583628c 100644
--- a/packages/0x.js/src/artifacts/TokenRegistry.json
+++ b/packages/0x.js/src/compact_artifacts/TokenRegistry.json
diff --git a/packages/0x.js/src/artifacts/TokenTransferProxy.json b/packages/0x.js/src/compact_artifacts/TokenTransferProxy.json
index 8cf551ddb..8cf551ddb 100644
--- a/packages/0x.js/src/artifacts/TokenTransferProxy.json
+++ b/packages/0x.js/src/compact_artifacts/TokenTransferProxy.json
diff --git a/packages/0x.js/src/artifacts/ZRX.json b/packages/0x.js/src/compact_artifacts/ZRX.json
index e40b8f268..e40b8f268 100644
--- a/packages/0x.js/src/artifacts/ZRX.json
+++ b/packages/0x.js/src/compact_artifacts/ZRX.json
diff --git a/packages/0x.js/test/0x.js_test.ts b/packages/0x.js/test/0x.js_test.ts
index e6163d568..5720f42ce 100644
--- a/packages/0x.js/test/0x.js_test.ts
+++ b/packages/0x.js/test/0x.js_test.ts
@@ -1,5 +1,9 @@
 import { Deployer } from '@0xproject/deployer';
 import { BlockchainLifecycle, devConstants, web3Factory } from '@0xproject/dev-utils';
+// HACK: This dependency is optional since it is only available when run from within
+// the monorepo. tslint doesn't handle optional dependencies
+// tslint:disable-next-line:no-implicit-dependencies
+import { runMigrationsAsync } from '@0xproject/migrations';
 import { BigNumber } from '@0xproject/utils';
 import * as chai from 'chai';
 import * as _ from 'lodash';
@@ -9,7 +13,6 @@ import * as Sinon from 'sinon';
 
 import { ApprovalContractEventArgs, LogWithDecodedArgs, Order, TokenEvents, ZeroEx } from '../src';
 
-import { runMigrationsAsync } from './migrations/migrate';
 import { chaiSetup } from './utils/chai_setup';
 import { constants } from './utils/constants';
 import { deployer } from './utils/deployer';
diff --git a/packages/0x.js/test/migrations/config/token_info.ts b/packages/0x.js/test/migrations/config/token_info.ts
deleted file mode 100644
index 0d0e90917..000000000
--- a/packages/0x.js/test/migrations/config/token_info.ts
+++ /dev/null
@@ -1,40 +0,0 @@
-import { constants } from '../../utils/constants';
-import { Token } from '../types';
-
-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/0x.js/test/migrations/migrate.ts b/packages/0x.js/test/migrations/migrate.ts
deleted file mode 100644
index 85fb2a34f..000000000
--- a/packages/0x.js/test/migrations/migrate.ts
+++ /dev/null
@@ -1,90 +0,0 @@
-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 { tokenInfo } from './config/token_info';
-import { ContractName } from './types';
-
-/**
- * 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/0x.js/test/migrations/types.ts b/packages/0x.js/test/migrations/types.ts
deleted file mode 100644
index 1887bfd96..000000000
--- a/packages/0x.js/test/migrations/types.ts
+++ /dev/null
@@ -1,38 +0,0 @@
-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',
-}