SD utility pool by sanjay-staderlabs · Pull Request #212 · stader-labs/ethx

sanjay-staderlabs · 2023-11-14T12:58:55Z

This PR introduces SD Utility Pool. where NO can utilise SD for collateral, following are the major changes

New SD Utility Pool Contract which deals with delegators and utilizers
New SDIncentiveController contract, which handles the distribution of reward tokens for the utility pool.
New Call in Permissionless Node Registry to add validator along with utilizing SD
New Deposit and Repay function in SDCollateral contract to interact with Utility Pool
introduction of getter and setter for utility pool contract and incentive controller in Stader Config
Feature to allow NOs to deposit their SD rewards as collateral

* Initial code * Change terminologies * IncentiveController->SDIncentiveController * Run prettier * Use block number and read from staderConfig

* User struct * mapping * calculation * liquidationCall initial * Add riskconfig

* init * Introduce owedAmount * Update OperatorRewardsCollector.sol

galacticminter · 2023-11-27T01:43:37Z

contracts/OperatorRewardsCollector.sol

    }

+    function claimFor(address operator) external {
+        uint256 toSendAmount;


Why do you need this variable? No usages right?

Can you add documentation? This logic is not very clear.

contracts/OperatorRewardsCollector.sol

galacticminter · 2023-11-27T05:13:18Z

contracts/SDCollateral.sol

            revert InsufficientSDToWithdraw(opSDBalance);
        }
