feat: comment

yearn · Jul 25, 2024 · e248eab · e248eab
1 parent b2671ba
commit e248eab
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
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
+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