Comment updates

This commit is contained in:
Christian Kamm 2022-02-14 10:37:09 +01:00
parent dd51d3cbdd
commit 94e74a71e5
1 changed files with 3 additions and 9 deletions

View File

@ -57,19 +57,13 @@ impl DepositEntry {
/// ```
///
/// with
/// baseline_vote_weight and max_extra_lockup_vote_weight from the
/// VotingMintConfig
/// lockup_duration_factor = lockup_time_remaining / max_lockup_time
/// - lockup_duration_factor = min(lockup_time_remaining / lockup_saturation_secs, 1)
/// - the VotingMintConfig providing the values for
/// baseline_vote_weight, max_extra_lockup_vote_weight, lockup_saturation_secs
///
/// Linear vesting schedules can be thought of as a sequence of cliff-
/// locked tokens and have the matching voting weight.
///
/// To achieve this with the SPL governance program--which requires a "max
/// vote weight"--we attach what amounts to a scalar multiplier between 0
/// and 1 to normalize voting power. This multiplier is a function of
/// the lockup schedule. Here we will describe two, a one time
/// cliff and a linear vesting schedule unlocking daily.
///
/// ## Cliff Lockup
///
/// The cliff lockup allows one to lockup their tokens for a set period