select_historic_denom_revenue.h (4397B)
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 typedef enum GNUNET_GenericReturnValue 46 (*TALER_AUDITORDB_HistoricDenominationRevenueDataCallback)( 47 void *cls, 48 uint64_t serial_id, 49 const struct TALER_DenominationHashP *denom_pub_hash, 50 struct GNUNET_TIME_Timestamp revenue_timestamp, 51 const struct TALER_Amount *revenue_balance, 52 const struct TALER_Amount *loss_balance); 53 54 struct TALER_AUDITORDB_HistoricDenominationRevenue 55 { 56 uint64_t row_id; 57 struct TALER_DenominationHashP denom_pub_hash; 58 struct GNUNET_TIME_Absolute revenue_timestamp; 59 struct TALER_Amount revenue_balance; 60 struct TALER_Amount loss_balance; 61 bool suppressed; 62 63 }; 64 65 66 /** 67 * Function called with the results of select_historic_denom_revenue() 68 * 69 * @param cls closure 70 * @param serial_id row for the denomination revenue in the auditor database 71 * @param denom_pub_hash hash of the denomination key 72 * @param revenue_timestamp when did this profit get realized 73 * @param revenue_balance what was the total profit made from 74 * deposit fees, melting fees, refresh fees 75 * and coins that were never returned? 76 * @param loss_balance what was the total loss 77 * @return sets the return value of select_denomination_info(), 78 * #GNUNET_OK to continue, 79 * #GNUNET_NO to stop processing further rows 80 * #GNUNET_SYSERR or other values on error. 81 */ 82 typedef enum GNUNET_GenericReturnValue 83 (*TALER_AUDITORDB_HistoricDenominationRevenueDataCallback)( 84 void *cls, 85 uint64_t serial_id, 86 const struct TALER_DenominationHashP *denom_pub_hash, 87 struct GNUNET_TIME_Timestamp revenue_timestamp, 88 const struct TALER_Amount *revenue_balance, 89 const struct TALER_Amount *loss_balance); 90 91 /** 92 * Obtain all of the historic denomination key revenue 93 * 94 * @param pg the database context 95 * @param limit return at most this number of results, negative to descend from @a offset 96 * @param offset row from which to return @a limit results 97 * @param cb function to call with the results 98 * @param cb_cls closure for @a cb 99 * @return transaction status code 100 */ 101 enum GNUNET_DB_QueryStatus 102 TALER_AUDITORDB_select_historic_denom_revenue (struct 103 TALER_AUDITORDB_PostgresContext * 104 pg, 105 int64_t limit, 106 uint64_t offset, 107 TALER_AUDITORDB_HistoricDenominationRevenueDataCallback 108 cb, 109 void *cb_cls); 110 111 #endif