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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
/*
This file is part of TALER
Copyright (C) 2014-2020 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 include/taler_exchangedb_lib.h
* @brief IO operations for the exchange's private keys
* @author Florian Dold
* @author Benedikt Mueller
* @author Christian Grothoff
*/
#ifndef TALER_EXCHANGEDB_LIB_H
#define TALER_EXCHANGEDB_LIB_H
#include "taler_signatures.h"
#include "taler_exchangedb_plugin.h"
#include "taler_bank_service.h"
/**
* Initialize the plugin.
*
* @param cfg configuration to use
* @param skip_preflight true if we should skip the usual
* preflight check which assures us that the DB is actually
* operational; only taler-exchange-dbinit should use true here.
* @return NULL on failure
*/
struct TALER_EXCHANGEDB_Plugin *
TALER_EXCHANGEDB_plugin_load (const struct GNUNET_CONFIGURATION_Handle *cfg,
bool skip_preflight);
/**
* Shutdown the plugin.
*
* @param[in] plugin plugin to unload
*/
void
TALER_EXCHANGEDB_plugin_unload (struct TALER_EXCHANGEDB_Plugin *plugin);
/**
* Information about an account from the configuration.
*/
struct TALER_EXCHANGEDB_AccountInfo
{
/**
* Authentication data. Only parsed if
* #TALER_EXCHANGEDB_ALO_AUTHDATA was set.
*/
const struct TALER_BANK_AuthenticationData *auth;
/**
* Section in the configuration file that specifies the
* account. Must start with "exchange-account-".
*/
const char *section_name;
/**
* Name of the wire method used by this account.
*/
const char *method;
/**
* true if this account is enabled to be debited
* by the taler-exchange-aggregator.
*/
bool debit_enabled;
/**
* true if this account is enabled to be credited by wallets
* and needs to be watched by the taler-exchange-wirewatch.
* Also, the account will only be included in /wire if credit
* is enabled.
*/
bool credit_enabled;
};
/**
* Calculate the total value of all transactions performed.
* Stores @a off plus the cost of all transactions in @a tl
* in @a ret.
*
* @param tl transaction list to process
* @param off offset to use as the starting value
* @param[out] ret where the resulting total is to be stored
* @return #GNUNET_OK on success, #GNUNET_SYSERR on errors
*/
enum GNUNET_GenericReturnValue
TALER_EXCHANGEDB_calculate_transaction_list_totals (
struct TALER_EXCHANGEDB_TransactionList *tl,
const struct TALER_Amount *off,
struct TALER_Amount *ret);
/**
* Function called with information about a wire account.
*
* @param cls closure
* @param ai account information
*/
typedef void
(*TALER_EXCHANGEDB_AccountCallback)(
void *cls,
const struct TALER_EXCHANGEDB_AccountInfo *ai);
/**
* Return information about all accounts that
* were loaded by #TALER_EXCHANGEDB_load_accounts().
*
* @param cb callback to invoke
* @param cb_cls closure for @a cb
*/
void
TALER_EXCHANGEDB_find_accounts (TALER_EXCHANGEDB_AccountCallback cb,
void *cb_cls);
/**
* Find the wire plugin for the given payto:// URL.
* Only useful after the accounts have been loaded
* using #TALER_EXCHANGEDB_load_accounts().
*
* @param method wire method we need an account for
* @return NULL on error
*/
const struct TALER_EXCHANGEDB_AccountInfo *
TALER_EXCHANGEDB_find_account_by_method (const char *method);
/**
* Find the wire plugin for the given payto:// URL
* Only useful after the accounts have been loaded
* using #TALER_EXCHANGEDB_load_accounts().
*
* @param url wire address we need an account for
* @return NULL on error
*/
const struct TALER_EXCHANGEDB_AccountInfo *
TALER_EXCHANGEDB_find_account_by_payto_uri (
const struct TALER_FullPayto url);
/**
* Options for #TALER_EXCHANGEDB_load_accounts()
*/
enum TALER_EXCHANGEDB_AccountLoaderOptions
{
TALER_EXCHANGEDB_ALO_NONE = 0,
/**
* Load accounts enabled for DEBITs.
*/
TALER_EXCHANGEDB_ALO_DEBIT = 1,
/**
* Load accounts enabled for CREDITs.
*/
TALER_EXCHANGEDB_ALO_CREDIT = 2,
/**
* Load authentication data from the
* "taler-accountcredentials-" section
* to access the account at the bank.
*/
TALER_EXCHANGEDB_ALO_AUTHDATA = 4
};
/**
* Load account information opf the exchange from
* @a cfg.
*
* @param cfg configuration to load from
* @param options loader options
* @return #GNUNET_OK on success, #GNUNET_NO if no accounts are configured
*/
enum GNUNET_GenericReturnValue
TALER_EXCHANGEDB_load_accounts (
const struct GNUNET_CONFIGURATION_Handle *cfg,
enum TALER_EXCHANGEDB_AccountLoaderOptions options);
/**
* Free resources allocated by
* #TALER_EXCHANGEDB_load_accounts().
*/
void
TALER_EXCHANGEDB_unload_accounts (void);
#endif
|
