ot_otapi_ot.hpp

Go to the documentation of this file.

/************************************************************
 *
 *  ot_otapi_ot.hpp
 *
 */

/************************************************************
 -----BEGIN PGP SIGNED MESSAGE-----
 Hash: SHA1

 *                 OPEN TRANSACTIONS
 *
 *       Financial Cryptography and Digital Cash
 *       Library, Protocol, API, Server, CLI, GUI
 *
 *       -- Anonymous Numbered Accounts.
 *       -- Untraceable Digital Cash.
 *       -- Triple-Signed Receipts.
 *       -- Cheques, Vouchers, Transfers, Inboxes.
 *       -- Basket Currencies, Markets, Payment Plans.
 *       -- Signed, XML, Ricardian-style Contracts.
 *       -- Scripted smart contracts.
 *
 *  Copyright (C) 2010-2013 by "Fellow Traveler" (A pseudonym)
 *
 *  EMAIL:
 *  [email protected]
 *
 *  BITCOIN:  1NtTPVVjDsUfDWybS4BwvHpG2pdS9RnYyQ
 *
 *  KEY FINGERPRINT (PGP Key in license file):
 *  9DD5 90EB 9292 4B48 0484  7910 0308 00ED F951 BB8E
 *
 *  OFFICIAL PROJECT WIKI(s):
 *  https://github.com/FellowTraveler/Moneychanger
 *  https://github.com/FellowTraveler/Open-Transactions/wiki
 *
 *  WEBSITE:
 *  http://www.OpenTransactions.org/
 *
 *  Components and licensing:
 *   -- Moneychanger..A Java client GUI.....LICENSE:.....GPLv3
 *   -- otlib.........A class library.......LICENSE:...LAGPLv3
 *   -- otapi.........A client API..........LICENSE:...LAGPLv3
 *   -- opentxs/ot....Command-line client...LICENSE:...LAGPLv3
 *   -- otserver......Server Application....LICENSE:....AGPLv3
 *  Github.com/FellowTraveler/Open-Transactions/wiki/Components
 *
 *  All of the above OT components were designed and written by
 *  Fellow Traveler, with the exception of Moneychanger, which
 *  was contracted out to Vicky C ([email protected]).
 *  The open-source community has since actively contributed.
 *
 *  -----------------------------------------------------
 *
 *   LICENSE:
 *   This program is free software: you can redistribute it
 *   and/or modify it under the terms of the GNU Affero
 *   General Public License as published by the Free Software
 *   Foundation, either version 3 of the License, or (at your
 *   option) any later version.
 *
 *   ADDITIONAL PERMISSION under the GNU Affero GPL version 3
 *   section 7: (This paragraph applies only to the LAGPLv3
 *   components listed above.) If you modify this Program, or
 *   any covered work, by linking or combining it with other
 *   code, such other code is not for that reason alone subject
 *   to any of the requirements of the GNU Affero GPL version 3.
 *   (==> This means if you are only using the OT API, then you
 *   don't have to open-source your code--only your changes to
 *   Open-Transactions itself must be open source. Similar to
 *   LGPLv3, except it applies to software-as-a-service, not
 *   just to distributing binaries.)
 *
 *   Extra WAIVER for OpenSSL, Lucre, and all other libraries
 *   used by Open Transactions: This program is released under
 *   the AGPL with the additional exemption that compiling,
 *   linking, and/or using OpenSSL is allowed. The same is true
 *   for any other open source libraries included in this
 *   project: complete waiver from the AGPL is hereby granted to
 *   compile, link, and/or use them with Open-Transactions,
 *   according to their own terms, as long as the rest of the
 *   Open-Transactions terms remain respected, with regard to
 *   the Open-Transactions code itself.
 *
 *   Lucre License:
 *   This code is also "dual-license", meaning that Ben Lau-
 *   rie's license must also be included and respected, since
 *   the code for Lucre is also included with Open Transactions.
 *   See Open-Transactions/src/otlib/lucre/LUCRE_LICENSE.txt
 *   The Laurie requirements are light, but if there is any
 *   problem with his license, simply remove the Lucre code.
 *   Although there are no other blind token algorithms in Open
 *   Transactions (yet. credlib is coming), the other functions
 *   will continue to operate.
 *   See Lucre on Github:  https://github.com/benlaurie/lucre
 *   -----------------------------------------------------
 *   You should have received a copy of the GNU Affero General
 *   Public License along with this program.  If not, see:
 *   http://www.gnu.org/licenses/
 *
 *   If you would like to use this software outside of the free
 *   software license, please contact FellowTraveler.
 *   (Unfortunately many will run anonymously and untraceably,
 *   so who could really stop them?)
 *
 *   DISCLAIMER:
 *   This program 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 Affero General Public License for
 *   more details.

 -----BEGIN PGP SIGNATURE-----
 Version: GnuPG v1.4.9 (Darwin)

 iQIcBAEBAgAGBQJRSsfJAAoJEAMIAO35UbuOQT8P/RJbka8etf7wbxdHQNAY+2cC
 vDf8J3X8VI+pwMqv6wgTVy17venMZJa4I4ikXD/MRyWV1XbTG0mBXk/7AZk7Rexk
 KTvL/U1kWiez6+8XXLye+k2JNM6v7eej8xMrqEcO0ZArh/DsLoIn1y8p8qjBI7+m
 aE7lhstDiD0z8mwRRLKFLN2IH5rAFaZZUvj5ERJaoYUKdn4c+RcQVei2YOl4T0FU
 LWND3YLoH8naqJXkaOKEN4UfJINCwxhe5Ke9wyfLWLUO7NamRkWD2T7CJ0xocnD1
 sjAzlVGNgaFDRflfIF4QhBx1Ddl6wwhJfw+d08bjqblSq8aXDkmFA7HeunSFKkdn
 oIEOEgyj+veuOMRJC5pnBJ9vV+7qRdDKQWaCKotynt4sWJDGQ9kWGWm74SsNaduN
 TPMyr9kNmGsfR69Q2Zq/FLcLX/j8ESxU+HYUB4vaARw2xEOu2xwDDv6jt0j3Vqsg
 x7rWv4S/Eh18FDNDkVRChiNoOIilLYLL6c38uMf1pnItBuxP3uhgY6COm59kVaRh
 nyGTYCDYD2TK+fI9o89F1297uDCwEJ62U0Q7iTDp5QuXCoxkPfv8/kX6lS6T3y9G
 M9mqIoLbIQ1EDntFv7/t6fUTS2+46uCrdZWbQ5RjYXdrzjij02nDmJAm2BngnZvd
 kamH0Y/n11lCvo1oQxM+
 =uSzz
 -----END PGP SIGNATURE-----
 **************************************************************/

