chore: updates to periphery (#35)

* chore: remove old * forge install: tokenized-strategy-periphery 6ce8d29b1e107a89754dd9f17337582734989b4d * fix: remove version * forge install: tokenized-strategy v3.0.2-1 * fix: module versions * chore: bump version (#34) * chore: bump version bump to 0.8.23 * chore: update submodules * fix: greater than 18 * fix: redo requirements * feat: one more bump * fix: use console2 --------- Co-authored-by: Schlag <[email protected]> * feat: comment --------- Co-authored-by: dudesahn <[email protected]>
yearn · Jul 25, 2024 · d185c78 · d185c78
1 parent 6c0deeb
commit d185c78
Show file tree

Hide file tree

Showing 20 changed files with 41 additions and 26 deletions.
diff --git a/.gitignore b/.gitignore
@@ -16,4 +16,5 @@ docs/
 node_modules/
 .gas-snapshot
 
-yarn.lock
+yarn.lock
+.DS_Store
diff --git a/.gitmodules b/.gitmodules
@@ -2,14 +2,15 @@
 	path = lib/forge-std
 	url = https://github.com/foundry-rs/forge-std
 	branch = master
-[submodule "lib/tokenized-strategy"]
-	path = lib/tokenized-strategy
-	url = https://github.com/yearn/tokenized-strategy
-	release = v3.0.2
 [submodule "lib/openzeppelin-contracts"]
 	path = lib/openzeppelin-contracts
 	url = https://github.com/OpenZeppelin/openzeppelin-contracts
+	branch = v4.9.5
 [submodule "lib/tokenized-strategy-periphery"]
 	path = lib/tokenized-strategy-periphery
 	url = https://github.com/yearn/tokenized-strategy-periphery
-	branch = master
+	branch = master
+[submodule "lib/tokenized-strategy"]
+	path = lib/tokenized-strategy
+	url = https://github.com/yearn/tokenized-strategy
+	branch = v3.0.2-1
diff --git a/.solhint.json b/.solhint.json
@@ -2,7 +2,7 @@
     "extends": "solhint:recommended",
     "plugins": [],
     "rules": {
-      "compiler-version": ["error", "0.8.18"],
+      "compiler-version": ["error", "^0.8.18"],
       "code-complexity": "warn",
       "const-name-snakecase": "warn",
       "function-max-lines": "warn",

diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,5 +1,5 @@
 {
-  "solidity.compileUsingRemoteVersion": "v0.8.18",
+  "solidity.compileUsingRemoteVersion": "v0.8.23",
   "solidity.remappings": [
     "@openzeppelin/=./lib/openzeppelin-contracts/",
     "forge-std/=lib/forge-std/src/",

diff --git a/Makefile b/Makefile
@@ -8,7 +8,12 @@ size  :; forge build --sizes
 # storage inspection
 inspect :; forge inspect ${contract} storage-layout --pretty
 
-FORK_URL := ${ETH_RPC_URL} 
+# specify which fork to use. set this in our .env
+# if we want to test multiple forks in one go, remove this as an argument below
+FORK_URL := ${ETH_RPC_URL} # BASE_RPC_URL, ETH_RPC_URL, ARBITRUM_RPC_URL
+
+# if we want to run only matching tests, set that here
+test := test_
 
 # local tests without fork
 test  :; forge test -vv --fork-url ${FORK_URL}
@@ -18,9 +23,15 @@ test-contract  :; forge test -vv --match-contract $(contract) --fork-url ${FORK_
 test-contract-gas  :; forge test --gas-report --match-contract ${contract} --fork-url ${FORK_URL}
 trace-contract  :; forge test -vvv --match-contract $(contract) --fork-url ${FORK_URL}
 test-test  :; forge test -vv --match-test $(test) --fork-url ${FORK_URL}
-trace-test  :; forge test -vvv --match-test $(test) --fork-url ${FORK_URL}
+test-test-trace  :; forge test -vvv --match-test $(test) --fork-url ${FORK_URL}
+trace-test  :; forge test -vvvvv --match-test $(test) --fork-url ${FORK_URL}
 snapshot :; forge snapshot -vv --fork-url ${FORK_URL}
 snapshot-diff :; forge snapshot --diff -vv --fork-url ${FORK_URL}
+trace-setup  :; forge test -vvvv --fork-url ${FORK_URL}
+trace-max  :; forge test -vvvvv --fork-url ${FORK_URL}
+coverage :; forge coverage --fork-url ${FORK_URL}
+coverage-report :; forge coverage --report lcov --fork-url ${FORK_URL}
+coverage-debug :; forge coverage --report debug --fork-url ${FORK_URL}
 
 
 clean  :; forge clean
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/foundry.toml b/foundry.toml
@@ -2,7 +2,7 @@
 src = 'src'
 out = 'out'
 libs = ['lib']
-solc = "0.8.18"
+solc = "0.8.23"
 
 remappings = [
     "@openzeppelin/=lib/openzeppelin-contracts/",

diff --git a/lib/forge-std b/lib/forge-std
diff --git a/lib/tokenized-strategy b/lib/tokenized-strategy
diff --git a/lib/tokenized-strategy-periphery b/lib/tokenized-strategy-periphery
diff --git a/package.json b/package.json
@@ -4,7 +4,7 @@
         "prettier": "^2.5.1",
         "prettier-plugin-solidity": "^1.0.0-beta.19",
         "pretty-quick": "^3.1.3",
-        "solc": "0.8.18",
+        "solc": "0.8.23",
         "solhint": "^3.3.7",
         "solhint-plugin-prettier": "^0.0.5"
     },

diff --git a/src/Strategy.sol b/src/Strategy.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPL-3.0
-pragma solidity 0.8.18;
+pragma solidity ^0.8.18;
 
 import {BaseStrategy, ERC20} from "@tokenized-strategy/BaseStrategy.sol";
 import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";

diff --git a/src/interfaces/IStrategyInterface.sol b/src/interfaces/IStrategyInterface.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPL-3.0
-pragma solidity 0.8.18;
+pragma solidity ^0.8.18;
 
 import {IStrategy} from "@tokenized-strategy/interfaces/IStrategy.sol";
 

diff --git a/src/periphery/StrategyAprOracle.sol b/src/periphery/StrategyAprOracle.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPL-3.0
-pragma solidity 0.8.18;
+pragma solidity ^0.8.18;
 
 import {AprOracleBase} from "@periphery/AprOracle/AprOracleBase.sol";
 

diff --git a/src/test/FunctionSignature.t.sol b/src/test/FunctionSignature.t.sol
@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: UNLICENSED
 pragma solidity ^0.8.18;
 
-import "forge-std/console.sol";
+import "forge-std/console2.sol";
 import {Setup, ERC20, IStrategyInterface} from "./utils/Setup.sol";
 
 contract FunctionSignatureTest is Setup {

diff --git a/src/test/Operation.t.sol b/src/test/Operation.t.sol
@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: UNLICENSED
 pragma solidity ^0.8.18;
 
-import "forge-std/console.sol";
+import "forge-std/console2.sol";
 import {Setup, ERC20, IStrategyInterface} from "./utils/Setup.sol";
 
 contract OperationTest is Setup {
@@ -10,7 +10,7 @@ contract OperationTest is Setup {
     }
 
     function test_setupStrategyOK() public {
-        console.log("address of strategy", address(strategy));
+        console2.log("address of strategy", address(strategy));
         assertTrue(address(0) != address(strategy));
         assertEq(strategy.asset(), address(asset));
         assertEq(strategy.management(), management);

diff --git a/src/test/Oracle.t.sol b/src/test/Oracle.t.sol
@@ -1,6 +1,6 @@
 pragma solidity ^0.8.18;
 
-import "forge-std/console.sol";
+import "forge-std/console2.sol";
 import {Setup} from "./utils/Setup.sol";
 
 import {StrategyAprOracle} from "../periphery/StrategyAprOracle.sol";

diff --git a/src/test/Shutdown.t.sol b/src/test/Shutdown.t.sol
@@ -1,6 +1,6 @@
 pragma solidity ^0.8.18;
 
-import "forge-std/console.sol";
+import "forge-std/console2.sol";
 import {Setup, ERC20, IStrategyInterface} from "./utils/Setup.sol";
 
 contract ShutdownTest is Setup {

diff --git a/src/test/utils/ExtendedTest.sol b/src/test/utils/ExtendedTest.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPL-3.0
-pragma solidity 0.8.18;
+pragma solidity ^0.8.18;
 
 import {Test} from "forge-std/Test.sol";
 

diff --git a/src/test/utils/Setup.sol b/src/test/utils/Setup.sol
@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: AGPL-3.0
-pragma solidity 0.8.18;
+pragma solidity ^0.8.18;
 
-import "forge-std/console.sol";
+import "forge-std/console2.sol";
 import {ExtendedTest} from "./ExtendedTest.sol";
 
 import {Strategy, ERC20} from "../../Strategy.sol";
+0 −1		.gitattributes
+6 −48		.github/workflows/ci.yml
+0 −29		.github/workflows/sync.yml
+3 −0		.gitmodules
+1 −1		README.md
+1 −1		foundry.toml
+1 −0		lib/ds-test
+1 −1		package.json
+0 −635		scripts/vm.py
+3 −5		src/Base.sol
+3 −4		src/Script.sol
+225 −518		src/StdAssertions.sol
+16 −33		src/StdChains.sol
+17 −195		src/StdCheats.sol
+1 −16		src/StdInvariant.sol
+25 −25		src/StdJson.sol
+98 −244		src/StdStorage.sol
+2 −2		src/StdStyle.sol
+0 −179		src/StdToml.sol
+34 −71		src/StdUtils.sol
+6 −7		src/Test.sol
+321 −1,526		src/Vm.sol
+382 −394		src/console2.sol
+0 −234		src/mocks/MockERC20.sol
+0 −235		src/mocks/MockERC721.sol
+0 −13,248		src/safeconsole.sol
+898 −44		test/StdAssertions.t.sol
+58 −119		test/StdChains.t.sol
+47 −247		test/StdCheats.t.sol
+11 −13		test/StdError.t.sol
+0 −49		test/StdJson.t.sol
+12 −27		test/StdMath.t.sol
+42 −222		test/StdStorage.t.sol
+4 −4		test/StdStyle.t.sol
+0 −49		test/StdToml.t.sol
+35 −80		test/StdUtils.t.sol
+0 −15		test/Vm.t.sol
+0 −8		test/fixtures/test.json
+0 −6		test/fixtures/test.toml
+0 −441		test/mocks/MockERC20.t.sol
+0 −721		test/mocks/MockERC721.t.sol
+3 −3		SPECIFICATION.md
+1 −1		script/Deploy.s.sol
+1 −1		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
+1 −2		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