fix casting issues in RPC CLIs, remove `proof` from `book_offers` #6044

mvadari · 2025-11-17T12:45:38Z

High Level Overview of Change

This PR fixes some casting issues that resulted in some bad errors in the RPC CLIs, namely:

account_tx
book_offers
can_delete
connect
get_counts
tx_history

This PR also removes the proof parameter from book_offers, which isn't documented anywhere and also doesn't do anything (there will be no change in behavior except in the CLI, since rippled just ignores other parameters).

This also results in some serious simplification opportunities in the RPCCall_test tests.

Context of Change

Downstream of #6043

Type of Change

Bug fix (non-breaking change which fixes an issue)
Tests (you added tests for code that already exists, or your new feature included in this PR)

API Impact

Some bugs were fixed in the CLI API. The proof parameter was also removed, which decreases the number of CLI params in book_offers.

There are no changes to HTTPS and WS API users.

Test Plan

CI passes. Tests were adjusted.

codecov · 2025-11-17T13:13:22Z

Codecov Report

❌ Patch coverage is 89.79592% with 5 lines in your changes missing coverage. Please review.
✅ Project coverage is 79.1%. Comparing base (6c67f1f) to head (100ad8b).

Files with missing lines	Patch %	Lines
src/xrpld/rpc/detail/RPCCall.cpp	89.8%	5 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##           develop   #6044   +/-   ##
=======================================
  Coverage     79.0%   79.1%           
=======================================
  Files          839     839           
  Lines        71377   71400   +23     
  Branches      8339    8333    -6     
=======================================
+ Hits         56422   56451   +29     
+ Misses       14955   14949    -6

Files with missing lines	Coverage Δ
src/xrpld/app/misc/NetworkOPs.cpp	`69.9% <ø> (ø)`
src/xrpld/app/misc/NetworkOPs.h	`100.0% <ø> (ø)`
src/xrpld/rpc/handlers/BookOffers.cpp	`98.9% <ø> (-<0.1%)`	⬇️
src/xrpld/rpc/handlers/Subscribe.cpp	`91.6% <ø> (ø)`
src/xrpld/rpc/detail/RPCCall.cpp	`93.9% <89.8%> (+0.2%)`	⬆️

... and 3 files with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

src/test/rpc/RPCCall_test.cpp

Tapanito · 2025-11-20T09:21:02Z

