get_ready_deposit.h (2876B)
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 src/include/exchange-database/get_ready_deposit.h 18 * @brief implementation of the get_ready_deposit function for Postgres 19 * @author Christian Grothoff 20 */ 21 #ifndef EXCHANGE_DATABASE_GET_READY_DEPOSIT_H 22 #define EXCHANGE_DATABASE_GET_READY_DEPOSIT_H 23 24 #include "taler/taler_util.h" 25 #include "taler/taler_json_lib.h" 26 #include "exchangedb_lib.h" 27 28 29 /** 30 * Obtain information about deposits that are ready to be executed. Such 31 * deposits must not be marked as "done" or policy-blocked, their wire 32 * deadline must have passed, and their refund deadline must have passed 33 * the current aggregation shift boundary. 34 * 35 * The last condition is what makes the result *actionable*: it is the 36 * same cut-off that TALER_EXCHANGEDB_do_aggregate() applies when marking 37 * deposits as done. Without it this function reports deposits that the 38 * aggregator then cannot make progress on, which makes it spin (and 39 * `taler-exchange-aggregator -t` never reach an idle shard, hence never 40 * terminate). Note that a deposit is therefore not necessarily ready 41 * the instant its wire deadline passes; it becomes ready at the next 42 * shift boundary, which is precisely what AGGREGATOR_SHIFT asks for. 43 * 44 * @param pg the database context 45 * @param start_shard_row minimum shard row to select 46 * @param end_shard_row maximum shard row to select (inclusive) 47 * @param[out] merchant_pub set to the public key of a merchant with a ready deposit 48 * @param[out] payto_uri set to the account of the merchant, to be freed by caller 49 * @param[out] extra_wire_subject_metadata set to additional metadata to include in the wire subject, or NULL for none 50 * @return transaction status code 51 */ 52 enum GNUNET_DB_QueryStatus 53 TALER_EXCHANGEDB_get_ready_deposit (struct TALER_EXCHANGEDB_PostgresContext *pg, 54 uint64_t start_shard_row, 55 uint64_t end_shard_row, 56 struct TALER_MerchantPublicKeyP * 57 merchant_pub, 58 struct TALER_FullPayto *payto_uri, 59 char **extra_wire_subject_metadata); 60 61 #endif