weETH withdrawal: Instant withdrawal with Fee + Implicit withdrawal fee handling

foundry.toml

@@ -2,13 +2,12 @@
 src = 'src'
 out = 'out'
 libs = ['lib']
-fs_permissions = [{ access = "read-write", path = "./release"}, { access = "read", path = "./test" }]
+fs_permissions = [{ access = "read-write", path = "./release"}, { access = "read", path = "./test" }, { access = "read-write", path = "./operations" }]
 gas_reports = ["*"]
 optimizer_runs = 2000
 extra_output = ["storageLayout"]
 bytecode_hash = 'none'
 solc-version = '0.8.24'
-bytecode_hash = 'none'
 
 # See more config options https://github.com/foundry-rs/foundry/tree/master/config
 [rpc_endpoints]

lib/BucketLimiter.sol

@@ -71,6 +71,11 @@ library BucketLimiter {
         return limit.remaining >= amount;
     }
 
+    function consumable(Limit memory limit) external view returns (uint64) {
+        _refill(limit);
+        return limit.remaining;
+    }
+
     /*
      * Consumes the given amount from the bucket, if there is sufficient capacity, and returns
      * whether the bucket had enough remaining capacity to consume the amount.
@@ -104,18 +109,22 @@ library BucketLimiter {
     }
 
     function _refill(Limit memory limit) internal view {
-        // We allow for overflow here, as the delta is resilient against it.
         uint64 now_ = uint64(block.timestamp);
-        uint64 delta;
+
+        if (now_ == limit.lastRefill) {
+            return;
+        }
+
+        uint256 delta;
         unchecked {
             delta = now_ - limit.lastRefill;
         }
-        uint64 tokens = delta * limit.refillRate;
-        uint64 newRemaining = limit.remaining + tokens;
+        uint256 tokens = delta * uint256(limit.refillRate);
+        uint256 newRemaining = uint256(limit.remaining) + tokens;
         if (newRemaining > limit.capacity) {
             limit.remaining = limit.capacity;
         } else {
-            limit.remaining = newRemaining;
+            limit.remaining = uint64(newRemaining);
         }
         limit.lastRefill = now_;
     }
@@ -157,4 +166,4 @@ library BucketLimiter {
         refill(limit);
         limit.remaining = remaining;
     }
-}
+}

operations/20250128_upgrade_instant_withdrawal_execute.json

@@ -0,0 +1,11 @@
+{
+  "chainId": "1",
+  "meta": { "txBuilderVersion": "1.16.5" },
+  "transactions": [
+    {
+      "to": "0x9f26d4c958fd811a1f59b01b86be7dffc9d20761",
+      "value": "0",
+      "data": "0xe38335e500000000000000000000000000000000000000000000000000000000000000a000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000000160000000000000000000000000000000000000000000000000000000000000000012cd17fdc855070e6b92a85ee62b7b5f78b031a423542fabd5d0ace52bdd8aea00000000000000000000000000000000000000000000000000000000000000020000000000000000000000007d5706f6ef3f89b3951e23e557cdfbc3239d4e2c000000000000000000000000308861a430be4cce5502d0a12724771fc6daf21600000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000014000000000000000000000000000000000000000000000000000000000000000c44f1ef28600000000000000000000000078f424c42f006b046b927d49b6d7abef74ca67ae00000000000000000000000000000000000000000000000000000000000000400000000000000000000000000000000000000000000000000000000000000044f8a025b40000000000000000000000009af1298993dc1f397973c62a5d47a284cf76844d0000000000000000000000000000000000000000000000000000000000001388000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000a44f1ef286000000000000000000000000a05d566bac16e2fbcec4cff68e89119ee2a96ef900000000000000000000000000000000000000000000000000000000000000400000000000000000000000000000000000000000000000000000000000000024984856a3000000000000000000000000d5fd46f4df70a63d60a8563cad0444fcc25dce7f0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000"
+    }
+  ]
+}

operations/20250128_upgrade_instant_withdrawal_schedule.json

@@ -0,0 +1,11 @@
+{
+  "chainId": "1",
+  "meta": { "txBuilderVersion": "1.16.5" },
+  "transactions": [
+    {
+      "to": "0x9f26d4c958fd811a1f59b01b86be7dffc9d20761",
+      "value": "0",
+      "data": "0x8f2a0bb000000000000000000000000000000000000000000000000000000000000000c000000000000000000000000000000000000000000000000000000000000001200000000000000000000000000000000000000000000000000000000000000180000000000000000000000000000000000000000000000000000000000000000012cd17fdc855070e6b92a85ee62b7b5f78b031a423542fabd5d0ace52bdd8aea000000000000000000000000000000000000000000000000000000000003f48000000000000000000000000000000000000000000000000000000000000000020000000000000000000000007d5706f6ef3f89b3951e23e557cdfbc3239d4e2c000000000000000000000000308861a430be4cce5502d0a12724771fc6daf21600000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000014000000000000000000000000000000000000000000000000000000000000000c44f1ef28600000000000000000000000078f424c42f006b046b927d49b6d7abef74ca67ae00000000000000000000000000000000000000000000000000000000000000400000000000000000000000000000000000000000000000000000000000000044f8a025b40000000000000000000000009af1298993dc1f397973c62a5d47a284cf76844d0000000000000000000000000000000000000000000000000000000000001388000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000a44f1ef286000000000000000000000000a05d566bac16e2fbcec4cff68e89119ee2a96ef900000000000000000000000000000000000000000000000000000000000000400000000000000000000000000000000000000000000000000000000000000024984856a3000000000000000000000000d5fd46f4df70a63d60a8563cad0444fcc25dce7f0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000"
+    }
+  ]
+}

script/GnosisHelpers.sol

@@ -0,0 +1,84 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+import "forge-std/Test.sol";
+
+import "@openzeppelin/contracts/utils/Strings.sol";
+
+
+contract GnosisHelpers is Test {
+
+    /**
+     * @dev Simulations the execution of a gnosis transaction bundle on the current fork
+     * @param transactionPath The path to the transaction bundle json file
+     * @param sender The address of the gnosis safe that will execute the transaction
+     */
+    function executeGnosisTransactionBundle(string memory transactionPath, address sender) public {
+        string memory json = vm.readFile(transactionPath);
+        for (uint256 i = 0; vm.keyExistsJson(json, string.concat(".transactions[", Strings.toString(i), "]")); i++) {
+            address to = vm.parseJsonAddress(json, string.concat(string.concat(".transactions[", Strings.toString(i)), "].to"));
+            uint256 value = vm.parseJsonUint(json, string.concat(string.concat(".transactions[", Strings.toString(i)), "].value"));
+            bytes memory data = vm.parseJsonBytes(json, string.concat(string.concat(".transactions[", Strings.toString(i)), "].data"));
+
+            vm.prank(sender);
+            (bool success,) = address(to).call{value: value}(data);
+            require(success, "Transaction failed");
+        }
+    }
+
+    // Get the gnosis transaction header
+    function _getGnosisHeader(string memory chainId) internal pure returns (string memory) {
+        return string.concat('{"chainId":"', chainId, '","meta": { "txBuilderVersion": "1.16.5" }, "transactions": [');
+    }
+
+    // Create a gnosis transaction
+    // ether sent value is always 0 for our usecase
+    function _getGnosisTransaction(string memory to, string memory data, bool isLast) internal pure returns (string memory) {
+        string memory suffix = isLast ? ']}' : ',';
+        return string.concat('{"to":"', to, '","value":"0","data":"', data, '"}', suffix);
+    }
+
+    // Helper function to convert bytes to hex strings 
+    // soldity encodes returns a bytes object and this must be converted to a hex string to be used in gnosis transactions
+    function iToHex(bytes memory buffer) public pure returns (string memory) {
+        // Fixed buffer size for hexadecimal convertion
+        bytes memory converted = new bytes(buffer.length * 2);
+
+        bytes memory _base = "0123456789abcdef";
+
+        for (uint256 i = 0; i < buffer.length; i++) {
+            converted[i * 2] = _base[uint8(buffer[i]) / _base.length];
+            converted[i * 2 + 1] = _base[uint8(buffer[i]) % _base.length];
+        }
+
+        return string(abi.encodePacked("0x", converted));
+    }
+
+    // Helper function to convert an address to a hex string of the bytes
+    function addressToHex(address addr) public pure returns (string memory) {
+        return iToHex(abi.encodePacked(addr));
+    }
+
+    address public timelock = 0x9f26d4C958fD811A1F59B01B86Be7dFFc9d20761;
+    bytes32 public predecessor = 0x0000000000000000000000000000000000000000000000000000000000000000;
+    bytes32 public salt = 0x0000000000000000000000000000000000000000000000000000000000000000;
+    uint256 public delay = 259200;
+
+    // Generates the schedule transaction for a gnosis safe
+    function _getGnosisScheduleTransaction(address to, bytes memory data, bool isLasts) internal view returns (string memory) {
+
+        string memory timelockAddressHex = iToHex(abi.encodePacked(address(timelock)));
+        string memory scheduleTransactionData = iToHex(abi.encodeWithSignature("schedule(address,uint256,bytes,bytes32,bytes32,uint256)", to, 0, data, predecessor, salt, delay));
+
+        return _getGnosisTransaction(timelockAddressHex, scheduleTransactionData, isLasts);
+    }
+
+    function _getGnosisExecuteTransaction(address to, bytes memory data, bool isLasts) internal view returns (string memory) {
+
+        string memory timelockAddressHex = iToHex(abi.encodePacked(address(timelock)));
+        string memory executeTransactionData = iToHex(abi.encodeWithSignature("execute(address,uint256,bytes,bytes32,bytes32)", to, 0, data, predecessor, salt));
+
+        return _getGnosisTransaction(timelockAddressHex, executeTransactionData, isLasts);
+    }
+
+}

