SetProtocol · cgewecke · Apr 28, 2021 · Apr 28, 2021 · Apr 29, 2021 · Apr 29, 2021
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -2,16 +2,12 @@ version: 2
 
 jobs:
   checkout_and_compile:
-    docker:
-      - image: circleci/node:10.16.0
-        environment:
-          NODE_OPTIONS: --max_old_space_size=8192
+    machine:
+      image: ubuntu-2004:202010-01
     resource_class: large
     working_directory: ~/set-protocol-v2
     steps:
       - checkout
-      - setup_remote_docker:
-          docker_layer_caching: false
       - restore_cache:
           key: module-cache-{{ checksum "yarn.lock" }}
       - run:
@@ -35,90 +31,50 @@ jobs:
     docker:
       - image: circleci/node:10.16.0
     working_directory: ~/set-protocol-v2
-    parallelism: 3
     steps:
-      - setup_remote_docker:
-          docker_layer_caching: false
-      - run:
-          name: Fetch solc version
-          command: docker pull ethereum/solc:0.6.10
       - restore_cache:
           key: compiled-env-{{ .Environment.CIRCLE_SHA1 }}
       - run:
           name: Set Up Environment Variables
           command: cp .env.default .env
+      - run:
+          name: Re-compile for HardhatEVM
+          command: yarn compile --force
       - run:
           name: Test RPC
           command: yarn chain
           background: true
       - run:
           name: Hardhat Test
-          command: |
-            TEST_FILES="$(circleci tests glob "./test/**/*.spec.ts" | circleci tests split --split-by=timings)"
-            yarn test ${TEST_FILES}
+          command: yarn test:fast
 
-  coverage:
-    docker:
-      - image: circleci/node:10.11.0
+  test_ovm:
+    machine:
+      image: ubuntu-2004:202010-01
+      docker_layer_caching: true
     working_directory: ~/set-protocol-v2
-    # When changing the parallelism value, you also
-    # need to update the `persist_to_workspace` paths
-    # in this job (below) as well as the list of files passed
-    # to istanbul-combine in the `report_coverage` job
-    parallelism: 5
     steps:
-      - setup_remote_docker:
-          docker_layer_caching: false
-      - run:
-          name: Fetch solc version
-          command: docker pull ethereum/solc:0.6.10
       - restore_cache:
           key: compiled-env-{{ .Environment.CIRCLE_SHA1 }}
       - run:
           name: Set Up Environment Variables
           command: cp .env.default .env
       - run:
-          name: Create shared coverage outputs folder
-          command: mkdir -p /tmp/coverage
-      - run:
-          name: Coverage
+          name: Docker ghcr.io login
           command: |
-            TEST_FILES="{$(circleci tests glob "./test/**/*.spec.ts" | \
-              circleci tests split --split-by=timings | xargs | sed -e 's/ /,/g')}"
-            yarn coverage -- --testfiles "$TEST_FILES"
+            docker login ghcr.io -u $DOCKER_USER -p $DOCKER_PASSWORD
       - run:
-          name: Save coverage
-          command: |
-            cp coverage.json /tmp/coverage/cov_$CIRCLE_NODE_INDEX.json
-            chmod -R 777 /tmp/coverage/cov_$CIRCLE_NODE_INDEX.json
-      - persist_to_workspace:
-          root: /tmp/coverage
-          paths:
-            - cov_0.json
-            - cov_1.json
-            - cov_2.json
-            - cov_3.json
-            - cov_4.json
-
-  report_coverage:
-    docker:
-      - image: circleci/node:10.11.0
-    working_directory: ~/set-protocol-v2
-    steps:
-      - attach_workspace:
-          at: /tmp/coverage
-      - restore_cache:
-          key: compiled-env-{{ .Environment.CIRCLE_SHA1 }}
+          name: Install Optimism client
+          command: yarn ovm:install
       - run:
