batch.h

//------------------------------------------------------------------------------
/*
    This file is part of rippled: https://github.com/ripple/rippled
    Copyright (c) 2024 Ripple Labs Inc.
 
    Permission to use, copy, modify, and/or distribute this software for any
    purpose  with  or without fee is hereby granted, provided that the above
    copyright notice and this permission notice appear in all copies.
 
    THE  SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
    WITH  REGARD  TO  THIS  SOFTWARE  INCLUDING  ALL  IMPLIED  WARRANTIES  OF
    MERCHANTABILITY  AND  FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
    ANY  SPECIAL ,  DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
    WHATSOEVER  RESULTING  FROM  LOSS  OF USE, DATA OR PROFITS, WHETHER IN AN
    ACTION  OF  CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
//==============================================================================
 
#ifndef RIPPLE_TEST_JTX_BATCH_H_INCLUDED
#define RIPPLE_TEST_JTX_BATCH_H_INCLUDED
 
#include <test/jtx/Account.h>
#include <test/jtx/Env.h>
#include <test/jtx/amount.h>
#include <test/jtx/owners.h>
#include <test/jtx/tags.h>
 
#include <xrpl/protocol/TxFlags.h>
 
#include "test/jtx/SignerUtils.h"
 
#include <concepts>
#include <cstdint>
#include <optional>
 
namespace ripple {
namespace test {
namespace jtx {
 
namespace batch {
 
XRPAmount
calcBatchFee(
    jtx::Env const& env,
    uint32_t const& numSigners,
    uint32_t const& txns = 0);
 
Json::Value
outer(
    jtx::Account const& account,
    uint32_t seq,
    STAmount const& fee,
    std::uint32_t flags);
 
class inner
{
private:
    Json::Value txn_;
    std::uint32_t seq_;
    std::optional<std::uint32_t> ticket_;
 
public:
    inner(
        Json::Value const& txn,
        std::uint32_t const& sequence,
        std::optional<std::uint32_t> const& ticket = std::nullopt,
        std::optional<std::uint32_t> const& fee = std::nullopt)
        : txn_(txn), seq_(sequence), ticket_(ticket)
    {
        txn_[jss::SigningPubKey] = "";
        txn_[jss::Sequence] = seq_;
        txn_[jss::Fee] = "0";
        txn_[jss::Flags] = txn_[jss::Flags].asUInt() | tfInnerBatchTxn;
 
        // Optionally set ticket sequence
        if (ticket_.has_value())
        {
            txn_[jss::Sequence] = 0;
            txn_[sfTicketSequence.jsonName] = *ticket_;
        }
    }
 
    void
    operator()(Env&, JTx& jtx) const;
 
    Json::Value&
    operator[](Json::StaticString const& key)
    {
        return txn_[key];
    }
 
    void
    removeMember(Json::StaticString const& key)
    {
        txn_.removeMember(key);
    }
 
    Json::Value const&
    getTxn() const
    {
        return txn_;
    }
};
 
class sig
{
public:
    std::vector<Reg> signers;
 
    sig(std::vector<Reg> signers_) : signers(std::move(signers_))
    {
        sortSigners(signers);
    }
 
    template <class AccountType, class... Accounts>
        requires std::convertible_to<AccountType, Reg>
    explicit sig(AccountType&& a0, Accounts&&... aN)
        : signers{std::forward<AccountType>(a0), std::forward<Accounts>(aN)...}
    {
        sortSigners(signers);
    }
 
    void
    operator()(Env&, JTx& jt) const;
};
 
class msig
{
public:
    Account master;
    std::vector<Reg> signers;
 
    msig(Account const& masterAccount, std::vector<Reg> signers_)
        : master(masterAccount), signers(std::move(signers_))
    {
        sortSigners(signers);
    }
 
    template <class AccountType, class... Accounts>
        requires std::convertible_to<AccountType, Reg>
    explicit msig(
        Account const& masterAccount,
        AccountType&& a0,
        Accounts&&... aN)
        : master(masterAccount)
        , signers{std::forward<AccountType>(a0), std::forward<Accounts>(aN)...}
    {
        sortSigners(signers);
    }
 
    void
    operator()(Env&, JTx& jt) const;
};
 
}  // namespace batch
 
}  // namespace jtx
 
}  // namespace test
}  // namespace ripple
 
#endif