script/deploys/DeployEtherFiRestaker.s.sol

@@ -0,0 +1,42 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.13;
+
+import "forge-std/Script.sol";
+
+import "../../src/Liquifier.sol";
+import "../../src/EtherFiRestaker.sol";
+import "../../src/helpers/AddressProvider.sol";
+import "../../src/UUPSProxy.sol";
+import "@openzeppelin/contracts/utils/Strings.sol";
+
+contract Deploy is Script {
+    using Strings for string;
+
+    UUPSProxy public liquifierProxy;
+
+    Liquifier public liquifierInstance;
+
+    AddressProvider public addressProvider;
+
+    address admin;
+
+    function run() external {
+        uint256 deployerPrivateKey = vm.envUint("PRIVATE_KEY");
+        address addressProviderAddress = vm.envAddress("CONTRACT_REGISTRY");
+        addressProvider = AddressProvider(addressProviderAddress);
+
+        vm.startBroadcast(deployerPrivateKey);
+
+        EtherFiRestaker restaker = EtherFiRestaker(payable(new UUPSProxy(payable(new EtherFiRestaker()), "")));
+        restaker.initialize(
+            addressProvider.getContractAddress("LiquidityPool"),
+            addressProvider.getContractAddress("Liquifier")
+        );
+
+        new Liquifier();
+
+        // addressProvider.addContract(address(liquifierInstance), "Liquifier");
+
+        vm.stopBroadcast();
+    }
+}