-        operatorSDBalance[operator] -= _requestedSD;
+        uint256 operatorCurrentUtilizeSD = ISDUtilityPool(staderConfig.getSDUtilityPool()).utilizerBalanceCurrent(


fn can called .currentBalance()

galacticminter · 2023-11-27T05:15:02Z

contracts/SDCollateral.sol

-        // cannot use safeERC20 as this contract is an upgradeable contract, and using safeERC20 is not upgrade-safe
-        if (!IERC20(staderConfig.getStaderToken()).transfer(payable(operator), _requestedSD)) {
-            revert SDTransferFailed();
+        uint256 utilizePositionChange = operatorUtilizedSD >= _requestedSD ? _requestedSD : operatorUtilizedSD;


No easier way to do Math.min()?

galacticminter · 2023-11-27T05:39:49Z

contracts/SDCollateral.sol

-        if (!IERC20(staderConfig.getStaderToken()).transfer(payable(operator), _requestedSD)) {
-            revert SDTransferFailed();
+        uint256 utilizePositionChange = operatorUtilizedSD >= _requestedSD ? _requestedSD : operatorUtilizedSD;
+        operatorUtilizedSDBalance[operator] -= utilizePositionChange;


SDRequestedLeft = SDRequested; interestAccrued = operatorTotalUtilizedSD - operatorRecordedUtilizedSD // difference between the two is interest interestPaid = Math.min(SDRequestedLeft, interestAccrued); sdRequestedLeft -= interestPaid; //Update repay amount in SDUtilityPool by transferring interestPaid tokens. Might have to update both utilized and bonded positions. if (sdRequestedLeft == 0) { // You are done.} utilizedPositionRepayAmount = Math.min(sdRequestedLeft, operatorRecordedUtilizedSD) sdRequestedLeft -= utilizedPositionRepayAmount; //definitely decrease the RecordedUtilizedSD & increment the Self Bonded SD & transfer utilizedPositionRepayAmount tokens to SD utilization pool. if (sdRequestedLeft == 0) { // You are done} // At this stage all interest + utilized amount has been repaid. The rest can to operator wallet & only self bonded position will be decremented

Will optimize this further.

SDRequestedLeft = SDRequested; operatorTotalUtilizedSD = utilityPool.currentUtilizedAmount(operator); repayAmount = Math.min(SDRequestedLeft, operatorTotalUtilizedSD); sdRequestedLeft -= repayAmount; // transfer repayAmount tokens to SD utility pool. Decrement total utilized balance on pool & operator current utilized balance on pool. interestPaid = Math.min(repayAmount, operatorTotalUtilizedSD - operatorRecordedUtilizedSD); // How do we make sure this math works for incentivized lending when the 2nd term might be negative? utilizedAmountPaid = repayAmount - interestPaid; operatorRecordedUtilizedSD -= utilizedAmountPaid; SDBalances[operator] += utilizedAmountPaid; if (sdRequestedLeft > 0) { // Send sdRequestedLeft tokens to operator wallet. } return (interestPaid, utilizedAmountPaid, sdRequestedLeft);

Is the above simpler?

I will push another implementation of this, mostly the same as above, with a change that the repay function will return the actual repayment amount.

galacticminter · 2023-11-27T18:13:07Z

contracts/SDCollateral.sol

    }

-    /// @notice for max approval to auction contract for spending SD tokens
+    /// @notice for max approval to auction/SD utility pool contract for spending SD tokens


galacticminter · 2023-11-27T18:13:38Z

contracts/SDCollateral.sol

+            operatorUtilizedSDBalance[_operator] -= sdSlashFromUtilized;
+        }
        IAuction(staderConfig.getAuctionContract()).createLot(sdSlashed);
+        emit SDSLashedFromUtilize(_operator, sdSlashFromUtilized);


Get casing right please.

galacticminter · 2023-11-27T18:14:28Z

contracts/SDCollateral.sol

+        uint256 sdSlashFromUtilized = operatorSelfBondedSD >= sdSlashed ? 0 : sdSlashed - operatorSelfBondedSD;
+        operatorSDBalance[_operator] -= (sdSlashed - sdSlashFromUtilized);
+        if (sdSlashFromUtilized > 0) {
+            operatorUtilizedSDBalance[_operator] -= sdSlashFromUtilized;


Isn't this the right place to inform the utility pool of the slashed SD?

i don't think there is any use case of informing the utility pool

Please simplify this logic.

sdToSlashFromSelfBonded = math.min(operatorSelfBondedSD, sdSlashed) operatorSDBalance[_operator] -= sdToSlashFromSelfBonded operatorUtilizedSDBalance[operator] -= (sdSlashed - sdToSlashFromSelfBonded)

This avoids the if stmt.

contracts/SDUtilityPool.sol

* basic utility pool structure * sdCollateral intergration with utilityPool * Rename SDx.sol to SDX.sol * terminology change * SD Incentive Controller (#210) * Initial code * Change terminologies * IncentiveController->SDIncentiveController * Run prettier * Use block number and read from staderConfig * utilize flow * dwlwgator withdraw flow * seperate function in node registry to utilze SD * view function to get latest data * Liquidation (#211) * User struct * mapping * calculation * liquidationCall initial * Add riskconfig * Add back comments * include pause functionality * repay flow changes and comments * Operator reward integration (#213) * init * Introduce owedAmount * Update OperatorRewardsCollector.sol * Add PoolUtils * claimLiquidation * Fix compile * Fix claimFor * Add liquidator data * review fixes * deposit SD reward as collateral changes * Fix compilation * Change function orders * Fix review * Add exit operator * deposit SD reward as collateral flow changes * Fix review * Use operatorUtilizedSDBalance * custom error message * deploy script for utility pool * Updates on incentiveController * Add docs and checkers * fix claim function time cool down logic * Add withdrawable * rename function and variables * Add non-existent liquidation check * fix sdCollateral withdraw function * Fix claim logic * refactor slash SD * whenNotPaused modifier * Claim rewards during requestWithdraw * review fixes * change in request withdraw logic * Review fix * Introduce weth * introducing withdrawOnBehalf in SDCollateral * Transfer back utilized SD * add getter in interface * incentiveController and addValidatorKey fix * test case for utilze and delegate flow * referral Id for adding validator keys * sdCollateral test cases * SD token decimal adjust * Multiply by DECIMAL * Liquidation test * Only manager role for certain functions * test fix * Fix weth issue * Small fix and unit test * Minimum reward amount * Claim available amount * Lint test * Add start incentive later test * SDP-06 fix * SDP-11 fix * Fix SDP-03 * SDP-02 fix * push back SDP-03 fix * SDP-07 fix * SDP-17 fix * Take initial _delegate into consideration * whenNotPaused test cases * comment fix * Expand liquidation call tests * Update SDIncentiveController.t.sol * Separate claim and claimLiquidation * Add test * Quick fix * Remove claimFor * Fix test * Lint and add tests * small change claim * Add emit tests * Refactor test * add emit test * claim after liquidation * change initial delegate amount to 1 SD * Initialise risk config at initialize * Internal function prefix with _ * renaming change * Collateral in ETH and expose liquidationIndexByOperator * rounding up interest in ETH * reward collector test fixed * foundry deploy script * minimum withdraw and delegate limits * rounding up cTokenShare in requestWithdrawWithSD call * fix utilityPool with min delegate amount * add clearUtilizedPosition function * add totalUtilizedSD getter in interface * clearing utilized position using withdrawOnBehalf * optimize _transferBackUtilizedSD * handling of edge cases when nonTerminalKeys are 0 * update interface * add utilityPool deploy script * introduce claimWithAmount function in rewardCollector * fix: only call withdraw if balance of nodeELVault greater than 0 * updating operatorRewardsCollector Interface * adding third party license file * fix formatting of README * add title in License file * formatting the title of License file --------- Co-authored-by: Sanjay Yadav <sanjayyadav@Sanjays-MacBook-Pro.local> Co-authored-by: Dulguun <99845398+dulguun-staderlabs@users.noreply.github.com>

Sanjay Yadav and others added 14 commits November 6, 2023 10:12

basic utility pool structure

b3e9567

sdCollateral intergration with utilityPool

d8664c1

Rename SDx.sol to SDX.sol

f47f2e1

terminology change

b7aee57

SD Incentive Controller (#210)

0b2b4c0

* Initial code * Change terminologies * IncentiveController->SDIncentiveController * Run prettier * Use block number and read from staderConfig

utilize flow

eb88282

origin pull

82cc1c8

dwlwgator withdraw flow

12bab11

seperate function in node registry to utilze SD

7d706b7

view function to get latest data

ac24c13

Liquidation (#211)

28e52c7

* User struct * mapping * calculation * liquidationCall initial * Add riskconfig

Add back comments

cb26fe2

include pause functionality

efcfa04

origin pull

d771bfb

sanjay-staderlabs requested a review from galacticminter November 17, 2023 15:07

sanjay-staderlabs marked this pull request as ready for review November 17, 2023 15:08

Sanjay Yadav and others added 4 commits November 20, 2023 16:54

repay flow changes and comments

5ea300a

Operator reward integration (#213)

1dd59d2

* init * Introduce owedAmount * Update OperatorRewardsCollector.sol

Add PoolUtils

28a5a64

claimLiquidation

4fbc7ba

galacticminter reviewed Nov 27, 2023

View reviewed changes

contracts/OperatorRewardsCollector.sol Outdated Show resolved Hide resolved

galacticminter reviewed Nov 27, 2023

View reviewed changes

contracts/SDUtilityPool.sol Outdated Show resolved Hide resolved

galacticminter reviewed Nov 28, 2023

View reviewed changes

contracts/SDUtilityPool.sol Outdated Show resolved Hide resolved

dulguun-staderlabs and others added 26 commits January 15, 2024 04:47

claim after liquidation

a0962b6

change initial delegate amount to 1 SD

a0b411f

Initialise risk config at initialize

e9bc3a9

Internal function prefix with _

85164c6

renaming change

21ba418

Collateral in ETH and expose liquidationIndexByOperator

a876de8

rounding up interest in ETH

73514c3

reward collector test fixed

7efcb29

foundry deploy script

5a5797f

minimum withdraw and delegate limits

9176358

rounding up cTokenShare in requestWithdrawWithSD call

10b4341

fix utilityPool with min delegate amount

492073d

add clearUtilizedPosition function

559d4bc

add totalUtilizedSD getter in interface

238519a

clearing utilized position using withdrawOnBehalf

b59025c

optimize _transferBackUtilizedSD

d652be5

handling of edge cases when nonTerminalKeys are 0

7d90edb

update interface

1469477

add utilityPool deploy script

e8b4afc

introduce claimWithAmount function in rewardCollector

cfb81ce

fix: only call withdraw if balance of nodeELVault greater than 0

c0b3f9a

updating operatorRewardsCollector Interface

5bb7c2d

adding third party license file

b2ca94c

fix formatting of README

a76a8e8

add title in License file

ffe585a

formatting the title of License file

46462f4

galacticminter approved these changes Apr 1, 2024

View reviewed changes

sanjay-staderlabs merged commit 8b8223f into mainnet_V0 Apr 1, 2024

sanjay-staderlabs deleted the feat/SD_Utility_Pool branch April 1, 2024 09:56

Comments

Conversation

sanjay-staderlabs commented Nov 14, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

galacticminter Nov 27, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sanjay-staderlabs Nov 28, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

sanjay-staderlabs commented Nov 14, 2023 •

edited

Loading

galacticminter Nov 27, 2023 •

edited

Loading

sanjay-staderlabs Nov 28, 2023 •

edited

Loading