check: master vs first collateral cap commit

.circleci/config.yml

@@ -153,7 +153,23 @@ jobs:
       - attach_workspace:
           at: ~/repo
       - run: yarn run lint
-
+  format:
+    docker:
+      - image: circleci/node:13
+    working_directory: ~/repo
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+          - v3-dependencies-{{ checksum "yarn.lock" }}
+      - run: yarn install || (yarn cache clean && yarn install)
+      - save_cache:
+          paths:
+            - node_modules
+          key: v3-dependencies-{{ checksum "yarn.lock" }}
+      - attach_workspace:
+          at: ~/repo
+      - run: yarn run prettier '**/**/*.sol' -c
   docker:
     docker:
       - image: cimg/go:1.13
@@ -187,4 +203,5 @@ workflows:
     jobs:
       - test
       - lint
+      - format
       - verify

.prettierrc

@@ -0,0 +1,15 @@
+{
+    "overrides": [
+      {
+        "files": "*.sol",
+        "options": {
+          "printWidth": 120,
+          "tabWidth": 4,
+          "useTabs": false,
+          "singleQuote": false,
+          "bracketSpacing": false,
+          "explicitTypes": "always"
+        }
+      }
+    ]
+  }

README.md

@@ -24,3 +24,67 @@ Testing
 Jest contract tests are defined under the [tests directory](https://github.com/compound-finance/compound-protocol/tree/master/tests). To run the tests run:
 
     yarn test
+
+Branch
+------
+[master](https://github.com/CreamFi/compound-protocol/tree/master) - deployed on ethereum mainnet
+
+[bsc](https://github.com/CreamFi/compound-protocol/tree/bsc) - deployed on binance smart chain
+
+[cream-v2](https://github.com/CreamFi/compound-protocol/tree/cream-v2) - (ironbank) deployed on ethereum mainnet
+
+[fantom_time_based](https://github.com/CreamFi/compound-protocol/tree/fantom_time_based) - deployed on fantom opera
+
+[polygon](https://github.com/CreamFi/compound-protocol/tree/polygon) - depolyed on polygon
+
+[arbitrum](https://github.com/CreamFi/compound-protocol/tree/arbitrum) - deployed on arbitrum
+
+[avalanche](https://github.com/CreamFi/compound-protocol/tree/avalanche) - deployed on avalanche
+
+Audits
+-------
+C.R.E.A.M. Finance smart contracts have been audited by Trail of Bits. The audit report is available on Trail of Bits [publications repo](https://github.com/trailofbits/publications/blob/master/reviews/CREAMSummary.pdf).
+
+Change Logs
+-----------
+C.R.E.A.M. Finance forked from this commit [7561dcf5964527dbf2f3c7cd670775b3c6f7e378](https://github.com/compound-finance/compound-protocol/commits/7561dcf5964527dbf2f3c7cd670775b3c6f7e378) of Compound Finance,
+Cream continues to add new features and submits pull requests back to Compound as appropriate. Below is a high level summary of the changes:
+
+- Add borrow cap feature, this feature is cherry picked from Compound Finance https://github.com/compound-finance/compound-protocol/pull/65
+  * Add a borrow cap check in Comptroller's borrowAllowed hook, disallow further borrowing if an market's totalBorrows reaches its borrow cap
+
+- Add supply cap feature, implemented in Comptroller.sol, CCapableErc20.sol
+  * Add a supply cap check in Comptroller's mintAllowed hook, disallow further minting (supplying) if an market's cash + totalBorrows reaches its supply cap
+  * CCapableErc20 tracks cash by itself instead of using balanceOf of underlying token. This avoids direct transfering to cToken to manipulate cash.
+  * Need to update cToken's implementation to enable this feature.
+
+- Add collateral cap feature, implemented in Comptroller.sol, CCollateralCapErc20.sol
+  * Add a collateral cap to determine the maximum balance to be considered as collateral. If the cap is reached, users could still supply the asset but it can't be used as collateral.
+  * The maximum borrow power of this kind of asset is roughly collateralCap * collateralFactor.
+  * Need to update cToken's implementation to enable this feature.
+
+- Add CWrappedNative to replace old CEther
+  * CWrappedNative could support both the native token and the wrapped native token.
+  * Users could choose the native token or the wrapped native token when supplying / borrowing / redeeming / repaying.
+
+- Support earning sushi LP tokens. Implemented in CSLPDelegate.sol
+  * CSLP deposit/withdraw sushi lp token to/from sushi MasterChef when doTransferIn/doTrasnferOut
+  * Suppliers can use sushi LP tokens as collateral
+  * Suppliers can claim sushi reward or borrow interest
+
+- Support claiming COMP earned from holding CTokens. Implemented in CCTokenDelegate.sol
+  * CCToken collects Compound reward and supplier can use claimComp function to claim their reward
+
+BSC
+- Update price oracle implementation to support BAND.
+- Support protocol to protocol borrowing without collateral, this gives whitelisted protocol borrows up to credit limit without collateral.
+   * add credit limit in Comptroller.sol
+   * When setup a credit limit, it also needs to specify the borrow markets.
+
+IronBank
+- Support protocol to protocol borrowing without collateral, this gives whitelisted protocol borrows up to credit limit without collateral.
+   * add credit limit in Comptroller.sol
+   * remove repayBorrowBehalf, so that protocol can track their debt easily.
+- Patch as part of the update in the Alpha Homora v2 exploit, excluding stolen funds from interest calculation.
+  * CToken.sol on cream-v2-no-interest branch
+  * Apply on cyWETH, cyUSDC, cyUSDT, cyDAI