[fold] address review

- fix comments - rename batch executions
Transia-RnD · Nov 11, 2024 · 8029c30 · 8029c30
1 parent 04519e6
commit 8029c30
Show file tree

Hide file tree

Showing 9 changed files with 21 additions and 20 deletions.
diff --git a/include/xrpl/protocol/TxFlags.h b/include/xrpl/protocol/TxFlags.h
@@ -217,7 +217,7 @@ constexpr std::uint32_t tfAMMClawbackMask = ~(tfUniversal | tfClawTwoAssets);
 constexpr std::uint32_t tfClearAccountCreateAmount     = 0x00010000;
 constexpr std::uint32_t tfBridgeModifyMask = ~(tfUniversalV2 | tfClearAccountCreateAmount);
 
-// Batch Flags
+// Batch Flags:
 constexpr std::uint32_t tfAllOrNothing                 = 0x00010000;
 constexpr std::uint32_t tfOnlyOne                      = 0x00020000;
 constexpr std::uint32_t tfUntilFailure                 = 0x00040000;

diff --git a/src/test/app/Batch_test.cpp b/src/test/app/Batch_test.cpp
@@ -76,7 +76,7 @@ class Batch_test : public beast::unit_test::suite
 
     void
     validateBatchMeta(
-        Json::Value meta,
+        Json::Value const& meta,
         STAmount const& balance,
         std::uint32_t const& sequence,
         std::optional<std::uint32_t> ownerCount = std::nullopt,
@@ -390,7 +390,7 @@ class Batch_test : public beast::unit_test::suite
             env.close();
         }
 
-        // temMALFORMED: Batch: txn hash does not match TxIDs hash.
+        // temMALFORMED: Batch: order of inner transactions does not match TxIDs.
         {
             auto const batchFee = ((1 + 2) * feeDrops) + feeDrops * 2;
             Json::Value jv =
@@ -449,7 +449,7 @@ class Batch_test : public beast::unit_test::suite
             auto const seq = env.seq(alice);
             auto const batchFee = ((1 + 2) * feeDrops) + feeDrops * 2;
             env(batch::batch(alice, seq, batchFee, tfAllOrNothing),
-                batch::add(pay(alice, bob, XRP(10)), seq + 0),
+                batch::add(pay(alice, bob, XRP(10)), seq + 1),
                 batch::add(pay(bob, alice, XRP(5)), env.seq(bob)),
                 batch::sig(carol),
                 ter(temBAD_SIGNER));
@@ -461,7 +461,7 @@ class Batch_test : public beast::unit_test::suite
             auto const seq = env.seq(alice);
             auto const batchFee = ((1 + 2) * feeDrops) + feeDrops * 2;
             env(batch::batch(alice, seq, batchFee, tfAllOrNothing),
-                batch::add(pay(alice, bob, XRP(10)), seq + 0),
+                batch::add(pay(alice, bob, XRP(10)), seq + 1),
                 batch::add(pay(bob, alice, XRP(5)), env.seq(bob)),
                 batch::sig(bob, carol),
                 ter(temBAD_SIGNER));

diff --git a/src/xrpld/app/misc/NetworkOPs.cpp b/src/xrpld/app/misc/NetworkOPs.cpp
@@ -1143,7 +1143,7 @@ NetworkOPsImp::submitTransaction(std::shared_ptr<STTx const> const& iTrans)
         view->rules().enabled(featureBatch) && iTrans->isFlag(tfInnerBatchTxn))
     {
         JLOG(m_journal.error())
-            << "Submitted transaction invalid: BatchTxn present.";
+            << "Submitted transaction invalid: tfInnerBatchTxn flag present.";
         return;
     }
 

diff --git a/src/xrpld/app/tx/detail/Batch.cpp b/src/xrpld/app/tx/detail/Batch.cpp
@@ -255,7 +255,7 @@ Batch::doApply()
         meta.setFieldU16(sfTransactionType, stx.getTxnType());
         if (ter == tesSUCCESS || isTecClaim(ter))
             meta.setFieldH256(sfTransactionHash, stx.getTransactionID());
