Feat/zap

.eslintignore

@@ -11,5 +11,6 @@ specification_docs/
 deployments/
 contracts/protocol/earn-protocol-configuration
 contracts/protocol/adapters
+contracts/protocol/optyfi-swapper
 # files
 .solcover.js

.gitmodules

@@ -37,6 +37,10 @@
 [submodule "contracts/protocol/adapters/ethereum/sushiswap-pool-adapter-ethereum"]
 	path = contracts/protocol/adapters/ethereum/sushiswap-pool-adapter-ethereum
 	url = git@github.com:Opty-Fi/sushiswap-pool-adapter-ethereum.git
+[submodule "contracts/protocol/optyfi-swapper"]
+	path = contracts/protocol/optyfi-swapper
+	url = git@github.com:Opty-Fi/optyfi-swapper.git
+	branch = swap
 [submodule "contracts/protocol/adapters/ethereum/team-defi-adapters"]
 	path = contracts/protocol/adapters/ethereum/team-defi-adapters
 	url = git@github.com:Opty-Fi/team-defi-adapters.git

.prettierignore

@@ -13,6 +13,8 @@
 **/specification_docs
 contracts/protocol/earn-protocol-configuration
 contracts/protocol/adapters
+contracts/protocol/optyfi-swapper
+contracts/protocol/zap
 
 # files
 *.env

.solhintignore

@@ -7,4 +7,6 @@ contracts/utils/
 contracts/dependencies/
 contracts/mocks/
 contracts/protocol/earn-protocol-configuration
-contracts/protocol/adapters
+contracts/protocol/adapters
+contracts/protocol/optyfi-swapper
+contracts/protocol/zap

contracts/protocol/zap/IZap.sol

@@ -0,0 +1,55 @@
+//SPDX-license-identifier: MIT
+pragma solidity ^0.8.15;
+
+import { DataTypes } from "./lib/DataTypes.sol";
+import { ZapStorage } from "./ZapStorage.sol";
+
+/**
+ * @title OptyFiZapper interface
+ * @author OptyFi
+ */
+interface IZap {
+    /**
+     * @notice performs an arbitrary swap of a given token or ETH to deposit in a OptyFi Vault
+     * @param _token the address of the input token
+     * @param _amount input token amount to deposit
+     * @param _permitParams ERC2612 permit params
+     * @param _zapParams the zapParams for the zap to be performed
+     * @return the shares received from the vault deposit
+     */
+    function zapIn(
+        address _token,
+        uint256 _amount,
+        bytes memory _permitParams,
+        DataTypes.ZapData memory _zapParams
+    ) external payable returns (uint256);
+
+    /**
+     * @notice redeems the vault shares and performs an arbitrary swap
+     * from the OptyFi Vault underlying token to any given token
+     * @param _token the address of the input token
+     * @param _amount input token amount to deposit
+     * @param _permitParams ERC2612 permit params
+     * @param _zapParams the zapParams for the zap to be performed
+     * @return the amount of output tokens received
+     */
+    function zapOut(
+        address _token,
+        uint256 _amount,
+        bytes memory _permitParams,
+        DataTypes.ZapData memory _zapParams
+    ) external returns (uint256);
+
+    /**
+     * @notice set swapper address
+     * @param _swapper swapper address
+     */
+    function setSwapper(address _swapper) external;
+
+    /**
+     * @notice set the zap contract merkle proof to deposit and withdraw on vault
+     * @param _vault address of the target vault
+     * @param _merkleProof zapper contract merkle proof
+     */
+    function setMerkleProof(address _vault, bytes32[] memory _merkleProof) external;
+}

contracts/protocol/zap/IZapView.sol

@@ -0,0 +1,20 @@
+//SPDX-license-identifier: MIT
+pragma solidity ^0.8.15;
+
+import { ISwapper } from "../optyfi-swapper/contracts/swap/ISwapper.sol";
+
+/**
+ * @title ZapperView interface
+ * @author OptyFi
+ */
+interface IZapView {
+    /**
+     * @notice get swapper address
+     */
+    function getSwapper() external view returns (ISwapper);
+
+    /**
+     * @notice get merkle proof on a given vault
+     */
+    function getMerkleProof(address _vault) external view returns (bytes32[] memory);
+}

contracts/protocol/zap/OptyFiZapper.sol

@@ -0,0 +1,16 @@
+//SPDX-license-identifier: MIT
+pragma solidity ^0.8.15;
+
+import { SolidStateDiamond } from "@solidstate/contracts/proxy/diamond/SolidStateDiamond.sol";
+import { ISwapper } from "../optyfi-swapper/contracts/swap/ISwapper.sol";
+import { ZapStorage } from "./ZapStorage.sol";
+
+/**
+ * @title Diamond proxy for OptyFiZapper
+ * @author OptyFi
+ */
+contract OptyFiZapper is SolidStateDiamond {
+    constructor(address _swapper) {
+        ZapStorage.layout().swapper = ISwapper(_swapper);
+    }
+}

contracts/protocol/zap/Zap.sol

@@ -0,0 +1,67 @@
+//SPDX-license-identifier: MIT
+pragma solidity ^0.8.15;
+
+// helper contracts
+import { ZapInternal } from "./ZapInternal.sol";
+import { OwnableInternal } from "@solidstate/contracts/access/ownable/OwnableInternal.sol";
+
+// libraries
+import { DataTypes } from "./lib/DataTypes.sol";
+import { ZapStorage } from "./ZapStorage.sol";
+
+// interfaces
+import { IZap } from "./IZap.sol";
+
+/**
+ * @title Zap
+ * @author OptyFi
+ */
+contract Zap is IZap, ZapInternal, OwnableInternal {
+    using ZapStorage for ZapStorage.Layout;
+
+    /**
+     * @inheritdoc IZap
+     */
+    function zapIn(
+        address _token,
+        uint256 _amount,
+        bytes memory _permitParams,
+        DataTypes.ZapData memory _zapParams
+    ) external payable override returns (uint256 sharesReceived) {
+        ZapStorage.Layout storage _l = ZapStorage.layout();
+
+        sharesReceived = _zapIn(_l, _token, _amount, _permitParams, _zapParams);
+    }
+
+    /**
+     * @inheritdoc IZap
+     */
+    function zapOut(
+        address _token,
+        uint256 _amount,
+        bytes memory _permitParams,
+        DataTypes.ZapData memory _zapParams
+    ) external override returns (uint256 receivedAmount) {
+        ZapStorage.Layout storage _l = ZapStorage.layout();
+
+        receivedAmount = _zapOut(_l, _token, _amount, _permitParams, _zapParams);
+    }
+
+    /**
+     * @inheritdoc IZap
+     */
+    function setSwapper(address _swapper) external override onlyOwner {
+        ZapStorage.Layout storage _l = ZapStorage.layout();
+
+        _setSwapper(_l, _swapper);
+    }
+
+    /**
+     * @inheritdoc IZap
+     */
+    function setMerkleProof(address _vault, bytes32[] memory _merkleProof) external override onlyOwner {
+        ZapStorage.Layout storage _l = ZapStorage.layout();
+
+        _setMerkleProof(_l, _vault, _merkleProof);
+    }
+}