/*
   This file is part of TALER
   Copyright (C) 2022 Taler Systems SA

   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
   TALER; see the file COPYING.  If not, see <http://www.gnu.org/licenses/>
 */
/**
 * @file src/include/exchange-database/iterate_refunds_by_coin.h
 * @brief implementation of the iterate_refunds_by_coin function for Postgres
 * @author Christian Grothoff
 */
#ifndef EXCHANGE_DATABASE_ITERATE_REFUNDS_BY_COIN_H
#define EXCHANGE_DATABASE_ITERATE_REFUNDS_BY_COIN_H

#include "taler/taler_util.h"
#include "taler/taler_json_lib.h"
#include "exchangedb_lib.h"


/**
 * Callback invoked with information about refunds applicable
 * to a particular coin and contract.
 *
 * @param cls closure
 * @param amount_with_fee amount being refunded
 * @return #GNUNET_OK to continue to iterate, #GNUNET_SYSERR to stop
 */
#ifndef TALER_EXCHANGEDB_REFUND_COIN_RESULT_CLOSURE
/**
 * Type of the closure for #TALER_EXCHANGEDB_RefundCoinCallback.
 */
#define TALER_EXCHANGEDB_REFUND_COIN_RESULT_CLOSURE void
#endif
typedef enum GNUNET_GenericReturnValue
(*TALER_EXCHANGEDB_RefundCoinCallback)(
  TALER_EXCHANGEDB_REFUND_COIN_RESULT_CLOSURE *cls,
  const struct TALER_Amount *amount_with_fee);


/* Callback typedefs */
/**
 * Callback invoked with information about refunds applicable
 * to a particular coin and contract.
 *
 * @param cls closure
 * @param amount_with_fee amount being refunded
 * @return #GNUNET_OK to continue to iterate, #GNUNET_SYSERR to stop
 */
typedef enum GNUNET_GenericReturnValue
(*TALER_EXCHANGEDB_RefundCoinCallback)(
  TALER_EXCHANGEDB_REFUND_COIN_RESULT_CLOSURE *cls,
  const struct TALER_Amount *amount_with_fee);

/**
 * Select refunds by @a coin_pub, @a merchant_pub and @a h_contract.
 *
 * @param pg the database context
 * @param coin_pub coin to get refunds for
 * @param merchant_pub merchant to get refunds for
 * @param h_contract contract (hash) to get refunds for
 * @param cb function to call for each refund found
 * @param cb_cls closure for @a cb
 * @return query result status
 */
enum GNUNET_DB_QueryStatus
TALER_EXCHANGEDB_iterate_refunds_by_coin (struct
                                          TALER_EXCHANGEDB_PostgresContext *pg,
                                          const struct
                                          TALER_CoinSpendPublicKeyP *
                                          coin_pub,
                                          const struct
                                          TALER_MerchantPublicKeyP *
                                          merchant_pub,
                                          const struct
                                          TALER_PrivateContractHashP *
                                          h_contract,
                                          TALER_EXCHANGEDB_RefundCoinCallback cb
                                          ,
                                          TALER_EXCHANGEDB_REFUND_COIN_RESULT_CLOSURE
                                          *cb_cls);

#endif
