dapp staking v3 - part 5 #1087

Dinonard · 2023-11-13T16:07:59Z

Pull Request Summary

Summary Of Changes

ContractStake storage map key changed from T::SmartContract to DAppId
- This allows for significant optimization in the tier assignment
calling stake extrinsic will now cleanup expired staked and staked_future entries if they exist
- it will also overwrite expired ContractStake entries
optimized dapp tier assignment process
lots of minor bug fixes find with extended testing
added tier labels but they are dead code
benchmarking of all extrinsics is done but more work remains

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?

Documentation

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

Architecture

introduce & implement TierLabels

Improvements

add tracing
improve cleanup of account's expired rewards
Improve check for active contracts (LINK)

Test

improve test coverage

Follow-up PRs

integrity test
storage migration logic
precompiles
benchmarks for all calls

PierreOssun · 2023-11-28T15:12:29Z

pallets/dapp-staking-v3/src/lib.rs

        UnstakeFromUnregistered {
            account: T::AccountId,
            smart_contract: T::SmartContract,
            amount: Balance,
        },
+        /// Some expired stake entries have been removed from storage.
+        ExpiredEntriesRemoved { account: T::AccountId, count: u16 },


Can you elaborate why do we need this Event ?

All other extrinsics have them, so I added it for cleanup as well. IMO it's better to be consistent. Not sure how often we have extrinsics without events.

PierreOssun · 2023-11-28T16:04:51Z

pallets/dapp-staking-v3/src/types.rs

@@ -148,7 +140,7 @@ pub struct PeriodInfo {
    /// Period number.
    #[codec(compact)]
    pub number: PeriodNumber,
-    /// subperiod.
+    /// Subperiod ytpe.


Suggested change

/// Subperiod ytpe.

/// Subperiod type.

shaunxw

LGTM. Just some minor suggestions.

shaunxw · 2023-11-29T07:17:45Z

pallets/dapp-staking-v3/src/lib.rs

        }

        /// `true` if smart contract is active, `false` if it has been unregistered.
        pub(crate) fn is_active(smart_contract: &T::SmartContract) -> bool {
            IntegratedDApps::<T>::get(smart_contract)
-                .map_or(false, |dapp_info| dapp_info.state == DAppState::Registered)
+                .map_or(false, |dapp_info| dapp_info.is_active())


Probably could be improved later, the active and IntegratedDApps containing states might be a bit confusing. We can either have a clearer naming of each different state or have terminology explained in header docstring.

Sorry, I'm not sure I get the comment - would you like me to rename is_active? Or remove the state from DAppInfo?

Let me try to elaborate. There are currently three cases for smart contract state check

Check if is_active

Check if IntegratedDApps contains the contract

Check both

It's probably just me, the terms active (it's actually a registration/listing check) and integrated are a bit confusing to understand until digging deeper into the implementation. IMO this could be improved by either more explicit naming or adding docs to cover the items.

(A big but) BUT let's merge the PR now without any change and address it later in the main dApp staking PR.

Oh, I got it! Yeah, let's address this later. I will add a TODO so I don't forget about it.

pallets/dapp-staking-v3/src/lib.rs

github-actions · 2023-11-29T09:59:17Z

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

Dinonard added 30 commits October 12, 2023 08:20

EraRewardSpan

0a7c519

Initial version of claim_staker_reward

e598d1b

Tests

fff0656

Test utils for claim-staker

0daae3a

Bug fixes, improvements

ebae663

Claim improvements & some tests

c76ade9

Refactoring in progress

096726e

Refactoring continued

39c6cf0

Refactoring progress

e77327d

Refactoring finished

025f0b7

Bonus rewards

80a0e4f

Docs & some minor changes

82c71ad

Comments, tests, improved coverage

582aef4

Tier params & config init solution

b25ccb1

Tier reward calculation WIP

3d2d146

Tier assignemnt

894d10d

Minor cleanup

ff61cf1

Claim dapp rewards

3ded046

Claim dapp reward tests

f2f8a5f

unstake from unregistered call

03d88f4

Extra traits

ea3e23d

fixes

7558682

Extra calls

e0f19e1

Refactoring

4926838

More refactoring, improvements, TODO solving

d47bcf4

Local integration

0197c95

Genesis config

4ea8556

Add forcing call

589575b

try runtime build fix

1e80e09

Minor changes

fbe4c4d

Dinonard added 16 commits November 16, 2023 15:53

Cleanup tests, minor fixes

cd3143d

force tests

a0efeed

Remove TODOs

a0725e4

Tier assignment test WIP

cafb67b

Finish dapp tier assignment test, fix reward calculation bug

8e93106

Some renaming, test utils for era change WIP

b7ba462

Fix minor issues, propagaste renaming

db6cd36

More checks

b940375

Finish on_init tests

878e450

Comments, docs, some benchmarks

215a13e

Benchmark progress

75e6fd3

More benchmarks

2bcb763

Even more benchmarks

218e6c2

All extrinsics benchmarked

b893000

Expand tests

6517154

Comment

076e867

Dinonard marked this pull request as ready for review November 21, 2023 16:08

Dinonard requested review from shaunxw, ashutoshvarma and PierreOssun November 21, 2023 16:08

Missed error test

a99bd64

PierreOssun reviewed Nov 28, 2023

View reviewed changes

shaunxw reviewed Nov 29, 2023

View reviewed changes

Review comments

af53a55

shaunxw approved these changes Nov 29, 2023

View reviewed changes

Dinonard merged commit c3f35fd into feat/dapp-staking-v3 Nov 29, 2023
13 checks passed

Dinonard deleted the feat/dapp-staking-v3-phase5 branch November 29, 2023 11:36

Dinonard mentioned this pull request Nov 29, 2023

dApp Staking v3 - part 6 #1093

Merged

23 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

dapp staking v3 - part 5 #1087

dapp staking v3 - part 5 #1087

Dinonard commented Nov 13, 2023 •

edited

Loading

PierreOssun Nov 28, 2023

Dinonard Nov 29, 2023

PierreOssun Nov 28, 2023

shaunxw left a comment

shaunxw Nov 29, 2023

Dinonard Nov 29, 2023 •

edited

Loading

shaunxw Nov 29, 2023

Dinonard Nov 29, 2023

github-actions bot commented Nov 29, 2023

dapp staking v3 - part 5 #1087

dapp staking v3 - part 5 #1087

Conversation

Dinonard commented Nov 13, 2023 • edited Loading

Summary Of Changes

TODO

Architecture & Functionality

Documentation

Architecture

Improvements

Test

Follow-up PRs

PierreOssun Nov 28, 2023

Choose a reason for hiding this comment

Dinonard Nov 29, 2023

Choose a reason for hiding this comment

PierreOssun Nov 28, 2023

Choose a reason for hiding this comment

shaunxw left a comment

Choose a reason for hiding this comment

shaunxw Nov 29, 2023

Choose a reason for hiding this comment

Dinonard Nov 29, 2023 • edited Loading

Choose a reason for hiding this comment

shaunxw Nov 29, 2023

Choose a reason for hiding this comment

Dinonard Nov 29, 2023

Choose a reason for hiding this comment

github-actions bot commented Nov 29, 2023

Dinonard commented Nov 13, 2023 •

edited

Loading

Dinonard Nov 29, 2023 •

edited

Loading