#ifndef __SERIALIZEDTYPES__ #define __SERIALIZEDTYPES__ #include #include #include "../json/value.h" #include "uint256.h" #include "Serializer.h" enum SerializedTypeID { // special types STI_DONE = -1, STI_NOTPRESENT = 0, // standard types STI_OBJECT = 1, STI_UINT8 = 2, STI_UINT16 = 3, STI_UINT32 = 4, STI_UINT64 = 5, STI_HASH128 = 6, STI_HASH160 = 7, STI_HASH256 = 8, STI_VL = 9, STI_TL = 10, STI_AMOUNT = 11, STI_PATHSET = 12, STI_VECTOR256 = 13, // high level types STI_ACCOUNT = 100, STI_TRANSACTION = 101, STI_LEDGERENTRY = 102 }; enum PathFlags { PF_END = 0x00, // End of current path & path list. PF_BOUNDRY = 0xFF, // End of current path & new path follows. PF_ACCOUNT = 0x01, PF_OFFER = 0x02, PF_WANTED_CURRENCY = 0x10, PF_WANTED_ISSUER = 0x20, PF_REDEEM = 0x40, PF_ISSUE = 0x80, }; #define QUALITY_ONE 1000000000 // 10e9 #define CURRENCY_XNS uint160(0) #define CURRENCY_ONE uint160(1) // Used as a place holder #define ACCOUNT_XNS uint160(0) #define ACCOUNT_ONE uint160(1) // Used as a place holder class SerializedType { protected: const char* name; virtual SerializedType* duplicate() const { return new SerializedType(name); } public: SerializedType() : name(NULL) { ; } SerializedType(const char* n) : name(n) { ; } SerializedType(const SerializedType& n) : name(n.name) { ; } virtual ~SerializedType() { ; } static std::auto_ptr deserialize(const char* name) { return std::auto_ptr(new SerializedType(name)); } void setName(const char* n) { name=n; } const char *getName() const { return name; } virtual int getLength() const { return 0; } virtual SerializedTypeID getSType() const { return STI_NOTPRESENT; } std::auto_ptr clone() const { return std::auto_ptr(duplicate()); } virtual std::string getFullText() const; virtual std::string getText() const // just the value { return std::string(); } virtual Json::Value getJson(int) const { return getText(); } virtual void add(Serializer& s) const { return; } virtual bool isEquivalent(const SerializedType& t) const { assert(getSType() == STI_NOTPRESENT); return t.getSType() == STI_NOTPRESENT; } SerializedType& operator=(const SerializedType& t) { name = (name == NULL) ? t.name : name; return *this; } bool operator==(const SerializedType& t) const { return (getSType() == t.getSType()) && isEquivalent(t); } bool operator!=(const SerializedType& t) const { return (getSType() != t.getSType()) || !isEquivalent(t); } }; inline SerializedType* new_clone(const SerializedType& s) { return s.clone().release(); } inline void delete_clone(const SerializedType* s) { boost::checked_delete(s); } class STUInt8 : public SerializedType { protected: unsigned char value; STUInt8* duplicate() const { return new STUInt8(name, value); } static STUInt8* construct(SerializerIterator&, const char* name = NULL); public: STUInt8(unsigned char v=0) : value(v) { ; } STUInt8(const char* n, unsigned char v=0) : SerializedType(n), value(v) { ; } static std::auto_ptr deserialize(SerializerIterator& sit, const char* name) { return std::auto_ptr(construct(sit, name)); } int getLength() const { return 1; } SerializedTypeID getSType() const { return STI_UINT8; } std::string getText() const; void add(Serializer& s) const { s.add8(value); } unsigned char getValue() const { return value; } void setValue(unsigned char v) { value=v; } operator unsigned char() const { return value; } virtual bool isEquivalent(const SerializedType& t) const; }; class STUInt16 : public SerializedType { protected: uint16 value; STUInt16* duplicate() const { return new STUInt16(name, value); } static STUInt16* construct(SerializerIterator&, const char* name = NULL); public: STUInt16(uint16 v=0) : value(v) { ; } STUInt16(const char* n, uint16 v=0) : SerializedType(n), value(v) { ; } static std::auto_ptr deserialize(SerializerIterator& sit, const char* name) { return std::auto_ptr(construct(sit, name)); } int getLength() const { return 2; } SerializedTypeID getSType() const { return STI_UINT16; } std::string getText() const; void add(Serializer& s) const { s.add16(value); } uint16 getValue() const { return value; } void setValue(uint16 v) { value=v; } operator uint16() const { return value; } virtual bool isEquivalent(const SerializedType& t) const; }; class STUInt32 : public SerializedType { protected: uint32 value; STUInt32* duplicate() const { return new STUInt32(name, value); } static STUInt32* construct(SerializerIterator&, const char* name = NULL); public: STUInt32(uint32 v=0) : value(v) { ; } STUInt32(const char* n, uint32 v=0) : SerializedType(n), value(v) { ; } static std::auto_ptr deserialize(SerializerIterator& sit, const char* name) { return std::auto_ptr(construct(sit, name)); } int getLength() const { return 4; } SerializedTypeID getSType() const { return STI_UINT32; } std::string getText() const; void add(Serializer& s) const { s.add32(value); } uint32 getValue() const { return value; } void setValue(uint32 v) { value=v; } operator uint32() const { return value; } virtual bool isEquivalent(const SerializedType& t) const; }; class STUInt64 : public SerializedType { protected: uint64 value; STUInt64* duplicate() const { return new STUInt64(name, value); } static STUInt64* construct(SerializerIterator&, const char* name = NULL); public: STUInt64(uint64 v=0) : value(v) { ; } STUInt64(const char* n, uint64 v=0) : SerializedType(n), value(v) { ; } static std::auto_ptr deserialize(SerializerIterator& sit, const char* name) { return std::auto_ptr(construct(sit, name)); } int getLength() const { return 8; } SerializedTypeID getSType() const { return STI_UINT64; } std::string getText() const; void add(Serializer& s) const { s.add64(value); } uint64 getValue() const { return value; } void setValue(uint64 v) { value=v; } operator uint64() const { return value; } virtual bool isEquivalent(const SerializedType& t) const; }; class STAmount : public SerializedType { // Internal form: // 1: If amount is zero, then value is zero and offset is -100 // 2: Otherwise: // legal offset range is -96 to +80 inclusive // value range is 10^15 to (10^16 - 1) inclusive // amount = value * [10 ^ offset] // Wire form: // High 8 bits are (offset+142), legal range is, 80 to 22 inclusive // Low 56 bits are value, legal range is 10^15 to (10^16 - 1) inclusive protected: uint160 mCurrency; uint160 mIssuer; // Only for access, not compared. uint64 mValue; int mOffset; bool mIsNative; // True for native stamps, ripple stamps are not native. bool mIsNegative; void canonicalize(); STAmount* duplicate() const { return new STAmount(*this); } static STAmount* construct(SerializerIterator&, const char* name = NULL); static const int cMinOffset = -96, cMaxOffset = 80; static const uint64 cMinValue = 1000000000000000ull, cMaxValue = 9999999999999999ull; static const uint64 cMaxNative = 9000000000000000000ull; static const uint64 cNotNative = 0x8000000000000000ull; static const uint64 cPosNative = 0x4000000000000000ull; STAmount(bool isNeg, uint64 value) : mValue(value), mOffset(0), mIsNative(true), mIsNegative(isNeg) { ; } STAmount(const char *name, uint64 value, bool isNegative) : SerializedType(name), mValue(value), mOffset(0), mIsNative(true), mIsNegative(isNegative) { ; } STAmount(const char *n, const uint160& cur, uint64 val, int off, bool isNative, bool isNegative) : SerializedType(n), mCurrency(cur), mValue(val), mOffset(off), mIsNative(isNative), mIsNegative(isNegative) { ; } uint64 toUInt64() const; static uint64 muldiv(uint64, uint64, uint64); public: STAmount(uint64 v = 0, bool isNeg = false) : mValue(v), mOffset(0), mIsNative(true), mIsNegative(isNeg) { if (v==0) mIsNegative = false; } STAmount(const char* n, uint64 v = 0) : SerializedType(n), mValue(v), mOffset(0), mIsNative(true), mIsNegative(false) { ; } STAmount(const uint160& currency, uint64 v = 0, int off = 0) : mCurrency(currency), mValue(v), mOffset(off), mIsNegative(false) { canonicalize(); } STAmount(const char* n, const uint160& currency, uint64 v = 0, int off = 0, bool isNeg = false) : SerializedType(n), mCurrency(currency), mValue(v), mOffset(off), mIsNegative(isNeg) { canonicalize(); } STAmount(const char* n, int64 v); static std::auto_ptr deserialize(SerializerIterator& sit, const char* name) { return std::auto_ptr(construct(sit, name)); } int getLength() const { return mIsNative ? 8 : 28; } SerializedTypeID getSType() const { return STI_AMOUNT; } std::string getText() const; std::string getRaw() const; std::string getFullText() const; void add(Serializer& s) const; int getExponent() const { return mOffset; } uint64 getMantissa() const { return mValue; } // When the currency is XNS, the value in raw units. S=signed uint64 getNValue() const { if (!mIsNative) throw std::runtime_error("not native"); return mValue; } void setNValue(uint64 v) { if (!mIsNative) throw std::runtime_error("not native"); mValue = v; } int64 getSNValue() const; void setSNValue(int64); std::string getHumanCurrency() const; bool isNative() const { return mIsNative; } bool isZero() const { return mValue == 0; } bool isNonZero() const { return mValue != 0; } bool isNegative() const { return mIsNegative && !isZero(); } bool isPositive() const { return !mIsNegative && !isZero(); } bool isGEZero() const { return !mIsNegative; } operator bool() const { return !isZero(); } void negate() { if (!isZero()) mIsNegative = !mIsNegative; } void zero() { mOffset = mIsNative ? -100 : 0; mValue = 0; mIsNegative = false; } const uint160& getIssuer() const { return mIssuer; } void setIssuer(const uint160& uIssuer) { mIssuer = uIssuer; } const uint160& getCurrency() const { return mCurrency; } bool setFullValue(const std::string& sAmount, const std::string& sCurrency = "", const std::string& sIssuer = ""); void setValue(const STAmount &); virtual bool isEquivalent(const SerializedType& t) const; bool operator==(const STAmount&) const; bool operator!=(const STAmount&) const; bool operator<(const STAmount&) const; bool operator>(const STAmount&) const; bool operator<=(const STAmount&) const; bool operator>=(const STAmount&) const; bool isComparable(const STAmount&) const; void throwComparable(const STAmount&) const; // native currency only bool operator<(uint64) const; bool operator>(uint64) const; bool operator<=(uint64) const; bool operator>=(uint64) const; STAmount operator+(uint64) const; STAmount operator-(uint64) const; STAmount operator-(void) const; STAmount& operator+=(const STAmount&); STAmount& operator-=(const STAmount&); STAmount& operator+=(uint64); STAmount& operator-=(uint64); STAmount& operator=(uint64); operator double() const; friend STAmount operator+(const STAmount& v1, const STAmount& v2); friend STAmount operator-(const STAmount& v1, const STAmount& v2); static STAmount divide(const STAmount& v1, const STAmount& v2, const uint160& currencyOut); static STAmount multiply(const STAmount& v1, const STAmount& v2, const uint160& currencyOut); // Someone is offering X for Y, what is the rate? // Rate: smaller is better, the taker wants the most out: in/out static uint64 getRate(const STAmount& offerOut, const STAmount& offerIn); static STAmount setRate(uint64 rate, const uint160& currencyOut); // Someone is offering X for Y, I try to pay Z, how much do I get? // And what's left of the offer? And how much do I actually pay? static bool applyOffer( const STAmount& saOfferFunds, const STAmount& saTakerFunds, const STAmount& saOfferPays, const STAmount& saOfferGets, const STAmount& saTakerPays, const STAmount& saTakerGets, STAmount& saTakerPaid, STAmount& saTakerGot); // Someone is offering X for Y, I need Z, how much do I pay static STAmount getPay(const STAmount& offerOut, const STAmount& offerIn, const STAmount& needed); // Native currency conversions, to/from display format static uint64 convertToDisplayAmount(const STAmount& internalAmount, uint64 totalNow, uint64 totalInit); static STAmount convertToInternalAmount(uint64 displayAmount, uint64 totalNow, uint64 totalInit, const char* name = NULL); static std::string createHumanCurrency(const uint160& uCurrency); static STAmount deserialize(SerializerIterator&); static bool currencyFromString(uint160& uDstCurrency, const std::string& sCurrency); Json::Value getJson(int) const; }; class STHash128 : public SerializedType { protected: uint128 value; STHash128* duplicate() const { return new STHash128(name, value); } static STHash128* construct(SerializerIterator&, const char* name = NULL); public: STHash128(const uint128& v) : value(v) { ; } STHash128(const char* n, const uint128& v) : SerializedType(n), value(v) { ; } STHash128(const char* n) : SerializedType(n) { ; } STHash128() { ; } static std::auto_ptr deserialize(SerializerIterator& sit, const char* name) { return std::auto_ptr(construct(sit, name)); } int getLength() const { return 20; } SerializedTypeID getSType() const { return STI_HASH128; } virtual std::string getText() const; void add(Serializer& s) const { s.add128(value); } const uint128& getValue() const { return value; } void setValue(const uint128& v) { value=v; } operator uint128() const { return value; } virtual bool isEquivalent(const SerializedType& t) const; }; class STHash160 : public SerializedType { protected: uint160 value; STHash160* duplicate() const { return new STHash160(name, value); } static STHash160* construct(SerializerIterator&, const char* name = NULL); public: STHash160(const uint160& v) : value(v) { ; } STHash160(const char* n, const uint160& v) : SerializedType(n), value(v) { ; } STHash160(const char* n) : SerializedType(n) { ; } STHash160() { ; } static std::auto_ptr deserialize(SerializerIterator& sit, const char* name) { return std::auto_ptr(construct(sit, name)); } int getLength() const { return 20; } SerializedTypeID getSType() const { return STI_HASH160; } virtual std::string getText() const; void add(Serializer& s) const { s.add160(value); } const uint160& getValue() const { return value; } void setValue(const uint160& v) { value=v; } operator uint160() const { return value; } virtual bool isEquivalent(const SerializedType& t) const; }; class STHash256 : public SerializedType { protected: uint256 value; STHash256* duplicate() const { return new STHash256(name, value); } static STHash256* construct(SerializerIterator&, const char* name = NULL); public: STHash256(const uint256& v) : value(v) { ; } STHash256(const char* n, const uint256& v) : SerializedType(n), value(v) { ; } STHash256(const char* n) : SerializedType(n) { ; } STHash256() { ; } static std::auto_ptr deserialize(SerializerIterator& sit, const char* name) { return std::auto_ptr(construct(sit, name)); } int getLength() const { return 32; } SerializedTypeID getSType() const { return STI_HASH256; } std::string getText() const; void add(Serializer& s) const { s.add256(value); } const uint256& getValue() const { return value; } void setValue(const uint256& v) { value=v; } operator uint256() const { return value; } virtual bool isEquivalent(const SerializedType& t) const; }; class STVariableLength : public SerializedType { // variable length byte string protected: protected: std::vector value; virtual STVariableLength* duplicate() const { return new STVariableLength(name, value); } static STVariableLength* construct(SerializerIterator&, const char* name = NULL); public: STVariableLength(const std::vector& v) : value(v) { ; } STVariableLength(const char* n, const std::vector& v) : SerializedType(n), value(v) { ; } STVariableLength(const char* n) : SerializedType(n) { ; } STVariableLength(SerializerIterator&, const char* name = NULL); STVariableLength() { ; } static std::auto_ptr deserialize(SerializerIterator& sit, const char* name) { return std::auto_ptr(construct(sit, name)); } int getLength() const; virtual SerializedTypeID getSType() const { return STI_VL; } virtual std::string getText() const; void add(Serializer& s) const { s.addVL(value); } const std::vector& peekValue() const { return value; } std::vector& peekValue() { return value; } std::vector getValue() const { return value; } void setValue(const std::vector& v) { value=v; } operator std::vector() const { return value; } virtual bool isEquivalent(const SerializedType& t) const; }; class STAccount : public STVariableLength { protected: virtual STAccount* duplicate() const { return new STAccount(name, value); } static STAccount* construct(SerializerIterator&, const char* name = NULL); public: STAccount(const std::vector& v) : STVariableLength(v) { ; } STAccount(const char* n, const std::vector& v) : STVariableLength(n, v) { ; } STAccount(const char* n) : STVariableLength(n) { ; } STAccount() { ; } static std::auto_ptr deserialize(SerializerIterator& sit, const char* name) { return std::auto_ptr(construct(sit, name)); } SerializedTypeID getSType() const { return STI_ACCOUNT; } std::string getText() const; NewcoinAddress getValueNCA() const; void setValueNCA(const NewcoinAddress& nca); void setValueH160(const uint160& v); bool getValueH160(uint160&) const; bool isValueH160() const; }; class STPathElement { public: enum { typeEnd = 0x00, typeAccount = 0x01, // Rippling through an account (vs taking an offer). typeRedeem = 0x04, // Redeem IOUs. typeIssue = 0x08, // Issue IOUs. typeCurrency = 0x10, // Currency follows. typeIssuer = 0x20, // Issuer follows. typeBoundary = 0xFF, // Boundary between alternate paths. typeValidBits = ( typeAccount | typeRedeem | typeIssue | typeCurrency | typeIssuer ), // Bits that may be non-zero. }; protected: int mType; uint160 mAccountID; uint160 mCurrencyID; uint160 mIssuerID; public: STPathElement(const uint160& uAccountID, const uint160& uCurrencyID, const uint160& uIssuerID, bool bRedeem=false, bool bIssue=false) : mAccountID(uAccountID), mCurrencyID(uCurrencyID), mIssuerID(uIssuerID) { mType = (uAccountID.isZero() ? 0 : STPathElement::typeAccount) | (uCurrencyID.isZero() ? 0 : STPathElement::typeCurrency) | (uIssuerID.isZero() ? 0 : STPathElement::typeIssuer) | (bRedeem ? STPathElement::typeRedeem : 0) | (bIssue ? STPathElement::typeIssue : 0); } int getNodeType() const { return mType; } bool isOffer() const { return mAccountID.isZero(); } bool isAccount() const { return !isOffer(); } // Nodes are either an account ID or a offer prefix. Offer prefixs denote a class of offers. const uint160& getAccountID() const { return mAccountID; } const uint160& getCurrency() const { return mCurrencyID; } const uint160& getIssuerID() const { return mIssuerID; } bool operator==(const STPathElement& t) const { return mType == t.mType && mAccountID == t.mAccountID && mCurrencyID == t.mCurrencyID && mIssuerID == mIssuerID; } }; class STPath { protected: std::vector mPath; public: STPath() { ; } STPath(const std::vector& p) : mPath(p) { ; } int getElementCount() const { return mPath.size(); } bool isEmpty() const { return mPath.empty(); } const STPathElement& getElement(int offset) const { return mPath[offset]; } const STPathElement& getElemet(int offset) { return mPath[offset]; } void addElement(const STPathElement& e) { mPath.push_back(e); } void clear() { mPath.clear(); } int getSerializeSize() const { return 1 + mPath.size() * 21; } // std::string getText() const; Json::Value getJson(int) const; std::vector::iterator begin() { return mPath.begin(); } std::vector::iterator end() { return mPath.end(); } std::vector::const_iterator begin() const { return mPath.begin(); } std::vector::const_iterator end() const { return mPath.end(); } bool operator==(const STPath& t) const { return mPath == t.mPath; } }; inline std::vector::iterator range_begin(STPath & x) { return x.begin(); } inline std::vector::iterator range_end(STPath & x) { return x.end(); } inline std::vector::const_iterator range_begin(const STPath& x) { return x.begin(); } inline std::vector::const_iterator range_end(const STPath& x) { return x.end(); } namespace boost { template<> struct range_mutable_iterator< STPath > { typedef std::vector::iterator type; }; template<> struct range_const_iterator< STPath > { typedef std::vector::const_iterator type; }; } class STPathSet : public SerializedType { // A set of zero or more payment paths protected: std::vector value; STPathSet* duplicate() const { return new STPathSet(name, value); } static STPathSet* construct(SerializerIterator&, const char* name = NULL); public: STPathSet() { ; } STPathSet(const char* n) : SerializedType(n) { ; } STPathSet(const std::vector& v) : value(v) { ; } STPathSet(const char* n, const std::vector& v) : SerializedType(n), value(v) { ; } static std::auto_ptr deserialize(SerializerIterator& sit, const char* name) { return std::auto_ptr(construct(sit, name)); } int getLength() const; // std::string getText() const; void add(Serializer& s) const; virtual Json::Value getJson(int) const; SerializedTypeID getSType() const { return STI_PATHSET; } int getPathCount() const { return value.size(); } const STPath& getPath(int off) const { return value[off]; } STPath& peekPath(int off) { return value[off]; } bool isEmpty() const { return value.empty(); } void clear() { value.clear(); } void addPath(const STPath& e) { value.push_back(e); } virtual bool isEquivalent(const SerializedType& t) const; std::vector::iterator begin() { return value.begin(); } std::vector::iterator end() { return value.end(); } std::vector::const_iterator begin() const { return value.begin(); } std::vector::const_iterator end() const { return value.end(); } }; inline std::vector::iterator range_begin(STPathSet & x) { return x.begin(); } inline std::vector::iterator range_end(STPathSet & x) { return x.end(); } inline std::vector::const_iterator range_begin(const STPathSet& x) { return x.begin(); } inline std::vector::const_iterator range_end(const STPathSet& x) { return x.end(); } namespace boost { template<> struct range_mutable_iterator< STPathSet > { typedef std::vector::iterator type; }; template<> struct range_const_iterator< STPathSet > { typedef std::vector::const_iterator type; }; } class STTaggedList : public SerializedType { protected: std::vector value; STTaggedList* duplicate() const { return new STTaggedList(name, value); } static STTaggedList* construct(SerializerIterator&, const char* name = NULL); public: STTaggedList() { ; } STTaggedList(const char* n) : SerializedType(n) { ; } STTaggedList(const std::vector& v) : value(v) { ; } STTaggedList(const char* n, const std::vector& v) : SerializedType(n), value(v) { ; } static std::auto_ptr deserialize(SerializerIterator& sit, const char* name) { return std::auto_ptr(construct(sit, name)); } int getLength() const; SerializedTypeID getSType() const { return STI_TL; } std::string getText() const; void add(Serializer& s) const { if (s.addTaggedList(value) < 0) throw(0); } const std::vector& peekValue() const { return value; } std::vector& peekValue() { return value; } std::vector getValue() const { return value; } virtual Json::Value getJson(int) const; void setValue(const std::vector& v) { value=v; } int getItemCount() const { return value.size(); } bool isEmpty() const { return value.empty(); } void clear() { value.erase(value.begin(), value.end()); } void addItem(const TaggedListItem& v) { value.push_back(v); } operator std::vector() const { return value; } virtual bool isEquivalent(const SerializedType& t) const; }; class STVector256 : public SerializedType { protected: std::vector mValue; STVector256* duplicate() const { return new STVector256(name, mValue); } static STVector256* construct(SerializerIterator&, const char* name = NULL); public: STVector256() { ; } STVector256(const char* n) : SerializedType(n) { ; } STVector256(const char* n, const std::vector& v) : SerializedType(n), mValue(v) { ; } STVector256(const std::vector& vector) : mValue(vector) { ; } SerializedTypeID getSType() const { return STI_VECTOR256; } int getLength() const { return Serializer::lengthVL(mValue.size() * (256 / 8)); } void add(Serializer& s) const; static std::auto_ptr deserialize(SerializerIterator& sit, const char* name) { return std::auto_ptr(construct(sit, name)); } const std::vector& peekValue() const { return mValue; } std::vector& peekValue() { return mValue; } virtual bool isEquivalent(const SerializedType& t) const; std::vector getValue() const { return mValue; } bool isEmpty() const { return mValue.empty(); } void setValue(const STVector256& v) { mValue = v.mValue; } void setValue(const std::vector& v) { mValue = v; } Json::Value getJson(int) const; }; #endif // vim:ts=4