[all] Introduction of AppRegistry and significant code improvements to facilitate it

.circleci/config.yml

@@ -1,4 +1,5 @@
 version: 2
+
 jobs:
   build:
     docker:
@@ -9,26 +10,22 @@ jobs:
       - restore_cache:
           key: dependency-cache-{{ checksum ".dependencies_checksum" }}
       - run: yarn
+      - run: yarn build
       - save_cache:
           key: dependency-cache-{{ checksum ".dependencies_checksum" }}
           paths:
             - node_modules
 
   run-tests:
     docker:
-      - image: circleci/node:10-browsers
+      - image: circleci/node:10
     steps:
       - checkout
       - run: cat packages/*/package.json | shasum > .dependencies_checksum
       - restore_cache:
           key: dependency-cache-{{ checksum ".dependencies_checksum" }}
       - run: yarn # symlink packages' node_modules
       - run: yarn build
-      - run:
-          name: "Run ganache"
-          command: yarn ganache:ci
-          background: true
-      - run: cd packages/contracts/ && yarn migrate --network ganache
       - run: yarn test:ci-non-playground
 
   run-playground-tests:

.soliumrc.json

@@ -0,0 +1,28 @@
+{
+  "extends": "solium:all",
+  "plugins": ["security"],
+  "rules": {
+    "arg-overflow": ["error", 8],
+    "array-declarations": 1,
+    "camelcase": 1,
+    "deprecated-suicide": 1,
+    "imports-on-top": 1,
+    "indentation": ["error", 2],
+    "lbrace": 0,
+    "max-len": ["error", 80],
+    "mixedcase": 0,
+    "no-empty-blocks": 1,
+    "no-experimental": 0,
+    "no-unused-vars": 1,
+    "operator-whitespace": 1,
+    "pragma-on-top": 1,
+    "quotes": 1,
+    "security/enforce-explicit-visibility": ["error"],
+    "security/no-block-members": ["warning"],
+    "security/no-inline-assembly": 0,
+    "security/no-low-level-calls": 0,
+    "uppercase": 1,
+    "variable-declarations": 1,
+    "whitespace": 1
+  }
+}

README.md

@@ -71,20 +71,7 @@ yarn lint:fix
 
 ### Tests
 
-Presently for some of the tests to work, you need to have a `ganache-cli` instance running in the background. To do this, run using:
-
-```shell
-yarn ganache
-```
-
-You also need to migrate the contracts in the contracts package to generate a `networks` file which the `machine` package directly consume (for now).
-
-```shell
-cd packages/contracts
-yarn migrate --network ganache
-```
-
-Finally, to run all tests:
+To run all tests:
 
 ```shell
 yarn test

build.sh

@@ -6,11 +6,11 @@
 
 set -e
 
-packages="contracts common-types cf.js machine node node-provider playground-server playground dapp-high-roller"
+packages="types apps contracts common-types cf.js machine node node-provider playground-server playground dapp-high-roller"
 
 for package in $packages; do
-  echo ">>> Building package: $package"
-  cd packages/$package
+  echo "⚙️  Building package: ${package}"
+  cd packages/${package}
   yarn build
   cd -
 done

package.json

@@ -14,35 +14,19 @@
   },
   "scripts": {
     "build": "sh build.sh",
-    "clean": "lerna run clean --parallel --no-bail",
+    "clean": "git clean -Xdf --exclude=\"!.env\"",
+    "clean:dry": "git clean -Xdn --exclude=\"!.env\"",
     "test": "lerna run --stream --concurrency 1 test",
-    "test:ci-non-playground": "lerna run --ignore @counterfactual/playground --ignore @counterfactual/dapp-high-roller --stream test",
-    "ganache": "ganache-cli --networkId ${npm_package_config_ganacheNetworkID} --verbose --gasLimit ${npm_package_config_ganacheGasLimit} --gasPrice ${npm_package_config_ganacheGasPrice} --port ${npm_package_config_ganachePort} --deterministic --account=\"${npm_package_config_unlockedAccount0},${npm_package_config_etherBalance}\" --account=\"${npm_package_config_unlockedAccount1},${npm_package_config_etherBalance}\" --account=\"${npm_package_config_unlockedAccount2},${npm_package_config_etherBalance}\" --account=\"${npm_package_config_unlockedAccount3},${npm_package_config_etherBalance}\" &> /dev/null &",
-    "ganache:windows": "ganache-cli --networkId %npm_package_config_ganacheNetworkID% --verbose --gasLimit %npm_package_config_ganacheGasLimit% --gasPrice %npm_package_config_ganacheGasPrice% --port %npm_package_config_ganachePort% --deterministic --account=\"%npm_package_config_unlockedAccount0%,%npm_package_config_etherBalance%\" --account=\"%npm_package_config_unlockedAccount1%,%npm_package_config_etherBalance%\" --account=\"%npm_package_config_unlockedAccount2%,%npm_package_config_etherBalance%\" --account=\"%npm_package_config_unlockedAccount3%,%npm_package_config_etherBalance%\"",
-    "ganache:ci": "ganache-cli --networkId ${npm_package_config_ganacheNetworkID} --gasLimit ${npm_package_config_ganacheGasLimit} --gasPrice ${npm_package_config_ganacheGasPrice} --port ${npm_package_config_ganachePort} --deterministic --account=\"${npm_package_config_unlockedAccount0},${npm_package_config_etherBalance}\" --account=\"${npm_package_config_unlockedAccount1},${npm_package_config_etherBalance}\" --account=\"${npm_package_config_unlockedAccount2},${npm_package_config_etherBalance}\" --account=\"${npm_package_config_unlockedAccount3},${npm_package_config_etherBalance}\"",
-    "ganache:stop": "ps aux | grep ganache-cli | grep -v grep | awk '{print $2}' | xargs kill -9",
+    "test:ci-non-playground": "lerna run --ignore @counterfactual/playground --ignore @counterfactual/dapp-high-roller --stream --concurrency 1 test",
     "lint": "lerna run lint --parallel --no-bail",
     "lint:fix": "lerna run lint:fix --parallel --no-bail"
   },
-  "config": {
-    "ganacheNetworkID": 7777777,
-    "ganachePort": 9545,
-    "ganacheGasLimit": "0xfffffffffff",
-    "ganacheGasPrice": "0x01",
-    "unlockedAccount0": "0xf2f48ee19680706196e2e339e5da3491186e0c4c5030670656b0e0164837257a",
-    "unlockedAccount1": "0xf2f48ee19680706196e2e339e5da3491186e0c4c5030670656b0e0164837257b",
-    "unlockedAccount2": "0xf2f48ee19680706196e2e339e5da3491186e0c4c5030670656b0e0164837257c",
-    "unlockedAccount3": "0xf2f48ee19680706196e2e339e5da3491186e0c4c5030670656b0e0164837257d",
-    "etherBalance": "1000000000000000000000000"
-  },
   "keywords": [
     "ethereum",
     "counterfactual",
-    "state channels",
-    "off chain"
+    "state channels"
   ],
   "devDependencies": {
-    "ganache-cli": "6.2.5",
     "lerna": "^3.4.3",
     "prettier": "1.15.3",
     "tslint": "^5.11.0",

packages/apps/.gitignore

@@ -0,0 +1 @@
+build

packages/apps/.solcover.js

@@ -0,0 +1,11 @@
+module.exports = {
+  testCommand: 'truffle test --network coverage lib/**/*.spec.js',
+  skipFiles: [
+    "external/Proxy.sol",
+    "external/ProxyFactory.sol",
+    "lib/StaticCall.sol",
+    "delegateTargets/MultiSend.sol",
+    "Registry.sol",
+    "test/loadContracts.sol"
+  ]
+};

