Update reward pool on `provider_boost` or `unstake` #1699 #1948

shannonwells · 2024-04-22T18:15:53Z

Goal

The goal of this PR is to update the StakingRewardPool on a provider_boost or unstake extrinsic call.

Closes #1699

Discussion

Also includes a bunch of lint changes

Checklist

Design doc(s) updated
Tests added
Benchmarks corrected and updated
Weights updated

Prototypes, make check working

updates to impl design doc

* Make some functions pass by reference (performance) * fix broken tests & calls

The goal of this PR is to implement storage of reward pool history. Closes #1710

The goal of this PR is to split the `stake` extrinsic into two: `stake` and `provider_boost` Closes #1707

The goal of this PR is to split up storage of boosting and maximized staking accounts, as well as store retarget history separately, which can store retargeting events for any type of staking. Closes #1726 * Lots of rattle, causing several helper functions to be split up - rather than having a bunch of conditionals due to type differences. * In the interest of limiting the size of this PR/merge into the branch I left a lot of TODOs for when reward pool updates on a stake/boost/unstake is resumed

* Add staking_history to StakingAccountDetails * Change type of some Configs * Stub some tests * separate provider_boost tests into own file

…a turnover

…ility

* Fix capacity benchmarking * Set up reward pool info in new_test_ext() in capacity mocks * Implement and fix tests

pallets/capacity/src/tests/mock.rs

aramikm

Added some questions and comments

Read the code
Ran the tests
Not able to verify the arithmetic changes compared to what was expected since don't have enough context about it.

pallets/capacity/src/benchmarking.rs

pallets/capacity/src/tests/mock.rs

saraswatpuneet · 2024-04-25T18:58:33Z

pallets/capacity/src/lib.rs

@@ -767,6 +771,10 @@ impl<T: Config> Pallet<T> {
 		CapacityLedger::<T>::insert(target, capacity_details);
 	}

+	fn set_reward_pool(era: <T>::RewardEra, new_reward_pool: &RewardPoolInfo<BalanceOf<T>>) {
+		StakingRewardPool::<T>::set(era, Some(new_reward_pool.clone()));
+	}


Should we mutate here ? set is cool assuming it serves dual purpose of remove/update but need to check

I'm following our previous pattern of let mut foo = Capacity::get_a_stored_thing(key) followed by a set. We've been moving away from mutate.

saraswatpuneet

Just a nit

# Goal The goal of this PR is to update the StakingRewardPool on a `provider_boost` or `unstake` extrinsic call. Closes #1699 # Discussion Also includes a bunch of lint changes # Checklist - [x] Design doc(s) updated - [x] Tests added - [x] Benchmarks corrected and updated - [x] Weights updated

The goal of this PR is to update the StakingRewardPool on a `provider_boost` or `unstake` extrinsic call. Closes #1699 Also includes a bunch of lint changes - [x] Design doc(s) updated - [x] Tests added - [x] Benchmarks corrected and updated - [x] Weights updated

