Staking Pool #1144

tbssajal · 2025-02-13T12:57:48Z

This PR addresses the following issues:

The runtime complexity of staking operations in finalize() is O(number of staking requests)
Users' balances are updated at protocol level contract call

The PR introduces the following changes:

Introduced staking pool as an additional layer between autonity and liquid contract
- All accounting related to staking is done in staking pool, delegators take their share (liquid, released stake or atn rewards) from the pool
- All stakes bonded or going under bonding or unbonding period can be accounted by the newton balance of staking pool contract
Users don't need to be aware of the staking pool contract.

Additional changes done in the PR:

Refactored how commission rate is updated: no need to iterate the queue in finalize() call.
Refactored how newton balances are updated in autonity contract: now we only use _transfer, _mint and _burn methods to update the balance.

codecov · 2025-02-13T13:34:30Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.90%. Comparing base (6ef2894) to head (36abb30).
Report is 143 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #1144      +/-   ##
===========================================
+ Coverage    72.97%   74.90%   +1.93%     
===========================================
  Files           27       29       +2     
  Lines         3281     4629    +1348     
===========================================
+ Hits          2394     3467    +1073     
- Misses         692      859     +167     
- Partials       195      303     +108

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Jason-Zhangxin-Chen

I have a few comments and questions left, thank you, Tariq. The structure looks better. However, if we can add a README.md for this feature in our contract directory would be better. In the README, you can high light the state machine transitions for the staking tasks and the asset steaming in those pools. For the other reviews, please start with the data models in IStakingPool.sol first, that would help a lots.

Jason-Zhangxin-Chen · 2025-03-06T12:46:45Z

autonity/solidity/contracts/Accountability.sol

