feat: comment

yearn · Schlagonia · Jul 25, 2024 · Jul 25, 2024 · Jul 25, 2024 · Jul 25, 2024
commit e248eab6d597c28d325ff72f8c4b06e888a5b651
diff --git a/README.md b/README.md
@@ -50,6 +50,8 @@ make test
 
 For a complete guide to creating a Tokenized Strategy please visit: https://docs.yearn.fi/developers/v3/strategy_writing_guide
 
+NOTE: Compiler defaults to 8.23 but it can be adjusted in the foundry toml.
+
 ## Testing
 
 Due to the nature of the BaseStrategy utilizing an external contract for the majority of its logic, the default interface for any tokenized strategy will not allow proper testing of all functions. Testing of your Strategy should utilize the pre-built [IStrategyInterface](https://github.com/yearn/tokenized-strategy-foundry-mix/blob/master/src/interfaces/IStrategyInterface.sol) to cast any deployed strategy through for testing, as seen in the Setup example. You can add any external functions that you add for your specific strategy to this interface to be able to test all functions with one variable. 

diff --git a/lib/tokenized-strategy b/lib/tokenized-strategy
diff --git a/src/interfaces/IStrategyInterface.sol b/src/interfaces/IStrategyInterface.sol

 import {IStrategy} from "@tokenized-strategy/interfaces/IStrategy.sol";

 interface IStrategyInterface is IStrategy {
    //TODO: Add your specific implementation interface in here.
 }
diff --git a/src/periphery/StrategyAprOracle.sol b/src/periphery/StrategyAprOracle.sol
     * @return . The expected apr for the strategy represented as 1e18.
     */
    function aprAfterDebtChange(
        address _strategy,
        int256 _delta
    ) external view override returns (uint256) {
        // TODO: Implement any necessary logic to return the most accurate
        //      APR estimation for the strategy.
diff --git a/src/Strategy.sol b/src/Strategy.sol
     * @param _amount The amount of 'asset' that the strategy can attempt
     * to deposit in the yield source.
     */
    function _deployFunds(uint256 _amount) internal override {
        // TODO: implement deposit logic EX:
        //
        //      lendingPool.deposit(address(asset), _amount ,0);
     *
     * @param _amount, The amount of 'asset' to be freed.
     */
    function _freeFunds(uint256 _amount) internal override {
        // TODO: implement withdraw logic EX:
        //
        //      lendingPool.withdraw(address(asset), _amount);
diff --git a/src/test/FunctionSignature.t.sol b/src/test/FunctionSignature.t.sol
 // SPDX-License-Identifier: UNLICENSED
 pragma solidity ^0.8.18;

 import "forge-std/console2.sol";
 import {Setup, ERC20, IStrategyInterface} from "./utils/Setup.sol";

 contract FunctionSignatureTest is Setup {
    function setUp() public virtual override {
    // This test should not be overridden and checks that
    // no function signature collisions occurred from the custom functions.
    // Does not check functions that are strategy dependant and will be checked in other tests
    function test_functionCollisions() public {
        uint256 wad = 1e18;
        vm.expectRevert("initialized");
        strategy.initialize(
diff --git a/src/test/Operation.t.sol b/src/test/Operation.t.sol
 // SPDX-License-Identifier: UNLICENSED
 pragma solidity ^0.8.18;

 import "forge-std/console2.sol";
 import {Setup, ERC20, IStrategyInterface} from "./utils/Setup.sol";

 contract OperationTest is Setup {
+3 −3		SPECIFICATION.md
+1 −1		script/Deploy.s.sol
+2 −3		src/BaseStrategy.sol
+1 −1		src/TokenizedStrategy.sol
+1 −1		src/interfaces/IBaseStrategy.sol
+1 −1		src/interfaces/IEvents.sol
+1 −1		src/interfaces/IFactory.sol
+1 −1		src/interfaces/IStrategy.sol
+1 −1		src/interfaces/ITokenizedStrategy.sol
+1 −1		src/test/AccessControl.t.sol
+1 −1		src/test/Accounting.t.sol
+1 −1		src/test/CustomImplementation.t.sol
+1 −1		src/test/ERC20Std.t.sol
+1 −1		src/test/ERC4626Std.t.sol
+1 −1		src/test/FaultyStrategy.t.sol
+1 −1		src/test/InvariantsSingleStrategy.t.sol
+1 −1		src/test/ProfitLocking.t.sol
+1 −1		src/test/Shutdown.t.sol
+1 −1		src/test/e2e.t.sol
+1 −1		src/test/handlers/StrategyHandler.sol
+2 −1		src/test/mocks/IMockStrategy.sol
+1 −1		src/test/mocks/MockFactory.sol
+1 −1		src/test/mocks/MockFaultyStrategy.sol
+1 −1		src/test/mocks/MockIlliquidStrategy.sol
+1 −1		src/test/mocks/MockStorage.sol
+1 −1		src/test/mocks/MockStrategy.sol
+1 −1		src/test/mocks/MockYieldSource.sol
+1 −1		src/test/utils/BaseInvariant.sol
+1 −1		src/test/utils/ExtendedTest.sol
+1 −1		src/test/utils/LibAddressSet.sol
+1 −1		src/test/utils/Setup.sol

	import {IStrategy} from "@tokenized-strategy/interfaces/IStrategy.sol";

	interface IStrategyInterface is IStrategy {
Check warning on line 6 in src/interfaces/IStrategyInterface.sol GitHub Actions / solidity `Code contains empty blocks`
	//TODO: Add your specific implementation interface in here.
	}
	* @return . The expected apr for the strategy represented as 1e18.
	*/
	function aprAfterDebtChange(
	address _strategy,
Check warning on line 29 in src/periphery/StrategyAprOracle.sol GitHub Actions / solidity `Variable "_strategy" is unused`
	int256 _delta
Check warning on line 30 in src/periphery/StrategyAprOracle.sol GitHub Actions / solidity `Variable "_delta" is unused`
	) external view override returns (uint256) {
	// TODO: Implement any necessary logic to return the most accurate
	// APR estimation for the strategy.
	* @param _amount The amount of 'asset' that the strategy can attempt
	* to deposit in the yield source.
	*/
	function _deployFunds(uint256 _amount) internal override {
Check warning on line 46 in src/Strategy.sol GitHub Actions / solidity `Code contains empty blocks`
	// TODO: implement deposit logic EX:
	//
	// lendingPool.deposit(address(asset), _amount ,0);
	*
	* @param _amount, The amount of 'asset' to be freed.
	*/
	function _freeFunds(uint256 _amount) internal override {
Check warning on line 73 in src/Strategy.sol GitHub Actions / solidity `Code contains empty blocks`
	// TODO: implement withdraw logic EX:
	//
	// lendingPool.withdraw(address(asset), _amount);
	// SPDX-License-Identifier: UNLICENSED
	pragma solidity ^0.8.18;

	import "forge-std/console2.sol";
Check warning on line 4 in src/test/FunctionSignature.t.sol GitHub Actions / solidity `global import of path forge-std/console2.sol is not allowed. Specify names to import individually or bind all exports of the module into a name (import "path" as Name)`
	import {Setup, ERC20, IStrategyInterface} from "./utils/Setup.sol";
Check warning on line 5 in src/test/FunctionSignature.t.sol GitHub Actions / solidity `imported name IStrategyInterface is not used`

	contract FunctionSignatureTest is Setup {
	function setUp() public virtual override {
	// This test should not be overridden and checks that
	// no function signature collisions occurred from the custom functions.
	// Does not check functions that are strategy dependant and will be checked in other tests
	function test_functionCollisions() public {
Check warning on line 15 in src/test/FunctionSignature.t.sol GitHub Actions / solidity `Function body contains 76 lines but allowed no more than 50 lines` Check warning on line 15 in src/test/FunctionSignature.t.sol GitHub Actions / solidity `Function name must be in mixedCase`
	uint256 wad = 1e18;
	vm.expectRevert("initialized");
	strategy.initialize(