rippled/src/tests/libxrpl/protocol_autogen/transactions/EscrowCreateTests.cpp

// Auto-generated unit tests for transaction EscrowCreate


#include <gtest/gtest.h>

#include <protocol_autogen/TestHelpers.h>

#include <xrpl/protocol/SecretKey.h>
#include <xrpl/protocol/Seed.h>
#include <xrpl/protocol/STTx.h>
#include <xrpl/protocol_autogen/transactions/EscrowCreate.h>
#include <xrpl/protocol_autogen/transactions/AccountSet.h>

#include <string>

namespace xrpl::transactions {

// 1 & 4) Set fields via builder setters, build, then read them back via
// wrapper getters. After build(), validate() should succeed.
TEST(TransactionsEscrowCreateTests, BuilderSettersRoundTrip)
{
    // Generate a deterministic keypair for signing
    auto const [publicKey, secretKey] =
        generateKeyPair(KeyType::Secp256k1, generateSeed("testEscrowCreate"));

    // Common transaction fields
    auto const accountValue = calcAccountID(publicKey);
    std::uint32_t const sequenceValue = 1;
    auto const feeValue = canonical_AMOUNT();

    // Transaction-specific field values
    auto const destinationValue = canonical_ACCOUNT();
    auto const destinationTagValue = canonical_UINT32();
    auto const amountValue = canonical_AMOUNT();
    auto const conditionValue = canonical_VL();
    auto const cancelAfterValue = canonical_UINT32();
    auto const finishAfterValue = canonical_UINT32();
    auto const bytecodeValue = canonical_VL();
    auto const dataValue = canonical_VL();

    EscrowCreateBuilder builder{
        accountValue,
        destinationValue,
        amountValue,
        sequenceValue,
        feeValue
    };

    // Set optional fields
    builder.setDestinationTag(destinationTagValue);
    builder.setCondition(conditionValue);
    builder.setCancelAfter(cancelAfterValue);
    builder.setFinishAfter(finishAfterValue);
    builder.setBytecode(bytecodeValue);
    builder.setData(dataValue);

    auto tx = builder.build(publicKey, secretKey);

    std::string reason;
    EXPECT_TRUE(tx.validate(reason)) << reason;

    // Verify signing was applied
    EXPECT_FALSE(tx.getSigningPubKey().empty());
    EXPECT_TRUE(tx.hasTxnSignature());

    // Verify common fields
    EXPECT_EQ(tx.getAccount(), accountValue);
    EXPECT_EQ(tx.getSequence(), sequenceValue);
    EXPECT_EQ(tx.getFee(), feeValue);

    // Verify required fields
    {
        auto const& expected = destinationValue;
        auto const actual = tx.getDestination();
        expectEqualField(expected, actual, "sfDestination");
    }

    {
        auto const& expected = amountValue;
        auto const actual = tx.getAmount();
        expectEqualField(expected, actual, "sfAmount");
    }

    // Verify optional fields
    {
        auto const& expected = destinationTagValue;
        auto const actualOpt = tx.getDestinationTag();
        ASSERT_TRUE(actualOpt.has_value()) << "Optional field sfDestinationTag should be present";
        expectEqualField(expected, *actualOpt, "sfDestinationTag");
        EXPECT_TRUE(tx.hasDestinationTag());
    }

    {
        auto const& expected = conditionValue;
        auto const actualOpt = tx.getCondition();
        ASSERT_TRUE(actualOpt.has_value()) << "Optional field sfCondition should be present";
        expectEqualField(expected, *actualOpt, "sfCondition");
        EXPECT_TRUE(tx.hasCondition());
    }

    {
        auto const& expected = cancelAfterValue;
        auto const actualOpt = tx.getCancelAfter();
        ASSERT_TRUE(actualOpt.has_value()) << "Optional field sfCancelAfter should be present";
        expectEqualField(expected, *actualOpt, "sfCancelAfter");
        EXPECT_TRUE(tx.hasCancelAfter());
    }

    {
        auto const& expected = finishAfterValue;
        auto const actualOpt = tx.getFinishAfter();
        ASSERT_TRUE(actualOpt.has_value()) << "Optional field sfFinishAfter should be present";
        expectEqualField(expected, *actualOpt, "sfFinishAfter");
        EXPECT_TRUE(tx.hasFinishAfter());
    }

    {
        auto const& expected = bytecodeValue;
        auto const actualOpt = tx.getBytecode();
        ASSERT_TRUE(actualOpt.has_value()) << "Optional field sfBytecode should be present";
        expectEqualField(expected, *actualOpt, "sfBytecode");
        EXPECT_TRUE(tx.hasBytecode());
    }

    {
        auto const& expected = dataValue;
        auto const actualOpt = tx.getData();
        ASSERT_TRUE(actualOpt.has_value()) << "Optional field sfData should be present";
        expectEqualField(expected, *actualOpt, "sfData");
        EXPECT_TRUE(tx.hasData());
    }

}

// 2 & 4) Start from an STTx, construct a builder from it, build a new wrapper,
// and verify all fields match.
TEST(TransactionsEscrowCreateTests, BuilderFromStTxRoundTrip)
{
    // Generate a deterministic keypair for signing
    auto const [publicKey, secretKey] =
        generateKeyPair(KeyType::Secp256k1, generateSeed("testEscrowCreateFromTx"));

    // Common transaction fields
    auto const accountValue = calcAccountID(publicKey);
    std::uint32_t const sequenceValue = 2;
    auto const feeValue = canonical_AMOUNT();

    // Transaction-specific field values
    auto const destinationValue = canonical_ACCOUNT();
    auto const destinationTagValue = canonical_UINT32();
    auto const amountValue = canonical_AMOUNT();
    auto const conditionValue = canonical_VL();
    auto const cancelAfterValue = canonical_UINT32();
    auto const finishAfterValue = canonical_UINT32();
    auto const bytecodeValue = canonical_VL();
    auto const dataValue = canonical_VL();

    // Build an initial transaction
    EscrowCreateBuilder initialBuilder{
        accountValue,
        destinationValue,
        amountValue,
        sequenceValue,
        feeValue
    };

    initialBuilder.setDestinationTag(destinationTagValue);
    initialBuilder.setCondition(conditionValue);
    initialBuilder.setCancelAfter(cancelAfterValue);
    initialBuilder.setFinishAfter(finishAfterValue);
    initialBuilder.setBytecode(bytecodeValue);
    initialBuilder.setData(dataValue);

    auto initialTx = initialBuilder.build(publicKey, secretKey);

    // Create builder from existing STTx
    EscrowCreateBuilder builderFromTx{initialTx.getSTTx()};

    auto rebuiltTx = builderFromTx.build(publicKey, secretKey);

    std::string reason;
    EXPECT_TRUE(rebuiltTx.validate(reason)) << reason;

    // Verify common fields
    EXPECT_EQ(rebuiltTx.getAccount(), accountValue);
    EXPECT_EQ(rebuiltTx.getSequence(), sequenceValue);
    EXPECT_EQ(rebuiltTx.getFee(), feeValue);

    // Verify required fields
    {
        auto const& expected = destinationValue;
        auto const actual = rebuiltTx.getDestination();
        expectEqualField(expected, actual, "sfDestination");
    }

    {
        auto const& expected = amountValue;
        auto const actual = rebuiltTx.getAmount();
        expectEqualField(expected, actual, "sfAmount");
    }

    // Verify optional fields
    {
        auto const& expected = destinationTagValue;
        auto const actualOpt = rebuiltTx.getDestinationTag();
        ASSERT_TRUE(actualOpt.has_value()) << "Optional field sfDestinationTag should be present";
        expectEqualField(expected, *actualOpt, "sfDestinationTag");
    }

    {
        auto const& expected = conditionValue;
        auto const actualOpt = rebuiltTx.getCondition();
        ASSERT_TRUE(actualOpt.has_value()) << "Optional field sfCondition should be present";
        expectEqualField(expected, *actualOpt, "sfCondition");
    }

    {
        auto const& expected = cancelAfterValue;
        auto const actualOpt = rebuiltTx.getCancelAfter();
        ASSERT_TRUE(actualOpt.has_value()) << "Optional field sfCancelAfter should be present";
        expectEqualField(expected, *actualOpt, "sfCancelAfter");
    }

    {
        auto const& expected = finishAfterValue;
        auto const actualOpt = rebuiltTx.getFinishAfter();
        ASSERT_TRUE(actualOpt.has_value()) << "Optional field sfFinishAfter should be present";
        expectEqualField(expected, *actualOpt, "sfFinishAfter");
    }

    {
        auto const& expected = bytecodeValue;
        auto const actualOpt = rebuiltTx.getBytecode();
        ASSERT_TRUE(actualOpt.has_value()) << "Optional field sfBytecode should be present";
        expectEqualField(expected, *actualOpt, "sfBytecode");
    }

    {
        auto const& expected = dataValue;
        auto const actualOpt = rebuiltTx.getData();
        ASSERT_TRUE(actualOpt.has_value()) << "Optional field sfData should be present";
        expectEqualField(expected, *actualOpt, "sfData");
    }

}

// 3) Verify wrapper throws when constructed from wrong transaction type.
TEST(TransactionsEscrowCreateTests, WrapperThrowsOnWrongTxType)
{
    // Build a valid transaction of a different type
    auto const [pk, sk] =
        generateKeyPair(KeyType::Secp256k1, generateSeed("testWrongType"));
    auto const account = calcAccountID(pk);

    AccountSetBuilder wrongBuilder{account, 1, canonical_AMOUNT()};
    auto wrongTx = wrongBuilder.build(pk, sk);

    EXPECT_THROW(EscrowCreate{wrongTx.getSTTx()}, std::runtime_error);
}

// 4) Verify builder throws when constructed from wrong transaction type.
TEST(TransactionsEscrowCreateTests, BuilderThrowsOnWrongTxType)
{
    // Build a valid transaction of a different type
    auto const [pk, sk] =
        generateKeyPair(KeyType::Secp256k1, generateSeed("testWrongTypeBuilder"));
    auto const account = calcAccountID(pk);

    AccountSetBuilder wrongBuilder{account, 1, canonical_AMOUNT()};
    auto wrongTx = wrongBuilder.build(pk, sk);

    EXPECT_THROW(EscrowCreateBuilder{wrongTx.getSTTx()}, std::runtime_error);
}

// 5) Build with only required fields and verify optional fields return nullopt.
TEST(TransactionsEscrowCreateTests, OptionalFieldsReturnNullopt)
{
    // Generate a deterministic keypair for signing
    auto const [publicKey, secretKey] =
        generateKeyPair(KeyType::Secp256k1, generateSeed("testEscrowCreateNullopt"));

    // Common transaction fields
    auto const accountValue = calcAccountID(publicKey);
    std::uint32_t const sequenceValue = 3;
    auto const feeValue = canonical_AMOUNT();

    // Transaction-specific required field values
    auto const destinationValue = canonical_ACCOUNT();
    auto const amountValue = canonical_AMOUNT();

    EscrowCreateBuilder builder{
        accountValue,
        destinationValue,
        amountValue,
        sequenceValue,
        feeValue
    };

    // Do NOT set optional fields

    auto tx = builder.build(publicKey, secretKey);

    // Verify optional fields are not present
    EXPECT_FALSE(tx.hasDestinationTag());
    EXPECT_FALSE(tx.getDestinationTag().has_value());
    EXPECT_FALSE(tx.hasCondition());
    EXPECT_FALSE(tx.getCondition().has_value());
    EXPECT_FALSE(tx.hasCancelAfter());
    EXPECT_FALSE(tx.getCancelAfter().has_value());
    EXPECT_FALSE(tx.hasFinishAfter());
    EXPECT_FALSE(tx.getFinishAfter().has_value());
    EXPECT_FALSE(tx.hasBytecode());
    EXPECT_FALSE(tx.getBytecode().has_value());
    EXPECT_FALSE(tx.hasData());
    EXPECT_FALSE(tx.getData().has_value());
}

}