Pallet inflation #1091

Dinonard · 2023-11-24T08:39:36Z

Pull Request Summary

Implementation for pallet that will handle Tokenomics 2.0 functionality.

Check list

Pallet rustodc
Extensive tests
Run benchmarks & integrate them
Move some pieces of code under primitives
re-run benchmarks on proper machine
remove forced config set before mainnet launch

pallets/inflation/src/lib.rs

ashutoshvarma · 2023-11-28T16:55:09Z

pallets/inflation/src/lib.rs

+            // This is a safety measure to prevent excessive minting.
+            // TODO: discuss this in review with the team. Is it strict enough? Should we use a different approach?
+            tracker.issued.saturating_accrue(reward);
+            ensure!(tracker.issued <= tracker.cap, ());


This should be strict enough, not sure what more strict than this would look like.
nitpick, we can have a method (called maybe issue(amount)) on tracker struct itself for increasing the issued with this check there itself.

It's still possible for a single account (or multiple ones) to claim excessive amounts of rewards, if a bug happens in dApp staking. But it's not indefinite.

nitpick, we can have a method (called maybe issue(amount)) on tracker struct itself for increasing the issued with this check there itself.

We could add that, but we cannot reuse it in on_timestamp since that has to be infallible 🙂

ashutoshvarma · 2023-11-28T17:00:49Z

pallets/inflation/src/lib.rs

+            // Update the tracker, but no check whether an `issued` has exceeded `cap`.
+            // This can modified if needed, but these amounts are supposed to be small &
+            // collators need to be paid for producing the block.
+            // TODO: potential discussion topic for the review!
+            SafetyInflationTracker::<T>::mutate(|tracker| {
+                tracker.issued.saturating_accrue(amount);
+            });


I know this will be ensured by tests that this'll not happen, but what if it happens then even for the next blocks we might be issuing more than cap, though unlikely as payout needs to be more than emission, right?

You're right this must be ensured by tests.
The config is static enough, and calculation is quite predictable so I don't believe we'll ever be seeing a scenario when this overflows.

In a scenario when this happens, collator and treasury rewards would keep being issued.
But staker & dApp rewards would no longer be claimable. This would be a big deal, an issue would be raised and we'd have to deal with it.

At least, that was my idea when writing this 😄

…pallet-inflation

pallets/inflation/src/lib.rs

Dinonard · 2023-11-30T13:55:58Z

@shaunxw resolved all comments.

github-actions · 2023-11-30T14:54:21Z

Package	Line Rate	Branch Rate	Health
precompiles/utils/macro/src	0%	0%	❌
chain-extensions/types/xvm/src	0%	0%	❌
chain-extensions/pallet-assets/src	0%	0%	❌
primitives/src	65%	0%	➖
chain-extensions/types/dapps-staking/src	0%	0%	❌
precompiles/xvm/src	80%	0%	✔
pallets/block-reward/src	85%	0%	✔
pallets/contracts-migration/src	0%	0%	❌
pallets/dapps-staking/src	81%	0%	✔
pallets/dapps-staking/src/pallet	85%	0%	✔
precompiles/xcm/src	84%	0%	✔
precompiles/assets-erc20/src	76%	0%	➖
pallets/xvm/src	45%	0%	❌
pallets/xc-asset-config/src	53%	0%	➖
chain-extensions/xvm/src	0%	0%	❌
pallets/ethereum-checked/src	48%	0%	❌
chain-extensions/types/assets/src	0%	0%	❌
precompiles/sr25519/src	79%	0%	➖
pallets/dapp-staking-v3/src	81%	0%	✔
pallets/dapp-staking-v3/src/test	0%	0%	❌
precompiles/dapps-staking/src	93%	0%	✔
precompiles/utils/src	68%	0%	➖
precompiles/utils/src/testing	62%	0%	➖
pallets/custom-signatures/src	51%	0%	➖
pallets/inflation/src	79%	0%	➖
pallets/collator-selection/src	69%	0%	➖
chain-extensions/dapps-staking/src	0%	0%	❌
precompiles/batch/src	80%	0%	✔
primitives/src/xcm	66%	0%	➖
precompiles/substrate-ecdsa/src	78%	0%	➖
pallets/pallet-xcm/src	53%	0%	➖
Summary	63% (3631 / 5799)	0% (0 / 0)	➖