-          name: Combine coverage reports
-          command: |
-            mkdir -p reports
-            cp -R /tmp/coverage/* .
-            npx istanbul-combine-updated -r lcov cov_0.json cov_1.json cov_2.json cov_3.json cov_4.json
+          name: Launch Optimism client
+          command: yarn ovm:run:ci
       - run:
-          name: Upload coverage
+          name: Test
           command: |
-            cat coverage/lcov.info | node_modules/.bin/coveralls
+            yarn ovm:fundl2EthAccounts
+            yarn test:ovm:fast test/protocol/core.spec.ts
+            yarn test:ovm:fast test/protocol/setToken.spec.ts
 
 workflows:
   version: 2
@@ -128,9 +84,6 @@ workflows:
       - test:
           requires:
             - checkout_and_compile
-      - coverage:
+      - test_ovm:
           requires:
             - checkout_and_compile
-      - report_coverage:
-          requires:
-            - coverage
diff --git a/.gitignore b/.gitignore
@@ -1,7 +1,10 @@
 .DS_Store
 /artifacts
+/artifacts-ovm
 /build
 /cache
+/cache-ovm
+/optimism
 /dist
 /etherscan
 /flatten

diff --git a/README.md b/README.md
@@ -10,21 +10,41 @@
 ## Contracts
 [Set Protocol](https://setprotocol.com/) is a specification for tokenized asset management strategies on the ethereum blockchain written in the Solidity programming language. We use [Hardhat](https://hardhat.org/) as a development environment for compiling, testing, and deploying our contracts.
 
-## Development
+## Optimism
 
-To use console.log during Solidity development, follow the [guides](https://hardhat.org/guides/hardhat-console.html).
+**Install the Optimism client**
 
-## Available Functionality
+```
+yarn ovm:install
+```
+
+**Run**
+
+This command spins up several services and takes a couple minutes to get going. It's ready
+when the log output shows `l2geth_1` blocks mining.
+```
+# In a separate terminal (use ctrl-c to stop)
+yarn ovm:run
+```
 
-### Run Hardhat EVM
+**Fund L2 accounts from L1 via bridge**
+```
+yarn ovm:fundl2EthAccounts
+```
 
-`yarn chain`
+## Available Functionality
+
+### Run Optimism OVM
+```
+cd optimism/ops
+docker-compose up
+```
 
 ### Build Contracts
 
-`yarn compile`
+`yarn compile:ovm`
 
-To speed up compilation, install solc 0.6.10 natively with the following command.
+To speed up compilation, install solc 0.6.12 natively with the following command.
 ```
 brew install https://raw.githubusercontent.com/ethereum/homebrew-ethereum/06d13a8499801dc3ea4f19b2d24ed2eeb3072ebb/solidity.rb
 ```
@@ -35,9 +55,7 @@ brew install https://raw.githubusercontent.com/ethereum/homebrew-ethereum/06d13a
 
 ### Run Contract Tests
 
-`yarn test` to run compiled contracts 
-
-OR `yarn test:clean` if contracts have been typings need to be updated
+`yarn test:ovm` to run compiled contracts
 
 ### Run Coverage Report for Tests
 

diff --git a/contracts/interfaces/IBasicIssuanceModule.sol b/contracts/interfaces/IBasicIssuanceModule.sol
@@ -14,8 +14,6 @@
     limitations under the License.
 
     SPDX-License-Identifier: Apache License, Version 2.0
-
-    // @unsupported: ovm
 */
 pragma solidity 0.6.12;
 

diff --git a/contracts/interfaces/IController.sol b/contracts/interfaces/IController.sol
@@ -14,8 +14,6 @@
     limitations under the License.
 
     SPDX-License-Identifier: Apache License, Version 2.0
-
-    // @unsupported: ovm
 */
 pragma solidity 0.6.12;
 

diff --git a/contracts/interfaces/IExchangeAdapter.sol b/contracts/interfaces/IExchangeAdapter.sol
@@ -14,8 +14,6 @@
     limitations under the License.
 
     SPDX-License-Identifier: Apache License, Version 2.0
-
-    // @unsupported: ovm
 */
 pragma solidity 0.6.12;
 

diff --git a/contracts/interfaces/IIndexExchangeAdapter.sol b/contracts/interfaces/IIndexExchangeAdapter.sol
@@ -14,8 +14,6 @@
     limitations under the License.
 
     SPDX-License-Identifier: Apache License, Version 2.0
-
-    // @unsupported: ovm
 */
 pragma solidity 0.6.12;
 

diff --git a/contracts/interfaces/IIntegrationRegistry.sol b/contracts/interfaces/IIntegrationRegistry.sol
@@ -14,8 +14,6 @@
     limitations under the License.
 
     SPDX-License-Identifier: Apache License, Version 2.0
-
-    // @unsupported: ovm
 */
 pragma solidity 0.6.12;
 

diff --git a/contracts/interfaces/IManagerIssuanceHook.sol b/contracts/interfaces/IManagerIssuanceHook.sol
@@ -14,8 +14,6 @@
     limitations under the License.
 
     SPDX-License-Identifier: Apache License, Version 2.0
-
-    // @unsupported: ovm
 */
 pragma solidity 0.6.12;
 

diff --git a/contracts/interfaces/IModule.sol b/contracts/interfaces/IModule.sol
@@ -14,8 +14,6 @@
     limitations under the License.
 
     SPDX-License-Identifier: Apache License, Version 2.0
-
-    // @unsupported: ovm
 */
 pragma solidity 0.6.12;
 

diff --git a/contracts/interfaces/IModuleIssuanceHook.sol b/contracts/interfaces/IModuleIssuanceHook.sol
@@ -14,8 +14,6 @@
     limitations under the License.
 
     SPDX-License-Identifier: Apache License, Version 2.0
-
-    // @unsupported: ovm
 */
 pragma solidity 0.6.12;
 

