Skip to content

Commit

Permalink
fix(lockup): improve wording in LockupInformation
Browse files Browse the repository at this point in the history
Fix comments in types.rs from https://hackmd.io/@ailisp/rJbiDYr5_
  • Loading branch information
telezhnaya committed Jul 5, 2021
1 parent 0d0411d commit e143dde
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 6 deletions.
Binary file modified lockup/res/lockup_contract.wasm
Binary file not shown.
18 changes: 12 additions & 6 deletions lockup/src/types.rs
Original file line number Diff line number Diff line change
Expand Up @@ -34,16 +34,22 @@ pub struct LockupInformation {
/// This amount has to be accounted separately from the lockup_amount to make sure
/// linear release is not being affected.
pub termination_withdrawn_tokens: Balance,
/// [deprecated] The lockup duration in nanoseconds from the moment when transfers are enabled
/// to unlock the lockup amount of tokens.
/// [deprecated] - the duration in nanoseconds of the lockup period from
/// the moment the transfers are enabled. During this period tokens are locked and
/// the release doesn't start. Instead of this, use `lockup_timestamp` and `release_duration`
pub lockup_duration: Duration,
/// If present, the duration when the full lockup amount will be available. The tokens are
/// linearly released from the moment transfers are enabled.
/// If present, it is the duration when the full lockup amount will be available. The tokens
/// are linearly released from the moment tokens are unlocked, defined by:
/// `max(transfers_timestamp + lockup_duration, lockup_timestamp)`.
/// If not present, the tokens are not locked (though, vesting logic could be used).
pub release_duration: Option<Duration>,
/// The optional absolute lockup timestamp in nanoseconds which locks the tokens until this
/// timestamp passes.
/// timestamp passes. Until this moment the tokens are locked and the release doesn't start.
/// If not present, `transfers_timestamp` will be used.
pub lockup_timestamp: Option<Timestamp>,
/// The information to indicate when the lockup period starts.
/// The information about the transfers. Either transfers are already enabled, then it contains
/// the timestamp when they were enabled. Or the transfers are currently disabled and
/// it contains the account ID of the transfer poll contract.
pub transfers_information: TransfersInformation,
}

Expand Down

0 comments on commit e143dde

Please sign in to comment.