OTMarket.hpp

Go to the documentation of this file.

/************************************************************
 *
 *  OTMarket.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-----
 **************************************************************/

// A market has a list of OTOffers for all the bids, and another list of
// OTOffers for all the asks.
// Presumably the server will have different markets for different asset types.

#ifndef OPENTXS_CORE_TRADE_OTMARKET_HPP
#define OPENTXS_CORE_TRADE_OTMARKET_HPP

#include "OTOffer.hpp"
#include "../cron/OTCron.hpp"
#include "../OTStorage.hpp"

namespace opentxs
{

class OTTrade;

#define MAX_MARKET_QUERY_DEPTH                                                 \
    50 // todo add this to the ini file. (Now that we actually have one.)

// Multiple offers, mapped by price limit.
// Using multi-map since there will be more than one offer for each single
// price.
// (Map would only allow a single item on the map for each price.)
typedef std::multimap<int64_t, OTOffer*> mapOfOffers;

// The same offers are also mapped (uniquely) to transaction number.
typedef std::map<int64_t, OTOffer*> mapOfOffersTrnsNum;

class OTMarket : public OTContract
{
private: // Private prevents erroneous use by other classes.
    typedef OTContract ot_super;

private:
    OTCron* m_pCron; // The Cron object that owns this Market.

    OTDB::TradeListMarket* m_pTradeList;

    mapOfOffers m_mapBids; // The buyers, ordered by price limit
    mapOfOffers m_mapAsks; // The sellers, ordered by price limit

    mapOfOffersTrnsNum m_mapOffers; // All of the offers on a single list,
                                    // ordered by transaction number.

    OTIdentifier m_SERVER_ID; // Always store this in any object that's
                              // associated with a specific server.

    // Every market involves a certain asset type being traded in a certain
    // currency.
    OTIdentifier m_ASSET_TYPE_ID; // This is the GOLD market. (Say.)    | (GOLD
                                  // for
    OTIdentifier m_CURRENCY_TYPE_ID; // Gold is trading for DOLLARS.        |
                                     // DOLLARS, for example.)

    // Each Offer on the market must have a minimum increment that this divides
    // equally into.
    // (There is a "gold for dollars, minimum 1 oz" market, a "gold for dollars,
    // min 500 oz" market, etc.)
    int64_t m_lScale;

    int64_t m_lLastSalePrice;
    std::string m_strLastSaleDate;

    // The server stores a map of markets, one for each unique combination of
    // asset types.
    // That's what this market class represents: one asset type being traded and
    // priced in another.
    // It could be wheat for dollars, wheat for yen, or gold for dollars, or
    // gold for wheat, or
    // gold for oil, or oil for wheat.  REALLY, THE TWO ARE JUST ARBITRARY ASSET
    // TYPES. But in
    // order to keep terminology clear, I will refer to one as the "asset type"
    // and the other as
    // the "currency type" so that it stays VERY clear which asset type is up
    // for sale, and which
    // asset type (currency type) it is being priced in. Other than that, the
    // two are technically
    // interchangeable.

public:
    bool ValidateOfferForMarket(OTOffer& theOffer, OTString* pReason = nullptr);

    OTOffer* GetOffer(const int64_t& lTransactionNum);
    bool AddOffer(OTTrade* pTrade, OTOffer& theOffer, bool bSaveFile = true,
                  time64_t tDateAddedToMarket = OT_TIME_ZERO);
    bool RemoveOffer(const int64_t& lTransactionNum);
    // returns general information about offers on the market
    EXPORT bool GetOfferList(OTASCIIArmor& ascOutput, int64_t lDepth,
                             int32_t& nOfferCount);
    EXPORT bool GetRecentTradeList(OTASCIIArmor& ascOutput,
                                   int32_t& nTradeCount);

    // Returns more detailed information about offers for a specific Nym.
    bool GetNym_OfferList(const OTIdentifier& NYM_ID,
                          OTDB::OfferListNym& theOutputList,
                          int32_t& nNymOfferCount);

    // Assumes a few things: Offer is part of Trade, and both have been
    // proven already to be a part of this market.
    // Basically the Offer is looked up on the Market by the Trade, and
    // then both are passed in here.
    // --Returns True if Trade should stay on the Cron list for more processing.
    // --Returns False if it should be removed and deleted.
    void ProcessTrade(OTTrade& theTrade, OTOffer& theOffer,
                      OTOffer& theOtherOffer);
    bool ProcessTrade(OTTrade& theTrade, OTOffer& theOffer);

    int64_t GetHighestBidPrice();
    int64_t GetLowestAskPrice();

    mapOfOffers::size_type GetBidCount()
    {
        return m_mapBids.size();
    }
    mapOfOffers::size_type GetAskCount()
    {
        return m_mapAsks.size();
    }
    void SetAssetID(const OTIdentifier& ASSET_ID)
    {
        m_ASSET_TYPE_ID = ASSET_ID;
    }
    void SetCurrencyID(const OTIdentifier& CURRENCY_ID)
    {
        m_CURRENCY_TYPE_ID = CURRENCY_ID;
    }
    void SetServerID(const OTIdentifier& SERVER_ID)
    {
        m_SERVER_ID = SERVER_ID;
    }

    inline const OTIdentifier& GetAssetID() const
    {
        return m_ASSET_TYPE_ID;
    }
    inline const OTIdentifier& GetCurrencyID() const
    {
        return m_CURRENCY_TYPE_ID;
    }
    inline const OTIdentifier& GetServerID() const
    {
        return m_SERVER_ID;
    }

    inline const int64_t& GetScale() const
    {
        return m_lScale;
    }
    inline void SetScale(const int64_t& lScale)
    {
        m_lScale = lScale;
        if (m_lScale < 1) m_lScale = 1;
    }

    inline const int64_t& GetLastSalePrice()
    {
        if (m_lLastSalePrice < 1) m_lLastSalePrice = 1;
        return m_lLastSalePrice;
    }
    inline void SetLastSalePrice(const int64_t& lLastSalePrice)
    {
        m_lLastSalePrice = lLastSalePrice;
        if (m_lLastSalePrice < 1) m_lLastSalePrice = 1;
    }

    const std::string& GetLastSaleDate()
    {
        return m_strLastSaleDate;
    }
    int64_t GetTotalAvailableAssets();
    OTMarket();
    OTMarket(const char* szFilename);
    OTMarket(const OTIdentifier& SERVER_ID, const OTIdentifier& ASSET_TYPE_ID,
             const OTIdentifier& CURRENCY_TYPE_ID, const int64_t& lScale);

    virtual ~OTMarket();

    // Overridden from OTContract.
    virtual void GetIdentifier(OTIdentifier& theIdentifier) const;

    inline void SetCronPointer(OTCron& theCron)
    {
        m_pCron = &theCron;
    }
    inline OTCron* GetCron()
    {
        return m_pCron;
    }
    bool LoadMarket();
    bool SaveMarket();

    void InitMarket();

    virtual void Release();
    void Release_Market();

    // return -1 if error, 0 if nothing, and 1 if the node was processed.
    virtual int32_t ProcessXMLNode(irr::io::IrrXMLReader*& xml);

    virtual void UpdateContents(); // Before transmission or serialization, this
                                   // is where the ledger saves its contents

    virtual bool SaveContractWallet(std::ofstream& ofs) const;
};

} // namespace opentxs

#endif // OPENTXS_CORE_TRADE_OTMARKET_HPP