Ensure compatibility with deposit v3

Zilliqa · Dec 17, 2024 · 0cdf822 · 0cdf822
1 parent 3708ab3
commit 0cdf822
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 163 deletions.
diff --git a/src/BaseDelegation.sol b/src/BaseDelegation.sol
@@ -80,11 +80,12 @@ abstract contract BaseDelegation is Delegation, PausableUpgradeable, Ownable2Ste
         (bool success, ) = DEPOSIT_CONTRACT.call{
             value: depositAmount
         }(
-            abi.encodeWithSignature("deposit(bytes,bytes,bytes,address)",
+            abi.encodeWithSignature("deposit(bytes,bytes,bytes,address,address)",
                 blsPubKey,
                 peerId,
                 signature,
-                address(this)
+                address(this),
+                owner()
             )
         );
         require(success, "deposit failed");

diff --git a/test/BaseDelegation.t.sol b/test/BaseDelegation.t.sol
@@ -2,11 +2,11 @@
 pragma solidity ^0.8.26;
 
 /* solhint-disable no-console */
-import {PopVerifyPrecompile} from "test/PopVerifyPrecompile.t.sol";
+import {BlsVerifyPrecompile} from "test/BlsVerifyPrecompile.t.sol";
 import {BaseDelegation} from "src/BaseDelegation.sol";
 import {WithdrawalQueue} from "src/WithdrawalQueue.sol";
 import {Delegation} from "src/Delegation.sol";
-import {Deposit} from "@zilliqa/zq2/deposit_v2.sol";
+import {Deposit} from "@zilliqa/zq2/deposit_v3.sol";
 import {ERC1967Proxy} from "@openzeppelin/contracts/proxy/ERC1967/ERC1967Proxy.sol";
 import {Test} from "forge-std/Test.sol";
 import {console} from "forge-std/console.sol";
@@ -104,27 +104,19 @@ abstract contract BaseDelegationTest is Test {
         //vm.deployCodeTo("Deposit.sol", delegation.DEPOSIT_CONTRACT());
         vm.etch(
             delegation.DEPOSIT_CONTRACT(),
-            // since the deposit contract is upgradeable, the constructor has no parameters
-            //address(new Deposit(10_000_000 ether, 256, 10, initialStakers)).code
             address(new Deposit()).code
         );
         vm.store(delegation.DEPOSIT_CONTRACT(), bytes32(uint256(0x958a6cf6390bd7165e3519675caa670ab90f0161508a9ee714d3db7edc50740b)), bytes32(uint256(block.number / 10)));
         vm.store(delegation.DEPOSIT_CONTRACT(), bytes32(uint256(0x958a6cf6390bd7165e3519675caa670ab90f0161508a9ee714d3db7edc50740c)), bytes32(uint256(10_000_000 ether)));
         vm.store(delegation.DEPOSIT_CONTRACT(), bytes32(uint256(0x958a6cf6390bd7165e3519675caa670ab90f0161508a9ee714d3db7edc50740d)), bytes32(uint256(256)));
         vm.store(delegation.DEPOSIT_CONTRACT(), bytes32(uint256(0x958a6cf6390bd7165e3519675caa670ab90f0161508a9ee714d3db7edc50740e)), bytes32(uint256(10)));
-        /* since the deposit contract is upgradeable, the storage locations changed too
-        vm.store(delegation.DEPOSIT_CONTRACT(), bytes32(uint256(11)), bytes32(uint256(block.number / 10)));
-        vm.store(delegation.DEPOSIT_CONTRACT(), bytes32(uint256(12)), bytes32(uint256(10_000_000 ether)));
-        vm.store(delegation.DEPOSIT_CONTRACT(), bytes32(uint256(13)), bytes32(uint256(256)));
-        vm.store(delegation.DEPOSIT_CONTRACT(), bytes32(uint256(14)), bytes32(uint256(10)));
-        */
         /*
         console.log("Deposit.minimimStake() =", Deposit(delegation.DEPOSIT_CONTRACT()).minimumStake());
         console.log("Deposit.maximumStakers() =", Deposit(delegation.DEPOSIT_CONTRACT()).maximumStakers());
         console.log("Deposit.blocksPerEpoch() =", Deposit(delegation.DEPOSIT_CONTRACT()).blocksPerEpoch());
         //*/
 
-        vm.etch(address(0x5a494c80), address(new PopVerifyPrecompile()).code);
+        vm.etch(address(0x5a494c81), address(new BlsVerifyPrecompile()).code);
 
         vm.stopPrank();
     }
@@ -144,6 +136,7 @@ abstract contract BaseDelegationTest is Test {
             bytes(hex"92fbe50544dce63cfdcc88301d7412f0edea024c91ae5d6a04c7cd3819edfc1b9d75d9121080af12e00f054d221f876c"),
             bytes(hex"002408011220d5ed74b09dcbe84d3b32a56c01ab721cf82809848b6604535212a219d35c412f"),
             bytes(hex"b14832a866a49ddf8a3104f8ee379d29c136f29aeb8fccec9d7fb17180b99e8ed29bee2ada5ce390cb704bc6fd7f5ce814f914498376c4b8bc14841a57ae22279769ec8614e2673ba7f36edc5a4bf5733aa9d70af626279ee2b2cde939b4bd8a"),
+            address(0x0),
             address(0x0)
         );
 
@@ -288,8 +281,6 @@ abstract contract BaseDelegationTest is Test {
         assertEq(delegation.getClaimable() + totalPending, totalUnstaked, "claims must match unstaked amount");
 
         vm.roll(block.number + 100);
-        //TODO: remove the next line once https://github.com/Zilliqa/zq2/issues/1761 is fixed
-        vm.warp(block.timestamp + 100);
 
         console.log("--------------------------------------------------------------------");
         console.log("block number: %s", block.number);
@@ -304,8 +295,6 @@ abstract contract BaseDelegationTest is Test {
         assertEq(delegation.getClaimable() + totalPending, totalUnstaked, "claims must match unstaked amount");
 
         vm.roll(block.number + WithdrawalQueue.unbondingPeriod());
-        //TODO: remove the next line once https://github.com/Zilliqa/zq2/issues/1761 is fixed
-        vm.warp(block.timestamp + WithdrawalQueue.unbondingPeriod());
 
         console.log("--------------------------------------------------------------------");
         console.log("block number: %s", block.number);

diff --git a/test/BlsVerifyPrecompile.t.sol b/test/BlsVerifyPrecompile.t.sol
@@ -0,0 +1,10 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+pragma solidity ^0.8.26;
+
+contract BlsVerifyPrecompile {
+
+    function blsVerify(bytes memory, bytes memory, bytes memory) public pure returns(bool) {
+        return true;
+    }
+
+}
diff --git a/test/LiquidDelegation.t.sol b/test/LiquidDelegation.t.sol
@@ -9,7 +9,7 @@ import {NonRebasingLST} from "src/NonRebasingLST.sol";
 import {BaseDelegation} from "src/BaseDelegation.sol";
 import {WithdrawalQueue} from "src/WithdrawalQueue.sol";
 import {Delegation} from "src/Delegation.sol";
-import {Deposit} from "@zilliqa/zq2/deposit_v2.sol";
+import {Deposit} from "@zilliqa/zq2/deposit_v3.sol";
 import {Console} from "src/Console.sol";
 import {Vm} from "forge-std/Test.sol";
 import {console} from "forge-std/console.sol";
@@ -58,8 +58,6 @@ contract LiquidDelegationTest is BaseDelegationTest {
         delegation = LiquidDelegationV2(proxy);
         lst = NonRebasingLST(delegation.getLST());
 
-        // TODO: remove the next line once https://github.com/Zilliqa/zq2/issues/2009 is fixed
-        if (mode == DepositMode.DepositThenMigrate) return;
         if (mode == DepositMode.DepositThenMigrate)
             migrate(BaseDelegation(delegation), depositAmount);
         else
@@ -268,8 +266,6 @@ contract LiquidDelegationTest is BaseDelegationTest {
         );
 
         vm.roll(block.number + blocksUntil);
-        //TODO: remove the next line once https://github.com/Zilliqa/zq2/issues/1761 is fixed
-        vm.warp(block.timestamp + blocksUntil);
 
         vm.recordLogs();
 
@@ -887,132 +883,4 @@ contract LiquidDelegationTest is BaseDelegationTest {
         );
     }
 
-    //TODO: remove the test once https://github.com/Zilliqa/zq2/issues/1761 is fixed
-    function test_DepositContract() public {
-        vm.deal(owner, 10_000_000 ether + 1_000_000 ether + 0 ether);
-        vm.deal(stakers[0], 0);
-        vm.startPrank(owner);
-        Deposit(delegation.DEPOSIT_CONTRACT()).deposit{
-            value: 10_000_000 ether
-        }(
-            bytes(hex"92fbe50544dce63cfdcc88301d7412f0edea024c91ae5d6a04c7cd3819edfc1b9d75d9121080af12e00f054d221f876c"),
-            bytes(hex"002408011220d5ed74b09dcbe84d3b32a56c01ab721cf82809848b6604535212a219d35c412f"),
-            bytes(hex"b14832a866a49ddf8a3104f8ee379d29c136f29aeb8fccec9d7fb17180b99e8ed29bee2ada5ce390cb704bc6fd7f5ce814f914498376c4b8bc14841a57ae22279769ec8614e2673ba7f36edc5a4bf5733aa9d70af626279ee2b2cde939b4bd8a"),
-            address(stakers[0])
-        );
-        console.log("validator deposited");
-        console.log("validator stake: %s", Deposit(delegation.DEPOSIT_CONTRACT()).getStake(
-            bytes(hex"92fbe50544dce63cfdcc88301d7412f0edea024c91ae5d6a04c7cd3819edfc1b9d75d9121080af12e00f054d221f876c")
-        ));
-        vm.roll(block.number + Deposit(delegation.DEPOSIT_CONTRACT()).blocksPerEpoch() * 2);
-        console.log("validator stake: %s", Deposit(delegation.DEPOSIT_CONTRACT()).getStake(
-            bytes(hex"92fbe50544dce63cfdcc88301d7412f0edea024c91ae5d6a04c7cd3819edfc1b9d75d9121080af12e00f054d221f876c")
-        ));
-        Deposit(delegation.DEPOSIT_CONTRACT()).depositTopup{
-            value: 1_000_000 ether
-        }();
-        console.log("validator staked");
-        console.log("validator stake: %s", Deposit(delegation.DEPOSIT_CONTRACT()).getStake(
-            bytes(hex"92fbe50544dce63cfdcc88301d7412f0edea024c91ae5d6a04c7cd3819edfc1b9d75d9121080af12e00f054d221f876c")
-        ));
-        vm.roll(block.number + Deposit(delegation.DEPOSIT_CONTRACT()).blocksPerEpoch() * 2);
-        console.log("validator stake: %s", Deposit(delegation.DEPOSIT_CONTRACT()).getStake(
-            bytes(hex"92fbe50544dce63cfdcc88301d7412f0edea024c91ae5d6a04c7cd3819edfc1b9d75d9121080af12e00f054d221f876c")
-        ));
-        Deposit(delegation.DEPOSIT_CONTRACT()).unstake(
-            500_000 ether
-        );
-        console.log("validator unstaked");
-        console.log("validator stake: %s", Deposit(delegation.DEPOSIT_CONTRACT()).getStake(
-            bytes(hex"92fbe50544dce63cfdcc88301d7412f0edea024c91ae5d6a04c7cd3819edfc1b9d75d9121080af12e00f054d221f876c")
-        ));
-        vm.roll(block.number + Deposit(delegation.DEPOSIT_CONTRACT()).blocksPerEpoch() * 2);
-        console.log("validator stake: %s", Deposit(delegation.DEPOSIT_CONTRACT()).getStake(
-            bytes(hex"92fbe50544dce63cfdcc88301d7412f0edea024c91ae5d6a04c7cd3819edfc1b9d75d9121080af12e00f054d221f876c")
-        ));
-        console.log("validator balance: %s", owner.balance);
-        Deposit(delegation.DEPOSIT_CONTRACT()).withdraw();
-        console.log("validator withdrew");
-        console.log("validator balance: %s", owner.balance);
-        //vm.roll(block.number + Deposit(delegation.DEPOSIT_CONTRACT()).withdrawalPeriod());
-        //TODO: remove the next line and uncomment the previous once https://github.com/Zilliqa/zq2/issues/1761 is fixed
-        vm.warp(block.timestamp + Deposit(delegation.DEPOSIT_CONTRACT()).withdrawalPeriod()); // skip(WithdrawalQueue.unbondingPeriod());
-        Deposit(delegation.DEPOSIT_CONTRACT()).withdraw();
-        console.log("validator withdrew again");
-        console.log("validator balance: %s", owner.balance);
-        vm.stopPrank();
-    }
-
-    /*
-    To compare the results of Foundry tests and a real network, use the bash scripts below
-    to stake, unstake and claim on the network your local node is connected to.
-
-    Before and after running the STAKING, UNSTAKING and CLAIMING scripts presented below,
-    always execute the STATE script to capture the values needed in the Foundry test below.
-
-    STATE:
-    chmod +x state.sh && ./state.sh <delegation_contract_address> <staker_address>
-
-    STAKING:
-    chmod +x stake.sh && ./stake.sh <delegation_contract_address> <staker_private_key> 10000000000000000000000
-
-    UNSTAKING:
-    chmod +x unstake.sh && ./unstake.sh <delegation_contract_address> <staker_private_key>
-
-    CLAIMING:
-    chmod +x claim.sh && ./claim.sh <delegation_contract_address> <staker_private_key>
-
-    Before running the test, replace the address on the first line with <staker_address>
-    */
-    //TODO: entirely remove or update the values based on the devnet and fix the failing test (typo intentional)
-    function est_DepositThenStake_ReproduceRealNetwork() public {
-        stakers[0] = 0xd819fFcE7A58b1E835c25617Db7b46a00888B013;
-        uint256 delegatedAmount = 10_000 ether;
-        // Insert the following values output by the STATE script below
-        uint256 rewardsBeforeStaking = 197818620596390326580;
-        uint256 taxedRewardsBeforeStaking = 166909461128204338052;
-        // Compare the taxedRewardsAfterStaking output by the STATE script
-        // with the value logged by the test below
-        uint256 taxedRewardsAfterStaking =
-            rewardsBeforeStaking - (rewardsBeforeStaking - taxedRewardsBeforeStaking) / uint256(10);
-        Console.log("Expected taxed rewards after staking: %s.%s%s ZIL", taxedRewardsAfterStaking);
-        // Insert the following value output by the UNSTAKING script
-        uint256 rewardsBeforeUnstaking = 233367080700403454378;
-        run(
-            10_000_000 ether,
-            rewardsBeforeStaking,
-            taxedRewardsBeforeStaking,
-            delegatedAmount,
-            1, // numberOfDelegations
-            0, // rewardsAccruedAfterEach
-            rewardsBeforeUnstaking,
-            WithdrawalQueue.unbondingPeriod(), // blocksUntil claiming
-            DepositMode.DepositThenStake
-        );
-        // Replace the values below in the same order with the values output by the STATE script
-        // run after the CLAIMING script or logged by the CLAIMING script itself
-        // the staker's ZIL balance in wei according to the STATE script after claiming
-        // the staker's ZIL balance in wei according to the STATE script before claiming
-        // the claiming transaction fee in wei output by the CLAIMING script
-        Console.log("Expected staker balance after claiming: %s.%s%s ZIL",
-            100_000 ether - delegatedAmount
-            + 100013.464887553198739807 ether - 90013.819919979031083499 ether + 0.3897714316896 ether
-        );
-        // Replace the values below in the same order with values output by the STATE script
-        // run before the STAKING and after the UNSTAKE scripts or logged by those script themselves
-        // the owner's ZIL balance in wei according to the STATE script after unstaking
-        // the owner's ZIL balance in wei according to the STATE script before staking
-        // the transaction fees in wei output by the STAKING and UNSTAKING scripts
-        Console.log("Actual owner commission: %s.%s%s ZIL",
-            uint256(
-                100032.696802178975738911 ether - 100025.741948627073967394 ether
-                + 0.6143714334864 ether + 0.8724381022176 ether
-            )
-        );
-        // Compare the value logged above with the sum of the following values
-        // you will see after running the test:
-        // Owner commission after staking
-        // Owner commission after unstaking
-    }
-
 }
diff --git a/test/NonLiquidDelegation.t.sol b/test/NonLiquidDelegation.t.sol
@@ -8,7 +8,7 @@ import {NonLiquidDelegationV2} from "src/NonLiquidDelegationV2.sol";
 import {BaseDelegation} from "src/BaseDelegation.sol";
 import {WithdrawalQueue} from "src/WithdrawalQueue.sol";
 import {Delegation} from "src/Delegation.sol";
-import {Deposit} from "@zilliqa/zq2/deposit_v2.sol";
+import {Deposit} from "@zilliqa/zq2/deposit_v3.sol";
 import {Console} from "src/Console.sol";
 import {Strings} from "@openzeppelin/contracts/utils/Strings.sol";
 import {console} from "forge-std/console.sol";
@@ -122,8 +122,6 @@ contract NonLiquidDelegationTest is BaseDelegationTest {
         int256[] memory relativeAmountsAfterWithdrawals = abi.decode(_relativeAmountsAfterWithdrawals, (int256[]));
         require(stakerIndicesAfterWithdrawals.length == relativeAmountsAfterWithdrawals.length, "array length mismatch");
 
-        // TODO: remove the next line once https://github.com/Zilliqa/zq2/issues/2009 is fixed
-        if (mode == DepositMode.DepositThenMigrate) return;
         if (mode == DepositMode.DepositThenMigrate)
             migrate(BaseDelegation(delegation), depositAmount);
         else
@@ -558,8 +556,6 @@ contract NonLiquidDelegationTest is BaseDelegationTest {
         vm.stopPrank();
 
         vm.roll(block.number + WithdrawalQueue.unbondingPeriod());
-        //TODO: remove the next line once https://github.com/Zilliqa/zq2/issues/1761 is fixed
-        vm.warp(block.timestamp + WithdrawalQueue.unbondingPeriod());
 
         i = 1;
         vm.startPrank(stakers[i-1]);

diff --git a/test/PopVerifyPrecompile.t.sol b/test/PopVerifyPrecompile.t.sol