updates to design docs to use a capacity rewards interface Prototypes, make check working refinements to design doc Implement Staking Reward Eras basics (#1589) Implement the basic functionality of tracking and rotating Reward Era. Closes #1567 Does not include anything to do with the Reward Pool. Feat/staking rewards rewards provider #1572 (#1598) The goal of this PR is to implement a really basic version of the StakingRewardsProvider in the Capacity pallet and in the test mock, neither of which is actively used. Closes #1572 Does not include anything to do with setting and storing RewardPoolInfo when each new Era starts. change staking target extrinsic, closes #1570 (#1623) comments, capacity boost fn added to StakingRewardsProvider trait * Refactor staking type to go in StakingTargetDetails * Make some functions pass by reference (performance) * fix broken tests & calls use capacity_boost and StakingType to adjust capacity generation, add/adjust tests * Check from/to aren't the same when retargeting * Performance: move non-db checks to top when retargeting * Lots more tests * Fix a bug where we weren't setting the staking type on a retarget * Remove staking type from StakingAccountDetails * Fix broken tests from last commit Feat/reward pool history (#1710) Closes #1710 Feat/split stake extrinsic #1699 (#1717) The goal of this PR is to split the `stake` extrinsic into two: `stake` and `provider_boost` Closes #1707 Feat/split storage #1726 (#1744) The goal of this PR is to split up storage of boosting and maximized staking accounts, as well as store retarget history separately, which can store retargeting events for any type of staking. Closes #1726 fix e2e tests, correction to implementation design doc initialize storage for ProviderBoost on runtime upgrade Set ProviderBoost capacity generated and fix tests (#1947) * set the amount of capacity generated by a provider boost to the final amount, 50% of what is generated by MaximizedCapacity staking. * Also Fixes some tests broken from the last rebase with main. Closes #1569 Update reward pool on `provider_boost` or `unstake` #1699 (#1948) The goal of this PR is to update the StakingRewardPool on a `provider_boost` or `unstake` extrinsic call. Closes #1699 Implement rewards calculation formula #1941 (#1956) The goal of this PR is to implement (but not really use yet) the chosen formula for calculation of a reward in a single Provider Boost Reward Era. Closes #1941 updates after rebase upsert staking history #1699 (#1963) The goal of this PR is to add and use storage for individual staking history so that rewards can be calculated and paid out. Benchmarks run to update capacity weights. Relates to #1699 Chores/update capacity benchmarks #1949 (#1966) The goal of this PR is to update the benchmark for `on_initialize` to include the weight when a new RewardEra must be created. Closes #1949 Feat/check unclaimed rewards 1969 (#1972) The goal of this PR is to implement `list_unclaimed_rewards`, and also one that is lighter weight, `has_unclaimed_rewards`, which returns a `bool` and which `unstake` extrinsic uses. Unstake now fails if there are any unclaimed rewards. Closes #1969 Closes #1578 Feat/reward pool refactor #1976 (#2005) The goal of this PR is to implement a "chunk" version of the overall reward pool history to reduce read/write load and hence weight for transactions and `on_initialize` when a new `RewardEra` needs to start. Part of #1976 Co-authored-by: Wil Wade <[email protected]> Revise Provider Boost implementation design doc #2016 (#2020) The goal of this PR is to review and update the implementation design doc in light of the chosen economic model, and to reflect some changes in behavior. Review of the design doc also fed back into the code itself. Some code is no longer needed. Closes #2016 Co-authored-by: Aramik <[email protected]> E2e for new extrinsics (#2067) The goal of this PR is to add some e2e tests for the `provider_boost` extrinsic, and update the `change_staking_target` extrinsic after a rebase with main. Refactor reward era (#2069) The goal of this PR is primarily to pull RewardEra out of the Capacity Config and make it the same type everywhere. `claim_staking_rewards` extrinsic (#2080) Closes #1970 Capacity runtime api with list_unclaimed_rewards endpoint (#2088) The goal of this PR is to implement a capacity runtime api for the `list_unclaimed_rewards` endpoint. Closes #1698 Update Capacity README address the lint failure. updates after rebase with main Remove TODO since it's already been addressed. Add a minor test case to unstaking tests Add new extrinsics to Capacity README

shannonwells changed the base branch from main to feat/capacity-staking-rewards-impl April 22, 2024 18:16

shannonwells force-pushed the feat/update-reward-pool-#1699 branch from 1cad250 to 0cee861 Compare April 22, 2024 18:41

shannonwells added 16 commits April 23, 2024 13:56

updates to design docs to use a capacity rewards interface

c0c5d78

Prototypes, make check working

make check and make test working

3ab6b51

updates to impl design doc

change staking target extrinsic, closes #1570 (#1623)

deb3642

* Refactor staking type to go in StakingTargetDetails

31a1049

* Make some functions pass by reference (performance) * fix broken tests & calls

Feat/reward pool history (#1710)

c5812c1

The goal of this PR is to implement storage of reward pool history. Closes #1710

Feat/split stake extrinsic #1699 (#1717)

5653c78

The goal of this PR is to split the `stake` extrinsic into two: `stake` and `provider_boost` Closes #1707

fix e2e tests, correction to implementation design doc

149f653

* Fix benchmarks

124fe64

* Add staking_history to StakingAccountDetails * Change type of some Configs * Stub some tests * separate provider_boost tests into own file

stubbed tests for when staking types are split up

4b0246e

updating reward pool total_staked on stake and calculating rest on er…

e952d94

…a turnover

unstake unlocks common storage, some tests, small refactor in test ut…

8a8cdc6

…ility

unstake unlocks common storage, some tests, small refactor in test ut…

fcc32b1

…ility

some updates after rebase

060a995

some more updates after rebasing w/ origin branch

2a89064

moved commented-out code from another branch to be implemented

b310d91

shannonwells force-pushed the feat/update-reward-pool-#1699 branch from 57f1d42 to b310d91 Compare April 23, 2024 20:59

WIP putting reward pool updates back to good state

ec74a0a

shannonwells changed the title ~~[WIP, may be deleted] Feat/update reward pool #1699~~ [WIP, may be deleted] update reward pool #1699 Apr 24, 2024

* Fix warnings

62baa65

* Fix capacity benchmarking * Set up reward pool info in new_test_ext() in capacity mocks * Implement and fix tests

shannonwells commented Apr 25, 2024

View reviewed changes

pallets/capacity/src/tests/mock.rs Show resolved Hide resolved

undo design doc changes

a6db4de

shannonwells marked this pull request as ready for review April 25, 2024 00:29

shannonwells requested a review from wilwade as a code owner April 25, 2024 00:29

shannonwells changed the title ~~[WIP, may be deleted] update reward pool #1699~~ Update reward pool on provider_boost or unstake #1699 Apr 25, 2024

aramikm approved these changes Apr 25, 2024

View reviewed changes

pallets/capacity/src/benchmarking.rs Show resolved Hide resolved

pallets/capacity/src/benchmarking.rs Show resolved Hide resolved

pallets/capacity/src/tests/mock.rs Show resolved Hide resolved

shannonwells requested review from mattheworris and saraswatpuneet April 25, 2024 18:36

shannonwells requested a review from JoeCap08055 April 25, 2024 18:36

saraswatpuneet reviewed Apr 25, 2024

View reviewed changes

saraswatpuneet approved these changes Apr 25, 2024

View reviewed changes

update benchmarks and related weights

0b5d184

shannonwells merged commit 4994281 into feat/capacity-staking-rewards-impl Apr 25, 2024

shannonwells deleted the feat/update-reward-pool-#1699 branch April 25, 2024 21:54

shannonwells added the Provider Boosting label Jul 19, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update reward pool on `provider_boost` or `unstake` #1699 #1948

Update reward pool on `provider_boost` or `unstake` #1699 #1948

shannonwells commented Apr 22, 2024 •

edited

Loading

aramikm left a comment

saraswatpuneet Apr 25, 2024

shannonwells Apr 25, 2024

saraswatpuneet left a comment

Update reward pool on provider_boost or unstake #1699 #1948

Update reward pool on provider_boost or unstake #1699 #1948

Conversation

shannonwells commented Apr 22, 2024 • edited Loading

Goal

Discussion

Checklist

aramikm left a comment

Choose a reason for hiding this comment

saraswatpuneet Apr 25, 2024

Choose a reason for hiding this comment

shannonwells Apr 25, 2024

Choose a reason for hiding this comment

saraswatpuneet left a comment

Choose a reason for hiding this comment

Update reward pool on `provider_boost` or `unstake` #1699 #1948

Update reward pool on `provider_boost` or `unstake` #1699 #1948

shannonwells commented Apr 22, 2024 •

edited

Loading