Clio  develop
The XRP Ledger API server.
Loading...
Searching...
No Matches
rpc::MPTokenIssuanceHistoryHandler Class Reference

The mptoken_issuance_history command returns past transactions associated with the queried MPTokenIssuance, optionally filtered by an affected account and/or transaction type. More...

#include <MPTokenIssuanceHistory.hpp>

Inheritance diagram for rpc::MPTokenIssuanceHistoryHandler:
Collaboration diagram for rpc::MPTokenIssuanceHistoryHandler:

Classes

struct  Output
 A struct to hold the output data of the command. More...

Public Types

using Marker = rpc::spec::handlers::mptoken_issuance_history::Marker
 A struct to hold the marker data.
using Result = HandlerReturnType<Output>

Public Member Functions

 MPTokenIssuanceHistoryHandler (std::shared_ptr< BackendInterface > sharedPtrBackend)
 Construct a new MPTokenIssuanceHistoryHandler object.
Result process (Input const &input, Context const &ctx) const
 Process the MPTokenIssuanceHistory command.

Static Public Attributes

static constexpr auto kLimitMin = rpc::spec::handlers::mptoken_issuance_history::kLimitMin
static constexpr auto kLimitMax = rpc::spec::handlers::mptoken_issuance_history::kLimitMax
static constexpr auto kLimitDefault
static constexpr char const * kMigratorName = "MPTokenIssuanceHistoryMigrator"
 The name used to query the issuance-history migrator's status.

Friends

void tag_invoke (boost::json::value_from_tag, boost::json::value &jv, MPTokenIssuanceHistoryHandler::Output const &output)
 Convert the Output to a JSON object.

Detailed Description

The mptoken_issuance_history command returns past transactions associated with the queried MPTokenIssuance, optionally filtered by an affected account and/or transaction type.

Note
This is a Clio-only method. Requests fail with notReady until the issuance-history backfill reports Migrated, so partial history is never served.

Constructor & Destructor Documentation

◆ MPTokenIssuanceHistoryHandler()

rpc::MPTokenIssuanceHistoryHandler::MPTokenIssuanceHistoryHandler ( std::shared_ptr< BackendInterface > sharedPtrBackend)
inlineexplicit

Construct a new MPTokenIssuanceHistoryHandler object.

Parameters
sharedPtrBackendThe backend to use.

Member Function Documentation

◆ process()

MPTokenIssuanceHistoryHandler::Result rpc::MPTokenIssuanceHistoryHandler::process ( Input const & input,
Context const & ctx ) const
nodiscard

Process the MPTokenIssuanceHistory command.

Parameters
inputThe input data for the command.
ctxThe context of the request.
Returns
The result of the operation.

◆ tag_invoke

void tag_invoke ( boost::json::value_from_tag ,
boost::json::value & jv,
MPTokenIssuanceHistoryHandler::Output const & output )
friend

Convert the Output to a JSON object.

Parameters
[out]jvThe JSON object to convert to.
outputThe output to convert.

Member Data Documentation

◆ kLimitDefault

auto rpc::MPTokenIssuanceHistoryHandler::kLimitDefault
staticconstexpr
Initial value:
=
rpc::spec::handlers::mptoken_issuance_history::kLimitDefault

◆ kMigratorName

char const* rpc::MPTokenIssuanceHistoryHandler::kMigratorName = "MPTokenIssuanceHistoryMigrator"
staticconstexpr

The name used to query the issuance-history migrator's status.

This is a literal to keep Cassandra migration headers out of RPC.


The documentation for this class was generated from the following files: