DepositPreauth.cpp

#include <xrpl/tx/transactors/payment/DepositPreauth.h>
 
#include <xrpl/basics/Log.h>
#include <xrpl/basics/Slice.h>
#include <xrpl/basics/base_uint.h>
#include <xrpl/core/ServiceRegistry.h>
#include <xrpl/ledger/helpers/AccountRootHelpers.h>
#include <xrpl/ledger/helpers/CredentialHelpers.h>
#include <xrpl/ledger/helpers/DirectoryHelpers.h>
#include <xrpl/ledger/helpers/SponsorHelpers.h>
#include <xrpl/protocol/AccountID.h>
#include <xrpl/protocol/Feature.h>
#include <xrpl/protocol/Indexes.h>
#include <xrpl/protocol/Keylet.h>
#include <xrpl/protocol/Protocol.h>
#include <xrpl/protocol/SField.h>
#include <xrpl/protocol/STArray.h>
#include <xrpl/protocol/STLedgerEntry.h>
#include <xrpl/protocol/STTx.h>
#include <xrpl/protocol/TER.h>
#include <xrpl/protocol/XRPAmount.h>
#include <xrpl/tx/Transactor.h>
 
#include <cstdint>
#include <memory>
#include <optional>
#include <set>
#include <utility>
 
namespace xrpl {
 
bool
DepositPreauth::checkExtraFeatures(PreflightContext const& ctx)
{
    bool const authArrPresent = ctx.tx.isFieldPresent(sfAuthorizeCredentials);
    bool const unauthArrPresent = ctx.tx.isFieldPresent(sfUnauthorizeCredentials);
    bool const authCredPresent = authArrPresent || unauthArrPresent;
 
    return !authCredPresent || ctx.rules.enabled(featureCredentials);
}
 
NotTEC
DepositPreauth::preflight(PreflightContext const& ctx)
{
    bool const authArrPresent = ctx.tx.isFieldPresent(sfAuthorizeCredentials);
    bool const unauthArrPresent = ctx.tx.isFieldPresent(sfUnauthorizeCredentials);
    int const authCredPresent =
        static_cast<int>(authArrPresent) + static_cast<int>(unauthArrPresent);
 
    auto const optAuth = ctx.tx[~sfAuthorize];
    auto const optUnauth = ctx.tx[~sfUnauthorize];
    int const authPresent =
        static_cast<int>(optAuth.has_value()) + static_cast<int>(optUnauth.has_value());
 
    if (authPresent + authCredPresent != 1)
    {
        // There can only be 1 field out of 4 or the transaction is malformed.
        JLOG(ctx.j.trace()) << "Malformed transaction: "
                               "Invalid Authorize and Unauthorize field combination.";
        return temMALFORMED;
    }
 
    if (authPresent != 0)
    {
        // Make sure that the passed account is valid.
        // NOLINTNEXTLINE(bugprone-unchecked-optional-access) authPresent != 0 guarantees one is set
        AccountID const& target(optAuth ? *optAuth : *optUnauth);
        if (!target)
        {
            JLOG(ctx.j.trace()) << "Malformed transaction: Authorized or Unauthorized "
                                   "field zeroed.";
            return temINVALID_ACCOUNT_ID;
        }
 
        // An account may not preauthorize itself.
        if (optAuth && (target == ctx.tx[sfAccount]))
        {
            JLOG(ctx.j.trace()) << "Malformed transaction: Attempting to DepositPreauth self.";
            return temCANNOT_PREAUTH_SELF;
        }
    }
    else
    {
        if (auto err = credentials::checkArray(
                ctx.tx.getFieldArray(
                    authArrPresent ? sfAuthorizeCredentials : sfUnauthorizeCredentials),
                kMaxCredentialsArraySize,
                ctx.j);
            !isTesSuccess(err))
            return err;
    }
 
    return tesSUCCESS;
}
 
TER
DepositPreauth::preclaim(PreclaimContext const& ctx)
{
    AccountID const account(ctx.tx[sfAccount]);
 
    // Determine which operation we're performing: authorizing or unauthorizing.
    if (ctx.tx.isFieldPresent(sfAuthorize))
    {
        // Verify that the Authorize account is present in the ledger.
        AccountID const auth{ctx.tx[sfAuthorize]};
        auto const sleAuth = ctx.view.read(keylet::account(auth));
        if (!sleAuth)
            return tecNO_TARGET;
 
        if (ctx.view.rules().enabled(fixCleanup3_3_0) && isPseudoAccount(sleAuth))
        {
            JLOG(ctx.j.debug()) << "Authorized account is a pseudo-account.";
            return tecPSEUDO_ACCOUNT;
        }
 
        // Verify that the Preauth entry they asked to add is not already
        // in the ledger.
        if (ctx.view.exists(keylet::depositPreauth(account, auth)))
            return tecDUPLICATE;
    }
    else if (ctx.tx.isFieldPresent(sfUnauthorize))
    {
        // Verify that the Preauth entry they asked to remove is in the ledger.
        if (!ctx.view.exists(keylet::depositPreauth(account, ctx.tx[sfUnauthorize])))
            return tecNO_ENTRY;
    }
    else if (ctx.tx.isFieldPresent(sfAuthorizeCredentials))
    {
        STArray const& authCred(ctx.tx.getFieldArray(sfAuthorizeCredentials));
        std::set<std::pair<AccountID, Slice>> sorted;
        for (auto const& o : authCred)
        {
            auto const& issuer = o[sfIssuer];
            if (!ctx.view.exists(keylet::account(issuer)))
                return tecNO_ISSUER;
            auto [it, ins] = sorted.emplace(issuer, o[sfCredentialType]);
            if (!ins)
                return tefINTERNAL;  // LCOV_EXCL_LINE
        }
 
        // Verify that the Preauth entry they asked to add is not already
        // in the ledger.
        if (ctx.view.exists(keylet::depositPreauth(account, sorted)))
            return tecDUPLICATE;
    }
    else if (ctx.tx.isFieldPresent(sfUnauthorizeCredentials))
    {
        // Verify that the Preauth entry is in the ledger.
        if (!ctx.view.exists(
                keylet::depositPreauth(
                    account,
                    credentials::makeSorted(ctx.tx.getFieldArray(sfUnauthorizeCredentials)))))
            return tecNO_ENTRY;
    }
    return tesSUCCESS;
}
 
TER
DepositPreauth::doApply()
{
    auto applyViewContext = ctx_.getApplyViewContext();
    if (ctx_.tx.isFieldPresent(sfAuthorize))
    {
        auto const sleOwner = view().peek(keylet::account(accountID_));
        if (!sleOwner)
            return {tefINTERNAL};
 
        // A preauth counts against the reserve of the issuing account, but we
        // check the starting balance because we want to allow dipping into the
        // reserve to pay fees.
        if (auto const ret = checkReserve(
                applyViewContext, sleOwner, preFeeBalance_, {.ownerCountDelta = 1}, j_);
            !isTesSuccess(ret))
            return ret;
 
        // Preclaim already verified that the Preauth entry does not yet exist.
        // Create and populate the Preauth entry.
        AccountID const auth{ctx_.tx[sfAuthorize]};
        Keylet const preauthKeylet = keylet::depositPreauth(accountID_, auth);
        auto slePreauth = std::make_shared<SLE>(preauthKeylet);
 
        slePreauth->setAccountID(sfAccount, accountID_);
        slePreauth->setAccountID(sfAuthorize, auth);
        view().insert(slePreauth);
 
        auto const page = view().dirInsert(
            keylet::ownerDir(accountID_), preauthKeylet, describeOwnerDir(accountID_));
 
        JLOG(j_.trace()) << "Adding DepositPreauth to owner directory "
                         << to_string(preauthKeylet.key) << ": " << (page ? "success" : "failure");
 
        if (!page)
            return tecDIR_FULL;  // LCOV_EXCL_LINE
 
        slePreauth->setFieldU64(sfOwnerNode, *page);
 
        // If we succeeded, the new entry counts against the creator's reserve.
        increaseOwnerCount(applyViewContext, sleOwner, 1, j_);
        addSponsorToLedgerEntry(applyViewContext, slePreauth);
    }
    else if (ctx_.tx.isFieldPresent(sfUnauthorize))
    {
        auto const preauth = keylet::depositPreauth(accountID_, ctx_.tx[sfUnauthorize]);
 
        return DepositPreauth::removeFromLedger(view(), preauth.key, j_);
    }
    else if (ctx_.tx.isFieldPresent(sfAuthorizeCredentials))
    {
        auto const sleOwner = view().peek(keylet::account(accountID_));
        if (!sleOwner)
            return tefINTERNAL;  // LCOV_EXCL_LINE
 
        // A preauth counts against the reserve of the issuing account, but we
        // check the starting balance because we want to allow dipping into the
        // reserve to pay fees.
        if (auto const ret = checkReserve(
                applyViewContext, sleOwner, preFeeBalance_, {.ownerCountDelta = 1}, j_);
            !isTesSuccess(ret))
            return ret;
 
        // Preclaim already verified that the Preauth entry does not yet exist.
        // Create and populate the Preauth entry.
 
        auto const sortedTX =
            credentials::makeSorted(ctx_.tx.getFieldArray(sfAuthorizeCredentials));
        STArray sortedLE(sfAuthorizeCredentials, sortedTX.size());
        for (auto const& p : sortedTX)
        {
            auto cred = STObject::makeInnerObject(sfCredential);
            cred.setAccountID(sfIssuer, p.first);
            cred.setFieldVL(sfCredentialType, p.second);
            sortedLE.pushBack(std::move(cred));
        }
 
        Keylet const preauthKey = keylet::depositPreauth(accountID_, sortedTX);
        auto slePreauth = std::make_shared<SLE>(preauthKey);
        if (!slePreauth)
            return tefINTERNAL;  // LCOV_EXCL_LINE
 
        slePreauth->setAccountID(sfAccount, accountID_);
        slePreauth->peekFieldArray(sfAuthorizeCredentials) = std::move(sortedLE);
 
        view().insert(slePreauth);
 
        auto const page = view().dirInsert(
            keylet::ownerDir(accountID_), preauthKey, describeOwnerDir(accountID_));
 
        JLOG(j_.trace()) << "Adding DepositPreauth to owner directory " << to_string(preauthKey.key)
                         << ": " << (page ? "success" : "failure");
 
        if (!page)
            return tecDIR_FULL;  // LCOV_EXCL_LINE
 
        slePreauth->setFieldU64(sfOwnerNode, *page);
 
        // If we succeeded, the new entry counts against the creator's reserve.
        increaseOwnerCount(applyViewContext, sleOwner, 1, j_);
        addSponsorToLedgerEntry(applyViewContext, slePreauth);
    }
    else if (ctx_.tx.isFieldPresent(sfUnauthorizeCredentials))
    {
        auto const preauthKey = keylet::depositPreauth(
            accountID_, credentials::makeSorted(ctx_.tx.getFieldArray(sfUnauthorizeCredentials)));
        return DepositPreauth::removeFromLedger(view(), preauthKey.key, j_);
    }
 
    return tesSUCCESS;
}
 
TER
DepositPreauth::removeFromLedger(ApplyView& view, uint256 const& preauthIndex, beast::Journal j)
{
    // Existence already checked in preclaim and AccountDelete
    auto const slePreauth{view.peek(keylet::depositPreauth(preauthIndex))};
    if (!slePreauth)
    {
        JLOG(j.warn()) << "Selected DepositPreauth does not exist.";
        return tecNO_ENTRY;
    }
 
    AccountID const account{(*slePreauth)[sfAccount]};
    std::uint64_t const page{(*slePreauth)[sfOwnerNode]};
    if (!view.dirRemove(keylet::ownerDir(account), page, preauthIndex, false))
    {
        // LCOV_EXCL_START
        JLOG(j.fatal()) << "Unable to delete DepositPreauth from owner.";
        return tefBAD_LEDGER;
        // LCOV_EXCL_STOP
    }
 
    // If we succeeded, update the DepositPreauth owner's reserve.
    auto const sleOwner = view.peek(keylet::account(account));
    if (!sleOwner)
        return tefINTERNAL;  // LCOV_EXCL_LINE
 
    decreaseOwnerCountForObject(view, sleOwner, slePreauth, 1, j);
    // Remove DepositPreauth from ledger.
    view.erase(slePreauth);
 
    return tesSUCCESS;
}
 
void
DepositPreauth::visitInvariantEntry(bool, SLE::const_ref, SLE::const_ref)
{
    // No transaction-specific invariants yet (future work).
}
 
bool
DepositPreauth::finalizeInvariants(
    STTx const&,
    TER,
    XRPAmount,
    ReadView const&,
    beast::Journal const&)
{
    // No transaction-specific invariants yet (future work).
    return true;
}
 
}  // namespace xrpl