packages/apps/.soliumignore

@@ -0,0 +1,2 @@
+node_modules
+coverageEnv

packages/apps/.soliumrc.json

@@ -0,0 +1 @@
+../../.soliumrc.json

packages/contracts/contracts/appDefinitions/CommitRevealApp.sol → packages/apps/contracts/CommitRevealApp.sol

@@ -1,7 +1,7 @@
 pragma solidity 0.4.25;
 pragma experimental "ABIEncoderV2";
 
-import "../lib/Transfer.sol";
+import "@counterfactual/contracts/contracts/libs/Transfer.sol";
 
 
 contract CommitRevealApp {

packages/contracts/contracts/appDefinitions/CountingApp.sol → packages/apps/contracts/CountingApp.sol

@@ -1,7 +1,7 @@
 pragma solidity 0.4.25;
 pragma experimental "ABIEncoderV2";
 
-import "../lib/Transfer.sol";
+import "@counterfactual/contracts/contracts/libs/Transfer.sol";
 
 
 contract CountingApp {

packages/contracts/contracts/appDefinitions/Nim.sol → packages/apps/contracts/NimApp.sol

@@ -1,14 +1,14 @@
 pragma solidity 0.4.25;
 pragma experimental "ABIEncoderV2";
 
-import "../lib/Transfer.sol";
+import "@counterfactual/contracts/contracts/libs/Transfer.sol";
 
 
 /*
 Normal-form Nim
 https://en.wikipedia.org/wiki/Nim
 */
-contract Nim {
+contract NimApp {
 
   struct Action {
     uint256 pileIdx;

packages/contracts/contracts/appDefinitions/PaymentApp.sol → packages/apps/contracts/PaymentApp.sol

@@ -1,7 +1,7 @@
 pragma solidity 0.4.25;
 pragma experimental "ABIEncoderV2";
 
-import "../lib/Transfer.sol";
+import "@counterfactual/contracts/contracts/libs/Transfer.sol";
 
 
 contract PaymentApp {

packages/contracts/contracts/appDefinitions/TicTacToe.sol → packages/apps/contracts/TicTacToeApp.sol

@@ -1,10 +1,10 @@
 pragma solidity 0.4.25;
 pragma experimental "ABIEncoderV2";
 
-import "../lib/Transfer.sol";
+import "@counterfactual/contracts/contracts/libs/Transfer.sol";
 
 
-contract TicTacToe {
+contract TicTacToeApp {
 
   enum ActionType {
     PLAY,

packages/apps/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@counterfactual/apps",
+  "version": "0.0.1",
+  "description": "Collection of various apps built on Counterfactual",
+  "repository": "github.com/counterfactual/monorepo",
+  "license": "MIT",
+  "private": true,
+  "files": [
+    "build"
+  ],
+  "scripts": {
+    "build": "waffle waffle.json",
+    "test": "ts-mocha test/*",
+    "lint:fix": "yarn lint:ts:fix && yarn lint:sol:fix",
+    "lint": "yarn lint:ts && yarn lint:sol",
+    "lint:sol:fix": "solium -d contracts/ --fix",
+    "lint:sol": "solium -d .",
+    "lint:ts:fix": "tslint -c tslint.json -p . --fix",
+    "lint:ts": "tslint -c tslint.json -p ."
+  },
+  "devDependencies": {
+    "@counterfactual/contracts": "0.0.3",
+    "@counterfactual/typescript-typings": "0.0.1",
+    "@types/chai": "^4.1.7",
+    "@types/mocha": "^5.2.5",
+    "chai": "^4.2.0",
+    "ethereum-waffle": "^1.0.5",
+    "ethers": "4.0.20",
+    "mocha": "^4.1.0",
+    "solium": "^1.1.8",
+    "ts-mocha": "^2.0.0",
+    "tslint": "^5.11.0"
+  }
+}

packages/apps/test/nim.spec.ts

@@ -0,0 +1,117 @@
+import chai from "chai";
+import * as waffle from "ethereum-waffle";
+import { Contract } from "ethers";
+import { AddressZero } from "ethers/constants";
+import { BigNumber, defaultAbiCoder } from "ethers/utils";
+
+import NimApp from "../build/NimApp.json";
+
+chai.use(waffle.solidity);
+
+const { expect } = chai;
+
+type NimAppState = {
+  players: string[];
+  turnNum: BigNumber;
+  pileHeights: BigNumber[];
+};
+
+function decodeAppState(encodedAppState: string): NimAppState {
+  return defaultAbiCoder.decode(
+    ["tuple(address[2] players, uint256 turnNum, uint256[3] pileHeights)"],
+    encodedAppState
+  )[0];
+}
+
+describe("Nim", () => {
+  let nim: Contract;
+
+  before(async () => {
+    const provider = waffle.createMockProvider();
+    const wallet = (await waffle.getWallets(provider))[0];
+    nim = await waffle.deployContract(wallet, NimApp);
+  });
+
+  describe("applyAction", () => {
+    it("can take from a pile", async () => {
+      const preState = {
+        players: [AddressZero, AddressZero],
+        turnNum: 0,
+        pileHeights: [6, 5, 12]
+      };
+
+      const action = {
+        pileIdx: 0,
+        takeAmnt: 5
+      };
+
+      const ret = await nim.functions.applyAction(preState, action);
+
+      const postState = decodeAppState(ret);
+
+      expect(postState.pileHeights[0]).to.eq(1);
+      expect(postState.pileHeights[1]).to.eq(5);
+      expect(postState.pileHeights[2]).to.eq(12);
+      expect(postState.turnNum).to.eq(1);
+    });
+
+    it("can take to produce an empty pile", async () => {
+      const preState = {
+        players: [AddressZero, AddressZero],
+        turnNum: 0,
+        pileHeights: [6, 5, 12]
+      };
+
+      const action = {
+        pileIdx: 0,
+        takeAmnt: 6
+      };
+
+      const ret = await nim.functions.applyAction(preState, action);
+
+      const postState = decodeAppState(ret);
+
+      expect(postState.pileHeights[0]).to.eq(0);
+      expect(postState.pileHeights[1]).to.eq(5);
+      expect(postState.pileHeights[2]).to.eq(12);
+      expect(postState.turnNum).to.eq(1);
+    });
+
+    it("should fail for taking too much", async () => {
+      const preState = {
+        players: [AddressZero, AddressZero],
+        turnNum: 0,
+        pileHeights: [6, 5, 12]
+      };
+
+      const action = {
+        pileIdx: 0,
+        takeAmnt: 7
+      };
+
+      await expect(
+        nim.functions.applyAction(preState, action)
+      ).to.be.revertedWith("invalid pileIdx");
+    });
+  });
+
+  describe("isFinal", () => {
+    it("empty state is final", async () => {
+      const preState = {
+        players: [AddressZero, AddressZero],
+        turnNum: 49,
+        pileHeights: [0, 0, 0]
+      };
+      expect(await nim.functions.isStateTerminal(preState)).to.eq(true);
+    });
+
+    it("nonempty state is not final", async () => {
+      const preState = {
+        players: [AddressZero, AddressZero],
+        turnNum: 49,
+        pileHeights: [0, 1, 0]
+      };
+      expect(await nim.functions.isStateTerminal(preState)).to.eq(false);
+    });
+  });
+});