src/xrpld/rpc/detail/RPCCall.cpp


        while (!bDone && iParams >= 2)
        {
            // VFALCO Why is Json::StaticString appearing on the right side?


As a flyby, does this comment still make sense? It's seems a little pointless

It is still factually correct (jss is Json::StaticString). Not sure why it's a problem though.

Tapanito · 2025-11-20T09:21:41Z

src/xrpld/rpc/detail/RPCCall.cpp

-            std::int64_t uLedgerMin = jvParams[1u].asInt();
-            std::int64_t uLedgerMax = jvParams[2u].asInt();
+            std::int32_t ledgerMin, ledgerMax;
+            if (auto ledgerMinOpt = jvParseInt(jvParams[1u]))


Can be const

Suggested change

if (auto ledgerMinOpt = jvParseInt(jvParams[1u]))

if (auto const ledgerMinOpt = jvParseInt(jvParams[1u]))

Here too, shouldn't we parse the ledgerMin as uint?

No, -1 is a valid value. https://xrpl.org/docs/references/http-websocket-apis/public-api-methods/account-methods/account_tx

A value of -1 instructs the server to use the most recent validated ledger version available.

Got it, thanks! Might be worth adding a blurb in the comments though, explaining that.

src/xrpld/rpc/detail/RPCCall.cpp

Tapanito · 2025-11-20T09:28:21Z

src/xrpld/rpc/detail/RPCCall.cpp

-            std::int64_t uLedgerMin = jvParams[1u].asInt();
-            std::int64_t uLedgerMax = jvParams[2u].asInt();
+            std::int32_t ledgerMin, ledgerMax;
+            if (auto ledgerMinOpt = jvParseInt(jvParams[1u]))


Here too, shouldn't we parse the ledgerMin as uint?

Tapanito · 2025-11-20T09:29:13Z

src/xrpld/rpc/detail/RPCCall.cpp


 #include <array>
 #include <iostream>
 #include <type_traits>


nit: (driveby) This include isn't used.

src/xrpld/rpc/detail/RPCCall.cpp

Tapanito · 2025-11-20T10:27:11Z

src/xrpld/rpc/detail/RPCCall.cpp

        if (jvParams.size())
-            jvRequest[jss::min_count] = jvParams[0u].asUInt();
+        {
+            if (auto minCount = jvParseUInt(jvParams[0u]))


My bad, I missed this:

Suggested change

if (auto minCount = jvParseUInt(jvParams[0u]))

if (auto const minCount = jvParseUInt(jvParams[0u]))

Tapanito · 2025-11-20T10:27:59Z

src/xrpld/rpc/detail/RPCCall.cpp

        {
            jvRequest[jss::ip] = ip;
-            jvRequest[jss::port] = jvParams[1u].asUInt();
+            if (auto port = jvParseUInt(jvParams[1u]))


I missed this too:

Suggested change

if (auto port = jvParseUInt(jvParams[1u]))

if (auto const port = jvParseUInt(jvParams[1u]))

Tapanito · 2025-11-20T10:28:18Z

src/xrpld/rpc/detail/RPCCall.cpp

        if (input.find_first_not_of("0123456789") == std::string::npos)
-            jvRequest["can_delete"] = jvParams[0u].asUInt();
+        {
+            if (auto seq = jvParseUInt(jvParams[0u]))


And I missed this too:

Suggested change

if (auto seq = jvParseUInt(jvParams[0u]))

if (auto const seq = jvParseUInt(jvParams[0u]))

Copilot

Pull request overview

This PR fixes casting issues in RPC command-line interfaces and removes the unused proof parameter from book_offers. The changes improve error handling by replacing unsafe type casts with proper validation using new helper functions jvParseInt and jvParseUInt.

Key Changes

Removed the proof parameter from book_offers RPC method (it was documented nowhere and had no effect)
Added jvParseInt and jvParseUInt helper functions for safer integer parsing from JSON values
Updated CLI parsing for account_tx, book_offers, can_delete, connect, get_counts, and tx_history to use the new helpers
Simplified test infrastructure by removing exception-based test expectations

Reviewed changes

Copilot reviewed 7 out of 8 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
src/xrpld/rpc/handlers/BookOffers.cpp	Removed `bProof` variable and parameter from `doBookOffers` function
src/xrpld/rpc/handlers/Subscribe.cpp	Removed `false` (proof) parameter from `getBookPage` call
src/xrpld/app/misc/NetworkOPs.h	Removed `bProof` parameter from `getBookPage` signature
src/xrpld/app/misc/NetworkOPs.cpp	Removed `bProof` parameter from both `getBookPage` implementations
src/xrpld/rpc/detail/RPCCall.cpp	Added parsing helpers, updated CLI parsers for better error handling, removed proof handling from `book_offers`, changed max params from 7 to 6
src/test/rpc/RPCCall_test.cpp	Removed exception-based test structure, updated test expectations for commands that now return errors instead of throwing
include/xrpl/protocol/jss.h	Removed `proof` constant declaration
API-CHANGELOG.md	Added entry documenting the removal of `proof` parameter

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-02T23:00:38Z

API-CHANGELOG.md

 ## 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.4.0](https://github.com/XRPLF/rippled/releases/tag/2.5.0) was released on June 24, 2025.


The version number in the link does not match the section heading. The link says "2.4.0" but should say "2.5.0" to match the section title "XRP Ledger server version 2.5.0".

Suggested change

[Version 2.4.0](https://github.com/XRPLF/rippled/releases/tag/2.5.0) was released on June 24, 2025.

[Version 2.5.0](https://github.com/XRPLF/rippled/releases/tag/2.5.0) was released on June 24, 2025.

Copilot · 2025-12-02T23:00:39Z

src/xrpld/rpc/detail/RPCCall.cpp

-
-                if (iLimit > 0)
-                    jvRequest[jss::limit] = iLimit;
+                if (limit > 0)


The condition if (limit > 0) means that a limit value of 0 will be silently ignored and not added to the request. However, based on the comment "limit: 0 = no limit", a limit of 0 appears to have special meaning. The code should either:

Add the limit to the request even when it's 0 (if 0 is a valid value)

Return an error if the limit is <= 0 (if 0 is not valid)

The current implementation silently ignores limit=0, which could be confusing to users.

Suggested change

if (limit > 0)

if (limit >= 0)

mvadari and others added 12 commits November 17, 2025 16:11

Fix index for iLimit in RPCCall.cpp

17e4d38

fix tests, more cleanup

e66cfab

remove debug statements

9fb088c

fix account_tx

403bfaa

fix can_delete

fb5d878

fix connect

9e23d50

fix get_counts

f1f2cc7

fix tx_history

2116ea6

remove debug lines

400cd02

clean up book_offers

711d765

fix test

8852594

simplify tests

efa2a1b

mvadari requested a review from vvysokikh1 November 17, 2025 12:45

mvadari requested a review from a team as a code owner November 17, 2025 12:45

re-remove debug lines

c326a80

mvadari changed the title ~~fix casting issues in RPC CLIs~~ fix casting issues in RPC CLIs, remove proof from book_offers Nov 17, 2025

mvadari mentioned this pull request Nov 17, 2025

fix: correct index for limit in book_offers CLI #6043

Merged

9 tasks

Merge branch 'develop' into mvadari/fix-bad-cast

3e07a64

bthomee requested a review from Tapanito November 19, 2025 22:27

Tapanito reviewed Nov 20, 2025

View reviewed changes

src/test/rpc/RPCCall_test.cpp Outdated Show resolved Hide resolved

Tapanito reviewed Nov 20, 2025

View reviewed changes

Tapanito requested changes Nov 20, 2025

View reviewed changes

mvadari added 4 commits November 20, 2025 15:34

remove jss::proof

96287e2

remove now-unneeded comments

5154649

add consts

50f418f

Merge branch 'develop' into mvadari/fix-bad-cast

fd2f2b1

mvadari requested a review from Tapanito November 20, 2025 10:11

Tapanito reviewed Nov 20, 2025

View reviewed changes

mvadari added 3 commits November 20, 2025 17:45

Merge branch 'develop' into mvadari/fix-bad-cast

69dba2e

update changelog

2d53099

respond to comments (mostly more consts)

eca65c0

mvadari requested a review from Tapanito November 20, 2025 12:20

mvadari and others added 2 commits November 20, 2025 18:35

fix tests

df52266

Merge branch 'develop' into mvadari/fix-bad-cast

100ad8b

Copilot AI review requested due to automatic review settings December 2, 2025 22:57

Copilot started reviewing on behalf of mvadari December 2, 2025 22:57 View session

Copilot finished reviewing on behalf of mvadari December 2, 2025 22:59

Copilot AI reviewed Dec 2, 2025

View reviewed changes

	if (auto ledgerMinOpt = jvParseInt(jvParams[1u]))
	if (auto const ledgerMinOpt = jvParseInt(jvParams[1u]))

	if (auto minCount = jvParseUInt(jvParams[0u]))
	if (auto const minCount = jvParseUInt(jvParams[0u]))

	if (auto port = jvParseUInt(jvParams[1u]))
	if (auto const port = jvParseUInt(jvParams[1u]))

	if (auto seq = jvParseUInt(jvParams[0u]))
	if (auto const seq = jvParseUInt(jvParams[0u]))

	[Version 2.4.0](https://github.com/XRPLF/rippled/releases/tag/2.5.0) was released on June 24, 2025.
	[Version 2.5.0](https://github.com/XRPLF/rippled/releases/tag/2.5.0) was released on June 24, 2025.

fix casting issues in RPC CLIs, remove proof from book_offers #6044

Are you sure you want to change the base?

fix casting issues in RPC CLIs, remove proof from book_offers #6044

Conversation

mvadari commented Nov 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

High Level Overview of Change

Context of Change

Type of Change

API Impact

Test Plan

Uh oh!

codecov bot commented Nov 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Key Changes

Reviewed changes

Uh oh!

Copilot AI Dec 2, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 2, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

fix casting issues in RPC CLIs, remove `proof` from `book_offers` #6044

fix casting issues in RPC CLIs, remove `proof` from `book_offers` #6044

mvadari commented Nov 17, 2025 •

edited

Loading

codecov bot commented Nov 17, 2025 •

edited

Loading