fix(various): fix typo and wrong comparison (#267)

Refactor `UnCmp` to `Uncmp` for consistency. Max UBI percent setters allows new value to be equal to max, not only < issue: none
piplabs · Oct 22, 2024 · a4918f6 · a4918f6
1 parent 55172fc
commit a4918f6
Show file tree

Hide file tree

Showing 9 changed files with 1,160 additions and 858 deletions.
diff --git a/client/cmd/abi/IPTokenStaking.abi.json b/client/cmd/abi/IPTokenStaking.abi.json
diff --git a/client/cmd/validator.go b/client/cmd/validator.go
@@ -775,7 +775,7 @@ func extractDelegationIDFromStake(cfg *stakeConfig, receipt *types.Receipt) (*bi
 		if vLog.Topics[0] == eventSignature {
 			eventData := struct {
 				DelegatorUncmpPubkey []byte
-				ValidatorUnCmpPubkey []byte
+				ValidatorUncmpPubkey []byte
 				StakeAmount          *big.Int
 				StakingPeriod        *big.Int
 				DelegationId         *big.Int //nolint:revive,stylecheck // Definition comes from ABI

diff --git a/client/x/evmstaking/keeper/deposit.go b/client/x/evmstaking/keeper/deposit.go
@@ -26,7 +26,7 @@ func (k Keeper) ProcessDeposit(ctx context.Context, ev *bindings.IPTokenStakingD
 					types.EventTypeDelegateFailure,
 					sdk.NewAttribute(types.AttributeKeyBlockHeight, strconv.FormatInt(sdkCtx.BlockHeight(), 10)),
 					sdk.NewAttribute(types.AttributeKeyDelegatorUncmpPubKey, hex.EncodeToString(ev.DelegatorUncmpPubkey)),
-					sdk.NewAttribute(types.AttributeKeyValidatorUncmpPubKey, hex.EncodeToString(ev.ValidatorUnCmpPubkey)),
+					sdk.NewAttribute(types.AttributeKeyValidatorUncmpPubKey, hex.EncodeToString(ev.ValidatorUncmpPubkey)),
 					sdk.NewAttribute(types.AttributeKeyDelegateID, ev.DelegationId.String()),
 					sdk.NewAttribute(types.AttributeKeyPeriodType, strconv.FormatInt(ev.StakingPeriod.Int64(), 10)),
 					sdk.NewAttribute(types.AttributeKeyAmount, ev.StakeAmount.String()),
@@ -46,7 +46,7 @@ func (k Keeper) ProcessDeposit(ctx context.Context, ev *bindings.IPTokenStakingD
 		return errors.Wrap(err, "depositor pubkey to cosmos")
 	}
 
-	valCmpPubkey, err := UncmpPubKeyToCmpPubKey(ev.ValidatorUnCmpPubkey)
+	valCmpPubkey, err := UncmpPubKeyToCmpPubKey(ev.ValidatorUncmpPubkey)
 	if err != nil {
 		return types.WrapErrWithCode(types.InvalidUncmpPubKey, errors.Wrap(err, "compress validator pubkey"))
 	}

diff --git a/client/x/evmstaking/keeper/deposit_test.go b/client/x/evmstaking/keeper/deposit_test.go
@@ -59,7 +59,7 @@ func (s *TestSuite) TestProcessDeposit() {
 	createDeposit := func(delPubKey, valPubKey []byte, amount *big.Int) *bindings.IPTokenStakingDeposit {
 		return &bindings.IPTokenStakingDeposit{
 			DelegatorUncmpPubkey: cmpToUncmp(delPubKey),
-			ValidatorUnCmpPubkey: cmpToUncmp(valPubKey),
+			ValidatorUncmpPubkey: cmpToUncmp(valPubKey),
 			StakeAmount:          amount,
 			StakingPeriod:        big.NewInt(0),
 			DelegationId:         big.NewInt(0),
@@ -87,7 +87,7 @@ func (s *TestSuite) TestProcessDeposit() {
 			name: "fail: invalid delegator pubkey",
 			deposit: &bindings.IPTokenStakingDeposit{
 				DelegatorUncmpPubkey: cmpToUncmp(delPubKey.Bytes())[:16],
-				ValidatorUnCmpPubkey: cmpToUncmp(valPubKey.Bytes()),
+				ValidatorUncmpPubkey: cmpToUncmp(valPubKey.Bytes()),
 				StakeAmount:          new(big.Int).SetUint64(1),
 				StakingPeriod:        big.NewInt(0),
 				DelegationId:         big.NewInt(0),
@@ -99,7 +99,7 @@ func (s *TestSuite) TestProcessDeposit() {
 			name: "fail: invalid validator pubkey",
 			deposit: &bindings.IPTokenStakingDeposit{
 				DelegatorUncmpPubkey: cmpToUncmp(delPubKey.Bytes()),
-				ValidatorUnCmpPubkey: cmpToUncmp(valPubKey.Bytes())[:16],
+				ValidatorUncmpPubkey: cmpToUncmp(valPubKey.Bytes())[:16],
 				StakeAmount:          new(big.Int).SetUint64(1),
 				StakingPeriod:        big.NewInt(0),
 				DelegationId:         big.NewInt(0),
@@ -111,7 +111,7 @@ func (s *TestSuite) TestProcessDeposit() {
 			name: "fail: corrupted delegator pubkey",
 			deposit: &bindings.IPTokenStakingDeposit{
 				DelegatorUncmpPubkey: createCorruptedPubKey(cmpToUncmp(delPubKey.Bytes())),
-				ValidatorUnCmpPubkey: cmpToUncmp(valPubKey.Bytes()),
+				ValidatorUncmpPubkey: cmpToUncmp(valPubKey.Bytes()),
 				StakeAmount:          new(big.Int).SetUint64(1),
 				StakingPeriod:        big.NewInt(0),
 				DelegationId:         big.NewInt(0),

diff --git a/client/x/evmstaking/keeper/withdraw.go b/client/x/evmstaking/keeper/withdraw.go
@@ -323,7 +323,7 @@ func (k Keeper) ProcessWithdraw(ctx context.Context, ev *bindings.IPTokenStaking
 					types.EventTypeUndelegateFailure,
 					sdk.NewAttribute(types.AttributeKeyBlockHeight, strconv.FormatInt(sdkCtx.BlockHeight(), 10)),
 					sdk.NewAttribute(types.AttributeKeyDelegatorUncmpPubKey, hex.EncodeToString(ev.DelegatorUncmpPubkey)),
-					sdk.NewAttribute(types.AttributeKeyValidatorUncmpPubKey, hex.EncodeToString(ev.ValidatorUnCmpPubkey)),
+					sdk.NewAttribute(types.AttributeKeyValidatorUncmpPubKey, hex.EncodeToString(ev.ValidatorUncmpPubkey)),
 					sdk.NewAttribute(types.AttributeKeyDelegateID, ev.DelegationId.String()),
 					sdk.NewAttribute(types.AttributeKeyAmount, ev.StakeAmount.String()),
 					sdk.NewAttribute(types.AttributeKeySenderAddress, ev.OperatorAddress.Hex()),
@@ -352,7 +352,7 @@ func (k Keeper) ProcessWithdraw(ctx context.Context, ev *bindings.IPTokenStaking
 		return errors.Wrap(err, "depositor pubkey to cosmos")
 	}
 
-	valCmpPubkey, err := UncmpPubKeyToCmpPubKey(ev.ValidatorUnCmpPubkey)
+	valCmpPubkey, err := UncmpPubKeyToCmpPubKey(ev.ValidatorUncmpPubkey)
 	if err != nil {
 		return types.WrapErrWithCode(types.InvalidUncmpPubKey, errors.Wrap(err, "compress validator pubkey"))
 	}

diff --git a/client/x/evmstaking/keeper/withdraw_test.go b/client/x/evmstaking/keeper/withdraw_test.go
@@ -287,7 +287,7 @@ func (s *TestSuite) TestProcessWithdraw() {
 			},
 			withdraw: &bindings.IPTokenStakingWithdraw{
 				DelegatorUncmpPubkey: cmpToUncmp(delPubKey1.Bytes()),
-				ValidatorUnCmpPubkey: cmpToUncmp(valPubKey.Bytes()),
+				ValidatorUncmpPubkey: cmpToUncmp(valPubKey.Bytes()),
 				StakeAmount:          new(big.Int).SetUint64(1),
 				DelegationId:         big.NewInt(0),
 				OperatorAddress:      cmpToEVM(delPubKey1.Bytes()),
@@ -296,7 +296,7 @@ func (s *TestSuite) TestProcessWithdraw() {
 			name: "fail: invalid delegator pubkey",
 			withdraw: &bindings.IPTokenStakingWithdraw{
 				DelegatorUncmpPubkey: cmpToUncmp(delPubKey1.Bytes())[:16],
-				ValidatorUnCmpPubkey: cmpToUncmp(valPubKey.Bytes()),
+				ValidatorUncmpPubkey: cmpToUncmp(valPubKey.Bytes()),
 				StakeAmount:          new(big.Int).SetUint64(1),
 				DelegationId:         big.NewInt(0),
 				OperatorAddress:      cmpToEVM(delPubKey1.Bytes()),
@@ -307,7 +307,7 @@ func (s *TestSuite) TestProcessWithdraw() {
 			name: "fail: invalid validator pubkey",
 			withdraw: &bindings.IPTokenStakingWithdraw{
 				DelegatorUncmpPubkey: cmpToUncmp(delPubKey1.Bytes()),
-				ValidatorUnCmpPubkey: cmpToUncmp(valPubKey.Bytes())[:16],
+				ValidatorUncmpPubkey: cmpToUncmp(valPubKey.Bytes())[:16],
 				StakeAmount:          new(big.Int).SetUint64(1),
 				DelegationId:         big.NewInt(0),
 				OperatorAddress:      cmpToEVM(delPubKey1.Bytes()),
@@ -318,7 +318,7 @@ func (s *TestSuite) TestProcessWithdraw() {
 			name: "fail: corrupted delegator pubkey",
 			withdraw: &bindings.IPTokenStakingWithdraw{
 				DelegatorUncmpPubkey: createCorruptedPubKey(cmpToUncmp(delPubKey1.Bytes())),
-				ValidatorUnCmpPubkey: cmpToUncmp(valPubKey.Bytes()),
+				ValidatorUncmpPubkey: cmpToUncmp(valPubKey.Bytes()),
 				StakeAmount:          new(big.Int).SetUint64(1),
 				DelegationId:         big.NewInt(0),
 				OperatorAddress:      cmpToEVM(delPubKey1.Bytes()),
@@ -329,7 +329,7 @@ func (s *TestSuite) TestProcessWithdraw() {
 			name: "fail: corrupted validator pubkey",
 			withdraw: &bindings.IPTokenStakingWithdraw{
 				DelegatorUncmpPubkey: cmpToUncmp(delPubKey1.Bytes()),
-				ValidatorUnCmpPubkey: createCorruptedPubKey(cmpToUncmp(valPubKey.Bytes())),
+				ValidatorUncmpPubkey: createCorruptedPubKey(cmpToUncmp(valPubKey.Bytes())),
 				StakeAmount:          new(big.Int).SetUint64(1),
 				DelegationId:         big.NewInt(0),
 				OperatorAddress:      cmpToEVM(delPubKey1.Bytes()),
@@ -343,7 +343,7 @@ func (s *TestSuite) TestProcessWithdraw() {
 			},
 			withdraw: &bindings.IPTokenStakingWithdraw{
 				DelegatorUncmpPubkey: cmpToUncmp(unknownPubKey.Bytes()),
-				ValidatorUnCmpPubkey: cmpToUncmp(valPubKey.Bytes()),
+				ValidatorUncmpPubkey: cmpToUncmp(valPubKey.Bytes()),
 				StakeAmount:          new(big.Int).SetUint64(1),
 				DelegationId:         big.NewInt(0),
 				OperatorAddress:      cmpToEVM(unknownPubKey.Bytes()),
@@ -357,7 +357,7 @@ func (s *TestSuite) TestProcessWithdraw() {
 			},
 			withdraw: &bindings.IPTokenStakingWithdraw{
 				DelegatorUncmpPubkey: cmpToUncmp(delPubKey1.Bytes()),
-				ValidatorUnCmpPubkey: cmpToUncmp(valPubKey.Bytes()),
+				ValidatorUncmpPubkey: cmpToUncmp(valPubKey.Bytes()),
 				StakeAmount:          new(big.Int).SetUint64(math.MaxUint64),
 				DelegationId:         big.NewInt(0),
 				OperatorAddress:      cmpToEVM(delPubKey1.Bytes()),

diff --git a/contracts/bindings/iptokenstaking.go b/contracts/bindings/iptokenstaking.go
diff --git a/contracts/src/interfaces/IIPTokenStaking.sol b/contracts/src/interfaces/IIPTokenStaking.sol
@@ -72,15 +72,15 @@ interface IIPTokenStaking {
 
     /// @notice Emitted when a user deposits token into the contract.
     /// @param delegatorUncmpPubkey Delegator's 65 bytes uncompressed secp256k1 public key.
-    /// @param validatorUnCmpPubkey Validator's 65 bytes uncompressed secp256k1 public key.
+    /// @param validatorUncmpPubkey Validator's 65 bytes uncompressed secp256k1 public key.
     /// @param stakeAmount Token deposited.
     /// @param stakingPeriod of the deposit
     /// @param delegationId The ID of the delegation
     /// @param operatorAddress The caller's address
     /// @param data Additional data for the deposit
     event Deposit(
         bytes delegatorUncmpPubkey,
-        bytes validatorUnCmpPubkey,
+        bytes validatorUncmpPubkey,
         uint256 stakeAmount,
         uint256 stakingPeriod,
         uint256 delegationId,
@@ -90,14 +90,14 @@ interface IIPTokenStaking {
 
     /// @notice Emitted when a user withdraws her stake and starts the unbonding period.
     /// @param delegatorUncmpPubkey Delegator's 65 bytes uncompressed secp256k1 public key.
-    /// @param validatorUnCmpPubkey Validator's 65 bytes uncompressed secp256k1 public key.
+    /// @param validatorUncmpPubkey Validator's 65 bytes uncompressed secp256k1 public key.
     /// @param stakeAmount Token deposited.
     /// @param delegationId The ID of the delegation, 0 if flexible
     /// @param operatorAddress The caller's address
     /// @param data Additional data for the deposit
     event Withdraw(
         bytes delegatorUncmpPubkey,
-        bytes validatorUnCmpPubkey,
+        bytes validatorUncmpPubkey,
         uint256 stakeAmount,
         uint256 delegationId,
         address operatorAddress,

diff --git a/contracts/src/protocol/UBIPool.sol b/contracts/src/protocol/UBIPool.sol
@@ -45,7 +45,7 @@ contract UBIPool is
     /// @notice Sets the UBI percentage distribution in CL
     /// @param percentage The percentage of the UBI
     function setUBIPercentage(uint32 percentage) external onlyOwner {
-        require(percentage < MAX_UBI_PERCENTAGE, "UBIPool: percentage too high");
+        require(percentage <= MAX_UBI_PERCENTAGE, "UBIPool: percentage too high");
         emit UBIPercentageSet(percentage);
     }