rpc::TxHandler Class Reference

The tx method retrieves information on a single transaction, by its identifying hash. More...

#include <Tx.hpp>

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

Public Types
using	Result = HandlerReturnType<Output>

Public Member Functions
	TxHandler (std::shared_ptr< BackendInterface > const &sharedPtrBackend, std::shared_ptr< etlng::ETLServiceInterface const > const &etl)
	Construct a new TxHandler object.
Result	process (Input input, Context const &ctx) const
	Process the Tx command.

Static Public Member Functions
static RpcSpecConstRef	spec (uint32_t apiVersion)
	Returns the API specification for the command.

Friends
void	tag_invoke (boost::json::value_from_tag, boost::json::value &jv, Output const &output)
Input	tag_invoke (boost::json::value_to_tag< Input >, boost::json::value const &jv)

Detailed Description

The tx method retrieves information on a single transaction, by its identifying hash.

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

Constructor & Destructor Documentation

TxHandler()

rpc::TxHandler::TxHandler ( std::shared_ptr< BackendInterface > const & sharedPtrBackend, std::shared_ptr< etlng::ETLServiceInterface const > const & etl )

inline

Construct a new TxHandler object.

Parameters

sharedPtrBackend	The backend to use
etl	The ETL service to use

Member Function Documentation

process()

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

inline

Process the Tx command.

Parameters

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

Returns

The result of the operation

spec()

static RpcSpecConstRef rpc::TxHandler::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

---

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

• /__w/clio/clio/src/rpc/handlers/Tx.hpp