Skip to content

Commit

Permalink
More docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Dinonard committed Dec 4, 2023
1 parent 6b4b84a commit 76d1e18
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions primitives/src/dapp_staking.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,13 @@

use super::{Balance, BlockNumber};

// TODO2: However this ends up looking in the end, we should not duplicate these parameters in the runtime.
// Both the dApp staking & inflation pallet should use the same source.
/// TODO: docs!
/// Configuration for cycles, periods, subperiods & eras.
///
/// * `cycle` - Time unit similar to 'year' in the real world. Consists of one or more periods. At the beginning of each cycle, inflation is recalculated.
/// * `period` - Period consists of two distinct subperiods: `Voting` & `Build&Earn`. They are integral parts of dApp staking.
/// Length is expressed in standard eras or just _eras_.
/// * `era` - Era is the basic time unit in the dApp staking protocol. At the end of each era, reward pools for stakers & dApps are calculated.
/// Era length is expressed in blocks.
pub trait CycleConfiguration {
/// How many different periods are there in a cycle (a 'year').
///
Expand Down

0 comments on commit 76d1e18

Please sign in to comment.