Fixes on interfaces (#313)

* Added OptionHelper interface * Allowing future version usage * Added missing SPDX
pods-finance · Nov 25, 2021 · b18a21f · b18a21f
1 parent 1dd7bfe
commit b18a21f
Show file tree

Hide file tree

Showing 7 changed files with 82 additions and 13 deletions.
diff --git a/contracts/configuration/OptionPoolRegistry.sol b/contracts/configuration/OptionPoolRegistry.sol
@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: agpl-3.0
 pragma solidity 0.8.4;
 
 import "../interfaces/IConfigurationManager.sol";

diff --git a/contracts/helpers/OptionHelper.sol b/contracts/helpers/OptionHelper.sol
@@ -12,13 +12,14 @@ import "../interfaces/IConfigurationManager.sol";
 import "../interfaces/IPodOption.sol";
 import "../interfaces/IOptionAMMPool.sol";
 import "../interfaces/IOptionPoolRegistry.sol";
+import "../interfaces/IOptionHelper.sol";
 
 /**
  * @title PodOption
  * @author Pods Finance
  * @notice Represents a Proxy that can perform a set of operations on the behalf of an user
  */
-contract OptionHelper is ReentrancyGuard {
+contract OptionHelper is IOptionHelper, ReentrancyGuard {
     using SafeERC20 for IERC20;
     using SafeMath for uint256;
 
@@ -79,7 +80,7 @@ contract OptionHelper is ReentrancyGuard {
      * @param option The option contract to mint
      * @param optionAmount Amount of options to mint
      */
-    function mint(IPodOption option, uint256 optionAmount) external {
+    function mint(IPodOption option, uint256 optionAmount) external override {
         _mint(option, optionAmount);
 
         // Transfers back the minted options
@@ -102,7 +103,7 @@ contract OptionHelper is ReentrancyGuard {
         uint256 minTokenAmount,
         uint256 deadline,
         uint256 initialIVGuess
-    ) external nonReentrant withinDeadline(deadline) {
+    ) external override nonReentrant withinDeadline(deadline) {
         IOptionAMMPool pool = _getPool(option);
 
         _mint(option, optionAmount);
@@ -128,7 +129,7 @@ contract OptionHelper is ReentrancyGuard {
         IPodOption option,
         uint256 optionAmount,
         uint256 tokenAmount
-    ) external nonReentrant {
+    ) external override nonReentrant {
         IOptionAMMPool pool = _getPool(option);
         IERC20 tokenB = IERC20(pool.tokenB());
 
@@ -156,7 +157,11 @@ contract OptionHelper is ReentrancyGuard {
      * @param option The option contract to mint
      * @param collateralAmount Amount of collateral tokens to be used to both mint and mint into the stable side
      */
-    function mintAndAddLiquidityWithCollateral(IPodOption option, uint256 collateralAmount) external nonReentrant {
+    function mintAndAddLiquidityWithCollateral(IPodOption option, uint256 collateralAmount)
+        external
+        override
+        nonReentrant
+    {
         require(option.optionType() == IPodOption.OptionType.PUT, "OptionHelper: Invalid option type");
         IOptionAMMPool pool = _getPool(option);
         IERC20 tokenB = IERC20(pool.tokenB());
@@ -189,7 +194,7 @@ contract OptionHelper is ReentrancyGuard {
         IPodOption option,
         uint256 optionAmount,
         uint256 tokenAmount
-    ) external nonReentrant {
+    ) external override nonReentrant {
         IOptionAMMPool pool = _getPool(option);
         IERC20 tokenB = IERC20(pool.tokenB());
 
@@ -229,7 +234,7 @@ contract OptionHelper is ReentrancyGuard {
         uint256 minTokenReceived,
         uint256 deadline,
         uint256 initialIVGuess
-    ) external withinDeadline(deadline) nonReentrant {
+    ) external override withinDeadline(deadline) nonReentrant {
         IOptionAMMPool pool = _getPool(option);
         IERC20 tokenA = IERC20(pool.tokenA());
 
@@ -261,7 +266,7 @@ contract OptionHelper is ReentrancyGuard {
         uint256 exactTokenReceived,
         uint256 deadline,
         uint256 initialIVGuess
-    ) external withinDeadline(deadline) nonReentrant {
+    ) external override withinDeadline(deadline) nonReentrant {
         IOptionAMMPool pool = _getPool(option);
         IERC20 tokenA = IERC20(pool.tokenA());
 
@@ -303,7 +308,7 @@ contract OptionHelper is ReentrancyGuard {
         uint256 maxTokenAmount,
         uint256 deadline,
         uint256 initialIVGuess
-    ) external withinDeadline(deadline) nonReentrant {
+    ) external override withinDeadline(deadline) nonReentrant {
         IOptionAMMPool pool = _getPool(option);
         IERC20 tokenB = IERC20(pool.tokenB());
 
@@ -344,7 +349,7 @@ contract OptionHelper is ReentrancyGuard {
         uint256 tokenAmount,
         uint256 deadline,
         uint256 initialIVGuess
-    ) external withinDeadline(deadline) nonReentrant {
+    ) external override withinDeadline(deadline) nonReentrant {
         IOptionAMMPool pool = _getPool(option);
         IERC20 tokenB = IERC20(pool.tokenB());
 

diff --git a/contracts/interfaces/IAMM.sol b/contracts/interfaces/IAMM.sol
@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: agpl-3.0
 
-pragma solidity 0.6.12;
+pragma solidity >=0.6.12;
 
 interface IAMM {
     function addLiquidity(

diff --git a/contracts/interfaces/IOptionAMMPool.sol b/contracts/interfaces/IOptionAMMPool.sol
@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: agpl-3.0
 
-pragma solidity 0.6.12;
+pragma solidity >=0.6.12;
 
 import "./IAMM.sol";
 

diff --git a/contracts/interfaces/IOptionHelper.sol b/contracts/interfaces/IOptionHelper.sol
@@ -0,0 +1,62 @@
+// SPDX-License-Identifier: agpl-3.0
+pragma solidity >=0.6.12;
+
+import "./IPodOption.sol";
+
+interface IOptionHelper {
+    function mint(IPodOption option, uint256 optionAmount) external;
+
+    function mintAndSellOptions(
+        IPodOption option,
+        uint256 optionAmount,
+        uint256 minTokenAmount,
+        uint256 deadline,
+        uint256 initialIVGuess
+    ) external;
+
+    function mintAndAddLiquidity(
+        IPodOption option,
+        uint256 optionAmount,
+        uint256 tokenAmount
+    ) external;
+
+    function mintAndAddLiquidityWithCollateral(IPodOption option, uint256 collateralAmount) external;
+
+    function addLiquidity(
+        IPodOption option,
+        uint256 optionAmount,
+        uint256 tokenAmount
+    ) external;
+
+    function sellExactOptions(
+        IPodOption option,
+        uint256 optionAmount,
+        uint256 minTokenReceived,
+        uint256 deadline,
+        uint256 initialIVGuess
+    ) external;
+
+    function sellOptionsAndReceiveExactTokens(
+        IPodOption option,
+        uint256 maxOptionAmount,
+        uint256 exactTokenReceived,
+        uint256 deadline,
+        uint256 initialIVGuess
+    ) external;
+
+    function buyExactOptions(
+        IPodOption option,
+        uint256 optionAmount,
+        uint256 maxTokenAmount,
+        uint256 deadline,
+        uint256 initialIVGuess
+    ) external;
+
+    function buyOptionsWithExactTokens(
+        IPodOption option,
+        uint256 minOptionAmount,
+        uint256 tokenAmount,
+        uint256 deadline,
+        uint256 initialIVGuess
+    ) external;
+}
diff --git a/contracts/interfaces/IOptionPoolRegistry.sol b/contracts/interfaces/IOptionPoolRegistry.sol
@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: agpl-3.0
 pragma solidity >=0.6.12;
 
 interface IOptionPoolRegistry {

diff --git a/contracts/interfaces/IPodOption.sol b/contracts/interfaces/IPodOption.sol
@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: agpl-3.0
 
-pragma solidity 0.6.12;
+pragma solidity >=0.6.12;
 
 import "@openzeppelin/contracts/token/ERC20/IERC20.sol";