#ifndef OPENTXS_CLIENT_OT_OTAPI_OT_HPP
#define OPENTXS_CLIENT_OT_OTAPI_OT_HPP

#include "opentxs/client/OTAPI.hpp"
#include "opentxs/client/OT_ME.hpp"
#include "opentxs/core/OTStorage.hpp"

#ifndef OT_USE_CXX11
#include <cstdlib>
#endif

#define OT_OTAPI_OT

class the_lambda_struct;

typedef std::map<std::string, opentxs::OTDB::OfferDataNym*> SubMap;
typedef std::map<std::string, SubMap*> MapOfMaps;
typedef int32_t (*LambdaFunc)(const opentxs::OTDB::OfferDataNym& offer_data,
                              int32_t nIndex, const MapOfMaps& map_of_maps,
                              const SubMap& sub_map,
                              the_lambda_struct& extra_vals);

EXPORT OT_OTAPI_OT MapOfMaps* convert_offerlist_to_maps(
    opentxs::OTDB::OfferListNym& offerList);
EXPORT OT_OTAPI_OT int32_t find_strange_offers(
    const opentxs::OTDB::OfferDataNym& offer_data, int32_t nIndex,
    const MapOfMaps& map_of_maps, const SubMap& sub_map,
    the_lambda_struct& extra_vals); // if 10 offers are printed
                                    // for the SAME market,
                                    // nIndex will be 0..9