script/deploys/DeployEtherFiWithdrawalBuffer.s.sol

@@ -0,0 +1,40 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.13;
+
+import "forge-std/Script.sol";
+
+import "@openzeppelin/contracts/utils/Strings.sol";
+
+import "../../src/Liquifier.sol";
+import "../../src/EtherFiRestaker.sol";
+import "../../src/helpers/AddressProvider.sol";
+import "../../src/UUPSProxy.sol";
+import "../../src/EtherFiRedemptionManager.sol";
+
+
+contract Deploy is Script {
+    using Strings for string;
+    AddressProvider public addressProvider;
+
+    function run() external {
+        uint256 deployerPrivateKey = vm.envUint("PRIVATE_KEY");
+        address addressProviderAddress = vm.envAddress("CONTRACT_REGISTRY");
+        addressProvider = AddressProvider(addressProviderAddress);
+
+        vm.startBroadcast(deployerPrivateKey);
+
+        EtherFiRedemptionManager impl = new EtherFiRedemptionManager(
+            addressProvider.getContractAddress("LiquidityPool"), 
+            addressProvider.getContractAddress("EETH"), 
+            addressProvider.getContractAddress("WeETH"), 
+            0x0c83EAe1FE72c390A02E426572854931EefF93BA, // protocol safe
+            0x1d3Af47C1607A2EF33033693A9989D1d1013BB50 // role registry
+        );
+        UUPSProxy proxy = new UUPSProxy(payable(impl), "");
+
+        EtherFiRedemptionManager instance = EtherFiRedemptionManager(payable(proxy));
+        instance.initialize(10_00, 1_00, 1_00, 5 ether, 0.001 ether);
+
+        vm.stopBroadcast();
+    }
+}

script/deploys/DeployPhaseTwo.s.sol

@@ -81,7 +81,7 @@ contract DeployPhaseTwoScript is Script {
         }
         retrieve_contract_addresses();
 
-        withdrawRequestNftImplementation = new WithdrawRequestNFT();
+        withdrawRequestNftImplementation = new WithdrawRequestNFT(address(0));
         withdrawRequestNftProxy = new UUPSProxy(address(withdrawRequestNftImplementation), "");
         withdrawRequestNftInstance = WithdrawRequestNFT(payable(withdrawRequestNftProxy));