V3-Prelude updates since initial audit

.github/workflows/claim_remainder.yaml

@@ -0,0 +1,41 @@
+name: test
+
+on:
+  schedule:
+    - cron: "0 0 * * 1"
+  workflow_dispatch:
+
+env:
+  FOUNDRY_PROFILE: ci
+
+jobs:
+  check:
+    name: Foundry project
+    runs-on: ubuntu-latest
+
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: nightly
+
+      - name: Create logs directory
+        run: mkdir -p ./release/logs/txns
+
+      - name: Run tests
+        run: forge test --match-test test_handle_remainder
+        env:
+          MAINNET_RPC_URL: ${{ secrets.MAINNET_RPC_URL }}
+
+      - name: Upload transaction logs
+        uses: actions/upload-artifact@v4
+        if: always()  # This ensures the step runs even if tests fail
+        with:
+          name: transaction-logs
+          path: ./release/logs/txns/
+          retention-days: 7  # Keeps artifacts for 7 days

README.md

@@ -1,81 +1,54 @@
-# etherfi-protocol smart-contracts
+# ether.fi Liquid Restaking Protocol
 
-Smart Contracts for ether.fi ethereum staking protocol.
 
-From 2024/02/15, we have migrated from our private repo to this public one.
-We start with the shallow copy of the latest commit of the private one.
 
-# EtherFi smart contracts setup
+## Overview
 
-## Get Started
+The ether.fi Liquid Restaking Protocol represents the core infrastructure powering ether.fi's vision of becoming the most secure and efficient liquid staking solution in DeFi. This protocol enables:
 
