ARM integration to Lending Markets

.env.example

@@ -2,6 +2,7 @@
 PROVIDER_URL=                   # [MANDATORY] : URL Provider for mainnet forks.
 TESTNET_URL=
 HOLESKY_URL=
+SONIC_URL=
 
 ### Etherscan ###
 # ETHERSCAN_API_KEY=            # [OPTIONAL] : API Key for Etherscan. Useful for verifying contracts and reading logs on forks.

.github/workflows/main.yml

@@ -28,10 +28,11 @@ jobs:
         run: forge fmt --check
 
   foundry-tests:
-    name: Foundry fork tests
+    name: Foundry tests
     runs-on: ubuntu-latest
     env:
       PROVIDER_URL: ${{ secrets.PROVIDER_URL }}
+      SONIC_URL: ${{ secrets.SONIC_URL }}
     steps:
       - uses: actions/checkout@v4
         with:
@@ -41,10 +42,15 @@ jobs:
         uses: foundry-rs/foundry-toolchain@v1
 
       - name: Install Dependencies
-        run: forge soldeer install
+        run: forge soldeer install && yarn install
 
       - name: Check contract sizes
         run: forge build --sizes
 
-      - name: Run fork tests
-        run: forge test -vvv --summary --detailed
+      - name: Run non-invariant tests
+        run: make test
+
+      - name: Run invariant tests
+        run: |
+          make test-invariant-lido
+          make test-invariant-origin

.vscode/settings.json