EXPORT OT_OTAPI_OT int32_t
    iterate_nymoffers_maps(MapOfMaps& map_of_maps,
                           LambdaFunc the_lambda); // low level. map_of_maps
                                                   // must be
                                                   // good. (assumed.)
EXPORT OT_OTAPI_OT int32_t
    iterate_nymoffers_maps(MapOfMaps& map_of_maps, LambdaFunc the_lambda,
                           the_lambda_struct& extra_vals); // low level.
                                                           // map_of_maps
                                                           // must be good.
                                                           // (assumed.)

EXPORT OT_OTAPI_OT int32_t
    iterate_nymoffers_sub_map(const MapOfMaps& map_of_maps, SubMap& sub_map,
                              LambdaFunc the_lambda);

EXPORT OT_OTAPI_OT int32_t
    iterate_nymoffers_sub_map(const MapOfMaps& map_of_maps, SubMap& sub_map,
                              LambdaFunc the_lambda,
                              the_lambda_struct& extra_vals);

EXPORT OT_OTAPI_OT opentxs::OTDB::OfferListNym* loadNymOffers(
    const std::string& serverID, const std::string& nymID);
EXPORT OT_OTAPI_OT int32_t output_nymoffer_data(
    const opentxs::OTDB::OfferDataNym& offer_data, int32_t nIndex,
    const MapOfMaps& map_of_maps, const SubMap& sub_map,
    the_lambda_struct& extra_vals); // if 10 offers are printed
                                    // for the SAME market,
                                    // nIndex will be 0..9

extern std::string Args;
extern std::string HisAcct;
extern std::string HisNym;
extern std::string HisPurse;
extern std::string MyAcct;
extern std::string MyNym;
extern std::string MyPurse;
extern std::string Server;

typedef enum {
    NO_FUNC = 0,
    CREATE_USER_ACCT = 1,
    DELETE_USER_ACCT = 2,
    CHECK_USER = 3,
    SEND_USER_MESSAGE = 4,
    SEND_USER_INSTRUMENT = 5,
    ISSUE_ASSET_TYPE = 6,
    ISSUE_BASKET = 7,
    CREATE_ASSET_ACCT = 8,
    DELETE_ASSET_ACCT = 9,
    ACTIVATE_SMART_CONTRACT = 10,
    TRIGGER_CLAUSE = 11,
    PROCESS_INBOX = 12,
    EXCHANGE_BASKET = 13,
    DEPOSIT_CASH = 14,
    EXCHANGE_CASH = 15,
    DEPOSIT_CHEQUE = 16,
    WITHDRAW_VOUCHER = 17,
    PAY_DIVIDEND = 18,
    WITHDRAW_CASH = 19,
    GET_CONTRACT = 20,
    SEND_TRANSFER = 21,
    GET_MARKET_LIST = 22,
    CREATE_MARKET_OFFER = 23,
    KILL_MARKET_OFFER = 24,
    KILL_PAYMENT_PLAN = 25,
    DEPOSIT_PAYMENT_PLAN = 26,
    GET_NYM_MARKET_OFFERS = 27,
    GET_MARKET_OFFERS = 28,
    GET_MARKET_RECENT_TRADES = 29,
    GET_MINT = 30,
    QUERY_ASSET_TYPES = 31,
    GET_BOX_RECEIPT = 32,
    ADJUST_USAGE_CREDITS = 33,
} OTAPI_Func_Type;

class the_lambda_struct
{
public:
    std::vector<std::string> the_vector; // used for returning a list of
                                         // something.
    std::string the_asset_acct;    // for newoffer, we want to remove existing
                                   // offers
                                   // for the same accounts in certain cases.
    std::string the_currency_acct; // for newoffer, we want to remove existing
                                   // offers
                                   // for the same accounts in certain cases.
    std::string the_scale;         // for newoffer as well.
    std::string the_price;         // for newoffer as well.
    bool bSelling;                 // for newoffer as well.

    the_lambda_struct();
};

