feat: pass the storage pointer (#74)

* feat: pass the storage pointer

* chore: rebase

* chore: formatting and comments

* chore: rebase

* fix: formatting functions

* fix: test coverage

* fix: remove lcov file

* fix: ignore coverage file

.gitignore

@@ -15,4 +15,5 @@ docs/
 .env
 
 node_modules/
-.gas-snapshot
+.gas-snapshot
+lcov.info

src/BaseStrategy.sol

@@ -77,6 +77,9 @@ abstract contract BaseStrategy {
         _;
     }
 
+    /**
+     * @dev Require that the msg.sender is this address.
+     */
     function _onlySelf() internal view {
         require(msg.sender == address(this), "!self");
     }
@@ -86,7 +89,7 @@ abstract contract BaseStrategy {
     //////////////////////////////////////////////////////////////*/
 
     /**
-     * This is the address of the TokenizedStrategy implementation
+     * @dev This is the address of the TokenizedStrategy implementation
      * contract that will be used by all strategies to handle the
      * accounting, logic, storage etc.
      *
@@ -106,7 +109,7 @@ abstract contract BaseStrategy {
     //////////////////////////////////////////////////////////////*/
 
     /**
-     * This variable is set to address(this) during initialization of each strategy.
+     * @dev This variable is set to address(this) during initialization of each strategy.
      *
      * This can be used to retrieve storage data within the strategy
      * contract as if it were a linked library.
@@ -119,8 +122,10 @@ abstract contract BaseStrategy {
      */
     ITokenizedStrategy internal immutable TokenizedStrategy;
 
-    // Underlying asset the Strategy is earning yield on.
-    // Stored here for cheap retrievals within the strategy.
+    /**
+     * @dev Underlying asset the Strategy is earning yield on.
+     * Stored here for cheap retrievals within the strategy.
+     */
     ERC20 internal immutable asset;
 
     /**
@@ -470,7 +475,17 @@ abstract contract BaseStrategy {
         return result;
     }
 
-    // execute a function on the TokenizedStrategy and return any value.
+    /**
+     * @dev execute a function on the TokenizedStrategy and return any value.
+     *
+     * This fallback function will be execute when any of the standard functions
+     * defined in the TokenizedStrategy are called since they wont be defined in
+     * this contract.
+     *
+     * It will delegatecall the TokenizedStrategy implementation with the exact
+     * calldata and return any relevant values.
+     *
+     */
     fallback() external {
         // load our target address
         address _tokenizedStrategyAddress = tokenizedStrategyAddress;