mpt.h

#pragma once
 
#include <test/jtx/Account.h>
#include <test/jtx/Env.h>
#include <test/jtx/amount.h>
#include <test/jtx/delegate.h>
#include <test/jtx/owners.h>
#include <test/jtx/tag.h>
#include <test/jtx/ter.h>
#include <test/jtx/ticket.h>
#include <test/jtx/txflags.h>
 
#include <xrpl/basics/Buffer.h>
#include <xrpl/basics/Slice.h>
#include <xrpl/basics/base_uint.h>
#include <xrpl/basics/contract.h>
#include <xrpl/beast/unit_test/suite.h>
#include <xrpl/core/ServiceRegistry.h>
#include <xrpl/json/json_value.h>
#include <xrpl/protocol/AccountID.h>
#include <xrpl/protocol/Asset.h>
#include <xrpl/protocol/ConfidentialTransfer.h>
#include <xrpl/protocol/TER.h>
#include <xrpl/protocol/TxFlags.h>
#include <xrpl/protocol/UintTypes.h>
#include <xrpl/protocol/XRPAmount.h>
#include <xrpl/protocol/jss.h>
 
#include <cstddef>
#include <cstdint>
#include <cstring>
#include <functional>
#include <optional>
#include <stdexcept>
#include <string>
#include <unordered_map>
#include <utility>
#include <variant>
#include <vector>
 
namespace xrpl::test::jtx {
 
class MPTTester;
 
auto const kMptDexFlags = tfMPTCanTrade | tfMPTCanTransfer;

[[nodiscard]] inline Buffer
gMakeZeroBuffer(std::size_t size)
{
    Buffer b(size);
    if (size > 0)
        std::memset(b.data(), 0, size);
    return b;
}

class MptFlags
{
private:
    MPTTester& tester_;
    std::uint32_t flags_;
    std::optional<Account> holder_;
 
public:
    MptFlags(
        MPTTester& tester,
        std::uint32_t flags,
        std::optional<Account> const& holder = std::nullopt)
        : tester_(tester), flags_(flags), holder_(holder)
    {
    }
 
    void
    operator()(Env& env) const;
};

class MptBalance
{
private:
    MPTTester const& tester_;
    Account const& account_;
    std::int64_t const amount_;
 
public:
    MptBalance(MPTTester& tester, Account const& account, std::int64_t amount)
        : tester_(tester), account_(account), amount_(amount)
    {
    }
 
    void
    operator()(Env& env) const;
};

class RequireAny
{
private:
    std::function<bool()> cb_;
 
public:
    RequireAny(std::function<bool()> const& cb) : cb_(cb)
    {
    }
 
