pr comments improvements

stader-labs · Sep 20, 2023 · 4982308 · 4982308
1 parent b9070f5
commit 4982308
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 10 deletions.
diff --git a/contracts/StaderStakePoolsManager.sol b/contracts/StaderStakePoolsManager.sol
@@ -166,25 +166,25 @@ contract StaderStakePoolsManager is
     }
 
     /**
-     * @notice auxiliary method for KOL users/referrals to stake ETH and mints ETHx for _receiver based on exchange rate
+     * @notice auxiliary method for KOL users/referrals to stake ETH and mint ETHx for _receiver based on exchange rate
      * @param _receiver account where ETHx minted are sent
      * @param _referralId referral id of KOL
      * @return _shares amount of ETHx token minted and sent to receiver
      * @dev emits an event with _referralId
      */
-    function depositViaKOL(address _receiver, string calldata _referralId)
+    function deposit(address _receiver, string calldata _referralId)
         external
         payable
         override
         whenNotPaused
         returns (uint256 _shares)
     {
         _shares = deposit(_receiver);
-        emit DepositedViaKOL(msg.sender, _receiver, msg.value, _shares, _referralId);
+        emit DepositReferral(msg.sender, _receiver, msg.value, _shares, _referralId);
     }
 
     /**
-     * @notice stake ETH and mints ETHx for _receiver based on exchange rate
+     * @notice stake ETH and mint ETHx for _receiver based on exchange rate
      * @param _receiver account where ETHx
      * @return shares amount of ETHx token minted and sent to receiver
      */

diff --git a/contracts/UserWithdrawalManager.sol b/contracts/UserWithdrawalManager.sol
@@ -94,14 +94,14 @@ contract UserWithdrawalManager is
      * @return _requestId
      * @dev emits an event with referralId
      */
-    function requestWithdrawViaKOL(
+    function requestWithdraw(
         uint256 _ethXAmount,
         address _owner,
         string calldata _referralId
     ) external override whenNotPaused returns (uint256 _requestId) {
         uint256 etherAmount = IStaderStakePoolManager(staderConfig.getStakePoolManager()).previewWithdraw(_ethXAmount);
         _requestId = requestWithdraw(_ethXAmount, _owner);
-        emit WithdrawRequestReceivedViaKOL(msg.sender, _owner, _requestId, _ethXAmount, etherAmount, _referralId);
+        emit WithdrawRequestReferral(msg.sender, _owner, _requestId, _ethXAmount, etherAmount, _referralId);
     }
 
     /**

diff --git a/contracts/interfaces/IStaderStakePoolManager.sol b/contracts/interfaces/IStaderStakePoolManager.sol
@@ -14,7 +14,7 @@ interface IStaderStakePoolManager {
 
     // Events
     event UpdatedStaderConfig(address staderConfig);
-    event DepositedViaKOL(
+    event DepositReferral(
         address indexed caller,
         address indexed owner,
         uint256 assets,
@@ -30,7 +30,7 @@ interface IStaderStakePoolManager {
     event WithdrawVaultUserShareReceived(uint256 amount);
     event UpdatedExcessETHDepositCoolDown(uint256 excessETHDepositCoolDown);
 
-    function depositViaKOL(address _receiver, string calldata _referralId) external payable returns (uint256);
+    function deposit(address _receiver, string calldata _referralId) external payable returns (uint256);
 
     function deposit(address _receiver) external payable returns (uint256);
 

diff --git a/contracts/interfaces/IUserWithdrawalManager.sol b/contracts/interfaces/IUserWithdrawalManager.sol
@@ -19,7 +19,7 @@ interface IUserWithdrawalManager {
     // Events
     event UpdatedFinalizationBatchLimit(uint256 paginationLimit);
     event UpdatedStaderConfig(address staderConfig);
-    event WithdrawRequestReceivedViaKOL(
+    event WithdrawRequestReferral(
         address indexed _msgSender,
         address _recipient,
         uint256 _requestId,
@@ -70,7 +70,7 @@ interface IUserWithdrawalManager {
 
     function updateFinalizationBatchLimit(uint256 _paginationLimit) external;
 
-    function requestWithdrawViaKOL(
+    function requestWithdraw(
         uint256 _ethXAmount,
         address receiver,
         string calldata referralId