ClawbackTests.cpp

// Auto-generated unit tests for transaction Clawback
 
 
#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/Clawback.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(TransactionsClawbackTests, BuilderSettersRoundTrip)
{
    // Generate a deterministic keypair for signing
    auto const [publicKey, secretKey] =
        generateKeyPair(KeyType::Secp256k1, generateSeed("testClawback"));
 
    // 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 amountValue = canonical_AMOUNT();
    auto const holderValue = canonical_ACCOUNT();
 
    ClawbackBuilder builder{
        accountValue,
        amountValue,
        sequenceValue,
        feeValue
    };
 
    // Set optional fields
    builder.setHolder(holderValue);
 
    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 = amountValue;
        auto const actual = tx.getAmount();
        expectEqualField(expected, actual, "sfAmount");
    }
 
    // Verify optional fields
    {
        auto const& expected = holderValue;
        auto const actualOpt = tx.getHolder();
        ASSERT_TRUE(actualOpt.has_value()) << "Optional field sfHolder should be present";
        expectEqualField(expected, *actualOpt, "sfHolder");
        EXPECT_TRUE(tx.hasHolder());
    }
 
}
 
// 2 & 4) Start from an STTx, construct a builder from it, build a new wrapper,
// and verify all fields match.
TEST(TransactionsClawbackTests, BuilderFromStTxRoundTrip)
{
    // Generate a deterministic keypair for signing
    auto const [publicKey, secretKey] =
        generateKeyPair(KeyType::Secp256k1, generateSeed("testClawbackFromTx"));
 
    // 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 amountValue = canonical_AMOUNT();
    auto const holderValue = canonical_ACCOUNT();
 
    // Build an initial transaction
    ClawbackBuilder initialBuilder{
        accountValue,
        amountValue,
        sequenceValue,
        feeValue
    };
 
    initialBuilder.setHolder(holderValue);
 
    auto initialTx = initialBuilder.build(publicKey, secretKey);
 
    // Create builder from existing STTx
    ClawbackBuilder 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 = amountValue;
        auto const actual = rebuiltTx.getAmount();
        expectEqualField(expected, actual, "sfAmount");
    }
 
    // Verify optional fields
    {
        auto const& expected = holderValue;
        auto const actualOpt = rebuiltTx.getHolder();
        ASSERT_TRUE(actualOpt.has_value()) << "Optional field sfHolder should be present";
        expectEqualField(expected, *actualOpt, "sfHolder");
    }
 
}
 
// 3) Verify wrapper throws when constructed from wrong transaction type.
TEST(TransactionsClawbackTests, 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(Clawback{wrongTx.getSTTx()}, std::runtime_error);
}
 
// 4) Verify builder throws when constructed from wrong transaction type.
TEST(TransactionsClawbackTests, 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(ClawbackBuilder{wrongTx.getSTTx()}, std::runtime_error);
}
 
// 5) Build with only required fields and verify optional fields return nullopt.
TEST(TransactionsClawbackTests, OptionalFieldsReturnNullopt)
{
    // Generate a deterministic keypair for signing
    auto const [publicKey, secretKey] =
        generateKeyPair(KeyType::Secp256k1, generateSeed("testClawbackNullopt"));
 
    // 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 amountValue = canonical_AMOUNT();
 
    ClawbackBuilder builder{
        accountValue,
        amountValue,
        sequenceValue,
        feeValue
    };
 
    // Do NOT set optional fields
 
    auto tx = builder.build(publicKey, secretKey);
 
    // Verify optional fields are not present
    EXPECT_FALSE(tx.hasHolder());
    EXPECT_FALSE(tx.getHolder().has_value());
}
 
}