SponsorHelpers.h

#pragma once
 
#include <xrpl/ledger/ApplyView.h>
#include <xrpl/ledger/ReadView.h>
#include <xrpl/protocol/AccountID.h>
#include <xrpl/protocol/SField.h>
#include <xrpl/protocol/STLedgerEntry.h>
#include <xrpl/protocol/STTx.h>
#include <xrpl/protocol/TER.h>
#include <xrpl/protocol/TxFlags.h>
#include <xrpl/protocol/TxFormats.h>
 
#include <cstdint>
#include <expected>
#include <optional>
 
namespace xrpl {

bool
isReserveSponsorAllowed(TxType txType);

inline bool
isFeeSponsored(STTx const& tx)
{
    return tx.isFieldPresent(sfSponsor) && ((tx.getFieldU32(sfSponsorFlags) & spfSponsorFee) != 0u);
}

inline bool
isReserveSponsored(STTx const& tx)
{
    return tx.isFieldPresent(sfSponsor) &&
        ((tx.getFieldU32(sfSponsorFlags) & spfSponsorReserve) != 0u);
}

std::optional<AccountID>
getTxReserveSponsorID(STTx const& tx);

std::expected<SLE::pointer, TER>
getTxReserveSponsor(ApplyViewContext ctx);

std::expected<SLE::const_pointer, TER>
getTxReserveSponsor(ReadView const& view, STTx const& tx);

[[nodiscard]] std::expected<SLE::pointer, TER>
getEffectiveTxReserveSponsor(ApplyViewContext ctx, SLE::const_ref accountSle);

std::optional<AccountID>
getLedgerEntryReserveSponsorID(SLE::const_ref sle, SF_ACCOUNT const& field = sfSponsor);

SLE::pointer
getLedgerEntryReserveSponsor(
    ApplyView& view,
    SLE::const_ref sle,
    SF_ACCOUNT const& field = sfSponsor);

void
addSponsorToLedgerEntry(
    SLE::ref sle,
    SLE::const_ref sponsorSle,
    SF_ACCOUNT const& field = sfSponsor);

void
addSponsorToLedgerEntry(ApplyViewContext ctx, SLE::ref sle, SF_ACCOUNT const& field = sfSponsor);

void
removeSponsorFromLedgerEntry(SLE::ref sle, SF_ACCOUNT const& field = sfSponsor);

bool
isLedgerEntryOwner(ReadView const& view, SLE const& sle, AccountID const& account);

bool
isLedgerEntrySupportedBySponsorship(SLE const& sle);

std::uint32_t
getLedgerEntryOwnerCount(SLE const& sle);

SF_ACCOUNT const&
getLedgerEntrySponsorField(SLE const& sle, AccountID const& owner);
 
}  // namespace xrpl