/*
   This file is part of TALER
   Copyright (C) 2026 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_legitimization_outcomes_above_serial_id.h
 * @brief implementation of the iterate_legitimization_outcomes_above_serial_id function for Postgres
 * @author Christian Grothoff
 */
#ifndef EXCHANGE_DATABASE_ITERATE_LEGITIMIZATION_OUTCOMES_ABOVE_SERIAL_ID_H
#define EXCHANGE_DATABASE_ITERATE_LEGITIMIZATION_OUTCOMES_ABOVE_SERIAL_ID_H

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


#ifndef TALER_EXCHANGEDB_LEGITIMIZATION_OUTCOME_RESULT_CLOSURE
/**
 * Type of the closure for #TALER_EXCHANGEDB_LegitimizationOutcomeCallback.
 */
#define TALER_EXCHANGEDB_LEGITIMIZATION_OUTCOME_RESULT_CLOSURE void
#endif

/* Callback typedefs */
/**
 * Function called with a legitimization outcome, together with the three
 * things that could have brought it about.  The flags are facts about the
 * database, not a verdict: which combinations of them an honest exchange can
 * produce is for the caller to decide.
 *
 * @param cls closure
 * @param rowid unique serial ID of the entry in legitimization_outcomes
 * @param h_payto normalized payto hash of the account the outcome is about
 * @param decision_time when the outcome was decided, as claimed
 * @param expiration_time when the outcome expires and its successor measure
 *        is due
 * @param has_aml_decision true if an `aml_history` row points at this
 *        outcome, that is, an AML officer signed it
 * @param has_legitimization_process true if the account had a legitimization
 *        process that had started by @a decision_time, that is, the outcome
 *        could be an AML program's verdict on a check the customer went
 *        through
 * @param has_expired_predecessor true if an earlier outcome for the same
 *        account had expired by @a decision_time, that is, the outcome could
 *        be the successor measure that expiry called for
 * @return #GNUNET_OK to continue to iterate, #GNUNET_SYSERR to stop
 */
typedef enum GNUNET_GenericReturnValue
(*TALER_EXCHANGEDB_LegitimizationOutcomeCallback)(
  TALER_EXCHANGEDB_LEGITIMIZATION_OUTCOME_RESULT_CLOSURE *cls,
  uint64_t rowid,
  const struct TALER_NormalizedPaytoHashP *h_payto,
  struct GNUNET_TIME_Timestamp decision_time,
  struct GNUNET_TIME_Timestamp expiration_time,
  bool has_aml_decision,
  bool has_legitimization_process,
  bool has_expired_predecessor);


/**
 * Select legitimization outcomes above @a serial_id in monotonically
 * increasing order, each with flags saying what in the database could
 * account for it.
 *
 * @param pg the database context
 * @param serial_id lowest serial ID to include (the row itself is returned,
 *        so callers resuming from a progress point pass last seen + 1)
 * @param cb function to call on each result
 * @param cb_cls closure for @a cb
 * @return transaction status code
 */
enum GNUNET_DB_QueryStatus
TALER_EXCHANGEDB_iterate_legitimization_outcomes_above_serial_id (
  struct TALER_EXCHANGEDB_PostgresContext *pg,
  uint64_t serial_id,
  TALER_EXCHANGEDB_LegitimizationOutcomeCallback cb,
  TALER_EXCHANGEDB_LEGITIMIZATION_OUTCOME_RESULT_CLOSURE *cb_cls);

#endif
