Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

dApp Staking v3 - part 6 #1093

Merged
merged 32 commits into from
Dec 5, 2023
Merged

dApp Staking v3 - part 6 #1093

merged 32 commits into from
Dec 5, 2023

Conversation

Dinonard
Copy link
Member

@Dinonard Dinonard commented Nov 29, 2023 •
edited
Loading

Summary

  • moved benchmarks util code under a new utils module to make it more clean
  • integrated weights
  • renamed a field in PeriodInfo struct: subperiod_end_era -> next_subperiod_start_era
  • integrated dApp staking & new inflation pallet together (loose coupling)
  • replaced locking with freeze functionality
  • resolved lots of TODOs

TODO

Architecture & Functionality

  • Multiple dApps satisfy tier entrance threshold with same score, but not enough capacity. What to do?
  • discuss & re-define PriceProvider and RewardPoolProvider if needed
  • replace deprecated Currency trait and locks with new trait(s) & freeze functionality
  • history cleanup of expired era/period rewards
  • use BTreeMap instead of sorted vector for rewards?
  • Oracle task definition
  • Bonus reward payment for unregistered contracts?
  • Improve check for active contracts (LINK)
  • Remove tier labels?
  • RPC for fetching non-constants
  • special pallet to handle eras, subperiods & periods - otherwise we get messy state when forcing new eras only in the pallet-dapp-staking-v3

Documentation

  • Expand README.md with additional information
  • Update pallet rustdoc
  • decide about naming with the team

Test

  • improve test coverage

Inflation

  • Pallet rustodc
  • Move some pieces of code under primitives
  • re-run benchmarks on proper machine
  • remove forced config set before mainnet launch

Follow-up PRs

  • integrity test
  • storage migration logic
  • precompiles
  • benchmarks for all calls

@Dinonard Dinonard changed the base branch from master to feat/dapp-staking-v3 November 29, 2023 15:52
@Dinonard Dinonard mentioned this pull request Nov 29, 2023
Merged
10 tasks
@Dinonard Dinonard added the runtime This PR/Issue is related to the topic “runtime”. label Nov 29, 2023
@Dinonard
Minor refactor of benchmarks
fc4b2b7
@Dinonard
Weights integration
d3b000c
@Dinonard
Merge remote-tracking branch 'origin/feat/dapp-staking-v3' into feat/…
48a0885 
…dapp-staking-v3-phase6
@Dinonard
Fix
958b013
@Dinonard
remove orig file
7263d17
@Dinonard
Merge remote-tracking branch 'origin/feat/dapp-staking-v3' into feat/…
a7c9afa 
…dapp-staking-v3-phase6
@Dinonard
Minor refactoring, more benchmark code
f3a0eaa
@Dinonard
Extract on_init logic
d063ddf
@Dinonard
Some renaming
1785d95
@Dinonard
More benchmarks
7a0ac61
@Dinonard
Full benchmarks integration
bfa3013
@Dinonard
Testing primitives
5d03ad8
@Dinonard
staking primitives
230f67b
@Dinonard
dev fix
b770d65
@Dinonard
Integration part1
0671b8c
@Dinonard
Integration part2
f8ddfc6
@Dinonard
Reward payout integration
ccdbf24
@Dinonard
Replace lock functionality with freeze
3bd8622
@Dinonard
Cleanup TODOs
b6e2d53
@Dinonard
More negative tests
ee9ce22
@Dinonard
Frozen balance test
42c4ec0
@Dinonard
Zero div
0569850
@Dinonard
Docs for inflation
27c6f3d
@Dinonard
Rename is_active & add some more docs
6b4b84a
@Dinonard
More docs
76d1e18
@Dinonard
pallet docs
7332f75
@Dinonard Dinonard marked this pull request as ready for review December 4, 2023 18:06
@bobo-k2
Copy link

bobo-k2 commented Dec 5, 2023 •
edited
Loading

What happened with constants, I don't see them anymore:

  • standardErasPerBuildAndEarnPeriod
  • standardErasPerVotingPeriod
    -standardEraLength

@Dinonard
Copy link
Member Author

Dinonard commented Dec 5, 2023

What happened with constants, I don't see them anymore:

* standardErasPerBuildAndEarnPeriod

* standardErasPerVotingPeriod
  -standardEraLength

The values have been moved under a trait that is shared between dApp staking & inflation logic. This is why it is no longer a constant.

Do you need this for the UI?

@bobo-k2
Copy link

bobo-k2 commented Dec 5, 2023

What happened with constants, I don't see them anymore:

