/*
   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_aml_history_above_serial_id.h
 * @brief implementation of the iterate_aml_history_above_serial_id function for Postgres
 * @author Christian Grothoff
 */
#ifndef EXCHANGE_DATABASE_ITERATE_AML_HISTORY_ABOVE_SERIAL_ID_H
#define EXCHANGE_DATABASE_ITERATE_AML_HISTORY_ABOVE_SERIAL_ID_H

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


#ifndef TALER_EXCHANGEDB_AML_DECISION_RESULT_CLOSURE
/**
 * Type of the closure for #TALER_EXCHANGEDB_AmlDecisionCallback.
 */
#define TALER_EXCHANGEDB_AML_DECISION_RESULT_CLOSURE void
#endif

/* Callback typedefs */
/**
 * Function called with an AML decision made by an AML officer, with
 * everything the officer's signature covers.
 *
 * @param cls closure
 * @param rowid unique serial ID of the entry in aml_history
 * @param h_payto normalized payto hash of the account the decision is about
 * @param justification human-readable justification given
 * @param decider_pub public key of the officer who decided, NULL if the
 *        exchange did not record one
 * @param decider_sig the officer's signature, NULL if the exchange did not
 *        record one
 * @param decision_time when the decision was taken, as claimed
 * @param jproperties new account properties, NULL for none
 * @param jnew_rules new KYC rules for the account, NULL if the exchange did
 *        not record any (which no honest decision lacks)
 * @param new_measure_name measure to apply immediately, NULL for none
 * @param to_investigate whether AML staff should investigate the account
 * @param attributes_expiration when the attributes set with the decision
 *        expire, zero if the decision set no attributes
 * @param h_attributes hash of the attributes set with the decision, NULL if
 *        the decision set none.  The attributes themselves are stored only
 *        encrypted, so this hash is all an auditor can check against.
 * @return #GNUNET_OK to continue to iterate, #GNUNET_SYSERR to stop
 */
typedef enum GNUNET_GenericReturnValue
(*TALER_EXCHANGEDB_AmlDecisionCallback)(
  TALER_EXCHANGEDB_AML_DECISION_RESULT_CLOSURE *cls,
  uint64_t rowid,
  const struct TALER_NormalizedPaytoHashP *h_payto,
  const char *justification,
  const struct TALER_AmlOfficerPublicKeyP *decider_pub,
  const struct TALER_AmlOfficerSignatureP *decider_sig,
  struct GNUNET_TIME_Timestamp decision_time,
  const json_t *jproperties,
  const json_t *jnew_rules,
  const char *new_measure_name,
  bool to_investigate,
  struct GNUNET_TIME_Timestamp attributes_expiration,
  const struct GNUNET_HashCode *h_attributes);


/**
 * Select AML decisions from aml_history above @a serial_id in monotonically
 * increasing order, joined with everything else the officer signed over.
 *
 * @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_aml_history_above_serial_id (
  struct TALER_EXCHANGEDB_PostgresContext *pg,
  uint64_t serial_id,
  TALER_EXCHANGEDB_AmlDecisionCallback cb,
  TALER_EXCHANGEDB_AML_DECISION_RESULT_CLOSURE *cb_cls);

#endif
