feat: pass the storage pointer

.gitignore

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

src/BaseStrategy.sol

@@ -74,6 +74,9 @@
         _;
     }
 
+    /**
+     * @dev Require that the msg.sender is this address.
+     */
     function _onlySelf() internal view {
         require(msg.sender == address(this), "!self");
     }
@@ -83,7 +86,7 @@
     //////////////////////////////////////////////////////////////*/
 
     /**
-     * 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.
      *
@@ -95,7 +98,7 @@
      * and always be checked before any integration with the Strategy.
      */
     // NOTE: This is a holder address based on expected deterministic location for testing
     address public constant tokenizedStrategyAddress =
         0x2e234DAe75C793f67A35089C9d99245E1C58470b;
 
     /*//////////////////////////////////////////////////////////////
@@ -103,7 +106,7 @@
     //////////////////////////////////////////////////////////////*/
 
     /**
-     * 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.
@@ -116,8 +119,10 @@
      */
     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;
 
     /**
@@ -148,7 +153,7 @@
         // Store the tokenizedStrategyAddress at the standard implementation
         // address storage slot so etherscan picks up the interface. This gets
         // stored on initialization and never updated.
         assembly {
             sstore(
                 // keccak256('eip1967.proxy.implementation' - 1)
                 0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc,
@@ -249,7 +254,7 @@
      *
      * @param _totalIdle The current amount of idle funds that are available to deploy.
      */
     function _tend(uint256 _totalIdle) internal virtual {}
 
     /**
      * @dev Optional trigger to override if tend() will be used by the strategy.
@@ -348,7 +353,7 @@
      *
      * @param _amount The amount of asset to attempt to free.
      */
     function _emergencyWithdraw(uint256 _amount) internal virtual {}
 
     /*//////////////////////////////////////////////////////////////
                         TokenizedStrategy HOOKS
@@ -450,12 +455,12 @@
         bytes memory _calldata
     ) internal returns (bytes memory) {
         // Delegate call the tokenized strategy with provided calldata.
         (bool success, bytes memory result) = tokenizedStrategyAddress
             .delegatecall(_calldata);
 
         // If the call reverted. Return the error.
         if (!success) {
             assembly {
                 let ptr := mload(0x40)
                 let size := returndatasize()
                 returndatacopy(ptr, 0, size)
@@ -467,12 +472,22 @@
         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;
         // Execute external function using delegatecall and return any value.
         assembly {
             // Copy function selector and any arguments.
             calldatacopy(0, 0, calldatasize())
             // Execute function delegatecall.