    void
    operator()(Env& env) const;
};
 
using Holders = std::vector<Account>;

struct MPTCreate
{
    static inline std::vector<Account> allHolders = {};
    std::optional<Account> issuer = std::nullopt;
    std::optional<std::uint64_t> maxAmt = std::nullopt;
    std::optional<std::uint8_t> assetScale = std::nullopt;
    std::optional<std::uint16_t> transferFee = std::nullopt;
    std::optional<std::string> metadata = std::nullopt;
    std::optional<std::uint32_t> ownerCount = std::nullopt;
    std::optional<std::uint32_t> holderCount = std::nullopt;
    // authorize if seated.
    // if empty vector then authorize all holders
    std::optional<std::vector<Account>> authorize = std::nullopt;
    // pay if seated. if authorize is not seated then authorize.
    // if empty vector then pay to either authorize or all holders.
    std::optional<std::pair<std::vector<Account>, std::uint64_t>> pay = std::nullopt;
    std::optional<std::uint32_t> flags = {0};
    std::optional<std::uint32_t> immutableFlags = std::nullopt;
    bool authHolder = false;
    std::optional<uint256> domainID = std::nullopt;
    std::optional<TER> err = std::nullopt;
};

struct MPTInit
{
    // Default-initialized so designated-initializer call sites that omit
    // `holders` don't trip GCC's -Werror=missing-field-initializers.
    Holders holders = {};  // NOLINT(readability-redundant-member-init)
    std::optional<Account> auditor = std::nullopt;
    PrettyAmount const xrp = XRP(10'000);
    PrettyAmount const xrpHolders = XRP(10'000);
    bool fund = true;
    bool close = true;
    // create MPTIssuanceID if seated and follow rules for MPTCreate args
    std::optional<MPTCreate> create = std::nullopt;
};
static MPTInit const kMptInitNoFund{.fund = false};

struct MPTInitDef
{
    Env& env;
    Account issuer;
    Holders holders = {};  // NOLINT(readability-redundant-member-init)
    std::optional<Account> auditor = std::nullopt;
    std::uint16_t transferFee = 0;
    std::optional<std::uint64_t> pay = std::nullopt;
    std::uint32_t flags = kMptDexFlags;
    std::optional<std::uint32_t> immutableFlags = std::nullopt;
    bool authHolder = false;
    bool fund = false;
    bool close = true;
    std::optional<std::uint64_t> maxAmt = std::nullopt;
    std::optional<TER> err = std::nullopt;
};

struct MPTDestroy
{
    std::optional<Account> issuer = std::nullopt;
    std::optional<MPTID> id = std::nullopt;
    std::optional<std::uint32_t> ownerCount = std::nullopt;
    std::optional<std::uint32_t> holderCount = std::nullopt;
    std::optional<std::uint32_t> flags = std::nullopt;
    std::optional<TER> err = std::nullopt;
};

struct MPTAuthorize
{
    std::optional<Account> account = std::nullopt;
    std::optional<Account> holder = std::nullopt;
    std::optional<MPTID> id = std::nullopt;
    std::optional<std::uint32_t> ownerCount = std::nullopt;
    std::optional<std::uint32_t> holderCount = std::nullopt;
    std::optional<std::uint32_t> flags = std::nullopt;
    std::optional<TER> err = std::nullopt;
};

struct MPTSet
{
    std::optional<Account> account = std::nullopt;
    std::optional<std::variant<Account, AccountID>> holder = std::nullopt;
    std::optional<MPTID> id = std::nullopt;
    std::optional<std::uint32_t> ownerCount = std::nullopt;
    std::optional<std::uint32_t> holderCount = std::nullopt;
    std::optional<std::uint32_t> flags = std::nullopt;
    std::optional<std::uint32_t> immutableFlags = std::nullopt;
    std::optional<std::uint16_t> transferFee = std::nullopt;
    std::optional<std::string> metadata = std::nullopt;
    std::optional<Account> delegate = std::nullopt;
    std::optional<uint256> domainID = std::nullopt;
    std::optional<Buffer> issuerPubKey = std::nullopt;
    std::optional<Buffer> auditorPubKey = std::nullopt;
    std::optional<std::uint32_t> ticketSeq = std::nullopt;
    std::optional<TER> err = std::nullopt;
};

struct MPTConvert
{
    std::optional<Account> account = std::nullopt;
    std::optional<MPTID> id = std::nullopt;
    std::optional<std::uint64_t> amt = std::nullopt;
    std::optional<std::string> proof = std::nullopt;
    std::optional<bool> fillAuditorEncryptedAmt = true;
    // indicates whether to autofill schnorr proof.
    // default : auto generate proof if holderPubKey is present.
    // true: force proof generation.
    // false: force proof omission.
    std::optional<bool> fillSchnorrProof = std::nullopt;
    std::optional<Buffer> holderPubKey = std::nullopt;
    std::optional<Buffer> holderEncryptedAmt = std::nullopt;
    std::optional<Buffer> issuerEncryptedAmt = std::nullopt;
    std::optional<Buffer> auditorEncryptedAmt = std::nullopt;
 
    std::optional<Buffer> blindingFactor = std::nullopt;
    std::optional<Account> delegate = std::nullopt;
    std::optional<std::uint32_t> ticketSeq = std::nullopt;
    std::optional<std::uint32_t> ownerCount = std::nullopt;
    std::optional<std::uint32_t> holderCount = std::nullopt;
    std::optional<std::uint32_t> flags = std::nullopt;
    std::optional<XRPAmount> fee = std::nullopt;
    std::optional<TER> err = std::nullopt;
};

struct MPTMergeInbox
{
    std::optional<Account> account = std::nullopt;
    std::optional<MPTID> id = std::nullopt;
    std::optional<Account> delegate = std::nullopt;
    std::optional<std::uint32_t> ticketSeq = std::nullopt;
    std::optional<std::uint32_t> ownerCount = std::nullopt;
    std::optional<std::uint32_t> holderCount = std::nullopt;
    std::optional<std::uint32_t> flags = std::nullopt;
    std::optional<XRPAmount> fee = std::nullopt;
    std::optional<TER> err = std::nullopt;
};

struct MPTConfidentialSend
{
    std::optional<Account> account = std::nullopt;
    std::optional<Account> dest = std::nullopt;
    std::optional<MPTID> id = std::nullopt;
    // amt is to generate encrypted amounts for testing purposes
    std::optional<std::uint64_t> amt = std::nullopt;
    std::optional<std::string> proof = std::nullopt;
    std::optional<Buffer> senderEncryptedAmt = std::nullopt;
    std::optional<Buffer> destEncryptedAmt = std::nullopt;
    std::optional<Buffer> issuerEncryptedAmt = std::nullopt;
    std::optional<Buffer> auditorEncryptedAmt = std::nullopt;
    std::optional<bool> fillAuditorEncryptedAmt = true;
    std::optional<std::vector<std::string>> credentials = std::nullopt;
    // not an txn param, only used for autofilling
    std::optional<Buffer> blindingFactor = std::nullopt;
    std::optional<Buffer> amountCommitment = std::nullopt;
    std::optional<Buffer> balanceCommitment = std::nullopt;
    std::optional<Account> delegate = std::nullopt;
    std::optional<std::uint32_t> destinationTag = std::nullopt;
    std::optional<std::uint32_t> ticketSeq = std::nullopt;
    std::optional<std::uint32_t> ownerCount = std::nullopt;
    std::optional<std::uint32_t> holderCount = std::nullopt;
    std::optional<std::uint32_t> flags = std::nullopt;
    std::optional<XRPAmount> fee = std::nullopt;
    std::optional<TER> err = std::nullopt;
};

struct MPTConvertBack
{
    std::optional<Account> account = std::nullopt;
    std::optional<MPTID> id = std::nullopt;
    std::optional<std::uint64_t> amt = std::nullopt;
    std::optional<Buffer> proof = std::nullopt;
    std::optional<Buffer> holderEncryptedAmt = std::nullopt;
    std::optional<Buffer> issuerEncryptedAmt = std::nullopt;
    std::optional<Buffer> auditorEncryptedAmt = std::nullopt;
    std::optional<bool> fillAuditorEncryptedAmt = true;
    // not an txn param, only used for autofilling
    std::optional<Buffer> blindingFactor = std::nullopt;
    std::optional<Buffer> pedersenCommitment = std::nullopt;
    std::optional<Account> delegate = std::nullopt;
    std::optional<std::uint32_t> ticketSeq = std::nullopt;
    std::optional<std::uint32_t> ownerCount = std::nullopt;
    std::optional<std::uint32_t> holderCount = std::nullopt;
    std::optional<std::uint32_t> flags = std::nullopt;
    std::optional<XRPAmount> fee = std::nullopt;
    std::optional<TER> err = std::nullopt;
};

struct MPTConfidentialClawback
{
    std::optional<Account> account = std::nullopt;
    std::optional<Account> holder = std::nullopt;
    std::optional<MPTID> id = std::nullopt;
    std::optional<std::uint64_t> amt = std::nullopt;
    std::optional<std::string> proof = std::nullopt;
    std::optional<Account> delegate = std::nullopt;
    std::optional<std::uint32_t> ticketSeq = std::nullopt;
    std::optional<std::uint32_t> ownerCount = std::nullopt;
    std::optional<std::uint32_t> holderCount = std::nullopt;
    std::optional<std::uint32_t> flags = std::nullopt;
    std::optional<XRPAmount> fee = std::nullopt;
    std::optional<TER> err = std::nullopt;
};

struct PedersenProofParams
{
    Buffer const pedersenCommitment;

    uint64_t const amt;

    Buffer const encryptedAmt;

    Buffer const blindingFactor;
};

struct ConfidentialSendChainState
{
    std::uint64_t spending;

    Buffer encSpending;

    std::uint32_t version;
};

std::optional<ConfidentialSendChainState>
computeNextSendChainState(
    std::uint64_t currentSpending,
    Slice const& currentEncSpending,
    std::uint32_t currentVersion,
    std::uint64_t sendAmt,
    Slice const& senderEncAmt);

class MPTTester
{
    Env& env_;
    Account const issuer_;
    std::unordered_map<std::string, Account> const holders_;
    std::optional<Account> const auditor_;
    std::optional<MPTID> id_;
    bool close_;
    std::unordered_map<AccountID, Buffer> pubKeys_;
    std::unordered_map<AccountID, Buffer> privKeys_;
 
public:
    enum class EncryptedBalanceType {
        IssuerEncryptedBalance,
        HolderEncryptedInbox,
        HolderEncryptedSpending,
        AuditorEncryptedBalance,
    };
 
    static constexpr auto issuerEncryptedBalance = EncryptedBalanceType::IssuerEncryptedBalance;
    static constexpr auto holderEncryptedInbox = EncryptedBalanceType::HolderEncryptedInbox;
    static constexpr auto holderEncryptedSpending = EncryptedBalanceType::HolderEncryptedSpending;
    static constexpr auto auditorEncryptedBalance = EncryptedBalanceType::AuditorEncryptedBalance;
 
    MPTTester(Env& env, Account issuer, MPTInit const& constr = {});
    MPTTester(MPTInitDef const& constr);
    MPTTester(
        Env& env,
        Account issuer,
        MPTID const& id,
        std::vector<Account> const& holders = {},
        bool close = true);
    operator MPT() const;
 
    void
    create(MPTCreate const& arg = MPTCreate{});
 
    static json::Value
    createJV(MPTCreate const& arg = MPTCreate{});
 
    void
    destroy(MPTDestroy const& arg = MPTDestroy{});
 
    static json::Value
    destroyJV(MPTDestroy const& arg = MPTDestroy{});
 
    void
    authorize(MPTAuthorize const& arg = MPTAuthorize{});
 
    static json::Value
    authorizeJV(MPTAuthorize const& arg = MPTAuthorize{});
 
    void
    authorizeHolders(Holders const& holders);
 
    void
    set(MPTSet const& set = {});
 
    static json::Value
    setJV(MPTSet const& set = {});
 
    void
    convert(MPTConvert const& arg = MPTConvert{});

    json::Value
    convertJV(MPTConvert const& arg, std::uint32_t seq);
 
    void
    mergeInbox(MPTMergeInbox const& arg = MPTMergeInbox{});
 
    [[nodiscard]] json::Value
    mergeInboxJV(MPTMergeInbox const& arg = MPTMergeInbox{}) const;
 
    void
    send(MPTConfidentialSend const& arg = MPTConfidentialSend{});

    json::Value
    sendJV(
        MPTConfidentialSend const& arg,
        std::uint32_t seq,
        std::optional<ConfidentialSendChainState> chain = std::nullopt);

    [[nodiscard]] ConfidentialSendChainState
    chainAfterSend(Account const& sender, std::uint64_t sendAmt, json::Value const& jv) const;
 
    void
    convertBack(MPTConvertBack const& arg = MPTConvertBack{});

    json::Value
    convertBackJV(MPTConvertBack const& arg, std::uint32_t seq);
 
    void
    confidentialClaw(MPTConfidentialClawback const& arg = MPTConfidentialClawback{});
 
    [[nodiscard]] bool
    checkDomainID(std::optional<uint256> expected) const;
 
    [[nodiscard]] bool
    checkMPTokenAmount(Account const& holder, std::int64_t expectedAmount) const;
 
    [[nodiscard]] bool
    checkMPTokenOutstandingAmount(std::int64_t expectedAmount) const;
 
    [[nodiscard]] bool
    checkIssuanceConfidentialBalance(std::int64_t expectedAmount) const;
 
    [[nodiscard]] bool
    checkFlags(uint32_t const expectedFlags, std::optional<Account> const& holder = std::nullopt)
        const;
 
    [[nodiscard]] bool
    checkMetadata(std::string const& metadata) const;
 
    [[nodiscard]] bool
    isMetadataPresent() const;
 
    [[nodiscard]] bool
    checkTransferFee(std::uint16_t transferFee) const;
 
    [[nodiscard]] bool
    isTransferFeePresent() const;
 
    [[nodiscard]] bool
    checkImmutableFlags(std::uint32_t expectedFlags) const;
 
    [[nodiscard]] Account const&
    issuer() const
    {
        return issuer_;
    }
    [[nodiscard]] Account const&
    holder(std::string const& h) const;
 
    void
    pay(Account const& src,
        Account const& dest,
        std::int64_t amount,
        std::optional<TER> err = std::nullopt,
        std::optional<std::vector<std::string>> credentials = std::nullopt);
 
    void
    claw(
        Account const& issuer,
        Account const& holder,
        std::int64_t amount,
        std::optional<TER> err = std::nullopt);
 
    [[nodiscard]] PrettyAmount
    mpt(std::int64_t amount) const;
 
    [[nodiscard]] MPTID const&
    issuanceID() const
    {
        if (!env_.test.BEAST_EXPECT(id_))
            Throw<std::logic_error>("Uninitialized issuanceID");
        return *id_;  // NOLINT(bugprone-unchecked-optional-access)
    }
 
    [[nodiscard]] std::int64_t
    getBalance(Account const& account) const;
 
    [[nodiscard]] std::int64_t
    getIssuanceConfidentialBalance() const;
 
    [[nodiscard]] std::optional<Buffer>
    getEncryptedBalance(Account const& account, EncryptedBalanceType option = holderEncryptedInbox)
        const;
 
    MPT
    operator[](std::string const& name) const;
 
    PrettyAmount
    operator()(std::int64_t amount) const;
 
    operator Asset() const;
 
    void
    generateKeyPair(Account const& account);
 
    [[nodiscard]] std::optional<Buffer>
    getPubKey(Account const& account) const;
 
    [[nodiscard]] std::optional<Buffer>
    getPrivKey(Account const& account) const;
 
    [[nodiscard]] Buffer
    encryptAmount(Account const& account, uint64_t const amt, Buffer const& blindingFactor) const;
 
    [[nodiscard]] std::optional<uint64_t>
    decryptAmount(Account const& account, Buffer const& amt) const;
 
    [[nodiscard]] std::optional<uint64_t>
    getDecryptedBalance(Account const& account, EncryptedBalanceType balanceType) const;
 
    [[nodiscard]] std::optional<std::int64_t>
    getIssuanceOutstandingBalance() const;
 
    [[nodiscard]] std::optional<Buffer>
    getClawbackProof(
        Account const& holder,
        std::uint64_t amount,
        Buffer const& privateKey,
        uint256 const& txHash) const;
 
    [[nodiscard]] std::optional<Buffer>
    getSchnorrProof(Account const& account, uint256 const& ctxHash) const;
 
    [[nodiscard]] std::optional<Buffer>
    getConfidentialSendProof(
        Account const& sender,
        std::uint64_t const amount,
        std::vector<ConfidentialRecipient> const& recipients,
        Slice const& blindingFactor,
        uint256 const& contextHash,
        PedersenProofParams const& amountParams,
        PedersenProofParams const& balanceParams) const;
 
    [[nodiscard]] Buffer
    getConvertBackProof(
        Account const& holder,
        std::uint64_t const amount,
        uint256 const& contextHash,
        PedersenProofParams const& pcParams) const;
 
    [[nodiscard]] std::uint32_t
    getMPTokenVersion(Account const account) const;
 
    static Buffer
    getPedersenCommitment(std::uint64_t const amount, Buffer const& pedersenBlindingFactor);
 
    friend BookSpec
    operator~(MPTTester const& mpt)
    {
        return ~static_cast<MPT>(mpt);
    }
 
private:
    using SLEP = SLE::const_pointer;
    bool
    forObject(
        std::function<bool(SLEP const& sle)> const& cb,
        std::optional<Account> const& holder = std::nullopt) const;
 
    template <typename A>
    TER
    submit(A const& arg, json::Value jv)
    {
        auto const expectedFlags = Txflags(arg.flags.value_or(0));
        auto const expectedTer = Ter(arg.err.value_or(tesSUCCESS));
 
        if constexpr (requires { arg.fee; })
        {
            if (arg.fee)
                jv[jss::Fee] = to_string(*arg.fee);
        }
 
        std::optional<std::uint32_t> ticketSeq;
        if constexpr (requires { arg.ticketSeq; })
            ticketSeq = arg.ticketSeq;
 
        std::optional<Account> delegateAcct;
        if constexpr (requires { arg.delegate; })
            delegateAcct = arg.delegate;
 
        std::optional<std::uint32_t> dstTag;
        if constexpr (requires { arg.destinationTag; })
            dstTag = arg.destinationTag;
 
        if (ticketSeq && delegateAcct)
        {
            env_(
                jv,
                expectedFlags,
                expectedTer,
                ticket::Use(*ticketSeq),
                delegate::As(*delegateAcct));
        }
        else if (ticketSeq)
        {
            env_(jv, expectedFlags, expectedTer, ticket::Use(*ticketSeq));
        }
        else if (delegateAcct)
        {
            env_(jv, expectedFlags, expectedTer, delegate::As(*delegateAcct));
        }
        else if (dstTag)
        {
            env_(jv, expectedFlags, expectedTer, Dtag(*dstTag));
        }
        else
        {
            env_(jv, expectedFlags, expectedTer);
        }
        auto const err = env_.ter();
        if (close_)
            env_.close();
        if (arg.ownerCount)
            env_.require(Owners(issuer_, *arg.ownerCount));
        if (arg.holderCount)
        {
            for (auto const& it : holders_)
                env_.require(Owners(it.second, *arg.holderCount));
        }
        return err;
    }
 
    static std::unordered_map<std::string, Account>
    makeHolders(std::vector<Account> const& holders);
 
    [[nodiscard]] std::uint32_t
    getFlags(std::optional<Account> const& holder) const;
 
    template <typename T>
    void
    fillConversionCiphertexts(
        T const& arg,
        json::Value& jv,
        Buffer& holderCiphertext,
        Buffer& issuerCiphertext,
        std::optional<Buffer>& auditorCiphertext,
        Buffer& blindingFactor) const;
};
 
}  // namespace xrpl::test::jtx