@@ -1,6 +1,6 @@
 {
   "editor.formatOnSave": true,
-  "plantuml.exportOutDir": "docs",
+  "plantuml.exportOutDir": "docs/plantuml",
   "plantuml.exportFormat": "png",
   "plantuml.exportIncludeFolderHeirarchy": false,
   "plantuml.exportSubFolder": false,

Hardhat.md

@@ -5,6 +5,7 @@
 1. Start a local Anvil node forked from the latest block
 
 ```
+export PROVIDER_URL=
 anvil --fork-url="$PROVIDER_URL"
 ```
 

Makefile

@@ -16,7 +16,7 @@ clean:
 	@rm -rf broadcast cache out
 
 clean-all:
-	@rm -rf broadcast cache out dependencies node_modules soldeer.lock
+	@rm -rf broadcast cache out dependencies node_modules soldeer.lock yarn.lock lcov.info lcov.info.pruned
 
 gas:
 	@forge test --gas-report
@@ -30,21 +30,30 @@ test-std:
 	forge test --summary --fail-fast --show-progress
 
 test:
-	@FOUNDRY_NO_MATCH_CONTRACT=Invariant make test-std
+	@FOUNDRY_NO_MATCH_CONTRACT=Fuzzer $(MAKE) test-std
 
 test-f-%:
-	@FOUNDRY_MATCH_TEST=$* make test-std
+	@FOUNDRY_MATCH_TEST=$* $(MAKE) test-std
 
 test-c-%:
-	@FOUNDRY_MATCH_CONTRACT=$* make test-std
+	@FOUNDRY_MATCH_CONTRACT=$* $(MAKE) test-std
 
 test-all:
-	@make test-std
+	@$(MAKE) test-std
+
+test-invariant-lido:
+	@FOUNDRY_INVARIANT_FAIL_ON_REVERT=false FOUNDRY_MATCH_CONTRACT=FuzzerFoundry_OethARM $(MAKE) test-std
+
+test-invariant-origin:
+	@FOUNDRY_INVARIANT_FAIL_ON_REVERT=true FOUNDRY_MATCH_CONTRACT=FuzzerFoundry_OriginARM $(MAKE) test-std
+
+test-invariants:
+	@$(MAKE) test-invariant-lido && $(MAKE) test-invariant-origin
+
 
 # Coverage
 coverage:
 	@forge coverage --report lcov
-	@lcov --ignore-errors unused --remove ./lcov.info -o ./lcov.info.pruned "test/*" "script/*"
 
 coverage-html:
 	@make coverage
@@ -54,21 +63,36 @@ coverage-html:
 simulate-s-%:
 	@forge script script/$*.s.sol --fork-url $(PROVIDER_URL) -vvvvv
 
+simulate-sonic-s-%:
+	@forge script script/$*.s.sol --fork-url $(SONIC_URL) -vvvvv
+
 run-s-%:
 	@forge script script/$*.s.sol --rpc-url $(PROVIDER_URL) --private-key ${DEPLOYER_PRIVATE_KEY} --broadcast --slow --verify -vvvvv
 
+run-sonic-s-%:
+	@forge script script/$*.s.sol --rpc-url $(SONIC_URL) --private-key ${DEPLOYER_PRIVATE_KEY} --broadcast --slow --verify -vvvvv
+
 # Deploy scripts
 deploy:
 	@forge script script/deploy/DeployManager.sol --rpc-url $(PROVIDER_URL) --private-key ${DEPLOYER_PRIVATE_KEY} --broadcast --slow --verify -vvvv
 
+deploy-local:
+	@forge script script/deploy/DeployManager.sol --rpc-url $(LOCAL_URL) --private-key ${DEPLOYER_PRIVATE_KEY} --broadcast --slow -vvvv
+
 deploy-testnet:
 	@forge script script/deploy/DeployManager.sol --rpc-url $(TESTNET_URL) --broadcast --slow --unlocked -vvvv
 
 deploy-holesky:
 	@forge script script/deploy/DeployManager.sol --rpc-url $(HOLESKY_URL) --private-key ${DEPLOYER_PRIVATE_KEY} --broadcast --slow --verify -vvv
 
+deploy-sonic:
+	@forge script script/deploy/DeployManager.sol --rpc-url $(SONIC_URL) --private-key ${DEPLOYER_PRIVATE_KEY} --broadcast --slow --verify -vvv
+
 simulate-deploys:
 	@forge script script/deploy/DeployManager.sol --fork-url $(PROVIDER_URL) --private-key ${DEPLOYER_PRIVATE_KEY} -vvvv
 
+simulate-sonic-deploys:
+	@forge script script/deploy/DeployManager.sol --fork-url $(SONIC_URL) --private-key ${DEPLOYER_PRIVATE_KEY} -vvvv
+
 # Override default `test` and `coverage` targets
 .PHONY: test coverage

README.md

@@ -190,6 +190,14 @@ In the `.env` file, set `DEPLOYER_PRIVATE_KEY`, `ETHERSCAN_API_KEY` and `PROVIDE
 make deploy
 ```
 
+### Sonic
+
+In the `.env` file, set `DEPLOYER_PRIVATE_KEY` and `SONIC_URL` to the mainnet values.
+
+```bash
+make deploy-sonic
+```
+
 ## Contract Verification
 
 If the verification doesn't work with the deployment, it can be done separately with forge `verify-contract`.
@@ -202,6 +210,9 @@ forge verify-contract 0xd8fF298eAed581f74ab845Af62C48aCF85B2f05e OethARM  \
 
 # Verify Proxy
 forge verify-contract 0x6bac785889A4127dB0e0CeFEE88E0a9F1Aaf3cC7 Proxy
+
+# Verify Proxy on Sonic
+forge verify-contract --chain 146 --etherscan-api-key $SONICSCAN_API_KEY 0x2F872623d1E1Af5835b08b0E49aAd2d81d649D30 Proxy
 ```
 
 ## Open Zeppelin Defender
@@ -240,6 +251,11 @@ npx hardhat setActionVars --id c010fb76-ea63-409d-9981-69322d27993a
 npx hardhat setActionVars --id 127171fd-7b85-497e-8335-fd7907c08386
 npx hardhat setActionVars --id 84b5f134-8351-4402-8f6a-fb4376034bc4
 npx hardhat setActionVars --id ffcfc580-7b0a-42ed-a4f2-3f0a3add9779
+npx hardhat setActionVars --id 32dbc67b-89f3-4856-8f3d-ad4dc5a09322
+npx hardhat setActionVars --id 7a0cb2c9-11c2-41dd-bcd0-d7c2dbda6af6
+npx hardhat setActionVars --id a9fc4c86-0506-4809-afbc-93b5e558cb68
+npx hardhat setActionVars --id 12977d51-d107-45eb-ac20-45942009ab01
+npx hardhat setActionVars --id 6ec46510-0b8e-48b4-a4c8-de759aad0ba4
 
 # The Defender autotask client uses generic env var names so we'll set them first from the values in the .env file
 export API_KEY=
@@ -252,6 +268,11 @@ npx defender-autotask update-code c010fb76-ea63-409d-9981-69322d27993a ./dist/au
 npx defender-autotask update-code 127171fd-7b85-497e-8335-fd7907c08386 ./dist/autoClaimLidoWithdraw
 npx defender-autotask update-code 84b5f134-8351-4402-8f6a-fb4376034bc4 ./dist/collectLidoFees
 npx defender-autotask update-code ffcfc580-7b0a-42ed-a4f2-3f0a3add9779 ./dist/setPrices
+npx defender-autotask update-code 32dbc67b-89f3-4856-8f3d-ad4dc5a09322 ./dist/collectFeesSonic
+npx defender-autotask update-code 7a0cb2c9-11c2-41dd-bcd0-d7c2dbda6af6 ./dist/allocateSonic
+npx defender-autotask update-code a9fc4c86-0506-4809-afbc-93b5e558cb68 ./dist/collectRewardsSonic
+npx defender-autotask update-code 12977d51-d107-45eb-ac20-45942009ab01 ./dist/autoRequestWithdrawSonic
+npx defender-autotask update-code 6ec46510-0b8e-48b4-a4c8-de759aad0ba4 ./dist/autoClaimWithdrawSonic
 ```
 
 `rollup` and `defender-autotask` can be installed globally to avoid the `npx` prefix.

build/deployments-146.json

@@ -0,0 +1,17 @@
+{
+  "executions": {
+    "001_DeployOriginARMProxyScript": 1747110973,
+    "002_DeployOriginARMScript": 1747907433
+  },
+  "contracts": {
+    "HARVESTER": "0x08876C0F5a80c1a43A6396b13A881A26F4b6Adfe",
+    "HARVESTER_IMPL": "0x995B0Fd5A5289bD1776406754933De12DBaf2314",
+    "ORIGIN_ARM": "0x2F872623d1E1Af5835b08b0E49aAd2d81d649D30",
+    "ORIGIN_ARM_CAP_IMPL": "0xB05e625e8a688883B13ed2AedAdC42669a76907A",
+    "ORIGIN_ARM_CAP_MAN": "0x38B654d7859dab79935c9CF99267392c06D254cF",
+    "ORIGIN_ARM_IMPL": "0x0f26EAC83E07077c6fD236CE000aAD8a25E06e07",
+    "ORIGIN_ARM_ZAPPER": "0xcb8199AB7F8b7D97885FBDfb1f0ABc044f403C18",
+    "SILO_VARLAMORE_S_MARKET": "0x248Dbbc31F2D7675775DB4A9308a98444DaBaECf",
+    "SILO_VARLAMORE_S_MARKET_IMPL": "0x42ee4912377f0240669eb05C9fA62d122Cd9bca6"
+  }
+}

docs/plantuml/sonicContracts.puml

@@ -0,0 +1,137 @@
+@startuml
+
+!$originColor = DeepSkyBlue
+' !$originColor = WhiteSmoke
+!$newColor = LightGreen
+!$changedColor = Orange
+!$thirdPartyColor = WhiteSmoke
+
+legend
+blue - Origin
+' green - new
+' orange - changed
+white - 3rd Party
+end legend
+
+title "Sonic Automated Redemption Manager (ARM) Contract Dependencies"
+
+
+object "Sonic Zapper" as zap #$originColor {
+    asset: S
+}
+
+object "Origin ARM" as originArm <<Proxy>> #$originColor {
+    assets: OS, wS
+}
+
+' object "Beets ARM" as beetsArm <<Proxy>> #$originColor {
+' }
+
+' object "Angles ARM" as anglesArm <<Proxy>> #$originColor {
+' }
+
+' object "CapManager" as capMan <<Proxy>> #$originColor {
+' }
+object "Origin\nCapManager" as osCapMan <<Proxy>> #$originColor {
+}
+' object "Beets\nCapManager" as stCapMan <<Proxy>> #$originColor {
+' }
+' object "Angles\nCapManager" as anCapMan <<Proxy>> #$originColor {
+' }
+
+
+' object "ARM" as arm <<Proxy>> #$originColor {
+' }
+' object "Strategy" as strat <<Proxy>> #$originColor {
+' }
+
+object "Silo\nStrategy" as siloStrategy #$originColor {
+    asset: wS
+}
+
+object "Varlamore\nVault" as siloVault <<Silo>> #$thirdPartyColor {
+    asset: wS
+}
+object "Varlamore\nGauge" as siloGauge <<Silo>> #$thirdPartyColor {
+    asset: wS
+}
+
+object "Lending\nMarkets" as siloLend <<Silo>> #$thirdPartyColor {
+    markets: stS, wOS, wanS, beS
+}
+' object "Lending\nMarket\nGauge" as gauge #$thirdPartyColor {
+' }
+' object "Liquid\nStaking\nToken" as lst #$thirdPartyColor {
+' }
+
+object "OS\nVault" as os <<Proxy>> #$originColor {
+    asset: wS
+}
+
+' object "Beets\nVault" as beets #$thirdPartyColor {
+' }
+
+' object "Angles\nVault" as angles #$thirdPartyColor {
+' }
+
+object "Origin\nHarvester" as osHarv #$originColor {
+    reward: SILO
+}
+
+' object "Beets\nHarvester" as stHarv #$originColor {
+' }
+
+object "Router" as magpie <<Magpie>> #$thirdPartyColor {
+    pair: SILO/wS
+}
+
+' object "Price\nProvider" as priceProvider #$originColor {
+'     Assets: Silo
+' }
+
+' object "Silo\nOracle" as siloOracle #$thirdPartyColor {
+' }
+
+' arm .> strat : ERC-4626
+' strat .> lend : ERC-4626
+' strat ..> gauge
+' arm ..> lst
+
+zap ..> originArm
+' zap ..> beetsArm
+' zap ..> anglesArm
+
+' originArm <..> capMan
+' beetsArm <..> capMan
+' anglesArm <..> capMan
+originArm <.> osCapMan
+' beetsArm <.> stCapMan
+' anglesArm <..> anCapMan
+
+
+originArm <... osHarv
+' beetsArm <... stHarv
+
+osHarv .> siloStrategy
+' stHarv .> siloStrategy
+
+originArm ..> siloStrategy
+siloStrategy ..> siloVault
+siloStrategy ..> siloGauge
+siloVault ..> siloLend
+' beetsArm ...> siloStrategy
+' anglesArm ..> lend
+
+originArm ..> os
+' beetsArm ..> beets
+' anglesArm ...> angles
+
+osHarv ..> magpie
+' stHarv ..> magpie
+
+' osHarv ..> priceProvider
+' stHarv ..> priceProvider
+' priceProvider ..> siloOracle
+
+
+@enduml