diff --git a/contracts/interfaces/IOracle.sol b/contracts/interfaces/IOracle.sol
@@ -14,8 +14,6 @@
     limitations under the License.
 
     SPDX-License-Identifier: Apache License, Version 2.0
-
-    // @unsupported: ovm
 */
 pragma solidity 0.6.12;
 

diff --git a/contracts/interfaces/IOracleAdapter.sol b/contracts/interfaces/IOracleAdapter.sol
@@ -14,8 +14,6 @@
     limitations under the License.
 
     SPDX-License-Identifier: Apache License, Version 2.0
-
-    // @unsupported: ovm
 */
 pragma solidity 0.6.12;
 

diff --git a/contracts/interfaces/IPriceOracle.sol b/contracts/interfaces/IPriceOracle.sol
@@ -14,8 +14,6 @@
     limitations under the License.
 
     SPDX-License-Identifier: Apache License, Version 2.0
-
-    // @unsupported: ovm
 */
 pragma solidity 0.6.12;
 

diff --git a/contracts/interfaces/ISetToken.sol b/contracts/interfaces/ISetToken.sol
@@ -14,8 +14,6 @@
     limitations under the License.
 
     SPDX-License-Identifier: Apache License, Version 2.0
-
-    // @unsupported: ovm
 */
 pragma solidity 0.6.12;
 pragma experimental "ABIEncoderV2";
@@ -118,19 +116,14 @@ interface ISetToken is IERC20 {
     function moduleStates(address _module) external view returns (ModuleState);
     function getModules() external view returns (address[] memory);
 
-    function getDefaultPositionRealUnit(address _component) external view returns(int256);
-    function getExternalPositionRealUnit(address _component, address _positionModule) external view returns(int256);
-    function getComponents() external view returns(address[] memory);
+    function getComponents() external view returns (address[] memory);
+    function getExternalPositionVirtualUnit(address _component, address _module) external view returns (int256);
+    function getDefaultPositionVirtualUnit(address _component) external view returns (int256);
+    function getComponentExternalPosition(address _component, address _positionModule) external view returns (ExternalPosition memory);
     function getExternalPositionModules(address _component) external view returns(address[] memory);
     function getExternalPositionData(address _component, address _positionModule) external view returns(bytes memory);
-    function isExternalPositionModule(address _component, address _module) external view returns(bool);
-    function isComponent(address _component) external view returns(bool);
 
     function positionMultiplier() external view returns (int256);
-    function getPositions() external view returns (Position[] memory);
-    function getTotalComponentRealUnits(address _component) external view returns(int256);
 
-    function isInitializedModule(address _module) external view returns(bool);
-    function isPendingModule(address _module) external view returns(bool);
     function isLocked() external view returns (bool);
-}
+}
diff --git a/contracts/interfaces/ISetValuer.sol b/contracts/interfaces/ISetValuer.sol
@@ -14,8 +14,6 @@
     limitations under the License.
 
     SPDX-License-Identifier: Apache License, Version 2.0
-
-    // @unsupported: ovm
 */
 pragma solidity 0.6.12;
 

diff --git a/contracts/interfaces/IStreamingFeeModule.sol b/contracts/interfaces/IStreamingFeeModule.sol
@@ -14,8 +14,6 @@
     limitations under the License.
 
     SPDX-License-Identifier: Apache License, Version 2.0
-
-    // @unsupported: ovm
 */
 pragma solidity 0.6.12;
 pragma experimental "ABIEncoderV2";

diff --git a/contracts/interfaces/external/ICErc20.sol b/contracts/interfaces/external/ICErc20.sol
@@ -14,8 +14,6 @@
     limitations under the License.
 
     SPDX-License-Identifier: Apache License, Version 2.0
-
-    // @unsupported: ovm
 */
 
 pragma solidity 0.6.12;

diff --git a/contracts/interfaces/external/ISynth.sol b/contracts/interfaces/external/ISynth.sol
@@ -14,8 +14,6 @@
     limitations under the License.
 
     SPDX-License-Identifier: Apache License, Version 2.0
-
-    // @unsupported: ovm
 */
 
 pragma solidity 0.6.12;

diff --git a/contracts/interfaces/external/ISynthetixExchanger.sol b/contracts/interfaces/external/ISynthetixExchanger.sol
@@ -14,8 +14,6 @@
     limitations under the License.
 
     SPDX-License-Identifier: Apache License, Version 2.0
-
-    // @unsupported: ovm
 */
 
 pragma solidity 0.6.12;

diff --git a/contracts/interfaces/external/IUniswapV2Pair.sol b/contracts/interfaces/external/IUniswapV2Pair.sol
@@ -10,8 +10,6 @@
     See the License for the specific language governing permissions and
     limitations under the License.
     SPDX-License-Identifier: Apache License, Version 2.0
-
-    // @unsupported: ovm
 */
 
 pragma solidity 0.6.12;