Fix issue 8 and add support for direct staking of rewards

README.md

@@ -7,6 +7,10 @@ Install Foundry (https://book.getfoundry.sh/getting-started/installation) and th
 forge install OpenZeppelin/openzeppelin-contracts-upgradeable --no-commit
 forge install OpenZeppelin/openzeppelin-contracts --no-commit
 ```
+The Zilliqa 2.0 deposit contract must be compiled for the tests in this repository to work. Specify the folder containing the `deposit.sol` file in `remappings.txt`:
+```
+@zilliqa/zq2/=/home/user/zq2/zilliqa/src/contracts/
+```
 
 ## Contract Deployment
 The delegation contract is used by delegators to stake and unstake ZIL with the respective validator. It acts as the validator node's control address and interacts with the `Deposit` system contract.
@@ -82,7 +86,7 @@ forge script script/commission_Delegation.s.sol --rpc-url http://localhost:4201
 using `same` for the second argument to leave the commission percentage unchanged and `true` for the third argument. Replacing the second argument with `same` and the third argument with `false` only displays the current commission rate.
 
 ## Validator Activation
-If you node's account has enough ZIL for the minimum stake required, you can activate your node as a validator with a deposit of e.g. 10 million ZIL. Run
+If your node's account has enough ZIL for the minimum stake required, you can activate your node as a validator with a deposit of e.g. 10 million ZIL. Run
 ```bash
 cast send --legacy --value 10000000ether --rpc-url http://localhost:4201 --private-key $PRIVATE_KEY \
 0x7a0b7e6d24ede78260c9ddbd98e828b0e11a8ea2 "deposit(bytes,bytes,bytes)" \
@@ -185,8 +189,13 @@ To query how much ZIL you can already claim, run
 cast to-unit $(cast call 0x7A0b7e6D24eDe78260c9ddBD98e828B0e11A8EA2 "getClaimable()(uint256)" --from 0xd819fFcE7A58b1E835c25617Db7b46a00888B013 --block latest --rpc-url http://localhost:4201 | sed 's/\[[^]]*\]//g') ether
 ```
 
-## Withdrawing Rewards
-In the non-liquid variant of staking delegators can withdraw their share of the rewards earned by the validator. To query the amount of rewards available, run
+## Staking and Withdrawing Rewards
+In the liquid staking variant, only you as the node operator can stake the rewards accrued by the node. To do so, run
+```bash
+forge script script/stakeRewards_Delegation.s.sol --rpc-url http://localhost:4201 --broadcast --legacy --sig "run(address payable)" 0x7A0b7e6D24eDe78260c9ddBD98e828B0e11A8EA2 --private-key 0x...
+```
+
+In the non-liquid variant of staking, delegators can stake or withdraw their share of the rewards earned by the validator. To query the amount of rewards available, run
 ```bash
 cast to-unit $(cast call 0x7A0b7e6D24eDe78260c9ddBD98e828B0e11A8EA2 "rewards()(uint256)" --from 0xd819fFcE7A58b1E835c25617Db7b46a00888B013 --block latest --rpc-url http://localhost:4201 | sed 's/\[[^]]*\]//g') ether
 ```
@@ -197,8 +206,14 @@ cast to-unit $(cast call 0x7A0b7e6D24eDe78260c9ddBD98e828B0e11A8EA2 "rewards(uin
 ```
 Note that `n` actually denotes the number of additional (un)stakings so that at least one is always reflected in the result, even if you specified `n = 0`.
 
-Last but not least, to withdraw 1 ZIL of rewards using `n = 100`, run
+To withdraw 1 ZIL of rewards using `n = 100`, run
+```bash
+forge script script/withdrawRewards_Delegation.s.sol --rpc-url http://localhost:4201 --broadcast --legacy --sig "run(address payable, string, string)" 0x7A0b7e6D24eDe78260c9ddBD98e828B0e11A8EA2 1000000000000000000 100 --private-key 0x...
+```
+with the private key of a staked account. To withdrawn as much as possible with the given value of `n` set the amount to `all`. To withdraw the chosen amount without setting `n` replace `n` with `all`. To withdraw all rewards replace both the amount and `n` with `all`.
+
+Last but not least, in order to stake rewards instead of withdrawing them, run
 ```bash
-forge script script/rewards_Delegation.s.sol --rpc-url http://localhost:4201 --broadcast --legacy --sig "run(address payable, string, string)" 0x7A0b7e6D24eDe78260c9ddBD98e828B0e11A8EA2 1000000000000000000 100 --private-key 0x...
+forge script script/stakeRewards_Delegation.s.sol --rpc-url http://localhost:4201 --broadcast --legacy --sig "run(address payable)" 0x7A0b7e6D24eDe78260c9ddBD98e828B0e11A8EA2 --private-key 0x...
 ```
-with the private key of an staked account. To withdrawn as much as possible with the given value of `n` set the amount to `all`. To withdraw the chosen amount without setting `n` replace `n` with `all`. To withdraw all rewards replace both the amount and `n` with `all`.
+with the private key of a staked account.

claim.sh

@@ -24,7 +24,7 @@ if [[ "$variant" == "ILiquidDelegation" ]]; then
     echo taxedRewardsAfterClaiming = $(cast call $1 "getTaxedRewards()(uint256)" --block $block_num --rpc-url http://localhost:4201 | sed 's/\[[^]]*\]//g')
 fi
 
-staker_wei_after=$(cast rpc eth_getBalance $staker $block --rpc-url http://localhost:4201 | tr -d '"' | cast to-dec --base-in 16)
+stakerWeiAfter=$(cast rpc eth_getBalance $staker $block --rpc-url http://localhost:4201 | tr -d '"' | cast to-dec --base-in 16)
 
 tmp=$(cast logs --from-block $block_num --to-block $block_num --address $1 "Claimed(address,uint256,bytes)" --rpc-url http://localhost:4201 | grep "data")
 if [[ "$tmp" != "" ]]; then
@@ -48,9 +48,9 @@ if [[ "$variant" == "ILiquidDelegation" ]]; then
     echo taxedRewardsBeforeClaiming = $(cast call $1 "getTaxedRewards()(uint256)" --block $block_num --rpc-url http://localhost:4201 | sed 's/\[[^]]*\]//g')
 fi
 
-staker_wei_before=$(cast rpc eth_getBalance $staker $block --rpc-url http://localhost:4201 | tr -d '"' | cast to-dec --base-in 16)
+stakerWeiBefore=$(cast rpc eth_getBalance $staker $block --rpc-url http://localhost:4201 | tr -d '"' | cast to-dec --base-in 16)
 
-echo claimed amount - gas fee = $(bc -l <<< "scale=18; $staker_wei_after-$staker_wei_before") wei
+echo claimed amount - gas fee = $(bc -l <<< "scale=18; $stakerWeiAfter-$stakerWeiBefore") wei
 
 if [[ "$tmp" != "" ]]; then echo event Claimed\($staker, $d1, $d2\) emitted; fi
 

remappings.txt

@@ -1,2 +1,3 @@
 @openzeppelin/contracts/=lib/openzeppelin-contracts/contracts/
-@openzeppelin/contracts-upgradeable/=lib/openzeppelin-contracts-upgradeable/contracts/
+@openzeppelin/contracts-upgradeable/=lib/openzeppelin-contracts-upgradeable/contracts/
+@zilliqa/zq2/=/home/zoltan/Github/zq2/zilliqa/src/contracts/

script/stakeRewards_Delegation.s.sol

@@ -0,0 +1,34 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+pragma solidity ^0.8.26;
+
+import {Script} from "forge-std/Script.sol";
+import {BaseDelegation} from "src/BaseDelegation.sol";
+import "forge-std/console.sol";
+
+contract StakeRewards is Script {
+
+    function run(address payable proxy) external {
+
+        BaseDelegation delegation = BaseDelegation(
+                proxy
+            );
+
+        console.log("Running version: %s",
+            delegation.version()
+        );
+
+        console.log("Current stake: %s wei \r\n  Current rewards: %s wei",
+            delegation.getStake(),
+            delegation.getRewards()
+        );
+
+        vm.broadcast();
+
+        delegation.stakeRewards();
+
+        console.log("New stake: %s wei \r\n  New rewards: %s wei",
+            delegation.getStake(),
+            delegation.getRewards()
+        );
+    }
+}

script/unstake_Delegation.s.sol

@@ -49,6 +49,7 @@ contract Unstake is Script {
             );
 
             if (amount == 0) {
+                vm.prank(msg.sender);
                 amount = INonLiquidDelegation(address(delegation)).getDelegatedStake();
             }
         } else

script/rewards_Delegation.s.sol → script/withdrawRewards_Delegation.s.sol

@@ -6,7 +6,7 @@ import {NonLiquidDelegation} from "src/NonLiquidDelegation.sol";
 import {Strings} from "@openzeppelin/contracts/utils/Strings.sol";
 import "forge-std/console.sol";
 
-contract Rewards is Script {
+contract WithdrawRewards is Script {
     using Strings for string;
 
     function run(address payable proxy, string calldata amount, string calldata additionalSteps) external {

src/BaseDelegation.sol

@@ -177,6 +177,8 @@ abstract contract BaseDelegation is Delegation, PausableUpgradeable, Ownable2Ste
 
     function collectCommission() public virtual;
 
+    function stakeRewards() public virtual;
+
     function getClaimable() public virtual view returns(uint256 total) {
         BaseDelegationStorage storage $ = _getBaseDelegationStorage();
         WithdrawalQueue.Fifo storage fifo = $.withdrawals[_msgSender()];

src/Delegation.sol

@@ -7,8 +7,11 @@ interface Delegation {
     event Staked(address indexed delegator, uint256 amount, bytes data);
     event Unstaked(address indexed delegator, uint256 amount, bytes data);
     event Claimed(address indexed delegator, uint256 amount, bytes data);
+    event CommissionPaid(address indexed owner, uint256 commission);
 
     function stake() external payable;
     function unstake(uint256) external;
     function claim() external;
+    function collectCommission() external;
+    function stakeRewards() external;
 }