Tx handler in new RPC framework (#526)

Fixes #527
2025-11-22 04:35:50 +00:00 · 2023-02-28 09:35:13 +00:00
parent a3211f4458
commit 67f0fa26ae
13 changed files with 549 additions and 14 deletions
--- a/unittests/rpc/handlers/TxTest.cpp
+++ b/unittests/rpc/handlers/TxTest.cpp
@@ -0,0 +1,275 @@
+//------------------------------------------------------------------------------
+/*
+    This file is part of clio: https://github.com/XRPLF/clio
+    Copyright (c) 2023, the clio developers.
+
+    Permission to use, copy, modify, and distribute this software for any
+    purpose with or without fee is hereby granted, provided that the above
+    copyright notice and this permission notice appear in all copies.
+
+    THE  SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+    WITH  REGARD  TO  THIS  SOFTWARE  INCLUDING  ALL  IMPLIED  WARRANTIES  OF
+    MERCHANTABILITY  AND  FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+    ANY  SPECIAL,  DIRECT,  INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+    WHATSOEVER  RESULTING  FROM  LOSS  OF USE, DATA OR PROFITS, WHETHER IN AN
+    ACTION  OF  CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+*/
+//==============================================================================
+
+#include <rpc/common/AnyHandler.h>
+#include <rpc/ngHandlers/Tx.h>
+#include <util/Fixtures.h>
+#include <util/TestObject.h>
+
+#include <fmt/core.h>
+
+using namespace RPCng;
+namespace json = boost::json;
+using namespace testing;
+
+constexpr static auto TXNID =
+    "05FB0EB4B899F056FA095537C5817163801F544BAFCEA39C995D76DB4D16F9DD";
+constexpr static auto ACCOUNT = "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn";
+constexpr static auto ACCOUNT2 = "rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun";
+constexpr static auto CURRENCY = "0158415500000000C1F76FF6ECB0BAC600000000";
+
+class RPCTxTest : public HandlerBaseTest
+{
+};
+
+TEST_F(RPCTxTest, ExcessiveLgrRange)
+{
+    boost::asio::spawn(ctx, [this](boost::asio::yield_context yield) {
+        auto const handler = AnyHandler{TxHandler{mockBackendPtr}};
+        auto const req = json::parse(fmt::format(
+            R"({{ 
+                "command": "tx",
+                "transaction": "{}",
+                "min_ledger": 1,
+                "max_ledger":1002
+                }})",
+            TXNID));
+        auto const output = handler.process(req, yield);
+        ASSERT_FALSE(output);
+
+        auto const err = RPC::makeError(output.error());
+        EXPECT_EQ(err.at("error").as_string(), "excessiveLgrRange");
+        EXPECT_EQ(
+            err.at("error_message").as_string(), "Ledger range exceeds 1000.");
+    });
+    ctx.run();
+}
+
+TEST_F(RPCTxTest, InvalidLgrRange)
+{
+    boost::asio::spawn(ctx, [this](boost::asio::yield_context yield) {
+        auto const handler = AnyHandler{TxHandler{mockBackendPtr}};
+        auto const req = json::parse(fmt::format(
+            R"({{ 
+                "command": "tx",
+                "transaction": "{}",
+                "max_ledger": 1,
+                "min_ledger": 10
+                }})",
+            TXNID));
+        auto const output = handler.process(req, yield);
+        ASSERT_FALSE(output);
+
+        auto const err = RPC::makeError(output.error());
+        EXPECT_EQ(err.at("error").as_string(), "invalidLgrRange");
+        EXPECT_EQ(
+            err.at("error_message").as_string(), "Ledger range is invalid.");
+    });
+    ctx.run();
+}
+
+TEST_F(RPCTxTest, TxnNotFound)
+{
+    auto const rawBackendPtr = static_cast<MockBackend*>(mockBackendPtr.get());
+    ON_CALL(*rawBackendPtr, fetchTransaction(ripple::uint256{TXNID}, _))
+        .WillByDefault(Return(std::optional<TransactionAndMetadata>{}));
+    EXPECT_CALL(*rawBackendPtr, fetchTransaction).Times(1);
+    boost::asio::spawn(ctx, [this](boost::asio::yield_context yield) {
+        auto const handler = AnyHandler{TxHandler{mockBackendPtr}};
+        auto const req = json::parse(fmt::format(
+            R"({{ 
+                "command": "tx",
+                "transaction": "{}"
+                }})",
+            TXNID));
+        auto const output = handler.process(req, yield);
+        ASSERT_FALSE(output);
+
+        auto const err = RPC::makeError(output.error());
+        EXPECT_EQ(err.at("error").as_string(), "txnNotFound");
+        EXPECT_EQ(
+            err.at("error_message").as_string(), "Transaction not found.");
+    });
+    ctx.run();
+}
+
+TEST_F(RPCTxTest, TxnNotFoundInGivenRangeSearchAllFalse)
+{
+    auto const rawBackendPtr = static_cast<MockBackend*>(mockBackendPtr.get());
+    mockBackendPtr->updateRange(10);  // min
+    mockBackendPtr->updateRange(30);  // max
+    ON_CALL(*rawBackendPtr, fetchTransaction(ripple::uint256{TXNID}, _))
+        .WillByDefault(Return(std::optional<TransactionAndMetadata>{}));
+    EXPECT_CALL(*rawBackendPtr, fetchTransaction).Times(1);
+    boost::asio::spawn(ctx, [this](boost::asio::yield_context yield) {
+        auto const handler = AnyHandler{TxHandler{mockBackendPtr}};
+        auto const req = json::parse(fmt::format(
+            R"({{ 
+                "command": "tx",
+                "transaction": "{}",
+                "min_ledger": 1,
+                "max_ledger":1000
+                }})",
+            TXNID));
+        auto const output = handler.process(req, yield);
+        ASSERT_FALSE(output);
+
+        auto const err = RPC::makeError(output.error());
+        EXPECT_EQ(err.at("error").as_string(), "txnNotFound");
+        EXPECT_EQ(
+            err.at("error_message").as_string(), "Transaction not found.");
+        EXPECT_EQ(err.at("searched_all").as_bool(), false);
+    });
+    ctx.run();
+}
+
+TEST_F(RPCTxTest, TxnNotFoundInGivenRangeSearchAllTrue)
+{
+    auto const rawBackendPtr = static_cast<MockBackend*>(mockBackendPtr.get());
+    mockBackendPtr->updateRange(1);     // min
+    mockBackendPtr->updateRange(1000);  // max
+    ON_CALL(*rawBackendPtr, fetchTransaction(ripple::uint256{TXNID}, _))
+        .WillByDefault(Return(std::optional<TransactionAndMetadata>{}));
+    EXPECT_CALL(*rawBackendPtr, fetchTransaction).Times(1);
+    boost::asio::spawn(ctx, [this](boost::asio::yield_context yield) {
+        auto const handler = AnyHandler{TxHandler{mockBackendPtr}};
+        auto const req = json::parse(fmt::format(
+            R"({{ 
+                "command": "tx",
+                "transaction": "{}",
+                "min_ledger": 1,
+                "max_ledger":1000
+                }})",
+            TXNID));
+        auto const output = handler.process(req, yield);
+        ASSERT_FALSE(output);
+
+        auto const err = RPC::makeError(output.error());
+        EXPECT_EQ(err.at("error").as_string(), "txnNotFound");
+        EXPECT_EQ(
+            err.at("error_message").as_string(), "Transaction not found.");
+        EXPECT_EQ(err.at("searched_all").as_bool(), true);
+    });
+    ctx.run();
+}
+
+TEST_F(RPCTxTest, DefaultParameter)
+{
+    auto constexpr static OUT = R"({
+            "Account":"rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
+            "Fee":"2",
+            "Sequence":100,
+            "SigningPubKey":"74657374",
+            "TakerGets":{
+                "currency":"0158415500000000C1F76FF6ECB0BAC600000000",
+                "issuer":"rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun",
+                "value":"200"
+            },
+            "TakerPays":"300",
+            "TransactionType":"OfferCreate",
+            "hash":"2E2FBAAFF767227FE4381C4BE9855986A6B9F96C62F6E443731AB36F7BBB8A08",
+            "meta":{
+                "AffectedNodes":[
+                    {
+                        "CreatedNode":{
+                        "LedgerEntryType":"Offer",
+                        "NewFields":{
+                            "TakerGets":"200",
+                            "TakerPays":{
+                                "currency":"0158415500000000C1F76FF6ECB0BAC600000000",
+                                "issuer":"rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
+                                "value":"300"
+                            }
+                        }
+                        }
+                    }
+                ],
+                "TransactionIndex":100,
+                "TransactionResult":"tesSUCCESS"
+            },
+            "date":123456,
+            "ledger_index":100
+    })";
+    auto const rawBackendPtr = static_cast<MockBackend*>(mockBackendPtr.get());
+    TransactionAndMetadata tx;
+    tx.metadata = CreateMetaDataForCreateOffer(CURRENCY, ACCOUNT, 100, 200, 300)
+                      .getSerializer()
+                      .peekData();
+    tx.transaction = CreateCreateOfferTransactionObject(
+                         ACCOUNT, 2, 100, CURRENCY, ACCOUNT2, 200, 300)
+                         .getSerializer()
+                         .peekData();
+    tx.date = 123456;
+    tx.ledgerSequence = 100;
+    ON_CALL(*rawBackendPtr, fetchTransaction(ripple::uint256{TXNID}, _))
+        .WillByDefault(Return(tx));
+    EXPECT_CALL(*rawBackendPtr, fetchTransaction).Times(1);
+    boost::asio::spawn(ctx, [this](boost::asio::yield_context yield) {
+        auto const handler = AnyHandler{TxHandler{mockBackendPtr}};
+        auto const req = json::parse(fmt::format(
+            R"({{ 
+                "command": "tx",
+                "transaction": "{}"
+                }})",
+            TXNID));
+        auto const output = handler.process(req, yield);
+        ASSERT_TRUE(output);
+        EXPECT_EQ(*output, json::parse(OUT));
+    });
+    ctx.run();
+}
+
+TEST_F(RPCTxTest, ReturnBinary)
+{
+    auto constexpr static OUT = R"({
+        "meta":"201C00000064F8E311006FE864D50AA87BEE5380000158415500000000C1F76FF6ECB0BAC6000000004B4E9C06F24296074F7BC48F92A97916C6DC5EA96540000000000000C8E1E1F1031000",
+        "tx":"120007240000006464400000000000012C65D5071AFD498D00000158415500000000C1F76FF6ECB0BAC600000000D31252CF902EF8DD8451243869B38667CBD89DF368400000000000000273047465737481144B4E9C06F24296074F7BC48F92A97916C6DC5EA9",
+        "hash":"05FB0EB4B899F056FA095537C5817163801F544BAFCEA39C995D76DB4D16F9DD",
+        "date":123456,
+        "ledger_index":100
+    })";
+    auto const rawBackendPtr = static_cast<MockBackend*>(mockBackendPtr.get());
+    TransactionAndMetadata tx;
+    tx.metadata = CreateMetaDataForCreateOffer(CURRENCY, ACCOUNT, 100, 200, 300)
+                      .getSerializer()
+                      .peekData();
+    tx.transaction = CreateCreateOfferTransactionObject(
+                         ACCOUNT, 2, 100, CURRENCY, ACCOUNT2, 200, 300)
+                         .getSerializer()
+                         .peekData();
+    tx.date = 123456;
+    tx.ledgerSequence = 100;
+    ON_CALL(*rawBackendPtr, fetchTransaction(ripple::uint256{TXNID}, _))
+        .WillByDefault(Return(tx));
+    EXPECT_CALL(*rawBackendPtr, fetchTransaction).Times(1);
+    boost::asio::spawn(ctx, [this](boost::asio::yield_context yield) {
+        auto const handler = AnyHandler{TxHandler{mockBackendPtr}};
+        auto const req = json::parse(fmt::format(
+            R"({{ 
+                "command": "tx",
+                "transaction": "{}",
+                "binary": true
+                }})",
+            TXNID));
+        auto const output = handler.process(req, yield);
+        ASSERT_TRUE(output);
+        EXPECT_EQ(*output, json::parse(OUT));
+    });
+    ctx.run();
+}