exchange/src/include/taler_pq_lib.h

235 lines
6.9 KiB
C
Raw Normal View History

2015-01-08 18:37:20 +01:00
/*
This file is part of TALER
Copyright (C) 2014-2022 Taler Systems SA
2015-01-08 18:37:20 +01:00
TALER is free software; you can redistribute it and/or modify it under the
terms of the GNU General Public License as published by the Free Software
Foundation; either version 3, or (at your option) any later version.
TALER is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with
2016-07-07 17:55:25 +02:00
TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/>
2015-01-08 18:37:20 +01:00
*/
/**
2015-03-28 15:42:07 +01:00
* @file include/taler_pq_lib.h
2015-01-08 18:37:20 +01:00
* @brief helper functions for DB interactions
* @author Sree Harsha Totakura <sreeharsha@totakura.in>
* @author Florian Dold
2015-01-26 11:04:46 +01:00
* @author Christian Grothoff
2015-01-08 18:37:20 +01:00
*/
#ifndef TALER_PQ_LIB_H_
#define TALER_PQ_LIB_H_
2015-01-08 18:37:20 +01:00
#include <libpq-fe.h>
#include <jansson.h>
#include <gnunet/gnunet_pq_lib.h>
2015-01-08 18:37:20 +01:00
#include "taler_util.h"
/**
2015-05-06 11:47:12 +02:00
* Generate query parameter for a currency, consisting of the three
* components "value", "fraction" and "currency" in this order. The
* types must be a 64-bit integer, 32-bit integer and a
* #TALER_CURRENCY_LEN-sized BLOB/VARCHAR respectively.
*
* @param x pointer to the query parameter to pass
*/
struct GNUNET_PQ_QueryParam
TALER_PQ_query_param_amount_nbo (const struct TALER_AmountNBO *x);
2015-01-26 11:04:46 +01:00
2015-01-08 18:37:20 +01:00
/**
2021-10-23 07:11:23 +02:00
* Generate query parameter for an amount, consisting of the two
* components "value" and "fraction" in this order. The
* types must be a 64-bit integer and a 32-bit integer
* respectively. The currency is dropped.
*
* @param x pointer to the query parameter to pass
*/
struct GNUNET_PQ_QueryParam
TALER_PQ_query_param_amount (const struct TALER_Amount *x);
2021-10-23 07:11:23 +02:00
/**
* Generate query parameter for a denomination public
* key. Internally, the various attributes of the
* public key will be serialized into on variable-size
* BLOB.
*
2022-02-12 11:12:33 +01:00
* @param denom_pub pointer to the query parameter to pass
2021-10-23 07:11:23 +02:00
*/
struct GNUNET_PQ_QueryParam
TALER_PQ_query_param_denom_pub (
const struct TALER_DenominationPublicKey *denom_pub);
/**
* Generate query parameter for a denomination signature. Internally, the
* various attributes of the signature will be serialized into on
* variable-size BLOB.
*
2022-02-12 11:12:33 +01:00
* @param denom_sig pointer to the query parameter to pass
2021-10-23 07:11:23 +02:00
*/
struct GNUNET_PQ_QueryParam
TALER_PQ_query_param_denom_sig (
const struct TALER_DenominationSignature *denom_sig);
/**
* Generate query parameter for a blinded planchet.
* Internally, various attributes of the blinded
* planchet will be serialized into on
* variable-size BLOB.
*
2022-02-12 11:12:33 +01:00
* @param bp pointer to the query parameter to pass
*/
struct GNUNET_PQ_QueryParam
TALER_PQ_query_param_blinded_planchet (
const struct TALER_BlindedPlanchet *bp);
/**
* Generate query parameter for a blinded denomination signature. Internally,
* the various attributes of the signature will be serialized into on
* variable-size BLOB.
*
2022-02-12 11:12:33 +01:00
* @param denom_sig pointer to the query parameter to pass
*/
struct GNUNET_PQ_QueryParam
TALER_PQ_query_param_blinded_denom_sig (
const struct TALER_BlindedDenominationSignature *denom_sig);
/**
* Generate query parameter for the exchange's contribution during a
* withdraw. Internally, the various attributes of the @a alg_values will be
* serialized into on variable-size BLOB.
*
2022-02-12 11:12:33 +01:00
* @param alg_values pointer to the query parameter to pass
*/
struct GNUNET_PQ_QueryParam
TALER_PQ_query_param_exchange_withdraw_values (
const struct TALER_ExchangeWithdrawValues *alg_values);
/**
* Generate query parameter for a JSON object (stored as a string
2015-06-10 17:39:34 +02:00
* in the DB). Note that @a x must really be a JSON object or array,
* passing just a value (string, integer) is not supported and will
* result in an abort.
*
* @param x pointer to the json object to pass
*/
struct GNUNET_PQ_QueryParam
TALER_PQ_query_param_json (const json_t *x);
2015-05-06 11:47:12 +02:00
/**
* Currency amount expected.
*
* @param name name of the field in the table
2020-01-18 14:13:28 +01:00
* @param currency currency to use for @a amount
* @param[out] amount where to store the result
* @return array entry for the result specification to use
2015-05-06 11:47:12 +02:00
*/
struct GNUNET_PQ_ResultSpec
TALER_PQ_result_spec_amount_nbo (const char *name,
2019-08-17 21:35:21 +02:00
const char *currency,
struct TALER_AmountNBO *amount);
2015-05-06 11:47:12 +02:00
/**
* Currency amount expected.
*
* @param name name of the field in the table
2020-01-18 14:13:28 +01:00
* @param currency currency to use for @a amount
* @param[out] amount where to store the result
* @return array entry for the result specification to use
*/
struct GNUNET_PQ_ResultSpec
TALER_PQ_result_spec_amount (const char *name,
2019-08-17 21:35:21 +02:00
const char *currency,
struct TALER_Amount *amount);
2015-01-26 11:04:46 +01:00
2021-10-23 07:11:23 +02:00
/**
* Denomination public key expected.
*
* @param name name of the field in the table
* @param[out] denom_pub where to store the public key
* @return array entry for the result specification to use
*/
struct GNUNET_PQ_ResultSpec
TALER_PQ_result_spec_denom_pub (const char *name,
struct TALER_DenominationPublicKey *denom_pub);
/**
* Denomination signature expected.
*
* @param name name of the field in the table
* @param[out] denom_sig where to store the denomination signature
* @return array entry for the result specification to use
*/
struct GNUNET_PQ_ResultSpec
TALER_PQ_result_spec_denom_sig (const char *name,
struct TALER_DenominationSignature *denom_sig);
/**
* Blinded denomination signature expected.
*
* @param name name of the field in the table
* @param[out] denom_sig where to store the denomination signature
* @return array entry for the result specification to use
*/
struct GNUNET_PQ_ResultSpec
TALER_PQ_result_spec_blinded_denom_sig (
const char *name,
struct TALER_BlindedDenominationSignature *denom_sig);
/**
* Exchange withdraw values expected.
*
* @param name name of the field in the table
* @param[out] ewv where to store the exchange values
* @return array entry for the result specification to use
*/
struct GNUNET_PQ_ResultSpec
TALER_PQ_result_spec_exchange_withdraw_values (
const char *name,
struct TALER_ExchangeWithdrawValues *ewv);
/**
* Blinded planchet expected.
*
* @param name name of the field in the table
* @param[out] bp where to store the blinded planchet
* @return array entry for the result specification to use
*/
struct GNUNET_PQ_ResultSpec
TALER_PQ_result_spec_blinded_planchet (
const char *name,
struct TALER_BlindedPlanchet *bp);
/**
* json_t expected.
*
* @param name name of the field in the table
* @param[out] jp where to store the result
* @return array entry for the result specification to use
*/
struct GNUNET_PQ_ResultSpec
TALER_PQ_result_spec_json (const char *name,
json_t **jp);
#endif /* TALER_PQ_LIB_H_ */
2015-01-08 18:37:20 +01:00
/* end of include/taler_pq_lib.h */