class OTAPI_Func
{
public:
    OTAPI_Func_Type funcType;
    std::string serverID;
    std::string nymID;
    std::string nymID2;
    std::string assetID;
    std::string assetID2;
    std::string accountID;
    std::string accountID2;
    std::string basket;
    std::string strData;
    std::string strData2;
    std::string strData3;
    std::string strData4;
    std::string strData5;
    bool bBool;
    int32_t nData;
    int64_t lData;
    time64_t tData;
    int32_t nTransNumsNeeded;
    int32_t nRequestNum;

    OTAPI_Func();
    OTAPI_Func(OTAPI_Func_Type theType, const std::string& p_serverID,
               const std::string& p_nymID); // 3 args
    OTAPI_Func(OTAPI_Func_Type theType, const std::string& p_serverID,
               const std::string& p_nymID,
               const std::string& p_strParam); // 4 args
    OTAPI_Func(OTAPI_Func_Type theType, const std::string& p_serverID,
               const std::string& p_nymID, const std::string& p_strParam,
               int64_t p_lData); // 5 args
    OTAPI_Func(OTAPI_Func_Type theType, const std::string& p_serverID,
               const std::string& p_nymID, const std::string& p_strParam,
               const std::string& p_strData); // 5 args
    OTAPI_Func(OTAPI_Func_Type theType, const std::string& p_serverID,
               const std::string& p_nymID, const std::string& p_nymID2,
               const std::string& p_strData,
               const std::string& p_strData2); // 6 args
    OTAPI_Func(OTAPI_Func_Type theType, const std::string& p_serverID,
               const std::string& p_nymID, const std::string& p_accountID,
               const std::string& p_strParam, int64_t p_lData,
               const std::string& p_strData2); // 7 args
    OTAPI_Func(OTAPI_Func_Type theType, const std::string& p_serverID,
               const std::string& p_nymID, const std::string& p_accountID,
               const std::string& p_strParam, const std::string& p_strData,
               int64_t p_lData2); // 7 args
    OTAPI_Func(OTAPI_Func_Type theType, const std::string& p_serverID,
               const std::string& p_nymID, const std::string& p_accountID,
               const std::string& p_strParam, const std::string& p_strData,
               const std::string& p_strData2); // 7 args
    OTAPI_Func(OTAPI_Func_Type theType, const std::string& p_serverID,
               const std::string& p_nymID, const std::string& p_assetID,
               const std::string& p_basket, const std::string& p_accountID,
               bool p_bBool, int32_t p_nTransNumsNeeded); // 8 args
    OTAPI_Func(OTAPI_Func_Type theType, const std::string& p_serverID,
               const std::string& p_nymID, const std::string& assetAccountID,
               const std::string& currencyAcctID, const std::string& scale,
               const std::string& minIncrement, const std::string& quantity,
               const std::string& price, bool bSelling); // 10 args
    ~OTAPI_Func();

    EXPORT OT_OTAPI_OT static void CopyVariables();
    OT_OTAPI_OT void InitCustom();
    OT_OTAPI_OT int32_t Run() const;
    OT_OTAPI_OT std::string SendRequest(OTAPI_Func& theFunction,
                                        const std::string& IN_FUNCTION) const;
    OT_OTAPI_OT int32_t
        SendRequestLowLevel(OTAPI_Func& theFunction,
                            const std::string& IN_FUNCTION) const;
    OT_OTAPI_OT std::string SendRequestOnce(OTAPI_Func& theFunction,
                                            const std::string& IN_FUNCTION,
                                            bool bIsTransaction,
                                            bool bWillRetryAfterThis,
                                            bool& bCanRetryAfterThis) const;
    OT_OTAPI_OT std::string SendTransaction(OTAPI_Func& theFunction,
                                            const std::string& IN_FUNCTION);
    OT_OTAPI_OT std::string SendTransaction(OTAPI_Func& theFunction,
                                            const std::string& IN_FUNCTION,
                                            int32_t nTotalRetries) const;
};

#endif // OPENTXS_CLIENT_OT_OTAPI_OT_HPP