* standardErasPerBuildAndEarnPeriod

* standardErasPerVotingPeriod
  -standardEraLength

The values have been moved under a trait that is shared between dApp staking & inflation logic. This is why it is no longer a constant.

Do you need this for the UI?

Yes, can you expose them?

@Dinonard
Copy link
Member Author

Dinonard commented Dec 5, 2023

What happened with constants, I don't see them anymore:

* standardErasPerBuildAndEarnPeriod

* standardErasPerVotingPeriod
  -standardEraLength

The values have been moved under a trait that is shared between dApp staking & inflation logic. This is why it is no longer a constant.
Do you need this for the UI?

Yes, can you expose them?

No, not as constants.

We'll look into an alternative. Please hardcode the values to what you see in local runtime for now.

shaunxw
shaunxw approved these changes Dec 5, 2023
View reviewed changes
Copy link
Member

@shaunxw shaunxw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

pallets/dapp-staking-v3/src/lib.rs Show resolved Hide resolved
pallets/dapp-staking-v3/src/benchmarking/utils.rs Show resolved Hide resolved
PierreOssun
PierreOssun approved these changes Dec 5, 2023
View reviewed changes
Copy link
Member

@PierreOssun PierreOssun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

pallets/dapp-staking-v3/src/test/tests.rs Outdated Show resolved Hide resolved
pallets/dapp-staking-v3/src/test/tests_types.rs Show resolved Hide resolved
@Dinonard Dinonard merged commit 91047f4 into feat/dapp-staking-v3 Dec 5, 2023
8 checks passed
@Dinonard Dinonard deleted the feat/dapp-staking-v3-phase6 branch December 5, 2023 16:33
@github-actions GitHub Actions
Copy link

github-actions bot commented Dec 5, 2023

Code Coverage

Package Line Rate Branch Rate Health
precompiles/xvm/src 75% 0% ➖
precompiles/utils/src 55% 0% ➖
chain-extensions/unified-accounts/src 0% 0% ❌
precompiles/substrate-ecdsa/src 78% 0% ➖
pallets/dapp-staking-v3/src/test 0% 0% ❌
pallets/dapp-staking-v3/src/benchmarking 0% 0% ❌
pallets/dapps-staking/src 81% 0% ✔
pallets/xvm/src 40% 0% ❌
precompiles/sr25519/src 79% 0% ➖
chain-extensions/types/dapps-staking/src 0% 0% ❌
pallets/dapp-staking-v3/src 80% 0% ✔
chain-extensions/xvm/src 0% 0% ❌
chain-extensions/dapps-staking/src 0% 0% ❌
pallets/contracts-migration/src 0% 0% ❌
pallets/block-reward/src 85% 0% ✔
chain-extensions/types/assets/src 0% 0% ❌
primitives/src 66% 0% ➖
pallets/collator-selection/src 69% 0% ➖
pallets/block-rewards-hybrid/src 87% 0% ✔
pallets/dynamic-evm-base-fee/src 81% 0% ✔
chain-extensions/types/unified-accounts/src 0% 0% ❌
precompiles/utils/macro/src 0% 0% ❌
pallets/ethereum-checked/src 48% 0% ❌
precompiles/assets-erc20/src 77% 0% ➖
primitives/src/xcm 66% 0% ➖
pallets/dapps-staking/src/pallet 85% 0% ✔
pallets/xc-asset-config/src 53% 0% ➖
precompiles/xcm/src 75% 0% ➖
chain-extensions/pallet-assets/src 0% 0% ❌
pallets/unified-accounts/src 83% 0% ✔
pallets/inflation/src 78% 0% ➖
precompiles/dapps-staking/src 93% 0% ✔
chain-extensions/types/xvm/src 0% 0% ❌
precompiles/utils/src/testing 38% 0% ❌
Summary 63% (3374 / 5386) 0% (0 / 0) ➖

Minimum allowed line rate is 50%

