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

Handles the noripple_check command. More...

#include <NoRippleCheck.hpp>

Inheritance diagram for rpc::NoRippleCheckHandler:
Collaboration diagram for rpc::NoRippleCheckHandler:

Classes

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

Public Types

using Result = HandlerReturnType<Output>

Public Member Functions

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

Static Public Attributes

static constexpr auto kLimitMin = 1
static constexpr auto kLimitMax = 500
static constexpr auto kLimitDefault = 300

Friends

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

Detailed Description

Handles the noripple_check command.

The noripple_check command provides a quick way to check the status of the Default Ripple field for an account and the No Ripple flag of its trust lines, compared with the recommended settings.

For more details see: https://xrpl.org/noripple_check.html

Constructor & Destructor Documentation

◆ NoRippleCheckHandler()

rpc::NoRippleCheckHandler::NoRippleCheckHandler ( std::shared_ptr< BackendInterface > sharedPtrBackend)
inline

Construct a new NoRippleCheckHandler object.

Parameters
sharedPtrBackendThe backend to use

Member Function Documentation

◆ process()

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

Process the NoRippleCheck 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,
NoRippleCheckHandler::Output const & output )
friend

Convert the Output to a JSON object.

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

The documentation for this class was generated from the following files:
  • /__w/clio/clio/src/rpc/handlers/NoRippleCheck.hpp
  • /__w/clio/clio/src/rpc/handlers/NoRippleCheck.cpp