ot_made_easy_ot.hpp

Go to the documentation of this file.

/************************************************************
 *
 *  ot_made_easy_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_MADE_EASY_OT_HPP
#define OPENTXS_CLIENT_OT_MADE_EASY_OT_HPP

#include "opentxs/core/util/Common.hpp"

#include <vector>

#define OT_MADE_EASY_OT

namespace opentxs
{

class MadeEasy
{
private:
    // do not allow construction
    MadeEasy()
    {
    }
    ~MadeEasy()
    {
    }

public:
    EXPORT OT_MADE_EASY_OT static std::string activate_smart_contract(
        const std::string& SERVER_ID, const std::string& NYM_ID,
        const std::string& ACCT_ID, const std::string& AGENT_NAME,
        const std::string& THE_SMART_CONTRACT);
    EXPORT OT_MADE_EASY_OT static std::string adjust_usage_credits(
        const std::string& SERVER_ID, const std::string& USER_NYM_ID,
        const std::string& TARGET_NYM_ID, const std::string& ADJUSTMENT);
    EXPORT OT_MADE_EASY_OT static std::string cancel_payment_plan(
        const std::string& SERVER_ID, const std::string& NYM_ID,
        const std::string& THE_PAYMENT_PLAN);
    EXPORT OT_MADE_EASY_OT static std::string check_user(
        const std::string& SERVER_ID, const std::string& NYM_ID,
        const std::string& TARGET_NYM_ID);
    EXPORT OT_MADE_EASY_OT static std::string create_asset_acct(
        const std::string& SERVER_ID, const std::string& NYM_ID,
        const std::string& ASSET_TYPE_ID);
    EXPORT OT_MADE_EASY_OT static std::string create_market_offer(
        const std::string& ASSET_ACCT_ID, const std::string& CURRENCY_ACCT_ID,
        const std::string& scale, const std::string& minIncrement,
        const std::string& quantity, const std::string& price, bool bSelling,
        const std::string& strLifespanInSeconds, const std::string& strStopSign,
        const std::string& strActivationPrice);
    EXPORT OT_MADE_EASY_OT static std::string create_nym(
        int32_t nKeybits, const std::string& strNymIDSource,
        const std::string& strAltLocation);
    EXPORT OT_MADE_EASY_OT static std::string deposit_cheque(
        const std::string& SERVER_ID, const std::string& NYM_ID,
        const std::string& ACCT_ID, const std::string& STR_CHEQUE);
    EXPORT OT_MADE_EASY_OT static std::string deposit_payment_plan(
        const std::string& SERVER_ID, const std::string& NYM_ID,
        const std::string& THE_PAYMENT_PLAN);
    EXPORT OT_MADE_EASY_OT static std::string deposit_purse(
        const std::string& SERVER_ID, const std::string& NYM_ID,
        const std::string& ACCT_ID, const std::string& STR_PURSE);
    EXPORT OT_MADE_EASY_OT static int32_t depositCashPurse(
        const std::string& serverID, const std::string& assetID,
        const std::string& nymID, const std::string& oldPurse,
        const std::vector<std::string>& selectedTokens,
        const std::string& accountID,
        bool bReimportIfFailure); // So we don't re-import a purse that
                                  // wasn't internal to begin with.
    EXPORT OT_MADE_EASY_OT static std::string exchange_basket_currency(
        const std::string& SERVER_ID, const std::string& NYM_ID,
        const std::string& ASSET_TYPE, const std::string& THE_BASKET,
        const std::string& ACCT_ID, bool IN_OR_OUT);
    EXPORT OT_MADE_EASY_OT static bool exchangeCashPurse(
        const std::string& serverID, const std::string& assetID,
        const std::string& nymID, std::string& oldPurse,
        const std::vector<std::string>& selectedTokens);
    EXPORT OT_MADE_EASY_OT static std::string exportCashPurse(
        const std::string& serverID, const std::string& assetID,
        const std::string& nymID, const std::string& oldPurse,
        const std::vector<std::string>& selectedTokens,
        std::string& recipientNymID, bool bPasswordProtected,
        std::string& strRetainedCopy);
    EXPORT OT_MADE_EASY_OT static std::string get_box_receipt(
        const std::string& SERVER_ID, const std::string& NYM_ID,
        const std::string& ACCT_ID, int32_t nBoxType,
        const std::string& STR_TRANS_NUM);
    EXPORT OT_MADE_EASY_OT static std::string get_market_list(
        const std::string& SERVER_ID, const std::string& NYM_ID);
    EXPORT OT_MADE_EASY_OT static std::string get_market_offers(
        const std::string& SERVER_ID, const std::string& NYM_ID,
        const std::string& MARKET_ID, int64_t MAX_DEPTH);
    EXPORT OT_MADE_EASY_OT static std::string get_market_recent_trades(
        const std::string& SERVER_ID, const std::string& NYM_ID,
        const std::string& MARKET_ID);
    EXPORT OT_MADE_EASY_OT static std::string get_nym_market_offers(
        const std::string& SERVER_ID, const std::string& NYM_ID);
    EXPORT OT_MADE_EASY_OT static std::string get_payment_instrument(
        const std::string& SERVER_ID, const std::string& NYM_ID, int32_t nIndex,
        const std::string& PRELOADED_INBOX); // PRELOADED_INBOX is optional.
    EXPORT OT_MADE_EASY_OT static bool importCashPurse(
        const std::string& serverID, const std::string& nymID,
        const std::string& assetID, std::string& userInput, bool isPurse);
    EXPORT OT_MADE_EASY_OT static bool insure_enough_nums(
        int32_t nNumberNeeded, const std::string& strMyServerID,
        const std::string& strMyNymID);
    EXPORT OT_MADE_EASY_OT static std::string issue_asset_type(
        const std::string& SERVER_ID, const std::string& NYM_ID,
        const std::string& THE_CONTRACT);
    EXPORT OT_MADE_EASY_OT static std::string issue_basket_currency(
        const std::string& SERVER_ID, const std::string& NYM_ID,
        const std::string& THE_BASKET);
    EXPORT OT_MADE_EASY_OT static std::string kill_market_offer(
        const std::string& SERVER_ID, const std::string& NYM_ID,
        const std::string& ASSET_ACCT_ID, const std::string& STR_TRANS_NUM);
    EXPORT OT_MADE_EASY_OT static std::string kill_payment_plan(
        const std::string& SERVER_ID, const std::string& NYM_ID,
        const std::string& ACCT_ID, const std::string& STR_TRANS_NUM);
    EXPORT OT_MADE_EASY_OT static std::string load_or_retrieve_contract(
        const std::string& SERVER_ID, const std::string& NYM_ID,
        const std::string& CONTRACT_ID);
    EXPORT OT_MADE_EASY_OT static std::string load_or_retrieve_encrypt_key(
        const std::string& SERVER_ID, const std::string& NYM_ID,
        const std::string& TARGET_NYM_ID);
    EXPORT OT_MADE_EASY_OT static std::string load_or_retrieve_mint(
        const std::string& SERVER_ID, const std::string& NYM_ID,
        const std::string& ASSET_ID);
    EXPORT OT_MADE_EASY_OT static std::string load_or_retrieve_signing_key(
        const std::string& SERVER_ID, const std::string& NYM_ID,
        const std::string& TARGET_NYM_ID);
    EXPORT OT_MADE_EASY_OT static std::string load_public_encryption_key(
        const std::string& NYM_ID); // from local storage.
    EXPORT OT_MADE_EASY_OT static std::string load_public_signing_key(
        const std::string& NYM_ID); // from local storage.
    EXPORT OT_MADE_EASY_OT static std::string pay_dividend(
        const std::string& SERVER_ID, const std::string& NYM_ID,
        const std::string& SOURCE_ACCT_ID, const std::string& SHARES_ASSET_ID,
        const std::string& STR_MEMO, int64_t AMOUNT_PER_SHARE);
    EXPORT OT_MADE_EASY_OT static std::string process_inbox(
        const std::string& SERVER_ID, const std::string& NYM_ID,
        const std::string& ACCOUNT_ID, const std::string& RESPONSE_LEDGER);
    EXPORT OT_MADE_EASY_OT static bool processCashPurse(
        std::string& newPurse, std::string& newPurseForSender,
        const std::string& serverID, const std::string& assetID,
        const std::string& nymID, std::string& oldPurse,
        const std::vector<std::string>& selectedTokens,
        const std::string& recipientNymID, bool bPWProtectOldPurse,
        bool bPWProtectNewPurse);
    EXPORT OT_MADE_EASY_OT static std::string query_asset_types(
        const std::string& SERVER_ID, const std::string& NYM_ID,
        const std::string& ENCODED_MAP);
    EXPORT OT_MADE_EASY_OT static std::string register_nym(
        const std::string& SERVER_ID, const std::string& NYM_ID);
    EXPORT OT_MADE_EASY_OT static bool retrieve_account(
        const std::string& SERVER_ID, const std::string& NYM_ID,
        const std::string& ACCOUNT_ID,
        bool bForceDownload); // bForceDownload=false
    EXPORT OT_MADE_EASY_OT static std::string retrieve_contract(
        const std::string& SERVER_ID, const std::string& NYM_ID,
        const std::string& CONTRACT_ID);
    EXPORT OT_MADE_EASY_OT static std::string retrieve_mint(
        const std::string& SERVER_ID, const std::string& NYM_ID,
        const std::string& ASSET_ID);
    EXPORT OT_MADE_EASY_OT static int32_t retrieve_nym(
        const std::string& strServerID, const std::string& strMyNymID,
        bool& bWasMsgSent, bool bForceDownload);
    EXPORT OT_MADE_EASY_OT static std::string send_transfer(
        const std::string& SERVER_ID, const std::string& NYM_ID,
        const std::string& ACCT_FROM, const std::string& ACCT_TO,
        int64_t AMOUNT, const std::string& NOTE);
    EXPORT OT_MADE_EASY_OT static std::string send_user_cash(
        const std::string& SERVER_ID, const std::string& NYM_ID,
        const std::string& RECIPIENT_NYM_ID, const std::string& THE_PAYMENT,
        const std::string& SENDERS_COPY);
    EXPORT OT_MADE_EASY_OT static std::string send_user_cash_pubkey(
        const std::string& SERVER_ID, const std::string& NYM_ID,
        const std::string& RECIPIENT_NYM_ID,
        const std::string& RECIPIENT_PUBKEY, const std::string& THE_INSTRUMENT,
        const std::string& INSTRUMENT_FOR_SENDER);
    EXPORT OT_MADE_EASY_OT static std::string send_user_msg(
        const std::string& SERVER_ID, const std::string& NYM_ID,
        const std::string& RECIPIENT_NYM_ID, const std::string& THE_MESSAGE);
    EXPORT OT_MADE_EASY_OT static std::string send_user_msg_pubkey(
        const std::string& SERVER_ID, const std::string& NYM_ID,
        const std::string& RECIPIENT_NYM_ID,
        const std::string& RECIPIENT_PUBKEY, const std::string& THE_MESSAGE);
    EXPORT OT_MADE_EASY_OT static std::string send_user_payment(
        const std::string& SERVER_ID, const std::string& NYM_ID,
        const std::string& RECIPIENT_NYM_ID, const std::string& THE_PAYMENT);
    EXPORT OT_MADE_EASY_OT static std::string send_user_pmnt_pubkey(
        const std::string& SERVER_ID, const std::string& NYM_ID,
        const std::string& RECIPIENT_NYM_ID,
        const std::string& RECIPIENT_PUBKEY, const std::string& THE_INSTRUMENT);
    EXPORT OT_MADE_EASY_OT static std::string stat_asset_account(
        const std::string& ACCOUNT_ID);
    EXPORT OT_MADE_EASY_OT static std::string trigger_clause(
        const std::string& SERVER_ID, const std::string& NYM_ID,
        const std::string& STR_TRANS_NUM, const std::string& CLAUSE_NAME,
        const std::string& STR_PARAM);
    EXPORT OT_MADE_EASY_OT static std::string withdraw_cash(
        const std::string& SERVER_ID, const std::string& NYM_ID,
        const std::string& ACCT_ID, int64_t AMOUNT);
    EXPORT OT_MADE_EASY_OT static std::string withdraw_voucher(
        const std::string& SERVER_ID, const std::string& NYM_ID,
        const std::string& ACCT_ID, const std::string& RECIP_NYM_ID,
        const std::string& STR_MEMO, int64_t AMOUNT);
};

} // namespace opentxs

#endif // OPENTXS_CLIENT_OT_MADE_EASY_OT_HPP