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
|
/*
This file is part of TALER
(C) 2016-2021 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_fakebank_lib.h
* @brief API for a library that fakes being a Taler bank
* @author Christian Grothoff <christian@grothoff.org>
*/
#ifndef TALER_FAKEBANK_H
#define TALER_FAKEBANK_H
#include "taler_util.h"
#include <gnunet/gnunet_json_lib.h>
#include "taler_json_lib.h"
#include <microhttpd.h>
/**
* Handle for the fake bank.
*/
struct TALER_FAKEBANK_Handle;
/**
* Start the fake bank. The fake bank will, like the normal bank, listen for
* requests for /admin/add/incoming and /transfer. However, instead of
* executing or storing those requests, it will simply allow querying whether
* such a request has been made via #TALER_FAKEBANK_check_debit() and
* #TALER_FAKEBANK_check_credit() as well as the history API.
*
* This is useful for writing testcases to check whether the exchange
* would have issued the correct wire transfer orders.
*
* @param port port to listen to
* @param currency which currency should the bank offer
* @return NULL on error
*/
struct TALER_FAKEBANK_Handle *
TALER_FAKEBANK_start (uint16_t port,
const char *currency);
/**
* Start the fake bank. The fake bank will, like the normal bank, listen for
* requests for /admin/add/incoming and /transfer. However, instead of
* executing or storing those requests, it will simply allow querying whether
* such a request has been made via #TALER_FAKEBANK_check_debit() and
* #TALER_FAKEBANK_check_credit() as well as the history API.
*
* This is useful for writing testcases to check whether the exchange
* would have issued the correct wire transfer orders.
*
* @param port port to listen to
* @param currency which currency should the bank offer
* @param ram_limit how much memory do we use at most
* @param num_threads size of the thread pool, 0 to use the GNUnet scheduler
* @return NULL on error
*/
struct TALER_FAKEBANK_Handle *
TALER_FAKEBANK_start2 (uint16_t port,
const char *currency,
uint64_t ram_limit,
unsigned int num_threads);
/**
* Start the fake bank. The fake bank will, like the normal bank, listen for
* requests for /admin/add/incoming and /transfer. However, instead of
* executing or storing those requests, it will simply allow querying whether
* such a request has been made via #TALER_FAKEBANK_check_debit() and
* #TALER_FAKEBANK_check_credit() as well as the history API.
*
* This is useful for writing testcases to check whether the exchange
* would have issued the correct wire transfer orders.
*
* @param hostname hostname to use in URLs and URIs.
* @param port port to listen to
* @param exchange_url suggested exchange base URL
* @param currency which currency should the bank offer
* @param ram_limit how much memory do we use at most
* @param num_threads size of the thread pool, 0 to use the GNUnet scheduler
* @return NULL on error
*/
struct TALER_FAKEBANK_Handle *
TALER_FAKEBANK_start3 (const char *hostname,
uint16_t port,
const char *exchange_url,
const char *currency,
uint64_t ram_limit,
unsigned int num_threads);
/**
* Check that no wire transfers were ordered (or at least none
* that have not been taken care of via #TALER_FAKEBANK_check_debit()
* or #TALER_FAKEBANK_check_credit()).
* If any transactions are onrecord, return #GNUNET_SYSERR.
*
* Note that this function only works in
* single-threaded mode while nothing else is happening.
*
* @param h bank instance
* @return #GNUNET_OK on success
*/
enum GNUNET_GenericReturnValue
TALER_FAKEBANK_check_empty (struct TALER_FAKEBANK_Handle *h);
/**
* Check that the @a want_amount was transferred from the @a
* want_debit to the @a want_credit account. If so, set the @a subject
* to the transfer identifier and remove the transaction from the
* list. If the transaction was not recorded, return #GNUNET_SYSERR.
*
* Note that this function only works in
* single-threaded mode while nothing else is happening.
*
* @param h bank instance
* @param want_amount transfer amount desired
* @param want_debit account that should have been debited
* @param want_credit account that should have been credited
* @param exchange_base_url expected base URL of the exchange,
* i.e. "https://example.com/"; may include a port
* @param[out] wtid set to the wire transfer identifier
* @return #GNUNET_OK on success
*/
enum GNUNET_GenericReturnValue
TALER_FAKEBANK_check_debit (struct TALER_FAKEBANK_Handle *h,
const struct TALER_Amount *want_amount,
const char *want_debit,
const char *want_credit,
const char *exchange_base_url,
struct TALER_WireTransferIdentifierRawP *wtid);
/**
* Check that the @a want_amount was transferred from the @a want_debit to the
* @a want_credit account with the @a subject. If so, remove the transaction
* from the list. If the transaction was not recorded, return #GNUNET_SYSERR.
*
* Note that this function only works in
* single-threaded mode while nothing else is happening.
*
* @param h bank instance
* @param want_amount transfer amount desired
* @param want_debit account that should have been debited
* @param want_credit account that should have been credited
* @param reserve_pub reserve public key expected in wire subject
* @return #GNUNET_OK on success
*/
enum GNUNET_GenericReturnValue
TALER_FAKEBANK_check_credit (struct TALER_FAKEBANK_Handle *h,
const struct TALER_Amount *want_amount,
const char *want_debit,
const char *want_credit,
const struct TALER_ReservePublicKeyP *reserve_pub);
/**
* Stop running the fake bank.
*
* @param h bank to stop
*/
void
TALER_FAKEBANK_stop (struct TALER_FAKEBANK_Handle *h);
#endif
|
