taler/exchange
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Commenting the "peer key" trait.

Browse Source
This commit is contained in:
Marcello Stanisci 2018-05-28 15:58:08 +02:00
parent d97260408c
commit 939c1dd6a5
No known key found for this signature in database
GPG Key ID: 8D526861953F4C0F
1 changed files with 24 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
src/exchange-lib/testing_api_trait_key_peer.c
View File

@ -36,12 +36,12 @@
* Obtain a private key from a "peer". Used e.g. to obtain * Obtain a private key from a "peer". Used e.g. to obtain
* a merchant's priv to sign a /track request. * a merchant's priv to sign a /track request.
* *
* @param index (tipically zero) which key to return if they * @param cmd command that is offering the key.
* exist in an array. * @param index (tipically zero) which key to return if there
* @param selector which coin to pick if @a cmd has multiple on * are multiple on offer.
* offer
* @param priv[out] set to the key coming from @a cmd. * @param priv[out] set to the key coming from @a cmd.
* @return #GNUNET_OK on success *
* @return #GNUNET_OK on success.
*/ */
int int
TALER_TESTING_get_trait_peer_key TALER_TESTING_get_trait_peer_key
@ -56,11 +56,14 @@ TALER_TESTING_get_trait_peer_key
} }
/** /**
* @param index (tipically zero) which key to return if they * Offer private key, typically done when CMD_1 needs it to
* exist in an array. * sign a request.
* @param priv which object should be returned
* *
* @return the trait, to be put in the traits array of the command * @param index (tipically zero) which key to return if there are
* multiple on offer.
* @param priv which object should be offered.
*
* @return the trait.
*/ */
struct TALER_TESTING_Trait struct TALER_TESTING_Trait
TALER_TESTING_make_trait_peer_key TALER_TESTING_make_trait_peer_key
@ -80,10 +83,12 @@ TALER_TESTING_make_trait_peer_key
* Obtain a public key from a "peer". Used e.g. to obtain * Obtain a public key from a "peer". Used e.g. to obtain
* a merchant's public key to use backend's API. * a merchant's public key to use backend's API.
* *
* @param index (tipically zero) which key to return if they * @param cmd command offering the key.
* exist in an array. * @param index (tipically zero) which key to return if there
* are multiple on offer.
* @param pub[out] set to the key coming from @a cmd. * @param pub[out] set to the key coming from @a cmd.
* @return #GNUNET_OK on success *
* @return #GNUNET_OK on success.
*/ */
int int
TALER_TESTING_get_trait_peer_key_pub TALER_TESTING_get_trait_peer_key_pub
@ -98,11 +103,14 @@ TALER_TESTING_get_trait_peer_key_pub
} }
/** /**
* @param index (tipically zero) which key to return if they * Offer public key.
* exist in an array.
* @param pub which object should be returned
* *
* @return the trait, to be put in the traits array of the command * @param index (tipically zero) which key to return if there
* are multiple on offer. NOTE: if one key is offered, it
* is mandatory to set this as zero.
* @param pub which object should be returned.
*
* @return the trait.
*/ */
struct TALER_TESTING_Trait struct TALER_TESTING_Trait
TALER_TESTING_make_trait_peer_key_pub TALER_TESTING_make_trait_peer_key_pub