-### Install Foundry
+- **Liquid Staking**: Seamless ETH staking with immediate liquidity through eETH
+- **Native Restaking**: Effortless & Secure restaking of staked ETH. Restaking & AVS management is strictly controlled by the Protocol via ether.fi's AVS operator contracts ([link](https://github.com/etherfi-protocol/etherfi-avs-operator)). Restaking rewards are distributed via KING ([link](https://github.com/orgs/King-Protocol/repositories))
+- **Massive Integration with DeFi**: Wide integration with DeFi protocols
+- **Cross-Chain Capabilities**: Native support for cross-chain staking & bridging of weETH ([link](https://github.com/etherfi-protocol/weETH-cross-chain/))
+- **Enterprise-Grade Security**: Rigorous security measures through audits, formal verification, and continuous monitoring
 
-```zsh
-curl -L https://foundry.paradigm.xyz | bash
-```
-
-### Update Foundry
-
-```zsh
-foundryup
-```
 
-### Install Submodules
+## 🔒 Security
 
-```zsh
-git submodule update --init --recursive
-```
+Security is paramount at ether.fi. Our protocol undergoes:
 
-### Formatter and Linter
+- Regular & Continuous audits by industry leaders
+- Formal verification through Certora
+- Continuous monitoring and testing
 
-Run `yarn` to install `package.json` which includes our formatter and linter. We will switch over to Foundry's sol formatter and linter once released.
 
-### Set your environment variables
 
-Check `.env.example` to see some of the environment variables you should have set in `.env` in order to run some of the commands.
+## 🛠️ Development Setup
 
-### Compile Project
 
-```zsh
+```bash
+# Install & Setup
+curl -L https://foundry.paradigm.xyz | bash
+git clone https://github.com/etherfi-protocol/smart-contracts.git && cd smart-contracts
+git submodule update --init --recursive
 forge build
-```
 
-### Run Project Tests
-
-```zsh
-forge test
-```
-
-### Run Project Fork Tests
-
-```zsh
-forge test --fork-url <your_rpc_url>>
-```
-
-### Run Project Fork Tests
-
-```zsh
-certoraRun certora/conf/<contract-name>.conf
+# Testing
+forge test                                    # Run all tests
+forge test --fork-url <your_rpc_url>         # Fork testing
+certoraRun certora/conf/<contract-name>.conf # Formal verification
 ```
 
-### Build Troubleshooting Tips
+## 📚 Documentation
 
-In case you run into an issue of `forge` not being able to find a compatible version of solidity compiler for one of your contracts/scripts, you may want to install the solidity version manager `svm`. To be able to do so, you will need to have [Rust](https://www.rust-lang.org/tools/install) installed on your system and with it the accompanying package manager `cargo`. Once that is done, to install `svm` run the following command:
+- [Protocol Documentation](https://etherfi.gitbook.io/etherfi/)
 
-```zsh
-cargo install svm-rs
-```
 
-To list the available versions of solidity compiler run:
 
-```zsh
-svm list
-```
+## 📄 License
 
-Make sure the version you need is in this list, or choose the closest one and install it:
+ether.fi is open-source and licensed under the [MIT License](LICENSE).
 
-```zsh
-svm install "0.7.6"
-```
+---
 
+<p align="center">Built with ❤️ by the ether.fi team</p>

roles.md

@@ -0,0 +1,14 @@
+# Roles Documentation
+
+| Name | Keccak-256 Value | Address | Role Description |
+|------|-----------------|---------|-----------------|
+| owner of Role Registry | not a role | 0x9f26d4C958fD811A1F59B01B86Be7dFFc9d20761 (timelock) | upgrade:<br>LiquidityPool<br>EtherFiRedemptionManager<br>EtherFiAdmin<br>CumulativeMerkleRewardsDistributor |
+| ETHERFI_ORACLE_EXECUTOR_ADMIN_ROLE | 0xf63b1ce674d2cec0dbfcdcc7e504ce31a335c457c363b9fafb6ca524addf1775 | 0xcD425f44758a08BaAB3C4908f3e3dE5776e45d7a (operating timelock) | setValidatorTaskBatchSize<br>invalidateValidatorManagementTask<br>updateAcceptableRebaseApr<br>updatePostReportWaitTimeInSlots |
+| ETHERFI_ORACLE_EXECUTOR_TASK_MANAGER_ROLE | 0xe9d356a03911100a5418b1829f363128136c30112754cb3dbe73b1674abe2ac8 | 0x12582A27E5e19492b4FcD194a60F8f5e1aa31B0F (oracle task executor eoa) | executeTasks<br>executeValidatorManagementTask |
+| LIQUIDITY_POOL_ADMIN_ROLE | 0x0e8d94121b3383f03d9ae60b39295aa793469d7230d51a3f62cbf47cd45481d9 | 0xcD425f44758a08BaAB3C4908f3e3dE5776e45d7a, (operating timelock)<br>0x0EF8fa4760Db8f5Cd4d993f3e3416f30f942D705 (EtherFiAdmin) | batchApproveRegistration<br>registerValidatorSpawner<br>unregisterValidatorSpawner<br>sendExitRequests<br>setFeeRecipient<br>setRestakeBnftDeposits |
+| ETHERFI_REWARDS_ROUTER_ADMIN_ROLE | 0x45dab652f6af38e394e24f46b5cac6c2825acb3d0b2d490b914660c6095274da | 0x2aCA71020De61bb532008049e1Bd41E451aE8AdC (L1 contract controller) | recoverERC20<br>recoverERC721 |
+| ETHERFI_REDEMPTION_MANAGER_ADMIN_ROLE | 0x1fa5f863eb8a62c868fa7eb98a4e47ded14913e6885050cfd9090d04516345b0 | 0xcD425f44758a08BaAB3C4908f3e3dE5776e45d7a (operating timelock) | setCapacity<br>setRefillRatePerSecond<br>setExitFeeBasisPoints<br>setLowWatermarkInBpsOfTvl<br>setExitFeeSplitToTreasuryInBps |
+| WITHDRAW_REQUEST_NFT_ADMIN_ROLE | 0xdf341d2a9af804fa0099198f83a0a0611aa273a03b36d576993f914e695dff2a | 0xcD425f44758a08BaAB3C4908f3e3dE5776e45d7a (operating timelock)<br>0x0EF8fa4760Db8f5Cd4d993f3e3416f30f942D705 (EtherFiAdmin) | finalizeRequests<br>invalidateRequest<br>validateRequest<br>handleRemainder |
+| PROTOCOL_PAUSER | 0xe6ff4398839854a2087720a46165c7be195bc9de6f7a3c5a977d3b6917b76af2 | 0x0EF8fa4760Db8f5Cd4d993f3e3416f30f942D705 (EtherFiAdmin), 0x9AF1298993DC1f397973C62A5D47a284CF76844D (Hypernative),<br>0x2aCA71020De61bb532008049e1Bd41E451aE8AdC (Mainnet contract controller) | pause on EtherFiAdmin<br>pauseContract of EtherFiRedemptionManager<br>pauseContract on LiquidityPool<br>pauseContract on WithdrawRequestNFT<br>unpause on CumulativeMerkleRewardsDistributor |
+| PROTOCOL_UNPAUSER | 0xb72d40a29b0ca5ab6e0b32830618dfdcae56fae676396ff1f7c3fede659935c8 | 0x0EF8fa4760Db8f5Cd4d993f3e3416f30f942D705 (EtherFiAdmin)<br>0x2aCA71020De61bb532008049e1Bd41E451aE8AdC (Mainnet contract controller) | unPause on EtherFiAdmin<br>unPauseContract of EtherFiRedemptionManager<br>unPauseContract on LiquidityPool<br>unPauseContract on WithdrawRequestNFT<br>unpause on CumulativeMerkleRewardsDistributor |
+| CUMULATIVE_MERKLE_REWARDS_DISTRIBUTOR_ADMIN_ROLE | 0xaa26b9baa4a66c7ac933a97b6adb2558a7a6fa699a65e95bb880b1c2156d033b | 0x8D5AAc5d3d5cda4c404fA7ee31B0822B648Bb150 | setPendingMerkleRoot<br>finalizeMerkleRoot<br>setClaimDelay<br>updateWhitelistedRecipient |

script/deploys/DeployCumulativeMerkleRewardsDistributor.sol

@@ -0,0 +1,43 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.13;
+
+import "forge-std/Script.sol";
+
+import "src/CumulativeMerkleRewardsDistributor.sol";
+import "src/UUPSProxy.sol";
+import "../../src/helpers/AddressProvider.sol";
+import "forge-std/console.sol";
+
+/* Deploy Command
+ *  source .env && forge script ./script/deploys/DeployCumulativeMerkleRewardsDistributor.sol:DeployCumulativeMerkleRewardsDistributor --rpc-url MAINNET_RPC_URL --broadcast --etherscan-api-key $ETHERSCAN_API_KEY --verify --slow -vvvv
+*/
+
+contract DeployCumulativeMerkleRewardsDistributor is Script {
+
+    AddressProvider public addressProvider;
+    ///////////////////////////////////////
+    address roleRegistryProxyAddress; 
+    //////////////////////////////////////
+
+    function run() external {
+
+        address addressProviderAddress = vm.envAddress("CONTRACT_REGISTRY");
+
+        vm.startBroadcast(); 
+
+
+        addressProvider = AddressProvider(addressProviderAddress);
+        roleRegistryProxyAddress = addressProvider.getContractAddress("RoleRegistry");
+        address timelockAddress = addressProvider.getContractAddress("EtherFiTimelock");
+        console2.log("RoleRegistry address:", roleRegistryProxyAddress);
+
+        bytes memory initializerData =  abi.encodeWithSelector(CumulativeMerkleRewardsDistributor.initialize.selector);
+        CumulativeMerkleRewardsDistributor cumulativeMerkleRewardsDistributorImplementation = new CumulativeMerkleRewardsDistributor(roleRegistryProxyAddress);
+        UUPSProxy cumulativeMerkleRewardsDistributorProxy = new UUPSProxy(address(cumulativeMerkleRewardsDistributorImplementation), initializerData);
+        CumulativeMerkleRewardsDistributor cumulativeMerkleInstance = CumulativeMerkleRewardsDistributor(address(cumulativeMerkleRewardsDistributorProxy));
+        //cumulativeMerkleInstance.grantRole(keccak256("CUMULATIVE_MERKLE_REWARDS_DISTRIBUTOR_ADMIN_ROLE"), msg.sender);
+        cumulativeMerkleInstance.transferOwnership(address(timelockAddress));
+
+        vm.stopBroadcast();
+    }
+}