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>

Classes
struct	Marker
	A struct to hold the marker data. More...
struct	Output
	A struct to hold the output data of the command. More...
struct	Input
	A struct to hold the input data for the command. More...

Public Types
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 Member Functions
static RpcSpecConstRef	spec (uint32_t apiVersion)
	Returns the API specification for the command.

Static Public Attributes
static constexpr auto	kLimitMin = 1
static constexpr auto	kLimitMax = 100
static constexpr auto	kLimitDefault = 50
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.
Input	tag_invoke (boost::json::value_to_tag< Input >, boost::json::value const &jv)
	Convert a JSON object to Input type.
void	tag_invoke (boost::json::value_from_tag, boost::json::value &jv, MPTokenIssuanceHistoryHandler::Marker const &marker)
	Convert the Marker 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

sharedPtrBackend

The backend to use.

Member Function Documentation

process()

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

nodiscard

Process the MPTokenIssuanceHistory command.

Parameters

input	The input data for the command.
ctx	The context of the request.

Returns

The result of the operation.

spec()

RpcSpecConstRef rpc::MPTokenIssuanceHistoryHandler::spec ( uint32_t apiVersion )

inlinestatic

Returns the API specification for the command.

Parameters

apiVersion

The api version to return the spec for.

Returns

The spec for the given apiVersion.

Friends And Related Symbol Documentation

tag_invoke [1/3]

void tag_invoke ( boost::json::value_from_tag , boost::json::value & jv, MPTokenIssuanceHistoryHandler::Marker const & marker )

friend

Convert the Marker to a JSON object.

Parameters

[out]	jv	The JSON object to convert to.
	marker	The marker to convert.

tag_invoke [2/3]

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]	jv	The JSON object to convert to.
	output	The output to convert.

tag_invoke [3/3]

Input tag_invoke ( boost::json::value_to_tag< Input > , boost::json::value const & jv )

friend

Convert a JSON object to Input type.

Parameters

jv	The JSON object to convert.

Returns

Input parsed from the JSON object.

Member Data Documentation

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:

• /__w/clio/clio/src/rpc/handlers/MPTokenIssuanceHistory.hpp
• /__w/clio/clio/src/rpc/handlers/MPTokenIssuanceHistory.cpp