select_historic_denom_revenue.h (4880B)
1 /* 2 This file is part of TALER 3 Copyright (C) 2022 Taler Systems SA 4 5 TALER is free software; you can redistribute it and/or modify it under the 6 terms of the GNU General Public License as published by the Free Software 7 Foundation; either version 3, or (at your option) any later version. 8 9 TALER is distributed in the hope that it will be useful, but WITHOUT ANY 10 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR 11 A PARTICULAR PURPOSE. See the GNU General Public License for more details. 12 13 You should have received a copy of the GNU General Public License along with 14 TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> 15 */ 16 /** 17 * @file select_historic_denom_revenue.h 18 * @brief implementation of the select_historic_denom_revenue function 19 * @author Christian Grothoff 20 */ 21 #ifndef AUDITOR_DATABASE_SELECT_HISTORIC_DENOM_REVENUE_H 22 #define AUDITOR_DATABASE_SELECT_HISTORIC_DENOM_REVENUE_H 23 24 #include "taler/taler_util.h" 25 #include "taler/taler_json_lib.h" 26 #include "auditordb_lib.h" 27 28 29 /** 30 * Function called with the results of select_historic_denom_revenue() 31 * 32 * @param cls closure 33 * @param serial_id row for the denomination revenue in the auditor database 34 * @param denom_pub_hash hash of the denomination key 35 * @param revenue_timestamp when did this profit get realized 36 * @param revenue_balance what was the total profit made from 37 * deposit fees, melting fees, refresh fees 38 * and coins that were never returned? 39 * @param loss_balance what was the total loss 40 * @return sets the return value of select_denomination_info(), 41 * #GNUNET_OK to continue, 42 * #GNUNET_NO to stop processing further rows 43 * #GNUNET_SYSERR or other values on error. 44 */ 45 #ifndef TALER_AUDITORDB_HISTORIC_DENOMINATION_REVENUE_DATA_RESULT_CLOSURE 46 /** 47 * Type of the closure for #TALER_AUDITORDB_HistoricDenominationRevenueDataCallback. 48 */ 49 #define TALER_AUDITORDB_HISTORIC_DENOMINATION_REVENUE_DATA_RESULT_CLOSURE void 50 #endif 51 typedef enum GNUNET_GenericReturnValue 52 (*TALER_AUDITORDB_HistoricDenominationRevenueDataCallback)( 53 TALER_AUDITORDB_HISTORIC_DENOMINATION_REVENUE_DATA_RESULT_CLOSURE *cls, 54 uint64_t serial_id, 55 const struct TALER_DenominationHashP *denom_pub_hash, 56 struct GNUNET_TIME_Timestamp revenue_timestamp, 57 const struct TALER_Amount *revenue_balance, 58 const struct TALER_Amount *loss_balance); 59 60 struct TALER_AUDITORDB_HistoricDenominationRevenue 61 { 62 uint64_t row_id; 63 struct TALER_DenominationHashP denom_pub_hash; 64 struct GNUNET_TIME_Absolute revenue_timestamp; 65 struct TALER_Amount revenue_balance; 66 struct TALER_Amount loss_balance; 67 bool suppressed; 68 69 }; 70 71 72 /** 73 * Function called with the results of select_historic_denom_revenue() 74 * 75 * @param cls closure 76 * @param serial_id row for the denomination revenue in the auditor database 77 * @param denom_pub_hash hash of the denomination key 78 * @param revenue_timestamp when did this profit get realized 79 * @param revenue_balance what was the total profit made from 80 * deposit fees, melting fees, refresh fees 81 * and coins that were never returned? 82 * @param loss_balance what was the total loss 83 * @return sets the return value of select_denomination_info(), 84 * #GNUNET_OK to continue, 85 * #GNUNET_NO to stop processing further rows 86 * #GNUNET_SYSERR or other values on error. 87 */ 88 typedef enum GNUNET_GenericReturnValue 89 (*TALER_AUDITORDB_HistoricDenominationRevenueDataCallback)( 90 TALER_AUDITORDB_HISTORIC_DENOMINATION_REVENUE_DATA_RESULT_CLOSURE *cls, 91 uint64_t serial_id, 92 const struct TALER_DenominationHashP *denom_pub_hash, 93 struct GNUNET_TIME_Timestamp revenue_timestamp, 94 const struct TALER_Amount *revenue_balance, 95 const struct TALER_Amount *loss_balance); 96 97 /** 98 * Obtain all of the historic denomination key revenue 99 * 100 * @param pg the database context 101 * @param limit return at most this number of results, negative to descend from @a offset 102 * @param offset row from which to return @a limit results 103 * @param cb function to call with the results 104 * @param cb_cls closure for @a cb 105 * @return transaction status code 106 */ 107 enum GNUNET_DB_QueryStatus 108 TALER_AUDITORDB_select_historic_denom_revenue (struct 109 TALER_AUDITORDB_PostgresContext * 110 pg, 111 int64_t limit, 112 uint64_t offset, 113 TALER_AUDITORDB_HistoricDenominationRevenueDataCallback 114 cb, 115 TALER_AUDITORDB_HISTORIC_DENOMINATION_REVENUE_DATA_RESULT_CLOSURE 116 *cb_cls); 117 118 #endif