fix: Update noripple_check to exclude transactions field on error responses

API-CHANGELOG.md

@@ -83,9 +83,15 @@ The [commandline](https://xrpl.org/docs/references/http-websocket-apis/api-conve
 
 The `network_id` field was added in the `server_info` response in version 1.5.0 (2019), but it is not returned in [reporting mode](https://xrpl.org/rippled-server-modes.html#reporting-mode). However, use of reporting mode is now discouraged, in favor of using [Clio](https://github.com/XRPLF/clio) instead.
 
+## Unreleased
+
+### Additions and bugfixes in unreleased version
+
+- `noripple_check`: The `transactions` field is no longer included in the response if the response is an error or if there are no `problems`.
+
 ## XRP Ledger server version 2.5.0
 
-As of 2025-04-04, version 2.5.0 is in development. You can use a pre-release version by building from source or [using the `nightly` package](https://xrpl.org/docs/infrastructure/installation/install-rippled-on-ubuntu).
+[Version 2.5.0](https://github.com/XRPLF/rippled/releases/tag/2.5.0) was released on June 24, 2025.
 
 ### Additions and bugfixes in 2.5.0
 

include/xrpl/protocol/jss.h

@@ -281,6 +281,7 @@ JSS(frozen_balances);         // out: GatewayBalances
 JSS(full);                    // in: LedgerClearer, handlers/Ledger
 JSS(full_reply);              // out: PathFind
 JSS(fullbelow_size);          // out: GetCounts
+JSS(gateway);                 // in: noripple_check
 JSS(git);                     // out: server_info
 JSS(good);                    // out: RPCVersion
 JSS(hash);                    // out: NetworkOPs, InboundLedger,
@@ -484,6 +485,7 @@ JSS(ports);                   // out: NetworkOPs
 JSS(previous);                // out: Reservations
 JSS(previous_ledger);         // out: LedgerPropose
 JSS(price);                   // out: amm_info, AuctionSlot
+JSS(problems);                // out: noripple_check
 JSS(proof);                   // in: BookOffers
 JSS(propose_seq);             // out: LedgerPropose
 JSS(proposers);               // out: NetworkOPs, LedgerConsensus
@@ -661,6 +663,7 @@ JSS(url);                     // in/out: Subscribe, Unsubscribe
 JSS(url_password);            // in: Subscribe
 JSS(url_username);            // in: Subscribe
 JSS(urlgravatar);             //
+JSS(user);                    // in: noripple_check
 JSS(username);                // in: Subscribe
 JSS(validated);               // out: NetworkOPs, RPCHelpers, AccountTx*
                               //      Tx

src/test/rpc/NoRippleCheck_test.cpp

@@ -102,13 +102,16 @@ class NoRippleCheck_test : public beast::unit_test::suite
 
         {  // passing an account private key will cause
            // parsing as a seed to fail
+           // also, `transactions` is not included
             Json::Value params;
             params[jss::account] = toBase58(TokenType::NodePrivate, alice.sk());
             params[jss::role] = "user";
             params[jss::ledger] = "current";
+            params[jss::transactions] = true;
             auto const result = env.rpc("json", "noripple_check", to_string(params))[jss::result];
             BEAST_EXPECT(result[jss::error] == "actMalformed");
             BEAST_EXPECT(result[jss::error_message] == "Account malformed.");
+            BEAST_EXPECT(!result.isMember(jss::transactions));
         }
 
         {
@@ -198,12 +201,12 @@ class NoRippleCheck_test : public beast::unit_test::suite
         // time.
         params[jss::transactions] = true;
         result = env.rpc("json", "noripple_check", to_string(params))[jss::result];
-        if (!BEAST_EXPECT(result[jss::transactions].isArray()))
-            return;
 
         auto const txs = result[jss::transactions];
         if (problems)
         {
+            if (!BEAST_EXPECT(result[jss::transactions].isArray()))
+                return;
             if (!BEAST_EXPECT(txs.size() == (user ? 1 : 2)))
                 return;
 

src/xrpld/rpc/handlers/NoRippleCheck.cpp

@@ -22,12 +22,12 @@ fillTransaction(
     std::uint32_t& sequence,
     ReadView const& ledger)
 {
-    txArray["Sequence"] = Json::UInt(sequence++);
-    txArray["Account"] = toBase58(accountID);
+    txArray[jss::Sequence] = Json::UInt(sequence++);
+    txArray[jss::Account] = toBase58(accountID);
     auto& fees = ledger.fees();
     // Convert the reference transaction cost in fee units to drops
     // scaled to represent the current fee load.
-    txArray["Fee"] = scaleFeeLoad(fees.base, context.app.getFeeTrack(), fees, false).jsonClipped();
+    txArray[jss::Fee] = scaleFeeLoad(fees.base, context.app.getFeeTrack(), fees, false).jsonClipped();
 }
 
 // {
@@ -42,32 +42,40 @@ Json::Value
 doNoRippleCheck(RPC::JsonContext& context)
 {
     auto const& params(context.params);
-    if (!params.isMember(jss::account))
-        return RPC::missing_field_error("account");
 
-    if (!params.isMember("role"))
-        return RPC::missing_field_error("role");
+    // check account param
+    if (!params.isMember(jss::account))
+        return RPC::missing_field_error(jss::account);
 
     if (!params[jss::account].isString())
         return RPC::invalid_field_error(jss::account);
 
+    auto id = parseBase58<AccountID>(params[jss::account].asString());
+    if (!id)
+    {
+        return rpcError(rpcACT_MALFORMED);
+    }
+    auto const accountID{std::move(id.value())};
+
+    // check role param
+    if (!params.isMember(jss::role))
+        return RPC::missing_field_error(jss::role);
+
     bool roleGateway = false;
     {
-        std::string const role = params["role"].asString();
-        if (role == "gateway")
+        std::string const role = params[jss::role].asString();
+        if (role == jss::gateway)
             roleGateway = true;
-        else if (role != "user")
-            return RPC::invalid_field_error("role");
+        else if (role != jss::user)
+            return RPC::invalid_field_error(jss::role);
     }
 
+    // check limit param
     unsigned int limit;
     if (auto err = readLimitField(limit, RPC::Tuning::noRippleCheck, context))
         return *err;
 
-    bool transactions = false;
-    if (params.isMember(jss::transactions))
-        transactions = params["transactions"].asBool();
-
+    // check transactions param
     // The document[https://xrpl.org/noripple_check.html#noripple_check] states
     // that transactions params is a boolean value, however, assigning any
     // string value works. Do not allow this. This check is for api Version 2
@@ -77,31 +85,28 @@ doNoRippleCheck(RPC::JsonContext& context)
         return RPC::invalid_field_error(jss::transactions);
     }
 
+    bool transactions = false;
+    if (params.isMember(jss::transactions))
+        transactions = params[jss::transactions].asBool();
+
+    // lookup ledger via params
     std::shared_ptr<ReadView const> ledger;
     auto result = RPC::lookupLedger(ledger, context);
     if (!ledger)
         return result;
 
-    Json::Value dummy;
-    Json::Value& jvTransactions = transactions ? (result[jss::transactions] = Json::arrayValue) : dummy;
-
-    auto id = parseBase58<AccountID>(params[jss::account].asString());
-    if (!id)
-    {
-        RPC::inject_error(rpcACT_MALFORMED, result);
-        return result;
-    }
-    auto const accountID{std::move(id.value())};
     auto const sle = ledger->read(keylet::account(accountID));
     if (!sle)
         return rpcError(rpcACT_NOT_FOUND);
 
     std::uint32_t seq = sle->getFieldU32(sfSequence);
 
-    Json::Value& problems = (result["problems"] = Json::arrayValue);
+    Json::Value& problems = (result[jss::problems] = Json::arrayValue);
 
     bool bDefaultRipple = sle->getFieldU32(sfFlags) & lsfDefaultRipple;
 
+    Json::Value jvTransactions = Json::arrayValue;
+
     if (bDefaultRipple & !roleGateway)
     {
         problems.append(
@@ -115,8 +120,8 @@ doNoRippleCheck(RPC::JsonContext& context)
         if (transactions)
         {
             Json::Value& tx = jvTransactions.append(Json::objectValue);
-            tx["TransactionType"] = jss::AccountSet;
-            tx["SetFlag"] = 8;
+            tx[jss::TransactionType] = jss::AccountSet;
+            tx[jss::SetFlag] = 8;
             fillTransaction(context, tx, accountID, seq, *ledger);
         }
     }
@@ -153,9 +158,9 @@ doNoRippleCheck(RPC::JsonContext& context)
                 limitAmount.setIssuer(peer);
 
                 Json::Value& tx = jvTransactions.append(Json::objectValue);
-                tx["TransactionType"] = jss::TrustSet;
-                tx["LimitAmount"] = limitAmount.getJson(JsonOptions::none);
-                tx["Flags"] = bNoRipple ? tfClearNoRipple : tfSetNoRipple;
+                tx[jss::TransactionType] = jss::TrustSet;
+                tx[jss::LimitAmount] = limitAmount.getJson(JsonOptions::none);
+                tx[jss::Flags] = bNoRipple ? tfClearNoRipple : tfSetNoRipple;
                 fillTransaction(context, tx, accountID, seq, *ledger);
 
                 return true;
@@ -164,6 +169,7 @@ doNoRippleCheck(RPC::JsonContext& context)
         return false;
     });
 
+    result[jss::transactions] = std::move(jvTransactions);
     return result;
 }