feat: Add mptoken_issuance_history RPC by BryanJ1ang · Pull Request #3141 · XRPLF/clio

BryanJ1ang · 2026-07-08T16:15:17Z

feat: add mptoken_issuance_history RPC

Summary

Adds mptoken_issuance_history, a Clio-only method that returns the transaction history for a given MPT issuance — the MPT-scoped sibling of nft_history. You can optionally filter by account and/or tx_type.

The index tables, backend fetch methods, and live ETL indexing landed earlier; this wires up the handler on top of them.

The handler

Routes to fetchMPTokenIssuanceTransactions or fetchAccountMPTokenIssuanceTransactions depending on whether account is set. When tx_type is given, it filters on TransactionType post-fetch, exactly like account_tx.
Follows the nft_history/account_tx conventions for ledger ranges, markers, binary, forward, and limit ([1,100], default 50), including api-version response branching.
Gated on backfill completion so it never returns partial history: until this node's MPTTransactionHistoryMigrator reports Migrated, requests get notReady with a message pointing at the --migrate command. Once migrated, the result is cached and the check is skipped — the method turns on automatically, no restart.

yinyiqian1 · 2026-07-29T15:31:14Z

The handler PR should not contain the migration code

The mptoken_issuance_history gate went through MigrationInspectorInterface, which required threading a MigrationInspector through ClioApplication and ProductionHandlerProvider purely for one status lookup. MigratorsRegister::getMigratorStatus ultimately just calls BackendInterface::fetchMigratorStatus wrapped in data::synchronous, which spins up a nested io_context and blocks the calling thread. Querying the backend directly with the request's yield context keeps the gate async and drops the extra dependency: ClioApplication, ProductionHandlerProvider and their tests return to their previous shape, and MockMigrationInspector is no longer needed. A missing status row and an unregistered migrator name are now indistinguishable (both nullopt), so the NotKnown warn log is gone. Both already failed closed with the same notReady error, so behaviour is unchanged; tests cover the absent-row and unparseable-status paths instead. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

Copilot

Pull request overview

Adds a new Clio-only RPC method, mptoken_issuance_history, to retrieve transaction history for a specific MPToken issuance, optionally filtered by account and/or tx_type, and gated behind completion of the MPT transaction-history backfill to avoid serving partial history.

Changes:

Introduces MPTokenIssuanceHistoryHandler with ledger-range handling, paging/markers, binary/forward options, and optional post-fetch tx_type filtering.
Registers the new RPC in the handler provider and RPC center, and links clio_rpc against clio_migration for migrator-status gating.
Adds comprehensive unit tests covering parameter validation, routing, gating, paging/markers, binary modes, and tx_type filtering behavior.

Reviewed changes

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

Show a summary per file

File	Description
tests/unit/rpc/handlers/MPTokenIssuanceHistoryTests.cpp	Adds extensive unit coverage for the new handler’s validation, gating, paging, and response shapes across API versions.
tests/unit/CMakeLists.txt	Includes the new unit test file in the unit test target.
src/rpc/RPCCenter.cpp	Adds `mptoken_issuance_history` to the handled RPC list.
src/rpc/handlers/MPTokenIssuanceHistory.hpp	Defines the new handler, input/output models, and RPC spec (including `tx_type` validation/modifiers).
src/rpc/handlers/MPTokenIssuanceHistory.cpp	Implements migrator gating, ledger range resolution, backend routing, marker/limit behavior, and response formatting.
src/rpc/common/impl/HandlerProvider.cpp	Registers the handler as Clio-only under `mptoken_issuance_history`.
src/rpc/CMakeLists.txt	Builds the new handler source and links `clio_rpc` with `clio_migration` for migrator-status usage.

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

PeterChen13579 · 2026-08-06T17:47:06Z

@maria-robobug Please note there is an extra RPC handler we are adding to clio

mathbunnyru

Please, merge latest changes - CI doesn't seem to have run, and you also didn't allow maintainers to update your branch, so I can't do it myself

codecov · 2026-08-11T14:59:00Z

Codecov Report

❌ Patch coverage is 92.30769% with 16 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
src/rpc/handlers/MPTokenIssuanceHistory.cpp	94.85%	2 Missing and 7 partials ⚠️
src/rpc/handlers/MPTokenIssuanceHistory.hpp	78.12%	5 Missing and 2 partials ⚠️

📢 Thoughts on this report? Let us know!

yinyiqian1 · 2026-08-11T15:25:40Z

@BryanJ1ang Could you add more tests regarding the coverage report?

…jiang-mpt-rpc-handler

mathbunnyru

I think process function is quite difficult to read, because it's too long, so this should be refactored.

General comments:

Please, fix clang-tidy
And PR title
And add more test coverage (I agree with @PeterChen13579)

mathbunnyru · 2026-08-11T15:11:29Z

+    util::Logger log_{"RPC"};
+    std::shared_ptr<BackendInterface> sharedPtrBackend_;
+    // Status is monotonic, so the terminal Migrated result is cached across handler copies.
+    std::shared_ptr<std::atomic_bool> migrated_ = std::make_shared<std::atomic_bool>(false);


Do we actually copy our handlers?
If not, we should probably get rid of shared_ptr and make this class non-copyable

