From 2b663f33c0b939ad463c71ffb52a95ec9325f011 Mon Sep 17 00:00:00 2001
From: Christian Grothoff <christian@grothoff.org>
Date: Thu, 29 Jan 2015 18:46:34 +0100
Subject: more comments

---
 src/mint/taler-mint-httpd_db.c | 40 +++++++++++++++++++++++++++++++---------
 1 file changed, 31 insertions(+), 9 deletions(-)

(limited to 'src/mint/taler-mint-httpd_db.c')

diff --git a/src/mint/taler-mint-httpd_db.c b/src/mint/taler-mint-httpd_db.c
index 36e87dd50..ac91cac5e 100644
--- a/src/mint/taler-mint-httpd_db.c
+++ b/src/mint/taler-mint-httpd_db.c
@@ -205,7 +205,8 @@ TALER_MINT_db_execute_deposit (struct MHD_Connection *connection,
 
 
 /**
- * Execute a /withdraw/status.
+ * Execute a /withdraw/status.  Given the public key of a reserve,
+ * return the associated transaction history.
  *
  * @param connection the MHD connection to handle
  * @param reserve_pub public key of the reserve to check
@@ -239,7 +240,10 @@ TALER_MINT_db_execute_withdraw_status (struct MHD_Connection *connection,
 
 
 /**
- * Execute a /withdraw/sign.
+ * Execute a "/withdraw/sign". Given a reserve and a properly signed
+ * request to withdraw a coin, check the balance of the reserve and
+ * if it is sufficient, store the request and return the signed
+ * blinded envelope.
  *
  * @param connection the MHD connection to handle
  * @param reserve public key of the reserve
@@ -603,12 +607,16 @@ refresh_accept_melts (struct MHD_Connection *connection,
 
 
 /**
- * Execute a /refresh/melt.
+ * Execute a "/refresh/melt".  We have been given a list of valid
+ * coins and a request to melt them into the given
+ * @a refresh_session_pub.  Check that the coins all have the
+ * required value left and if so, store that they have been
+ * melted and confirm the melting operation to the client.
  *
  * @param connection the MHD connection to handle
  * @param refresh_session_pub public key of the refresh session
  * @param num_new_denoms number of entries in @a denom_pubs
- * @param denum_pubs ???
+ * @param denum_pubs public keys of the coins we want to withdraw in the end
  * @param coin_count number of entries in @a coin_public_infos
  * @param coin_public_infos information about the coins to melt
  * @return MHD result code
@@ -752,14 +760,22 @@ TALER_MINT_db_execute_refresh_melt (struct MHD_Connection *connection,
 
 
 /**
- * Execute a /refresh/commit.
+ * Execute a "/refresh/commit".  The client is committing to @a kappa
+ * sets of transfer keys, and linkage information for a refresh
+ * operation.  Confirm that the commit matches the melts of an
+ * existing @a refresh_session_pub, store the refresh session commit
+ * data and then return the client a challenge specifying which of the
+ * @a kappa sets of private transfer keys should not be revealed.
  *
  * @param connection the MHD connection to handle
  * @param kappa size of x-dimension of @commit_coin and @commit_link arrays
  * @param num_oldcoins size of y-dimension of @commit_link array
  * @param num_newcoins size of y-dimension of @commit_coin array
- * @param commit_coin
- * @param commit_link
+ * @param commit_coin 2d array of coin commitments (what the mint is to sign
+ *                    once the "/refres/reveal" of cut and choose is done)
+ * @param commit_link 2d array of coin link commitments (what the mint is
+ *                    to return via "/refresh/link" to enable linkage in the
+ *                    future)
  * @return MHD result code
  */
 int
@@ -920,7 +936,11 @@ helper_refresh_reveal_send_response (struct MHD_Connection *connection,
 
 
 /**
- * Execute a /refresh/reveal.
+ * Execute a "/refresh/reveal".  The client is revealing to us the
+ * transfer keys for @a kappa-1 sets of coins.  Verify that the
+ * revealed transfer keys would allow linkage to the blinded coins,
+ * and if so, return the signed coins for corresponding to the set of
+ * coins that was not chosen.
  *
  * @param connection the MHD connection to handle
  * @param refresh_session_pub public key of the refresh session
@@ -1276,7 +1296,9 @@ link_iter (void *cls,
 
 
 /**
- * Execute a /refresh/link.
+ * Execute a "/refresh/link".  Returns the linkage information that
+ * will allow the owner of a coin to follow the refresh trail to
+ * the refreshed coin.
  *
  * @param connection the MHD connection to handle
  * @param coin_pub public key of the coin to link
-- 
cgit v1.2.3