Open-Transactions  0.93.0-ge03d287
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Transactor.hpp
Go to the documentation of this file.
1 /************************************************************
2  *
3  * Transactor.hpp
4  *
5  */
6 
7 /************************************************************
8  -----BEGIN PGP SIGNED MESSAGE-----
9  Hash: SHA1
10 
11  * OPEN TRANSACTIONS
12  *
13  * Financial Cryptography and Digital Cash
14  * Library, Protocol, API, Server, CLI, GUI
15  *
16  * -- Anonymous Numbered Accounts.
17  * -- Untraceable Digital Cash.
18  * -- Triple-Signed Receipts.
19  * -- Cheques, Vouchers, Transfers, Inboxes.
20  * -- Basket Currencies, Markets, Payment Plans.
21  * -- Signed, XML, Ricardian-style Contracts.
22  * -- Scripted smart contracts.
23  *
24  * Copyright (C) 2010-2013 by "Fellow Traveler" (A pseudonym)
25  *
26  * EMAIL:
28  *
29  * BITCOIN: 1NtTPVVjDsUfDWybS4BwvHpG2pdS9RnYyQ
30  *
31  * KEY FINGERPRINT (PGP Key in license file):
32  * 9DD5 90EB 9292 4B48 0484 7910 0308 00ED F951 BB8E
33  *
34  * OFFICIAL PROJECT WIKI(s):
35  * https://github.com/FellowTraveler/Moneychanger
36  * https://github.com/FellowTraveler/Open-Transactions/wiki
37  *
38  * WEBSITE:
39  * http://www.OpenTransactions.org/
40  *
41  * Components and licensing:
42  * -- Moneychanger..A Java client GUI.....LICENSE:.....GPLv3
43  * -- otlib.........A class library.......LICENSE:...LAGPLv3
44  * -- otapi.........A client API..........LICENSE:...LAGPLv3
45  * -- opentxs/ot....Command-line client...LICENSE:...LAGPLv3
46  * -- otserver......Server Application....LICENSE:....AGPLv3
47  * Github.com/FellowTraveler/Open-Transactions/wiki/Components
48  *
49  * All of the above OT components were designed and written by
50  * Fellow Traveler, with the exception of Moneychanger, which
51  * was contracted out to Vicky C ([email protected]).
52  * The open-source community has since actively contributed.
53  *
54  * -----------------------------------------------------
55  *
56  * LICENSE:
57  * This program is free software: you can redistribute it
58  * and/or modify it under the terms of the GNU Affero
59  * General Public License as published by the Free Software
60  * Foundation, either version 3 of the License, or (at your
61  * option) any later version.
62  *
63  * ADDITIONAL PERMISSION under the GNU Affero GPL version 3
64  * section 7: (This paragraph applies only to the LAGPLv3
65  * components listed above.) If you modify this Program, or
66  * any covered work, by linking or combining it with other
67  * code, such other code is not for that reason alone subject
68  * to any of the requirements of the GNU Affero GPL version 3.
69  * (==> This means if you are only using the OT API, then you
70  * don't have to open-source your code--only your changes to
71  * Open-Transactions itself must be open source. Similar to
72  * LGPLv3, except it applies to software-as-a-service, not
73  * just to distributing binaries.)
74  *
75  * Extra WAIVER for OpenSSL, Lucre, and all other libraries
76  * used by Open Transactions: This program is released under
77  * the AGPL with the additional exemption that compiling,
78  * linking, and/or using OpenSSL is allowed. The same is true
79  * for any other open source libraries included in this
80  * project: complete waiver from the AGPL is hereby granted to
81  * compile, link, and/or use them with Open-Transactions,
82  * according to their own terms, as long as the rest of the
83  * Open-Transactions terms remain respected, with regard to
84  * the Open-Transactions code itself.
85  *
86  * Lucre License:
87  * This code is also "dual-license", meaning that Ben Lau-
88  * rie's license must also be included and respected, since
89  * the code for Lucre is also included with Open Transactions.
90  * See Open-Transactions/src/otlib/lucre/LUCRE_LICENSE.txt
91  * The Laurie requirements are light, but if there is any
92  * problem with his license, simply remove the Lucre code.
93  * Although there are no other blind token algorithms in Open
94  * Transactions (yet. credlib is coming), the other functions
95  * will continue to operate.
96  * See Lucre on Github: https://github.com/benlaurie/lucre
97  * -----------------------------------------------------
98  * You should have received a copy of the GNU Affero General
99  * Public License along with this program. If not, see:
100  * http://www.gnu.org/licenses/
101  *
102  * If you would like to use this software outside of the free
103  * software license, please contact FellowTraveler.
104  * (Unfortunately many will run anonymously and untraceably,
105  * so who could really stop them?)
106  *
107  * DISCLAIMER:
108  * This program is distributed in the hope that it will be
109  * useful, but WITHOUT ANY WARRANTY; without even the implied
110  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
111  * PURPOSE. See the GNU Affero General Public License for
112  * more details.
113 
114  -----BEGIN PGP SIGNATURE-----
115  Version: GnuPG v1.4.9 (Darwin)
116 
117  iQIcBAEBAgAGBQJRSsfJAAoJEAMIAO35UbuOQT8P/RJbka8etf7wbxdHQNAY+2cC
118  vDf8J3X8VI+pwMqv6wgTVy17venMZJa4I4ikXD/MRyWV1XbTG0mBXk/7AZk7Rexk
119  KTvL/U1kWiez6+8XXLye+k2JNM6v7eej8xMrqEcO0ZArh/DsLoIn1y8p8qjBI7+m
120  aE7lhstDiD0z8mwRRLKFLN2IH5rAFaZZUvj5ERJaoYUKdn4c+RcQVei2YOl4T0FU
121  LWND3YLoH8naqJXkaOKEN4UfJINCwxhe5Ke9wyfLWLUO7NamRkWD2T7CJ0xocnD1
122  sjAzlVGNgaFDRflfIF4QhBx1Ddl6wwhJfw+d08bjqblSq8aXDkmFA7HeunSFKkdn
123  oIEOEgyj+veuOMRJC5pnBJ9vV+7qRdDKQWaCKotynt4sWJDGQ9kWGWm74SsNaduN
124  TPMyr9kNmGsfR69Q2Zq/FLcLX/j8ESxU+HYUB4vaARw2xEOu2xwDDv6jt0j3Vqsg
125  x7rWv4S/Eh18FDNDkVRChiNoOIilLYLL6c38uMf1pnItBuxP3uhgY6COm59kVaRh
126  nyGTYCDYD2TK+fI9o89F1297uDCwEJ62U0Q7iTDp5QuXCoxkPfv8/kX6lS6T3y9G
127  M9mqIoLbIQ1EDntFv7/t6fUTS2+46uCrdZWbQ5RjYXdrzjij02nDmJAm2BngnZvd
128  kamH0Y/n11lCvo1oQxM+
129  =uSzz
130  -----END PGP SIGNATURE-----
131 **************************************************************/
132 
133 #ifndef OPENTXS_SERVER_TRANSACTOR_HPP
134 #define OPENTXS_SERVER_TRANSACTOR_HPP
135 
137 #include <string>
138 #include <map>
139 #include <memory>
140 #include <cstdint>
141 
142 namespace opentxs
143 {
144 
145 class Mint;
146 class OTServer;
147 class OTPseudonym;
148 class OTAssetContract;
149 class OTIdentifier;
150 class OTAccount;
151 class MainFile;
152 
154 {
155  friend class MainFile;
156 
157 public:
158  explicit Transactor(OTServer* server);
159  ~Transactor();
160 
161  bool issueNextTransactionNumber(OTPseudonym& nym, int64_t& txNumber,
162  bool storeNumber = true);
164  const int64_t& transactionNumber);
166  const int64_t& transactionNumber,
167  bool save = false);
168  bool removeIssuedNumber(OTPseudonym& nym, const int64_t& transactionNumber,
169  bool save = false);
170 
171  int64_t transactionNumber() const
172  {
173  return transactionNumber_;
174  }
175 
176  void transactionNumber(int64_t value)
177  {
178  transactionNumber_ = value;
179  }
180 
181  // When a user uploads an asset contract, the server adds it to the list
182  // (and verifies the user's key against the
183  // contract.) This way the server has a directory with all the asset
184  // contracts that it supports, saved by their ID.
185  // As long as the IDs are in the server file, it can look them up.
186  // When a new asset type is added, a new Mint is added as well. It goes into
187  // the mints folder.
188  bool addAssetContract(OTAssetContract& contract);
190 
191  bool addBasketAccountID(const OTIdentifier& basketId,
192  const OTIdentifier& basketAccountId,
193  const OTIdentifier& basketContractId);
194  bool lookupBasketAccountID(const OTIdentifier& basketId,
195  OTIdentifier& basketAccountId);
196 
197  bool lookupBasketAccountIDByContractID(const OTIdentifier& basketContractId,
198  OTIdentifier& basketAccountId);
199  bool lookupBasketContractIDByAccountID(const OTIdentifier& basketAccountId,
200  OTIdentifier& basketContractId);
201 
202  // Whenever the server issues a voucher (like a cashier's cheque), it puts
203  // the funds in one
204  // of these voucher accounts (one for each asset type ID). Then it issues
205  // the cheque from the
206  // same account.
207  // TODO: also should save the cheque itself to a folder, where the folder is
208  // named based on the date
209  // that the cheque will expire. This way, the server operator can go back
210  // later, or have a script,
211  // to retrieve the cheques from the expired folders, and total them. The
212  // server operator is free to
213  // remove that total from the Voucher Account once the cheque has expired:
214  // it is his money now.
215  std::shared_ptr<OTAccount> getVoucherAccount(
216  const OTIdentifier& assetTypeId);
217 
218  // Each asset contract has its own series of Mints
219  Mint* getMint(const OTIdentifier& assetTypeId, int32_t seriesCount);
220 
221 private:
222  // Why does the map of mints use multimap instead of map?
223  // Because there might be multiple valid mints for the same asset type.
224  // Perhaps I am redeeming tokens from the previous series, which have not
225  // yet expired.
226  // Only tokens from the new series are being issued today, but tokens from
227  // the previous series are still good until their own expiration date, which
228  // is coming up soon.
229  // Therefore the server manages different mints for the same asset type, and
230  // since the asset type is the key in the multimap, we don't want to
231  // accidentally remove one from the list every time another is added. Thus
232  // multimap is employed.
233  typedef std::multimap<std::string, Mint*> MintsMap;
234  typedef std::map<std::string, OTAssetContract*> ContractsMap;
235  typedef std::map<std::string, std::string> BasketsMap;
236 
237 private:
238  // This stores the last VALID AND ISSUED transaction number.
239  int64_t transactionNumber_;
240  // The asset types supported by this server.
241  ContractsMap contractsMap_;
242  // maps basketId with basketAccountId
243  BasketsMap idToBasketMap_;
244  // basket issuer account ID, which is *different* on each server, using the
245  // Basket Currency's ID, which is the *same* on every server.)
246  // Need a way to look up a Basket Account ID using its Contract ID
247  BasketsMap contractIdToBasketAccountId_;
248  // The list of voucher accounts (see GetVoucherAccount below for details)
249  AccountList voucherAccounts_;
250  // The mints for each asset type.
251  MintsMap mintsMap_;
252 
253  OTServer* server_; // TODO: remove later when feasible
254 };
255 
256 } // namespace opentxs
257 
258 #endif // OPENTXS_SERVER_TRANSACTOR_HPP
bool lookupBasketContractIDByAccountID(const OTIdentifier &basketAccountId, OTIdentifier &basketContractId)
Definition: Transactor.cpp:484
bool lookupBasketAccountIDByContractID(const OTIdentifier &basketContractId, OTIdentifier &basketAccountId)
Definition: Transactor.cpp:457
bool issueNextTransactionNumber(OTPseudonym &nym, int64_t &txNumber, bool storeNumber=true)
Definition: Transactor.cpp:211
void transactionNumber(int64_t value)
Definition: Transactor.hpp:176
bool verifyTransactionNumber(OTPseudonym &nym, const int64_t &transactionNumber)
Definition: Transactor.cpp:278
int64_t transactionNumber() const
Definition: Transactor.hpp:171
Transactor(OTServer *server)
Definition: Transactor.cpp:148
bool lookupBasketAccountID(const OTIdentifier &basketId, OTIdentifier &basketAccountId)
Definition: Transactor.cpp:511
std::shared_ptr< OTAccount > getVoucherAccount(const OTIdentifier &assetTypeId)
Definition: Transactor.cpp:536
bool removeTransactionNumber(OTPseudonym &nym, const int64_t &transactionNumber, bool save=false)
Definition: Transactor.cpp:320
Mint * getMint(const OTIdentifier &assetTypeId, int32_t seriesCount)
Lookup the current mint for any given asset type ID and series.
Definition: Transactor.cpp:565
bool removeIssuedNumber(OTPseudonym &nym, const int64_t &transactionNumber, bool save=false)
Definition: Transactor.cpp:354
bool addAssetContract(OTAssetContract &contract)
Definition: Transactor.cpp:411
OTAssetContract * getAssetContract(const OTIdentifier &id)
Definition: Transactor.cpp:394
bool addBasketAccountID(const OTIdentifier &basketId, const OTIdentifier &basketAccountId, const OTIdentifier &basketContractId)
Definition: Transactor.cpp:432