Skip to content

Commit b6b9a62

Browse files
committed
chore(signer): better explanation of the kes period in 'SignerWithStake'
1 parent f0ff321 commit b6b9a62

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

mithril-common/src/entities/signer.rs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -158,8 +158,10 @@ pub struct SignerWithStake {
158158
#[serde(skip_serializing_if = "Option::is_none")]
159159
pub operational_certificate: Option<ProtocolOpCert>,
160160

161-
/// The kes period used to compute the verification key signature
162-
// TODO: This kes period should not be used as is and should probably be within an allowed range of kes period for the epoch
161+
/// The number of evolutions of the KES key since the start KES period of the operational certificate at the time of signature.
162+
///
163+
/// Note: the naming 'kes_period' lacks clarity and should be renamed to 'kes_evolutions'
164+
// TODO: This 'kes_period' should be rename to 'kes_evolutions' to avoid confusion
163165
#[serde(skip_serializing_if = "Option::is_none")]
164166
pub kes_period: Option<KesPeriod>,
165167

0 commit comments

Comments
 (0)