mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-15 16:45:50 +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.
93 lines
2.0 KiB
C++
93 lines
2.0 KiB
C++
#ifndef XRPL_LEDGER_RAWVIEW_H_INCLUDED
|
|
#define XRPL_LEDGER_RAWVIEW_H_INCLUDED
|
|
|
|
#include <xrpl/ledger/ReadView.h>
|
|
#include <xrpl/protocol/STLedgerEntry.h>
|
|
#include <xrpl/protocol/Serializer.h>
|
|
|
|
namespace ripple {
|
|
|
|
/** Interface for ledger entry changes.
|
|
|
|
Subclasses allow raw modification of ledger entries.
|
|
*/
|
|
class RawView
|
|
{
|
|
public:
|
|
virtual ~RawView() = default;
|
|
RawView() = default;
|
|
RawView(RawView const&) = default;
|
|
RawView&
|
|
operator=(RawView const&) = delete;
|
|
|
|
/** Delete an existing state item.
|
|
|
|
The SLE is provided so the implementation
|
|
can calculate metadata.
|
|
*/
|
|
virtual void
|
|
rawErase(std::shared_ptr<SLE> const& sle) = 0;
|
|
|
|
/** Unconditionally insert a state item.
|
|
|
|
Requirements:
|
|
The key must not already exist.
|
|
|
|
Effects:
|
|
|
|
The key is associated with the SLE.
|
|
|
|
@note The key is taken from the SLE
|
|
*/
|
|
virtual void
|
|
rawInsert(std::shared_ptr<SLE> const& sle) = 0;
|
|
|
|
/** Unconditionally replace a state item.
|
|
|
|
Requirements:
|
|
|
|
The key must exist.
|
|
|
|
Effects:
|
|
|
|
The key is associated with the SLE.
|
|
|
|
@note The key is taken from the SLE
|
|
*/
|
|
virtual void
|
|
rawReplace(std::shared_ptr<SLE> const& sle) = 0;
|
|
|
|
/** Destroy XRP.
|
|
|
|
This is used to pay for transaction fees.
|
|
*/
|
|
virtual void
|
|
rawDestroyXRP(XRPAmount const& fee) = 0;
|
|
};
|
|
|
|
//------------------------------------------------------------------------------
|
|
|
|
/** Interface for changing ledger entries with transactions.
|
|
|
|
Allows raw modification of ledger entries and insertion
|
|
of transactions into the transaction map.
|
|
*/
|
|
class TxsRawView : public RawView
|
|
{
|
|
public:
|
|
/** Add a transaction to the tx map.
|
|
|
|
Closed ledgers must have metadata,
|
|
while open ledgers omit metadata.
|
|
*/
|
|
virtual void
|
|
rawTxInsert(
|
|
ReadView::key_type const& key,
|
|
std::shared_ptr<Serializer const> const& txn,
|
|
std::shared_ptr<Serializer const> const& metaData) = 0;
|
|
};
|
|
|
|
} // namespace ripple
|
|
|
|
#endif
|