-            curCommittee.push(committee[i].addr);
-            allowedReporters[committee[i].addr] = true;
+    function finalizeInitialization(Autonity.CommitteeMember[] memory _committee) external onlyAutonity {
+        delete curCommittee;


In reality, this delete statement should not be required as we deploy and initialize it in genesis block setup, but I think this would help the testing be easier. Please add a comment here, otherwise it can confuse teammates a little bit.

Jason-Zhangxin-Chen · 2025-03-06T12:54:13Z

autonity/solidity/contracts/Autonity.sol

    event MintedStake(address indexed addr, uint256 amount);
    event BurnedStake(address indexed addr, uint256 amount);
-    event CommissionRateChange(address indexed validator, uint256 rate);
+    event CommissionRateChange(address indexed validator, uint256 rate, uint256 activeBlock, bool overridePendingRate);


Just curious, what is a overridePendingRate typed in boolean?

I see, you return a flag to let user to know an un applied rate is overwrite.

Jason-Zhangxin-Chen · 2025-03-06T13:01:20Z

autonity/solidity/contracts/Autonity.sol

-            stakeSupply += _bondedStake;
-            stakeCirculating += _bondedStake;
-            _bond(_validators[i].nodeAddress, _bondedStake, payable(_validators[i].treasury));
+            _mint(_validators[i].treasury, _validators[i].bondedStake);


Just curious, why the self bonding is removed here?

Okay, I see you have a function to mange the genesis bonding.

Jason-Zhangxin-Chen · 2025-03-07T11:50:03Z

autonity/solidity/contracts/Autonity.sol

-        commissionRateChangeQueue[commissionRateChangeQueueLast] = _newRequest;
-        commissionRateChangeQueueLast += 1;
-        emit CommissionRateChange(_validator, _rate);
+        _applyNewCommissionRate(_validator);


_applyNewCommissionRate is called at the end of each epoch, just curious, why do we need call it at here? Is there any edge case need to be handled by this?

Jason-Zhangxin-Chen · 2025-03-07T11:53:29Z

autonity/solidity/contracts/Autonity.sol

        return (_oracleVoters, _afdReporters, _treasuries);
    }

    function autobond(address _validator, uint256 _selfBond, uint256 _delegated) external virtual onlyAtEpochEnd onlyRewardDistributor(_validator) {


Coud rename autobond to autoBond() as we are here.

Jason-Zhangxin-Chen · 2025-03-09T01:50:31Z

autonity/solidity/contracts/lib/UintQueueLib.sol

+// this library is not for general queue operation
+// a general-purpose queue library may be implemented later
+library UintQueueLib {
+    function enqueue(UintQueue storage _queue, uint256 _item) internal {


/** * @dev Adds an item to the end of the queue. * @param _queue The queue to modify. * @param _item The item to enqueue. */

Jason-Zhangxin-Chen · 2025-03-09T01:53:03Z

autonity/solidity/contracts/lib/UintQueueLib.sol

+    function enqueue(UintQueue storage _queue, uint256 _item) internal {
+        _queue.array.push(_item);
+    }
+


/** * @dev Removes up to _deleteCount elements from the front of the queue. * @param _queue The queue to modify. * @param _deleteCount The number of elements to remove. */

Jason-Zhangxin-Chen · 2025-03-10T07:02:25Z

autonity/solidity/contracts/liquid/LiquidLogic.sol

+
+    function balanceInPool(address _account) public virtual view returns (uint256) {
+        IStakingPool _stakingPool = IStakingPool(autonityContract.getStakingPool());
+        return _stakingPool.calculateLiquidBurning(_account, validator) + _stakingPool.calculateLiquidMinted(_account, validator);


At first galance, the naming of function calculateLiquidBurning is a little bit confused. However I can understand it after dive into the staking pool contract. Can we add a comment here, as the burning here is about the ongoing unbonding assets.

Jason-Zhangxin-Chen · 2025-03-10T08:35:59Z

autonity/solidity/contracts/StakingPool.sol

+            uint256 _liquidBalance = _liquidContracts[i].balanceInContract(address(this));
+            if (_liquidBalance > 0) {
+                _liquidContracts[i].claimRewards();
+                lastFeeFactor[_validators[i]] += (address(this).balance - _atnBalance) * FEE_FACTOR_UNIT_RECIP / _liquidBalance;


So, in this case, when one claim rewards, the lastFeeFactor will be decreasing, right? The _liquidContracts[i].claimRewards(); will update the atn balance saved in the staking pool contract. Can we add more comments in this function to let it be clearly understand. Thanks, Tariq.

Jason-Zhangxin-Chen · 2025-03-10T09:16:19Z

autonity/solidity/contracts/StakingPool.sol

+     */
+    function collectRewards(address[] memory _validators, ILiquid[] memory _liquidContracts) external onlyAutonity {
+        uint256 _count = _validators.length;
+        require(_count == _liquidContracts.length, "invalid inputs");


This error message should be refined to add more specific info.

Jason-Zhangxin-Chen · 2025-03-10T09:30:35Z

@tbssajal @yazzaoui @lorenzo-dev1 @vpiyush @ScottRMalley , ever thought to cap the pending queues of bonding and unboding request? In edge case, if there are too much accumulating requests, some of them might be malicious with dust weighted bonding, will we spend a lot of effort to process them at Epoch rotation which is critical for us.

tbssajal added 3 commits February 13, 2025 18:53

staking pool

3349896

integrate staking pool

fb75467

optimize lib

7b96074

tbssajal added 5 commits February 17, 2025 17:48

fix bug, complete getters

255626e

remove initialization from contruction

ca7cb0b

fix bug

80a1615

genesis seq

f78ae02

fix bug

ca9ea5d

tbssajal force-pushed the staking-pool branch from ea09619 to 3a0d65f Compare February 20, 2025 17:42

tbssajal added 2 commits February 24, 2025 17:49

bug fix

fc23e57

fix test

a70d4fa

tbssajal force-pushed the staking-pool branch from 3a0d65f to 51859f4 Compare February 24, 2025 12:18

tbssajal added 2 commits February 24, 2025 18:48

fix truffle test

1458698

add epoch info for height 0

af905da

tbssajal force-pushed the staking-pool branch 9 times, most recently from b6ee9f6 to 1ab7a9e Compare February 26, 2025 10:37

tbssajal added 4 commits February 26, 2025 20:08

bug fix

8d82d08

fix test

d82d612

e2e test fix

7d3bf03

bindings

36abb30

tbssajal force-pushed the staking-pool branch from 708f1fc to 36abb30 Compare February 26, 2025 14:12

tbssajal marked this pull request as ready for review February 26, 2025 14:12

tbssajal requested review from Jason-Zhangxin-Chen, ScottRMalley, lorenzo-dev1, vpiyush and yazzaoui as code owners February 26, 2025 14:12

Jason-Zhangxin-Chen requested changes Mar 10, 2025

View reviewed changes

tbssajal added 2 commits March 24, 2025 13:11

test

d9e6b39

temp

7e85bf3

tbssajal marked this pull request as draft April 7, 2025 13:13

Staking Pool #1144

Are you sure you want to change the base?

Staking Pool #1144

Uh oh!

Conversation

tbssajal commented Feb 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Feb 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Jason-Zhangxin-Chen left a comment

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!

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!

Choose a reason for hiding this comment

Uh oh!

Jason-Zhangxin-Chen commented Mar 10, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

tbssajal commented Feb 13, 2025 •

edited

Loading

codecov bot commented Feb 13, 2025 •

edited

Loading