-        avi.addBatchExecutionMetaData(std::move(meta));
+        avi.addBatchExecution(std::move(meta));
 
         if (ter != tesSUCCESS)
         {

diff --git a/src/xrpld/app/tx/detail/Transactor.cpp b/src/xrpld/app/tx/detail/Transactor.cpp
@@ -869,7 +869,7 @@ Transactor::reset(XRPAmount fee)
     avi.copyBatchMetaData(executions);
     ctx_.discard();
     ApplyViewImpl& avi2 = dynamic_cast<ApplyViewImpl&>(ctx_.view());
-    avi2.setBatchMetaData(std::move(executions));
+    avi2.setBatchExecutions(std::move(executions));
 
     auto const txnAcct =
         view().peek(keylet::account(ctx_.tx.getAccountID(sfAccount)));

diff --git a/src/xrpld/app/tx/detail/apply.cpp b/src/xrpld/app/tx/detail/apply.cpp
@@ -44,7 +44,7 @@ checkValidity(
     auto const id = tx.getTransactionID();
     auto const flags = router.getFlags(id);
 
-    // Validate Inner BatchTxn
+    // Validate tfInnerBatchTxn
     if (rules.enabled(featureBatch) && tx.isFlag(tfInnerBatchTxn))
     {
         // batched transactions do not contain signatures

diff --git a/src/xrpld/ledger/ApplyViewImpl.h b/src/xrpld/ledger/ApplyViewImpl.h
@@ -84,23 +84,23 @@ class ApplyViewImpl final : public detail::ApplyViewBase
     }
 
     void
-    addBatchExecutionMetaData(STObject&& batchExecution)
+    addBatchExecution(STObject&& batchExecution)
     {
-        batchExecution_.push_back(std::move(batchExecution));
+        batchExecutions_.push_back(std::move(batchExecution));
     }
 
     void
-    setBatchMetaData(std::vector<STObject>&& batch)
+    setBatchExecutions(std::vector<STObject>&& batchExecutions)
     {
-        batchExecution_ = std::move(batch);
+        batchExecutions_ = std::move(batchExecutions);
     }
 
     void
     copyBatchMetaData(std::vector<STObject>& execution)
     {
         std::copy(
-            batchExecution_.begin(),
-            batchExecution_.end(),
+            batchExecutions_.begin(),
+            batchExecutions_.end(),
             std::back_inserter(execution));
     }
 
@@ -122,7 +122,7 @@ class ApplyViewImpl final : public detail::ApplyViewBase
 
 private:
     std::optional<STAmount> deliver_;
-    std::vector<STObject> batchExecution_;
+    std::vector<STObject> batchExecutions_;
     std::optional<STObject> batchPrevAcctRootFields_;
 };
 

diff --git a/src/xrpld/ledger/detail/ApplyStateTable.cpp b/src/xrpld/ledger/detail/ApplyStateTable.cpp
@@ -115,7 +115,7 @@ ApplyStateTable::apply(
     STTx const& tx,
     TER ter,
     std::optional<STAmount> const& deliver,
-    std::vector<STObject> const& batchExecution,
+    std::vector<STObject> const& batchExecutions,
     std::optional<STObject> const& batchPrevAcctRootFields,
     beast::Journal j)
 {
@@ -130,10 +130,11 @@ ApplyStateTable::apply(
         if (deliver)
             meta.setDeliveredAmount(*deliver);
 
-        if (!batchExecution.empty())
+        if (!batchExecutions.empty())
         {
+            assert(isBatch);
             auto array = STArray{sfBatchExecutions};
-            for (auto element : batchExecution)
+            for (auto const& element : batchExecutions)
                 array.push_back(element);
             meta.setBatchExecutions(array);
         }

diff --git a/src/xrpld/ledger/detail/ApplyViewImpl.cpp b/src/xrpld/ledger/detail/ApplyViewImpl.cpp
@@ -32,7 +32,7 @@ void
 ApplyViewImpl::apply(OpenView& to, STTx const& tx, TER ter, beast::Journal j)
 {
     items_.apply(
-        to, tx, ter, deliver_, batchExecution_, batchPrevAcctRootFields_, j);
+        to, tx, ter, deliver_, batchExecutions_, batchPrevAcctRootFields_, j);
 }
 
 std::size_t