Minimum allowed line rate is 50%

* 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

Pallet inflation

7a317ad

Dinonard changed the base branch from master to feat/dapp-staking-v3 November 24, 2023 08:39

Dinonard added the runtime This PR/Issue is related to the topic “runtime”. label Nov 24, 2023

Dinonard added 2 commits November 24, 2023 10:33

Hooks

fa21dcc

Functionality, mock & benchmarks

087cd2b

Dinonard marked this pull request as ready for review November 24, 2023 17:45

Dinonard requested review from shaunxw, ashutoshvarma and PierreOssun November 24, 2023 17:45

Dinonard added 10 commits November 24, 2023 18:46

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

ed452b2

Tests, fixes

3f968e4

More tests, minor fixes&changes

0a27041

Zero divison protection, frontier update

b674d1c

More tests, minor changes

69f3c5a

Integration & renaming

7ce4c78

Genesis integration, more tests

439d0c8

Final integration

612e242

Cleanup deps

1673200

Division with zero test

ec32fab

PierreOssun reviewed Nov 27, 2023

View reviewed changes

This was referenced Nov 28, 2023

dApp Staking v3 & Tokenomics 2.0 #990

Merged

[Tokenomics][Meta] Tokenomics v2 #1023

Closed

Dinonard added 4 commits November 28, 2023 10:57

Comments

648e402

More minor changes

90e04a4

Improve test coverage

b1a67ae

Integrate into pallet-timestamp

36032e7

ashutoshvarma reviewed Nov 28, 2023

View reviewed changes

Merge remote-tracking branch 'origin/feat/dapp-staking-v3' into feat/…

f55d114

…pallet-inflation

shaunxw reviewed Nov 30, 2023

View reviewed changes

pallets/inflation/src/lib.rs Outdated Show resolved Hide resolved

pallets/inflation/src/lib.rs Outdated Show resolved Hide resolved

pallets/inflation/src/lib.rs Show resolved Hide resolved

pallets/inflation/src/lib.rs Outdated Show resolved Hide resolved

shaunxw reviewed Nov 30, 2023

View reviewed changes

pallets/inflation/src/lib.rs Outdated Show resolved Hide resolved

Dinonard added 3 commits November 30, 2023 10:29

Remove timestamp

20e3c22

Fix

9699e56

review comments

7ac1179

toml format

cd3e473

shaunxw approved these changes Nov 30, 2023

View reviewed changes

Dinonard merged commit ccb8e73 into feat/dapp-staking-v3 Nov 30, 2023
12 checks passed

Dinonard deleted the feat/pallet-inflation branch November 30, 2023 16:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Pallet inflation #1091

Pallet inflation #1091

Dinonard commented Nov 24, 2023 •

edited

Loading

ashutoshvarma Nov 28, 2023

Dinonard Nov 29, 2023

ashutoshvarma Nov 28, 2023

Dinonard Nov 29, 2023

Dinonard commented Nov 30, 2023

github-actions bot commented Nov 30, 2023

Pallet inflation #1091

Pallet inflation #1091

Conversation

Dinonard commented Nov 24, 2023 • edited Loading

ashutoshvarma Nov 28, 2023

Choose a reason for hiding this comment

Dinonard Nov 29, 2023

Choose a reason for hiding this comment

ashutoshvarma Nov 28, 2023

Choose a reason for hiding this comment

Dinonard Nov 29, 2023

Choose a reason for hiding this comment

Dinonard commented Nov 30, 2023

github-actions bot commented Nov 30, 2023

Dinonard commented Nov 24, 2023 •

edited

Loading