set commission (#2)

update the change commission event params; update test for set commission;
Hydra-Chain · Apr 25, 2024 · c1afcce · c1afcce
1 parent e5b98fe
commit c1afcce
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 10 deletions.
diff --git a/contracts/ValidatorSet/modules/Staking/IStaking.sol b/contracts/ValidatorSet/modules/Staking/IStaking.sol
@@ -3,7 +3,7 @@ pragma solidity 0.8.17;
 
 interface IStaking {
     event NewValidator(address indexed validator, uint256[4] blsKey);
-    event CommissionUpdated(address indexed validator, uint256 oldCommission, uint256 newCommission);
+    event CommissionUpdated(address indexed validator, uint256 newCommission);
     event Staked(address indexed validator, uint256 amount);
     event Unstaked(address indexed validator, uint256 amount);
 

diff --git a/contracts/ValidatorSet/modules/Staking/Staking.sol b/contracts/ValidatorSet/modules/Staking/Staking.sol
@@ -144,7 +144,7 @@ abstract contract Staking is
 
         validators[validator].commission = newCommission;
 
-        emit CommissionUpdated(msg.sender, validators[msg.sender].commission, newCommission);
+        emit CommissionUpdated(validator, newCommission);
     }
 
     // slither-disable-next-line unused-state,naming-convention

diff --git a/docs/ValidatorSet/ValidatorSet.md b/docs/ValidatorSet/ValidatorSet.md
@@ -1067,7 +1067,7 @@ event AddedToWhitelist(address indexed validator)
 ### CommissionUpdated
 
 ```solidity
-event CommissionUpdated(address indexed validator, uint256 oldCommission, uint256 newCommission)
+event CommissionUpdated(address indexed validator, uint256 newCommission)
 ```
 
 
@@ -1079,7 +1079,6 @@ event CommissionUpdated(address indexed validator, uint256 oldCommission, uint25
 | Name | Type | Description |
 |---|---|---|
 | validator `indexed` | address | undefined |
-| oldCommission  | uint256 | undefined |
 | newCommission  | uint256 | undefined |
 
 ### Delegated

diff --git a/docs/ValidatorSet/modules/Staking/IStaking.md b/docs/ValidatorSet/modules/Staking/IStaking.md
@@ -94,7 +94,7 @@ Unstakes amount for sender. Claims rewards beforehand.
 ### CommissionUpdated
 
 ```solidity
-event CommissionUpdated(address indexed validator, uint256 oldCommission, uint256 newCommission)
+event CommissionUpdated(address indexed validator, uint256 newCommission)
 ```
 
 
@@ -106,7 +106,6 @@ event CommissionUpdated(address indexed validator, uint256 oldCommission, uint25
 | Name | Type | Description |
 |---|---|---|
 | validator `indexed` | address | undefined |
-| oldCommission  | uint256 | undefined |
 | newCommission  | uint256 | undefined |
 
 ### NewValidator

diff --git a/docs/ValidatorSet/modules/Staking/Staking.md b/docs/ValidatorSet/modules/Staking/Staking.md
@@ -622,7 +622,7 @@ event AddedToWhitelist(address indexed validator)
 ### CommissionUpdated
 
 ```solidity
-event CommissionUpdated(address indexed validator, uint256 oldCommission, uint256 newCommission)
+event CommissionUpdated(address indexed validator, uint256 newCommission)
 ```
 
 
@@ -634,7 +634,6 @@ event CommissionUpdated(address indexed validator, uint256 oldCommission, uint25
 | Name | Type | Description |
 |---|---|---|
 | validator `indexed` | address | undefined |
-| oldCommission  | uint256 | undefined |
 | newCommission  | uint256 | undefined |
 
 ### Initialized

diff --git a/test/ValidatorSet/ValidatorSet.test.ts b/test/ValidatorSet/ValidatorSet.test.ts
@@ -854,10 +854,15 @@ describe("ValidatorSet", function () {
       it("should set commission", async function () {
         const { validatorSet } = await loadFixture(this.fixtures.withdrawableFixture);
 
-        await validatorSet.connect(this.signers.validators[0]).setCommission(MAX_COMMISSION.div(2));
+        // set commission and verify event
+        const newCommission = MAX_COMMISSION.div(2);
+        await expect(validatorSet.connect(this.signers.validators[0]).setCommission(newCommission))
+          .to.emit(validatorSet, "CommissionUpdated")
+          .withArgs(this.signers.validators[0].address, newCommission);
 
+        // get the update validator and ensure that the new commission is set
         const validator = await validatorSet.getValidator(this.signers.validators[0].address);
-        expect(validator.commission).to.equal(MAX_COMMISSION.div(2));
+        expect(validator.commission).to.equal(newCommission);
       });
     });
   });