summaryrefslogtreecommitdiff
path: root/src/include/taler_merchantdb_plugin.h
blob: ca7870d7577654e0b12264cdfd340a27de9ea8f6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
/*
  This file is part of TALER
  Copyright (C) 2014, 2015, 2016 INRIA

  TALER is free software; you can redistribute it and/or modify it under the
  terms of the GNU Lesser 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.GPL.  If not, If not, see <http://www.gnu.org/licenses/>
*/
/**
 * @file include/taler_merchantdb_plugin.h
 * @brief database access for the merchant
 * @author Florian Dold
 * @author Christian Grothoff
 */
#ifndef TALER_MERCHANTDB_PLUGIN_H
#define TALER_MERCHANTDB_PLUGIN_H

#include <gnunet/gnunet_util_lib.h>
#include <jansson.h>

/**
 * Handle to interact with the database.
 */
struct TALER_MERCHANTDB_Plugin;


typedef void
(*TALER_MERCHANTDB_PaymentCallback)(void *cls,
                                    ...);


/**
 * Handle to interact with the database.
 */
struct TALER_MERCHANTDB_Plugin
{

  /**
   * Closure for all callbacks.
   */
  void *cls;

  /**
   * Name of the library which generated this plugin.  Set by the
   * plugin loader.
   */
  char *library_name;

  /**
   * Drop merchant tables. Used for testcases.
   *
   * @param cls closure
   * @return #GNUNET_OK upon success; #GNUNET_SYSERR upon failure
   */
  int
  (*drop_tables) (void *cls);

  /**
   * Initialize merchant tables
   *
   * @param cls closure
   * @return #GNUNET_OK upon success; #GNUNET_SYSERR upon failure
   */
  int
  (*initialize) (void *cls);

  /**
   * Insert payment confirmation from the exchange into the database.
   *
   * @param cls closure
   * @param h_contract hash of the contract
   * @param h_wire hash of our wire details
   * @param transaction_id of the contract
   * @param timestamp time of the confirmation
   * @param refund refund deadline
   * @param amount_without_fee amount the exchange will deposit
   * @param coin_pub public key of the coin
   * @param exchange_proof proof from exchange that coin was accepted
   * @return #GNUNET_OK on success, #GNUNET_SYSERR upon error
   */
  int
  (*store_payment) (void *cls,
                    const struct GNUNET_HashCode *h_contract,
                    const struct GNUNET_HashCode *h_wire,
                    uint64_t transaction_id,
                    struct GNUNET_TIME_Absolute timestamp,
                    struct GNUNET_TIME_Absolute refund,
                    const struct TALER_Amount *amount_without_fee,
                    const struct TALER_CoinSpendPublicKeyP *coin_pub,
		    const json_t *exchange_proof);


  /**
   * Check whether a payment has already been stored
   *
   * @param cls our plugin handle
   * @param transaction_id the transaction id to search into
   * the db
   *
   * @return #GNUNET_OK if found, #GNUNET_NO if not, #GNUNET_SYSERR
   * upon error
   */
  int
  (*check_payment) (void *cls,
                    uint64_t transaction_id);


  /**
   * Lookup information about a payment by transaction ID.
   *
   * @param cls closure
   * @param transaction_id key for the search
   * @param cb function to call with payment data
   * @param cb_cls closure for @a cb
   * @return #GNUNET_OK on success, #GNUNET_NO if transaction Id is unknown,
   *         #GNUNET_SYSERR on hard errors
   */
  int
  (*find_payment) (void *cls,
                   uint64_t transaction_id,
                   TALER_MERCHANTDB_PaymentCallback cb,
                   void *cb_cls);

};
#endif