mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-19 18:45:52 +00:00
1d42c4f6de
Per XLS-0095, we are taking steps to rename ripple(d) to xrpl(d). This change specifically removes all copyright notices referencing Ripple, XRPLF, and certain affiliated contributors upon mutual agreement, so the notice in the LICENSE.md file applies throughout. Copyright notices referencing external contributions remain as-is. Duplicate verbiage is also removed.
82 lines
2.5 KiB
C++
82 lines
2.5 KiB
C++
#ifndef XRPL_PROTOCOL_TXFORMATS_H_INCLUDED
|
|
#define XRPL_PROTOCOL_TXFORMATS_H_INCLUDED
|
|
|
|
#include <xrpl/protocol/KnownFormats.h>
|
|
|
|
namespace ripple {
|
|
|
|
/** Transaction type identifiers.
|
|
|
|
These are part of the binary message format.
|
|
|
|
@ingroup protocol
|
|
*/
|
|
/** Transaction type identifiers
|
|
|
|
Each ledger object requires a unique type identifier, which is stored
|
|
within the object itself; this makes it possible to iterate the entire
|
|
ledger and determine each object's type and verify that the object you
|
|
retrieved from a given hash matches the expected type.
|
|
|
|
@warning Since these values are included in transactions, which are signed
|
|
objects, and used by the code to determine the type of transaction
|
|
being invoked, they are part of the protocol. **Changing them
|
|
should be avoided because without special handling, this will
|
|
result in a hard fork.**
|
|
|
|
@note When retiring types, the specific values should not be removed but
|
|
should be marked as [[deprecated]]. This is to avoid accidental
|
|
reuse of identifiers.
|
|
|
|
@todo The C++ language does not enable checking for duplicate values
|
|
here. If it becomes possible then we should do this.
|
|
|
|
@ingroup protocol
|
|
*/
|
|
// clang-format off
|
|
enum TxType : std::uint16_t
|
|
{
|
|
|
|
#pragma push_macro("TRANSACTION")
|
|
#undef TRANSACTION
|
|
|
|
#define TRANSACTION(tag, value, ...) tag = value,
|
|
|
|
#include <xrpl/protocol/detail/transactions.macro>
|
|
|
|
#undef TRANSACTION
|
|
#pragma pop_macro("TRANSACTION")
|
|
|
|
/** This transaction type is deprecated; it is retained for historical purposes. */
|
|
ttNICKNAME_SET [[deprecated("This transaction type is not supported and should not be used.")]] = 6,
|
|
|
|
/** This transaction type is deprecated; it is retained for historical purposes. */
|
|
ttCONTRACT [[deprecated("This transaction type is not supported and should not be used.")]] = 9,
|
|
|
|
/** This identifier was never used, but the slot is reserved for historical purposes. */
|
|
ttSPINAL_TAP [[deprecated("This transaction type is not supported and should not be used.")]] = 11,
|
|
|
|
/** This transaction type installs a hook. */
|
|
ttHOOK_SET [[maybe_unused]] = 22,
|
|
};
|
|
// clang-format on
|
|
|
|
/** Manages the list of known transaction formats.
|
|
*/
|
|
class TxFormats : public KnownFormats<TxType, TxFormats>
|
|
{
|
|
private:
|
|
/** Create the object.
|
|
This will load the object with all the known transaction formats.
|
|
*/
|
|
TxFormats();
|
|
|
|
public:
|
|
static TxFormats const&
|
|
getInstance();
|
|
};
|
|
|
|
} // namespace ripple
|
|
|
|
#endif
|