foundry.toml

@@ -6,7 +6,7 @@ verbosity = 3
 sender = "0x0165C55EF814dEFdd658532A48Bd17B2c8356322"
 tx_origin = "0x0165C55EF814dEFdd658532A48Bd17B2c8356322"
 auto_detect_remappings = false
-gas_reports = ["OethARM", "Proxy", "LidoARM"]
+gas_reports = ["OethARM", "Proxy", "LidoARM", "OriginARM"]
 fs_permissions = [{ access = "read-write", path = "./build" }]
 extra_output_files = ["metadata"]
 ignored_warnings_from = ["src/contracts/Proxy.sol"]
@@ -22,6 +22,7 @@ remappings = [
 ]
 optimizer = true
 optimizer_runs = 200
+ffi = true
 
 [fuzz]
 runs = 1_000
@@ -49,5 +50,6 @@ remappings_location = "config"
 
 [rpc_endpoints]
 mainnet = "${PROVIDER_URL}"
+sonic = "${SONIC_URL}"
 
 # See more config options https://github.com/foundry-rs/foundry/blob/master/crates/config/README.md#all-options

hardhat.config.js

@@ -27,6 +27,10 @@ module.exports = {
       url: `${process.env.HOLESKY_URL}`,
       chainId: 17000,
     },
+    sonic: {
+      url: `${process.env.SONIC_URL}`,
+      chainId: 146,
+    },
     testnet: {
       url: `${process.env.TESTNET_URL}`,
       chainId: 1,

package.json

@@ -23,7 +23,7 @@
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^15.2.3",
     "@solidity-parser/parser": "^0.18.0",
-    "axios": "^1.7.5",
+    "axios": "^1.9.0",
     "builtin-modules": "^3.3.0",
     "chai": "^4.3.10",
     "dayjs": "^1.11.12",