From efe8a160504ae8e19a1722719eb0ade96bb7b015 Mon Sep 17 00:00:00 2001 From: aniampio Date: Tue, 21 Nov 2023 18:34:19 +0000 Subject: [PATCH] Add documentation to aggregate_expiration_signatures --- .../src/scheme/expiration_date_signatures.rs | 26 +++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/common/nym_offline_compact_ecash/src/scheme/expiration_date_signatures.rs b/common/nym_offline_compact_ecash/src/scheme/expiration_date_signatures.rs index 2510f003a1..df957aa5e6 100644 --- a/common/nym_offline_compact_ecash/src/scheme/expiration_date_signatures.rs +++ b/common/nym_offline_compact_ecash/src/scheme/expiration_date_signatures.rs @@ -67,6 +67,27 @@ pub fn sign_expiration_date( exp_signs } +/// Aggregates partial expiration date signatures into a list of aggregated expiration date signatures. +/// +/// # Arguments +/// +/// * `params` - The cryptographic parameters used in the signing process. +/// * `vk_auth` - The global verification key. +/// * `expiration_date` - The expiration date for which the signatures are being aggregated. +/// * `indices` - A list of unique indices corresponding to the signing authorities. +/// * `vkeys` - A list of verification keys associated with the signing authorities. +/// * `signatures` - A list of partial expiration date signatures to be aggregated. +/// +/// # Returns +/// +/// A `Result` containing a vector of `ExpirationDateSignature` if the aggregation is successful, +/// or an `Err` variant with a description of the encountered error. +/// +/// # Errors +/// +/// This function returns an error if there is a mismatch in the lengths of `vkeys` and `signatures`, +/// or if there are not enough unique indices. It also returns an error the verification of +/// the partial or aggregated signatures fails. pub fn aggregate_expiration_signatures( params: &Parameters, vk_auth: &VerificationKeyAuth, @@ -155,4 +176,9 @@ pub fn aggregate_expiration_signatures( } Ok(exp_date_signs) +} + +#[cfg(test)] +mod tests { + } \ No newline at end of file