exchange

Base system with REST service to issue digital coins, run by the payment service provider
Log | Files | Refs | Submodules | README | LICENSE

pg_get_coin_transactions.h (2617B)


      1 /*
      2    This file is part of TALER
      3    Copyright (C) 2022, 2023 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 pg_get_coin_transactions.h
     18  * @brief implementation of the get_coin_transactions function
     19  * @author Christian Grothoff
     20  */
     21 #ifndef PG_GET_COIN_TRANSACTIONS_H
     22 #define PG_GET_COIN_TRANSACTIONS_H
     23 
     24 #include "taler/taler_util.h"
     25 #include "taler/taler_json_lib.h"
     26 #include "taler/taler_exchangedb_plugin.h"
     27 
     28 
     29 /**
     30  * Compile a list of (historic) transactions performed with the given coin
     31  * (melt, refund, recoup and deposit operations).  Should return 0 if the @a
     32  * coin_pub is unknown, otherwise determine @a etag_out and if it is past @a
     33  * etag_in return the history after @a start_off. @a etag_out should be set
     34  * to the last row ID of the given @a coin_pub in the coin history table.
     35  *
     36  * @param cls the @e cls of this struct with the plugin-specific state
     37  * @param begin_transaction true to run this in its own transaction(s)
     38  * @param coin_pub coin to investigate
     39  * @param start_off starting offset from which on to return entries
     40  * @param etag_in up to this offset the client already has a response, do not
     41  *                   return anything unless @a etag_out will be larger
     42  * @param[out] etag_out set to the latest history offset known for this @a coin_pub
     43  * @param[out] balance set to current balance of the coin
     44  * @param[out] h_denom_pub set to denomination public key of the coin
     45  * @param[out] tlp set to list of transactions, set to NULL if coin has no
     46  *             transaction history past @a start_off or if @a etag_in is equal
     47  *             to the value written to @a etag_out.
     48  * @return database transaction status
     49  */
     50 enum GNUNET_DB_QueryStatus
     51 TEH_PG_get_coin_transactions (
     52   void *cls,
     53   bool begin_transaction,
     54   const struct TALER_CoinSpendPublicKeyP *coin_pub,
     55   uint64_t start_off,
     56   uint64_t etag_in,
     57   uint64_t *etag_out,
     58   struct TALER_Amount *balance,
     59   struct TALER_DenominationHashP *h_denom_pub,
     60   struct TALER_EXCHANGEDB_TransactionList **tlp);
     61 
     62 
     63 #endif