rippled
Loading...
Searching...
No Matches
EscrowCreateTests.cpp
1// Auto-generated unit tests for transaction EscrowCreate
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/EscrowCreate.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(TransactionsEscrowCreateTests, 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 destinationValue = canonical_ACCOUNT();
33 auto const amountValue = canonical_AMOUNT();
34 auto const conditionValue = canonical_VL();
35 auto const cancelAfterValue = canonical_UINT32();
36 auto const finishAfterValue = canonical_UINT32();
37 auto const destinationTagValue = canonical_UINT32();
38
39 EscrowCreateBuilder builder{
40 accountValue,
41 destinationValue,
42 amountValue,
43 sequenceValue,
44 feeValue
45 };
46
47 // Set optional fields
48 builder.setCondition(conditionValue);
49 builder.setCancelAfter(cancelAfterValue);
50 builder.setFinishAfter(finishAfterValue);
51 builder.setDestinationTag(destinationTagValue);
52
53 auto tx = builder.build(publicKey, secretKey);
54
55 std::string reason;
56 EXPECT_TRUE(tx.validate(reason)) << reason;
57
58 // Verify signing was applied
59 EXPECT_FALSE(tx.getSigningPubKey().empty());
60 EXPECT_TRUE(tx.hasTxnSignature());
61
62 // Verify common fields
63 EXPECT_EQ(tx.getAccount(), accountValue);
64 EXPECT_EQ(tx.getSequence(), sequenceValue);
65 EXPECT_EQ(tx.getFee(), feeValue);
66
67 // Verify required fields
68 {
69 auto const& expected = destinationValue;
70 auto const actual = tx.getDestination();
71 expectEqualField(expected, actual, "sfDestination");
72 }
73
74 {
75 auto const& expected = amountValue;
76 auto const actual = tx.getAmount();
77 expectEqualField(expected, actual, "sfAmount");
78 }
79
80 // Verify optional fields
81 {
82 auto const& expected = conditionValue;
83 auto const actualOpt = tx.getCondition();
84 ASSERT_TRUE(actualOpt.has_value()) << "Optional field sfCondition should be present";
85 expectEqualField(expected, *actualOpt, "sfCondition");
86 EXPECT_TRUE(tx.hasCondition());
87 }
88
89 {
90 auto const& expected = cancelAfterValue;
91 auto const actualOpt = tx.getCancelAfter();
92 ASSERT_TRUE(actualOpt.has_value()) << "Optional field sfCancelAfter should be present";
93 expectEqualField(expected, *actualOpt, "sfCancelAfter");
94 EXPECT_TRUE(tx.hasCancelAfter());
95 }
96
97 {
98 auto const& expected = finishAfterValue;
99 auto const actualOpt = tx.getFinishAfter();
100 ASSERT_TRUE(actualOpt.has_value()) << "Optional field sfFinishAfter should be present";
101 expectEqualField(expected, *actualOpt, "sfFinishAfter");
102 EXPECT_TRUE(tx.hasFinishAfter());
103 }
104
105 {
106 auto const& expected = destinationTagValue;
107 auto const actualOpt = tx.getDestinationTag();
108 ASSERT_TRUE(actualOpt.has_value()) << "Optional field sfDestinationTag should be present";
109 expectEqualField(expected, *actualOpt, "sfDestinationTag");
110 EXPECT_TRUE(tx.hasDestinationTag());
111 }
112
113}
114
115// 2 & 4) Start from an STTx, construct a builder from it, build a new wrapper,
116// and verify all fields match.
117TEST(TransactionsEscrowCreateTests, BuilderFromStTxRoundTrip)
118{
119 // Generate a deterministic keypair for signing
120 auto const [publicKey, secretKey] =
121 generateKeyPair(KeyType::secp256k1, generateSeed("testEscrowCreateFromTx"));
122
123 // Common transaction fields
124 auto const accountValue = calcAccountID(publicKey);
125 std::uint32_t const sequenceValue = 2;
126 auto const feeValue = canonical_AMOUNT();
127
128 // Transaction-specific field values
129 auto const destinationValue = canonical_ACCOUNT();
130 auto const amountValue = canonical_AMOUNT();
131 auto const conditionValue = canonical_VL();
132 auto const cancelAfterValue = canonical_UINT32();
133 auto const finishAfterValue = canonical_UINT32();
134 auto const destinationTagValue = canonical_UINT32();
135
136 // Build an initial transaction
137 EscrowCreateBuilder initialBuilder{
138 accountValue,
139 destinationValue,
140 amountValue,
141 sequenceValue,
142 feeValue
143 };
144
145 initialBuilder.setCondition(conditionValue);
146 initialBuilder.setCancelAfter(cancelAfterValue);
147 initialBuilder.setFinishAfter(finishAfterValue);
148 initialBuilder.setDestinationTag(destinationTagValue);
149
150 auto initialTx = initialBuilder.build(publicKey, secretKey);
151
152 // Create builder from existing STTx
153 EscrowCreateBuilder builderFromTx{initialTx.getSTTx()};
154
155 auto rebuiltTx = builderFromTx.build(publicKey, secretKey);
156
157 std::string reason;
158 EXPECT_TRUE(rebuiltTx.validate(reason)) << reason;
159
160 // Verify common fields
161 EXPECT_EQ(rebuiltTx.getAccount(), accountValue);
162 EXPECT_EQ(rebuiltTx.getSequence(), sequenceValue);
163 EXPECT_EQ(rebuiltTx.getFee(), feeValue);
164
165 // Verify required fields
166 {
167 auto const& expected = destinationValue;
168 auto const actual = rebuiltTx.getDestination();
169 expectEqualField(expected, actual, "sfDestination");
170 }
171
172 {
173 auto const& expected = amountValue;
174 auto const actual = rebuiltTx.getAmount();
175 expectEqualField(expected, actual, "sfAmount");
176 }
177
178 // Verify optional fields
179 {
180 auto const& expected = conditionValue;
181 auto const actualOpt = rebuiltTx.getCondition();
182 ASSERT_TRUE(actualOpt.has_value()) << "Optional field sfCondition should be present";
183 expectEqualField(expected, *actualOpt, "sfCondition");
184 }
185
186 {
187 auto const& expected = cancelAfterValue;
188 auto const actualOpt = rebuiltTx.getCancelAfter();
189 ASSERT_TRUE(actualOpt.has_value()) << "Optional field sfCancelAfter should be present";
190 expectEqualField(expected, *actualOpt, "sfCancelAfter");
191 }
192
193 {
194 auto const& expected = finishAfterValue;
195 auto const actualOpt = rebuiltTx.getFinishAfter();
196 ASSERT_TRUE(actualOpt.has_value()) << "Optional field sfFinishAfter should be present";
197 expectEqualField(expected, *actualOpt, "sfFinishAfter");
198 }
199
200 {
201 auto const& expected = destinationTagValue;
202 auto const actualOpt = rebuiltTx.getDestinationTag();
203 ASSERT_TRUE(actualOpt.has_value()) << "Optional field sfDestinationTag should be present";
204 expectEqualField(expected, *actualOpt, "sfDestinationTag");
205 }
206
207}
208
209// 3) Verify wrapper throws when constructed from wrong transaction type.
210TEST(TransactionsEscrowCreateTests, WrapperThrowsOnWrongTxType)
211{
212 // Build a valid transaction of a different type
213 auto const [pk, sk] =
215 auto const account = calcAccountID(pk);
216
217 AccountSetBuilder wrongBuilder{account, 1, canonical_AMOUNT()};
218 auto wrongTx = wrongBuilder.build(pk, sk);
219
220 EXPECT_THROW(EscrowCreate{wrongTx.getSTTx()}, std::runtime_error);
221}
222
223// 4) Verify builder throws when constructed from wrong transaction type.
224TEST(TransactionsEscrowCreateTests, BuilderThrowsOnWrongTxType)
225{
226 // Build a valid transaction of a different type
227 auto const [pk, sk] =
228 generateKeyPair(KeyType::secp256k1, generateSeed("testWrongTypeBuilder"));
229 auto const account = calcAccountID(pk);
230
231 AccountSetBuilder wrongBuilder{account, 1, canonical_AMOUNT()};
232 auto wrongTx = wrongBuilder.build(pk, sk);
233
234 EXPECT_THROW(EscrowCreateBuilder{wrongTx.getSTTx()}, std::runtime_error);
235}
236
237// 5) Build with only required fields and verify optional fields return nullopt.
238TEST(TransactionsEscrowCreateTests, OptionalFieldsReturnNullopt)
239{
240 // Generate a deterministic keypair for signing
241 auto const [publicKey, secretKey] =
242 generateKeyPair(KeyType::secp256k1, generateSeed("testEscrowCreateNullopt"));
243
244 // Common transaction fields
245 auto const accountValue = calcAccountID(publicKey);
246 std::uint32_t const sequenceValue = 3;
247 auto const feeValue = canonical_AMOUNT();
248
249 // Transaction-specific required field values
250 auto const destinationValue = canonical_ACCOUNT();
251 auto const amountValue = canonical_AMOUNT();
252
253 EscrowCreateBuilder builder{
254 accountValue,
255 destinationValue,
256 amountValue,
257 sequenceValue,
258 feeValue
259 };
260
261 // Do NOT set optional fields
262
263 auto tx = builder.build(publicKey, secretKey);
264
265 // Verify optional fields are not present
266 EXPECT_FALSE(tx.hasCondition());
267 EXPECT_FALSE(tx.getCondition().has_value());
268 EXPECT_FALSE(tx.hasCancelAfter());
269 EXPECT_FALSE(tx.getCancelAfter().has_value());
270 EXPECT_FALSE(tx.hasFinishAfter());
271 EXPECT_FALSE(tx.getFinishAfter().has_value());
272 EXPECT_FALSE(tx.hasDestinationTag());
273 EXPECT_FALSE(tx.getDestinationTag().has_value());
274}
275
276}
EscrowCreate build(PublicKey const &publicKey, SecretKey const &secretKey)
Build and return the EscrowCreate 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)