Add coverage badge (#140)

* Add coverage badge * Remove unused contracts * Update Docs * Update MockUniswapFactory
opynfinance · Aug 7, 2020 · 8cbbb90 · 8cbbb90
1 parent aab6a54
commit 8cbbb90
Show file tree

Hide file tree

Showing 31 changed files with 86 additions and 179 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# Convexity Protocol [![CircleCI](https://circleci.com/gh/opynfinance/OptionsProtocol/tree/dev.svg?style=svg&circle-token=dff9c1ce21f639bc170ef267bf2a93f43a5e5870)](https://circleci.com/gh/opynfinance/OptionsProtocol/tree/dev)
+# Convexity Protocol [![CircleCI](https://circleci.com/gh/opynfinance/OptionsProtocol/tree/dev.svg?style=svg&circle-token=dff9c1ce21f639bc170ef267bf2a93f43a5e5870)](https://circleci.com/gh/opynfinance/OptionsProtocol/tree/dev)[![Coverage Status](https://coveralls.io/repos/github/opynfinance/OptionsProtocol/badge.svg?branch=dev)](https://coveralls.io/github/opynfinance/OptionsProtocol?branch=dev)
 
 This vault contains all the smart contracts for Opyn's Convexity Protocol. Convexity allows options sellers to earn premiums on their collateral and options buyers to protect themselves against technical, financial and systemic risks that the underlying token faces.
 

diff --git a/contracts/OptionsUtils.sol b/contracts/OptionsUtils.sol
diff --git a/contracts/lib/MockUniswapFactory.sol b/contracts/lib/MockUniswapFactory.sol
@@ -7,19 +7,28 @@ contract MockUniswapFactory {
 
     address public exchangeTemplate;
     uint256 public tokenCount;
+    mapping(uint256 => address) public idToToken;
+    mapping(address => address) public exchanges;
+    mapping(address => address) public tokens;
+    address public _exchange;
+
     // Create Exchange
     function createExchange(address token) external pure returns (address exchange) {
-        return 0x06D014475F84Bb45b9cdeD1Cf3A1b8FE3FbAf128;
+        return token; // return random address.
     }
     // Get Exchange and Token Info
-    function getExchange(address token) external pure returns (address exchange){
-        return 0x06D014475F84Bb45b9cdeD1Cf3A1b8FE3FbAf128;
+    function getExchange(address token) external view returns (address exchange){
+        return exchanges[token];
+    }
+    function getToken(address exchange) external view returns (address token) {
+        return tokens[exchange];
     }
-    function getToken(address exchange) external pure returns (address token) {
-        return 0x06D014475F84Bb45b9cdeD1Cf3A1b8FE3FbAf128;
+    function getTokenWithId(uint256 tokenId) external view returns (address token) {
+        return idToToken[tokenId];
     }
-    function getTokenWithId(uint256 tokenId) external pure returns (address token) {
-        return 0x06D014475F84Bb45b9cdeD1Cf3A1b8FE3FbAf128;
+    function setTokenExchange(address token, address exchange) public {
+        exchanges[token] = exchange;
+        tokens[exchange] = token;
     }
     // Never use
     function initializeFactory(address template) external {

diff --git a/docs/CTokenInterface.md b/docs/CTokenInterface.md
@@ -1,6 +1,6 @@
 # CTokenInterface.sol
 
-View Source: [contracts/lib/CTokenInterface.sol](../contracts/lib/CTokenInterface.sol)
+View Source: [contracts/interfaces/CTokenInterface.sol](../contracts/interfaces/CTokenInterface.sol)
 
 **CTokenInterface**
 
@@ -264,7 +264,6 @@ returns(uint256)
 * [ERC20Detailed](ERC20Detailed.md)
 * [ERC20Mintable](ERC20Mintable.md)
 * [IERC20](IERC20.md)
-* [IOptionsExchange](IOptionsExchange.md)
 * [LibNote](LibNote.md)
 * [Migrations](Migrations.md)
 * [MinterRole](MinterRole.md)

diff --git a/docs/CompoundOracleInterface.md b/docs/CompoundOracleInterface.md
@@ -1,6 +1,6 @@
 # CompoundOracleInterface.sol
 
-View Source: [contracts/lib/CompoundOracleInterface.sol](../contracts/lib/CompoundOracleInterface.sol)
+View Source: [contracts/interfaces/CompoundOracleInterface.sol](../contracts/interfaces/CompoundOracleInterface.sol)
 
 **CompoundOracleInterface**
 
@@ -63,7 +63,6 @@ returns(uint256)
 * [ERC20Detailed](ERC20Detailed.md)
 * [ERC20Mintable](ERC20Mintable.md)
 * [IERC20](IERC20.md)
-* [IOptionsExchange](IOptionsExchange.md)
 * [LibNote](LibNote.md)
 * [Migrations](Migrations.md)
 * [MinterRole](MinterRole.md)

diff --git a/docs/Context.md b/docs/Context.md
@@ -57,7 +57,6 @@ returns(bytes)
 * [ERC20Detailed](ERC20Detailed.md)
 * [ERC20Mintable](ERC20Mintable.md)
 * [IERC20](IERC20.md)
-* [IOptionsExchange](IOptionsExchange.md)
 * [LibNote](LibNote.md)
 * [Migrations](Migrations.md)
 * [MinterRole](MinterRole.md)

diff --git a/docs/Dai.md b/docs/Dai.md
@@ -278,7 +278,6 @@ function permit(address holder, address spender, uint256 nonce, uint256 expiry,
 * [ERC20Detailed](ERC20Detailed.md)
 * [ERC20Mintable](ERC20Mintable.md)
 * [IERC20](IERC20.md)
-* [IOptionsExchange](IOptionsExchange.md)
 * [LibNote](LibNote.md)
 * [Migrations](Migrations.md)
 * [MinterRole](MinterRole.md)

diff --git a/docs/ERC20.md b/docs/ERC20.md
@@ -324,7 +324,6 @@ function _burnFrom(address account, uint256 amount) internal nonpayable
 * [ERC20Detailed](ERC20Detailed.md)
 * [ERC20Mintable](ERC20Mintable.md)
 * [IERC20](IERC20.md)
-* [IOptionsExchange](IOptionsExchange.md)
 * [LibNote](LibNote.md)
 * [Migrations](Migrations.md)
 * [MinterRole](MinterRole.md)

diff --git a/docs/ERC20Detailed.md b/docs/ERC20Detailed.md
@@ -103,7 +103,6 @@ returns(uint8)
 * [ERC20Detailed](ERC20Detailed.md)
 * [ERC20Mintable](ERC20Mintable.md)
 * [IERC20](IERC20.md)
-* [IOptionsExchange](IOptionsExchange.md)
 * [LibNote](LibNote.md)
 * [Migrations](Migrations.md)
 * [MinterRole](MinterRole.md)

diff --git a/docs/ERC20Mintable.md b/docs/ERC20Mintable.md
@@ -42,7 +42,6 @@ returns(bool)
 * [ERC20Detailed](ERC20Detailed.md)
 * [ERC20Mintable](ERC20Mintable.md)
 * [IERC20](IERC20.md)
-* [IOptionsExchange](IOptionsExchange.md)
 * [LibNote](LibNote.md)
 * [Migrations](Migrations.md)
 * [MinterRole](MinterRole.md)

diff --git a/docs/IERC20.md b/docs/IERC20.md
@@ -158,7 +158,6 @@ returns(bool)
 * [ERC20Detailed](ERC20Detailed.md)
 * [ERC20Mintable](ERC20Mintable.md)
 * [IERC20](IERC20.md)
-* [IOptionsExchange](IOptionsExchange.md)
 * [LibNote](LibNote.md)
 * [Migrations](Migrations.md)
 * [MinterRole](MinterRole.md)

diff --git a/docs/IOptionsExchange.md b/docs/IOptionsExchange.md
diff --git a/docs/LibNote.md b/docs/LibNote.md
@@ -279,7 +279,6 @@ function permit(address holder, address spender, uint256 nonce, uint256 expiry,
 * [ERC20Detailed](ERC20Detailed.md)
 * [ERC20Mintable](ERC20Mintable.md)
 * [IERC20](IERC20.md)
-* [IOptionsExchange](IOptionsExchange.md)
 * [LibNote](LibNote.md)
 * [Migrations](Migrations.md)
 * [MinterRole](MinterRole.md)

diff --git a/docs/Migrations.md b/docs/Migrations.md
@@ -79,7 +79,6 @@ function upgrade(address new_address) public nonpayable restricted
 * [ERC20Detailed](ERC20Detailed.md)
 * [ERC20Mintable](ERC20Mintable.md)
 * [IERC20](IERC20.md)
-* [IOptionsExchange](IOptionsExchange.md)
 * [LibNote](LibNote.md)
 * [Migrations](Migrations.md)
 * [MinterRole](MinterRole.md)

diff --git a/docs/MinterRole.md b/docs/MinterRole.md
@@ -127,7 +127,6 @@ function _removeMinter(address account) internal nonpayable
 * [ERC20Detailed](ERC20Detailed.md)
 * [ERC20Mintable](ERC20Mintable.md)
 * [IERC20](IERC20.md)
-* [IOptionsExchange](IOptionsExchange.md)
 * [LibNote](LibNote.md)
 * [Migrations](Migrations.md)
 * [MinterRole](MinterRole.md)

diff --git a/docs/MockCompoundOracle.md b/docs/MockCompoundOracle.md
@@ -64,7 +64,6 @@ function updatePrice(uint256 newPrice) public nonpayable
 * [ERC20Detailed](ERC20Detailed.md)
 * [ERC20Mintable](ERC20Mintable.md)
 * [IERC20](IERC20.md)
-* [IOptionsExchange](IOptionsExchange.md)
 * [LibNote](LibNote.md)
 * [Migrations](Migrations.md)
 * [MinterRole](MinterRole.md)

diff --git a/docs/MockUniswapFactory.md b/docs/MockUniswapFactory.md
@@ -36,7 +36,7 @@ function () public nonpayable
 ### createExchange
 
 ```js
-function createExchange(address token) external nonpayable
+function createExchange(address token) external pure
 returns(exchange address)
 ```
 
@@ -49,7 +49,7 @@ returns(exchange address)
 ### getExchange
 
 ```js
-function getExchange(address token) external view
+function getExchange(address token) external pure
 returns(exchange address)
 ```
 
@@ -62,7 +62,7 @@ returns(exchange address)
 ### getToken
 
 ```js
-function getToken(address exchange) external view
+function getToken(address exchange) external pure
 returns(token address)
 ```
 
@@ -75,7 +75,7 @@ returns(token address)
 ### getTokenWithId
 
 ```js
-function getTokenWithId(uint256 tokenId) external view
+function getTokenWithId(uint256 tokenId) external pure
 returns(token address)
 ```
 
@@ -107,7 +107,6 @@ function initializeFactory(address template) external nonpayable
 * [ERC20Detailed](ERC20Detailed.md)
 * [ERC20Mintable](ERC20Mintable.md)
 * [IERC20](IERC20.md)
-* [IOptionsExchange](IOptionsExchange.md)
 * [LibNote](LibNote.md)
 * [Migrations](Migrations.md)
 * [MinterRole](MinterRole.md)

diff --git a/docs/OptionsContract.md b/docs/OptionsContract.md
@@ -47,7 +47,7 @@ int32 public underlyingExp;
 contract IERC20 public collateral;
 contract IERC20 public underlying;
 contract IERC20 public strike;
-contract CompoundOracleInterface public COMPOUND_ORACLE;
+contract CompoundOracleInterface public compoundOracle;
 string public name;
 string public symbol;
 uint8 public decimals;
@@ -718,7 +718,6 @@ returns(uint256)
 * [ERC20Detailed](ERC20Detailed.md)
 * [ERC20Mintable](ERC20Mintable.md)
 * [IERC20](IERC20.md)
-* [IOptionsExchange](IOptionsExchange.md)
 * [LibNote](LibNote.md)
 * [Migrations](Migrations.md)
 * [MinterRole](MinterRole.md)

diff --git a/docs/OptionsExchange.md b/docs/OptionsExchange.md
@@ -13,7 +13,7 @@ uint256 internal constant LARGE_BLOCK_SIZE;
 uint256 internal constant LARGE_APPROVAL_NUMBER;
 
 //public members
-contract UniswapFactoryInterface public UNISWAP_FACTORY;
+contract UniswapFactoryInterface public uniswapFactory;
 
 ```
 
@@ -198,7 +198,6 @@ function () external payable
 * [ERC20Detailed](ERC20Detailed.md)
 * [ERC20Mintable](ERC20Mintable.md)
 * [IERC20](IERC20.md)
-* [IOptionsExchange](IOptionsExchange.md)
 * [LibNote](LibNote.md)
 * [Migrations](Migrations.md)
 * [MinterRole](MinterRole.md)

diff --git a/docs/OptionsFactory.md b/docs/OptionsFactory.md
@@ -156,7 +156,6 @@ returns(bool)
 * [ERC20Detailed](ERC20Detailed.md)
 * [ERC20Mintable](ERC20Mintable.md)
 * [IERC20](IERC20.md)
-* [IOptionsExchange](IOptionsExchange.md)
 * [LibNote](LibNote.md)
 * [Migrations](Migrations.md)
 * [MinterRole](MinterRole.md)

diff --git a/docs/OptionsUtils.md b/docs/OptionsUtils.md
@@ -8,8 +8,8 @@ View Source: [contracts/OptionsUtils.sol](../contracts/OptionsUtils.sol)
 **Constants & Variables**
 
 ```js
-contract UniswapFactoryInterface public UNISWAP_FACTORY;
-contract CompoundOracleInterface public COMPOUND_ORACLE;
+contract UniswapFactoryInterface public uniswapFactory;
+contract CompoundOracleInterface public compoundOracle;
 
 ```
 
@@ -68,7 +68,6 @@ returns(bool)
 * [ERC20Detailed](ERC20Detailed.md)
 * [ERC20Mintable](ERC20Mintable.md)
 * [IERC20](IERC20.md)
-* [IOptionsExchange](IOptionsExchange.md)
 * [LibNote](LibNote.md)
 * [Migrations](Migrations.md)
 * [MinterRole](MinterRole.md)

diff --git a/docs/Oracle.md b/docs/Oracle.md
@@ -8,13 +8,10 @@ View Source: [contracts/Oracle.sol](../contracts/Oracle.sol)
 **Constants & Variables**
 
 ```js
-//internal members
-mapping(address => bool) internal isCToken;
-mapping(address => address) internal assetToCTokens;
-address internal cETH;
-
-//public members
-contract CompoundOracleInterface public PriceOracle;
+mapping(address => bool) public isCToken;
+mapping(address => address) public assetToCTokens;
+address public cETH;
+contract CompoundOracleInterface public priceOracle;
 
 ```
 
@@ -86,7 +83,6 @@ returns(uint256)
 * [ERC20Detailed](ERC20Detailed.md)
 * [ERC20Mintable](ERC20Mintable.md)
 * [IERC20](IERC20.md)
-* [IOptionsExchange](IOptionsExchange.md)
 * [LibNote](LibNote.md)
 * [Migrations](Migrations.md)
 * [MinterRole](MinterRole.md)

diff --git a/docs/Ownable.md b/docs/Ownable.md
@@ -150,7 +150,6 @@ function _transferOwnership(address newOwner) internal nonpayable
 * [ERC20Detailed](ERC20Detailed.md)
 * [ERC20Mintable](ERC20Mintable.md)
 * [IERC20](IERC20.md)
-* [IOptionsExchange](IOptionsExchange.md)
 * [LibNote](LibNote.md)
 * [Migrations](Migrations.md)
 * [MinterRole](MinterRole.md)

diff --git a/docs/Roles.md b/docs/Roles.md
@@ -81,7 +81,6 @@ bool
 * [ERC20Detailed](ERC20Detailed.md)
 * [ERC20Mintable](ERC20Mintable.md)
 * [IERC20](IERC20.md)
-* [IOptionsExchange](IOptionsExchange.md)
 * [LibNote](LibNote.md)
 * [Migrations](Migrations.md)
 * [MinterRole](MinterRole.md)