Yes, handlers are copied per request. getHandler() returns AnyHandler by value, and clone() copies the concrete handler.

The shared atomic keeps the cached Migrated state across those copies. otherwise each request would query the status again.

mathbunnyru · 2026-08-12T12:25:11Z

+namespace rpc {
+
+MPTokenIssuanceHistoryHandler::Result
+MPTokenIssuanceHistoryHandler::process(


This function is very long, could you please refactor it in smaller, but meaningful private methods?

mathbunnyru · 2026-08-12T12:26:44Z

+{
+    // Fail closed unless the backfill is done: partial history must never be served.
+    if (not migrated_->load(std::memory_order_relaxed)) {
+        auto const statusString = sharedPtrBackend_->fetchMigratorStatus(kMigratorName, ctx.yield);


I'm not sure if it's a good idea, but maybe we should have a small refactoring PR, so fetchMigratorStatus returns MigratorStatus, or optional or sth like that?

Yeah I think this would make sense for a separate PR

mathbunnyru · 2026-08-12T12:27:57Z

+        cursor = {input.marker->ledger, input.marker->seq};
+    } else {
+        if (input.forward) {
+            cursor = {minIndex, 0};
+        } else {
+            cursor = {maxIndex, std::numeric_limits<int32_t>::max()};
+        }


Can we use designated initializers here to make it more clear what's going on?

TransactionsCursor has user declared constructors so we can't use designated initializers here. Added some comments to make it more clear

yinyiqian1 · 2026-08-12T18:25:12Z

 )

-target_link_libraries(clio_rpc PUBLIC clio_util clio_data)
+target_link_libraries(clio_rpc PUBLIC clio_util clio_data clio_migration)


This line should be reverted as well

BryanJ1ang force-pushed the brjiang-mpt-rpc-handler branch from 12615d0 to f3d1c1f Compare July 29, 2026 15:03

feat: implemented mptoken_issuance_history rpc

05f2826

BryanJ1ang force-pushed the brjiang-mpt-rpc-handler branch from f3d1c1f to 05f2826 Compare July 29, 2026 15:15

Cleaned up comments

b147be7

BryanJ1ang marked this pull request as ready for review July 30, 2026 02:01

yinyiqian1 reviewed Aug 4, 2026

View reviewed changes

Comment thread src/rpc/handlers/MPTokenIssuanceHistory.cpp

Comment thread src/rpc/handlers/MPTokenIssuanceHistory.cpp Outdated

BryanJ1ang and others added 2 commits August 4, 2026 16:52

Added log

03d443e

BryanJ1ang requested a review from yinyiqian1 August 4, 2026 20:56

yinyiqian1 previously approved these changes Aug 6, 2026

View reviewed changes

mathbunnyru requested a review from Copilot August 6, 2026 14:51

Copilot started reviewing on behalf of mathbunnyru August 6, 2026 14:52 View session

Copilot AI reviewed Aug 6, 2026

View reviewed changes

PeterChen13579 requested a review from mathbunnyru August 6, 2026 17:21

mathbunnyru requested changes Aug 11, 2026

View reviewed changes

Merge branch 'develop' into brjiang-mpt-rpc-handler

f1ce356

BryanJ1ang requested a review from mathbunnyru August 11, 2026 14:38

BryanJ1ang changed the title ~~feat: add mptoken_issuance_history RPC~~ Feat: add mptoken_issuance_history RPC Aug 11, 2026

BryanJ1ang added 2 commits August 11, 2026 15:37

Removed unused import statement

9ec0308

Updated test coverage

af2b35c

BryanJ1ang changed the title ~~Feat: add mptoken_issuance_history RPC~~ feat: add mptoken_issuance_history RPC Aug 11, 2026

BryanJ1ang added 2 commits August 11, 2026 19:21

updated test comments

2e5e793

Merge remote-tracking branch 'origin/brjiang-mpt-rpc-handler' into br…

884d87b

…jiang-mpt-rpc-handler

mathbunnyru requested changes Aug 12, 2026

View reviewed changes

BryanJ1ang dismissed yinyiqian1’s stale review via 884d87b August 12, 2026 15:05

BryanJ1ang changed the title ~~feat: add mptoken_issuance_history RPC~~ feat: Add mptoken_issuance_history RPC Aug 12, 2026

BryanJ1ang added 7 commits August 12, 2026 12:21

Updated comment formatting

757f105

explicit has_value checks

21117a9

Add comments

b66e7f4

refactored process to use helper functions

da4b2f1

Added logging test

2b5b48a

Updated style

f79f717

fix clang tidy

f9b8b1a

BryanJ1ang requested review from mathbunnyru and yinyiqian1 August 12, 2026 18:16

yinyiqian1 reviewed Aug 12, 2026

View reviewed changes

Uh oh!

Conversation

BryanJ1ang commented Jul 8, 2026

Uh oh!

yinyiqian1 commented Jul 29, 2026

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

PeterChen13579 commented Aug 6, 2026

Uh oh!

mathbunnyru left a comment

Choose a reason for hiding this comment

Uh oh!

codecov Bot commented Aug 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

yinyiqian1 commented Aug 11, 2026

Uh oh!

mathbunnyru left a comment

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!

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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

codecov Bot commented Aug 11, 2026 •

edited

Loading