[taler-exchange] branch master updated: added documenation to the age-restriction related structures

[gnunet]

This is an automated email from the git hooks/post-receive script.

oec pushed a commit to branch master
in repository exchange.

The following commit(s) were added to refs/heads/master by this push:
     new d2537de6 added documenation to the age-restriction related structures
d2537de6 is described below

commit d2537de68cbe05f873874121491bae8a59729480
Author: Özgür Kesim <oec-taler@kesim.org>
AuthorDate: Mon Jun 27 11:56:18 2022 +0200

    added documenation to the age-restriction related structures
---
 src/include/taler_crypto_lib.h | 36 ++++++++++++++++++++++++++++++++----
 1 file changed, 32 insertions(+), 4 deletions(-)

diff --git a/src/include/taler_crypto_lib.h b/src/include/taler_crypto_lib.h
index aee2be55..d594d689 100644
--- a/src/include/taler_crypto_lib.h
+++ b/src/include/taler_crypto_lib.h
@@ -5069,7 +5069,15 @@ struct TALER_AgeCommitment
 };
 
 
-// FIXME-oec: document!
+/**
+ * @brief Proof for a particular age commitment, used in age attestation
+ *
+ * This struct is used in a call to TALER_age_commitment_attest to create an
+ * attestation for a minimum age (if that minimum age is less or equal to the
+ * commited age for this proof).  It consists of a list private keys, one per
+ * age group, for which the commited age is either lager or within that
+ * particular group.
+ */
 struct TALER_AgeProof
 {
   /**
@@ -5094,12 +5102,32 @@ struct TALER_AgeProof
 };
 
 
-// FIXME-oec: document!
+/**
+ * @brief Commitment and Proof for a maximum age
+ *
+ * Calling TALER_age_restriction_commit on an (maximum) age value returns this
+ * data structure.  It consists of the proof, which is used to create
+ * attestations for compatible minimum ages, and the commitment, which is used
+ * to verify the attestations and derived commitments.
+ *
+ * The hash value of the commitment is bound to a particular coin with age
+ * restriction.
+ */
 struct TALER_AgeCommitmentProof
 {
-  // FIXME-oec: document!
+  /**
+   * The commitment is used to verify a particular attestation.  Its hash value
+   * is bound to a particular coin with age restriction.  This structure is
+   * sent to the merchant in order to verify a particular attestation for a
+   * minimum age.
+   * In itself, it does not convey any information about the maximum age that
+   * went into the call to TALER_age_restriction_commit.
+   */
   struct TALER_AgeCommitment commitment;
-  // FIXME-oec: document!
+
+  /**
+   * The proof is used to create an attestation for a (compatible) minimum age.
+   */
   struct TALER_AgeProof proof;
 };
 

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.