From e143dde817d9066fc34a20cb6046067c9d819168 Mon Sep 17 00:00:00 2001
From: Olga Telezhnaya <olyatelezhnaya@gmail.com>
Date: Fri, 2 Jul 2021 13:33:34 +0300
Subject: [PATCH] fix(lockup): improve wording in LockupInformation

Fix comments in types.rs from https://hackmd.io/@ailisp/rJbiDYr5_
---
 lockup/res/lockup_contract.wasm | Bin 338890 -> 338890 bytes
 lockup/src/types.rs             |  18 ++++++++++++------
 2 files changed, 12 insertions(+), 6 deletions(-)

diff --git a/lockup/res/lockup_contract.wasm b/lockup/res/lockup_contract.wasm
index c049d3ba40447d1a360c7510085ae469bbe3e60d..6d227c6f901c618d3481979a909b45e487c45a85 100755
GIT binary patch
delta 25
hcmX?gUF6htk%kt=7N!>FEiAtR7|(709l&z_766#L3;h59

delta 25
hcmX?gUF6htk%kt=7N!>FEiAtR7*A~f9l&z_766!$3-<s3

diff --git a/lockup/src/types.rs b/lockup/src/types.rs
index 421965ac..b4078eea 100644
--- a/lockup/src/types.rs
+++ b/lockup/src/types.rs
@@ -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,
 }