Dinonard added a commit that referenced this pull request Dec 20, 2023
@Dinonard
dApp Staking v3 & Tokenomics 2.0 (#990)
9536303 
* dApp Staking v3 Part1

* Feat/dapp staking v3 phase2 (#991)

* Phase2 progress

* Adapt for 0.9.43

* Abstract sparse vector type

* Further modifications

* claim unlocked functionality WIP

* claim unlocked tested

* Relock unlocking

* Check era when adding chunk

* Custom error for some types

* Additional type tests - WIP

* More type tests

* Review comments

* Additional changes

* dApp staking v3 - part 3 (#1036)

* dApp staking v3 - PR3

* SingularStakingInfo

* SingularStakingInfo tests

* Stake work

* Stake & lots of tests

* TODOs, renaming, improvements

* Refactoring & cleanup

* More fixes

* Rework series

* Series tests

* Minor adjustment

* stake test utils & first test

* Stake test

* stake extrinsic tests

* Era & Period change logic

* Update era/period transition in mock & tests

* on_init tests & refactoring

* Unstake & some minor improvements

* Lots of type tests for unstake

* More tests

* More types test

* Testing utils for unstake, some TODOs

* Unstake tests

* Minor adjustments

* Fixes

* Additional scenario

* Address review comments

* Correct unstake amount

* Tests

* dapp staking v3 - part 4 (#1053)

* EraRewardSpan

* Initial version of claim_staker_reward

* Tests

* Test utils for claim-staker

* Bug fixes, improvements

* Claim improvements & some tests

* Refactoring in progress

* Refactoring continued

* Refactoring progress

* Refactoring finished

* Bonus rewards

* Docs & some minor changes

* Comments, tests, improved coverage

* Tier params & config init solution

* Tier reward calculation WIP

* Tier assignemnt

* Minor cleanup

* Claim dapp rewards

* Claim dapp reward tests

* unstake from unregistered call

* Extra traits

* fixes

* Extra calls

* Refactoring

* More refactoring, improvements, TODO solving

* Local integration

* Genesis config

* Add forcing call

* try runtime build fix

* Minor changes

* Minor

* Formatting

* Benchmarks INIT

* Compiling benchmarks

* Fix

* dapp tier calculation benchmark

* Measured tier assignment

* Decending rewards in benchmarks

* Series refactoring & partial tests

* Comments, minor changes

* Tests, improvements

* More tests, some minor refactoring

* Formatting

* More benchmarks & experiments, refactoring

* Readme, docs

* Minor renaming, docs

* More docs

* More docs

* Minor addition

* Review comment fixes & changes

* Minor change

* Review comments

* Update frontier to make CI pass

* Fix for cleanup

* dapp staking v3 - part 5 (#1087)

* EraRewardSpan

* Initial version of claim_staker_reward

* Tests

* Test utils for claim-staker

* Bug fixes, improvements

* Claim improvements & some tests

* Refactoring in progress

* Refactoring continued

* Refactoring progress

* Refactoring finished

* Bonus rewards

* Docs & some minor changes

* Comments, tests, improved coverage

* Tier params & config init solution

* Tier reward calculation WIP

* Tier assignemnt

* Minor cleanup

* Claim dapp rewards

* Claim dapp reward tests

* unstake from unregistered call

* Extra traits

* fixes

* Extra calls

* Refactoring

* More refactoring, improvements, TODO solving

* Local integration

* Genesis config

* Add forcing call

* try runtime build fix

* Minor changes

* Minor

* Formatting

* Benchmarks INIT

* Compiling benchmarks

* Fix

* dapp tier calculation benchmark

* Measured tier assignment

* Decending rewards in benchmarks

* Series refactoring & partial tests

* Comments, minor changes

* Tests, improvements

* More tests, some minor refactoring

* Formatting

* More benchmarks & experiments, refactoring

* Readme, docs

* Minor renaming, docs

* More docs

* More docs

* Minor addition

* Review comment fixes & changes

* Minor change

* Review comments

* Update frontier to make CI pass

* dApp staking v3 - part 5

* Make check work

* Limit map size to improve benchmarks

* Fix for cleanup

* Minor fixes, more tests

* More fixes & test

* Minor changes

* More tests

* More tests, some clippy fixes

* Finished with type tests for now

* Log, remove some TODOs

* Changes

* Bug fix for unstake era, more tests

* Formatting, extra test

* Unregistered unstake, expired cleanup, test utils & tests

* Cleanup tests, minor fixes

* force tests

* Remove TODOs

* Tier assignment test WIP

* Finish dapp tier assignment test, fix reward calculation bug

* Some renaming, test utils for era change WIP

* Fix minor issues, propagaste renaming

* More checks

* Finish on_init tests

* Comments, docs, some benchmarks

* Benchmark progress

* More benchmarks

* Even more benchmarks

* All extrinsics benchmarked

* Expand tests

* Comment

* Missed error test

* Review comments

* Pallet inflation (#1091)

* Pallet inflation

* Hooks

* Functionality, mock & benchmarks

* Empty commit since it seems last push didn't work properly

* Tests, fixes

* More tests, minor fixes&changes

* Zero divison protection, frontier update

* More tests, minor changes

* Integration & renaming

* Genesis integration, more tests

* Final integration

* Cleanup deps

* Division with zero test

* Comments

* More minor changes

* Improve test coverage

* Integrate into pallet-timestamp

* Remove timestamp

* Fix

* review comments

* toml format

* dApp Staking v3 - part 6 (#1093)

* dApp staking v3 part 6

* Minor refactor of benchmarks

* Weights integration

* Fix

* remove orig file

* Minor refactoring, more benchmark code

* Extract on_init logic

* Some renaming

* More benchmarks

* Full benchmarks integration

* Testing primitives

* staking primitives

* dev fix

* Integration part1

* Integration part2

* Reward payout integration

* Replace lock functionality with freeze

* Cleanup TODOs

* More negative tests

* Frozen balance test

* Zero div

* Docs for inflation

* Rename is_active & add some more docs

* More docs

* pallet docs

* text

* scripts

* More tests

* Test, docs

* Review comment

* dApp staking v3 - part 7 (#1099)

* dApp staking v3 part 6

* Minor refactor of benchmarks

* Weights integration

* Fix

* remove orig file

* Minor refactoring, more benchmark code

* Extract on_init logic

* Some renaming

* More benchmarks

* Full benchmarks integration

* Testing primitives

* staking primitives

* dev fix

* Integration part1

* Integration part2

* Reward payout integration

* Replace lock functionality with freeze

* Cleanup TODOs

* More negative tests

* Frozen balance test

* Zero div

* Docs for inflation

* Rename is_active & add some more docs

* More docs

* pallet docs

* text

* scripts

* More tests

* Test, docs

* Review comment

* Runtime API

* Changes

* Change dep

* Comment

* Formatting

* Expired entry cleanup

* Cleanup logic test

* Remove tier labels

* fix

* Improve README

* Improved cleanup

* Review comments

* Docs

* Formatting

* Typo

* Fix - bonus reward update ledger (#1102)

* Bonus claim reduced contract_stake_count

* Extra test

* dApp Staking Migration (#1101)

* dApp Staking Migration

* Events, benchmark prep

* benchmarks

* Benchmarks & mock

* weights

* limit

* Use extrinsic call

* Solved todos, docs, improvements

* Maintenance mode, on_runtime_upgrade logic

* Tests, refactoring

* Finish

* More tests

* Type cleanup

* try-runtime checks

* deps

* Improve docs

* Fixes & try-runtime testing modifications

* Fix test

* repeated

* Minor improvements

* Improvements

* taplo

* Minor rename

* Feat/dapp staking v3 precompiles (#1096)

* Init commit

* All legacy calls covered

* v2 interface first definition

* Rename

* Resolve merge errors

* TODO

* v2 init implementation

* Prepared mock

* todo

* Migration to v2 utils

* More adjustments

* Finish adapting implementation to v2

* Mock & fixes

* Primitive smart contract

* Fix dsv3 test

* Prepare impl & mock

* Remove redundant code, adjust mock & prepare tests

* Tests & utils

* Test for legacy getters/view functions

* More legacy tests

* v1 interface covered with tests

* Minor refactor, organization, improvements

* v2 tests

* Cleanup TODOs

* More tests

* Updates

* docs

* Fixes

* Address review comments

* Adjustments

* Audit comments

* Fix mock

* FMT

* Review comments

* Fix for incorrect freeze amount (#1111)

* dApp Staking v3 - Shibuya integration (#1109)

* dApp staking v3 - Shibuya integration

* Init

* Fix build

* Fix find/replace doc mess

* Migration & disable

* More integration

* Progress

* Adjusted integration

* Finished integration

* Additional modifications & cleanup

* Move comment

* Fixes

* Shibuya integration tests fix & proxy

* Renaming

* Integration test fixes & legacy support

* Adjust for benchmarks

* Remove chain-extension, small updates

* fixes

* Partial weights

* Minor changes

* Benchmark fixes

* dApp staking weights

* Weights, deps

* Remove redundant storage item

* Inflation params, resolve TODOs

* Optimize lengthy benchmark

* Integration test

* Sort out more TODOs

* Benchmark optimization

* Fix seed

* Remove spec version bump

* Fix integration test

* Weights update
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@PierreOssun PierreOssun PierreOssun approved these changes

@shaunxw shaunxw shaunxw approved these changes

@ashutoshvarma ashutoshvarma Awaiting requested review from ashutoshvarma

Assignees
No one assigned
Labels
runtime This PR/Issue is related to the topic “runtime”.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@Dinonard @bobo-k2 @shaunxw @PierreOssun