rippled
Loading...
Searching...
No Matches
AMMClawbackTests.cpp
1// Auto-generated unit tests for transaction AMMClawback
2
3
4#include <gtest/gtest.h>
5
6#include <protocol_autogen/TestHelpers.h>
7
8#include <xrpl/protocol/SecretKey.h>
9#include <xrpl/protocol/Seed.h>
10#include <xrpl/protocol/STTx.h>
11#include <xrpl/protocol_autogen/transactions/AMMClawback.h>
12#include <xrpl/protocol_autogen/transactions/AccountSet.h>
13
14#include <string>
15
16namespace xrpl::transactions {
17
18// 1 & 4) Set fields via builder setters, build, then read them back via
19// wrapper getters. After build(), validate() should succeed.
20TEST(TransactionsAMMClawbackTests, BuilderSettersRoundTrip)
21{
22 // Generate a deterministic keypair for signing
23 auto const [publicKey, secretKey] =
25
26 // Common transaction fields
27 auto const accountValue = calcAccountID(publicKey);
28 std::uint32_t const sequenceValue = 1;
29 auto const feeValue = canonical_AMOUNT();
30
31 // Transaction-specific field values
32 auto const holderValue = canonical_ACCOUNT();
33 auto const assetValue = canonical_ISSUE();
34 auto const asset2Value = canonical_ISSUE();
35 auto const amountValue = canonical_AMOUNT();
36
37 AMMClawbackBuilder builder{
38 accountValue,
39 holderValue,
40 assetValue,
41 asset2Value,
42 sequenceValue,
43 feeValue
44 };
45
46 // Set optional fields
47 builder.setAmount(amountValue);
48
49 auto tx = builder.build(publicKey, secretKey);
50
51 std::string reason;
52 EXPECT_TRUE(tx.validate(reason)) << reason;
53
54 // Verify signing was applied
55 EXPECT_FALSE(tx.getSigningPubKey().empty());
56 EXPECT_TRUE(tx.hasTxnSignature());
57
58 // Verify common fields
59 EXPECT_EQ(tx.getAccount(), accountValue);
60 EXPECT_EQ(tx.getSequence(), sequenceValue);
61 EXPECT_EQ(tx.getFee(), feeValue);
62
63 // Verify required fields
64 {
65 auto const& expected = holderValue;
66 auto const actual = tx.getHolder();
67 expectEqualField(expected, actual, "sfHolder");
68 }
69
70 {
71 auto const& expected = assetValue;
72 auto const actual = tx.getAsset();
73 expectEqualField(expected, actual, "sfAsset");
74 }
75
76 {
77 auto const& expected = asset2Value;
78 auto const actual = tx.getAsset2();
79 expectEqualField(expected, actual, "sfAsset2");
80 }
81
82 // Verify optional fields
83 {
84 auto const& expected = amountValue;
85 auto const actualOpt = tx.getAmount();
86 ASSERT_TRUE(actualOpt.has_value()) << "Optional field sfAmount should be present";
87 expectEqualField(expected, *actualOpt, "sfAmount");
88 EXPECT_TRUE(tx.hasAmount());
89 }
90
91}
92
93// 2 & 4) Start from an STTx, construct a builder from it, build a new wrapper,
94// and verify all fields match.
95TEST(TransactionsAMMClawbackTests, BuilderFromStTxRoundTrip)
96{
97 // Generate a deterministic keypair for signing
98 auto const [publicKey, secretKey] =
99 generateKeyPair(KeyType::secp256k1, generateSeed("testAMMClawbackFromTx"));
100
101 // Common transaction fields
102 auto const accountValue = calcAccountID(publicKey);
103 std::uint32_t const sequenceValue = 2;
104 auto const feeValue = canonical_AMOUNT();
105
106 // Transaction-specific field values
107 auto const holderValue = canonical_ACCOUNT();
108 auto const assetValue = canonical_ISSUE();
109 auto const asset2Value = canonical_ISSUE();
110 auto const amountValue = canonical_AMOUNT();
111
112 // Build an initial transaction
113 AMMClawbackBuilder initialBuilder{
114 accountValue,
115 holderValue,
116 assetValue,
117 asset2Value,
118 sequenceValue,
119 feeValue
120 };
121
122 initialBuilder.setAmount(amountValue);
123
124 auto initialTx = initialBuilder.build(publicKey, secretKey);
125
126 // Create builder from existing STTx
127 AMMClawbackBuilder builderFromTx{initialTx.getSTTx()};
128
129 auto rebuiltTx = builderFromTx.build(publicKey, secretKey);
130
131 std::string reason;
132 EXPECT_TRUE(rebuiltTx.validate(reason)) << reason;
133
134 // Verify common fields
135 EXPECT_EQ(rebuiltTx.getAccount(), accountValue);
136 EXPECT_EQ(rebuiltTx.getSequence(), sequenceValue);
137 EXPECT_EQ(rebuiltTx.getFee(), feeValue);
138
139 // Verify required fields
140 {
141 auto const& expected = holderValue;
142 auto const actual = rebuiltTx.getHolder();
143 expectEqualField(expected, actual, "sfHolder");
144 }
145
146 {
147 auto const& expected = assetValue;
148 auto const actual = rebuiltTx.getAsset();
149 expectEqualField(expected, actual, "sfAsset");
150 }
151
152 {
153 auto const& expected = asset2Value;
154 auto const actual = rebuiltTx.getAsset2();
155 expectEqualField(expected, actual, "sfAsset2");
156 }
157
158 // Verify optional fields
159 {
160 auto const& expected = amountValue;
161 auto const actualOpt = rebuiltTx.getAmount();
162 ASSERT_TRUE(actualOpt.has_value()) << "Optional field sfAmount should be present";
163 expectEqualField(expected, *actualOpt, "sfAmount");
164 }
165
166}
167
168// 3) Verify wrapper throws when constructed from wrong transaction type.
169TEST(TransactionsAMMClawbackTests, WrapperThrowsOnWrongTxType)
170{
171 // Build a valid transaction of a different type
172 auto const [pk, sk] =
174 auto const account = calcAccountID(pk);
175
176 AccountSetBuilder wrongBuilder{account, 1, canonical_AMOUNT()};
177 auto wrongTx = wrongBuilder.build(pk, sk);
178
179 EXPECT_THROW(AMMClawback{wrongTx.getSTTx()}, std::runtime_error);
180}
181
182// 4) Verify builder throws when constructed from wrong transaction type.
183TEST(TransactionsAMMClawbackTests, BuilderThrowsOnWrongTxType)
184{
185 // Build a valid transaction of a different type
186 auto const [pk, sk] =
187 generateKeyPair(KeyType::secp256k1, generateSeed("testWrongTypeBuilder"));
188 auto const account = calcAccountID(pk);
189
190 AccountSetBuilder wrongBuilder{account, 1, canonical_AMOUNT()};
191 auto wrongTx = wrongBuilder.build(pk, sk);
192
193 EXPECT_THROW(AMMClawbackBuilder{wrongTx.getSTTx()}, std::runtime_error);
194}
195
196// 5) Build with only required fields and verify optional fields return nullopt.
197TEST(TransactionsAMMClawbackTests, OptionalFieldsReturnNullopt)
198{
199 // Generate a deterministic keypair for signing
200 auto const [publicKey, secretKey] =
201 generateKeyPair(KeyType::secp256k1, generateSeed("testAMMClawbackNullopt"));
202
203 // Common transaction fields
204 auto const accountValue = calcAccountID(publicKey);
205 std::uint32_t const sequenceValue = 3;
206 auto const feeValue = canonical_AMOUNT();
207
208 // Transaction-specific required field values
209 auto const holderValue = canonical_ACCOUNT();
210 auto const assetValue = canonical_ISSUE();
211 auto const asset2Value = canonical_ISSUE();
212
213 AMMClawbackBuilder builder{
214 accountValue,
215 holderValue,
216 assetValue,
217 asset2Value,
218 sequenceValue,
219 feeValue
220 };
221
222 // Do NOT set optional fields
223
224 auto tx = builder.build(publicKey, secretKey);
225
226 // Verify optional fields are not present
227 EXPECT_FALSE(tx.hasAmount());
228 EXPECT_FALSE(tx.getAmount().has_value());
229}
230
231}
AMMClawback build(PublicKey const &publicKey, SecretKey const &secretKey)
Build and return the AMMClawback wrapper.
std::shared_ptr< STTx const > getSTTx() const
Get the underlying STTx object.
TEST(TransactionsAccountDeleteTests, BuilderSettersRoundTrip)
Seed generateSeed(std::string const &passPhrase)
Generate a seed deterministically.
Definition Seed.cpp:57
std::pair< PublicKey, SecretKey > generateKeyPair(KeyType type, Seed const &seed)
Generate a key pair deterministically.
AccountID calcAccountID(PublicKey const &pk)
void expectEqualField(T const &expected, T const &actual, char const *fieldName)