The ledger_data method retrieves contents of the specified ledger. You can iterate through several calls to retrieve the entire contents of a single ledger version.
More...
#include <LedgerData.hpp>
|
| 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...
|
|
| static RpcSpecConstRef | spec (uint32_t apiVersion) |
| | Returns the API specification for the command.
|
|
|
static constexpr uint32_t | kLIMIT_BINARY = 2048 |
|
static constexpr uint32_t | kLIMIT_JSON = 256 |
The ledger_data method retrieves contents of the specified ledger. You can iterate through several calls to retrieve the entire contents of a single ledger version.
For more details see: https://xrpl.org/ledger_data.html
◆ LedgerDataHandler()
| rpc::LedgerDataHandler::LedgerDataHandler |
( |
std::shared_ptr< BackendInterface > const & | sharedPtrBackend | ) |
|
|
inline |
Construct a new LedgerDataHandler object.
- Parameters
-
| sharedPtrBackend | The backend to use |
◆ process()
| LedgerDataHandler::Result rpc::LedgerDataHandler::process |
( |
Input const & | input, |
|
|
Context const & | ctx ) const |
Process the LedgerData command.
- Parameters
-
| input | The input data for the command |
| ctx | The context of the request |
- Returns
- The result of the operation
◆ spec()
Returns the API specification for the command.
- Parameters
-
| apiVersion | The api version to return the spec for |
- Returns
- The spec for the given apiVersion
◆ tag_invoke [1/2]
Convert the Output to a JSON object.
- Parameters
-
| [out] | jv | The JSON object to convert to |
| output | The output to convert |
◆ tag_invoke [2/2]
| 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
The documentation for this class was generated from the following files:
- /__w/clio/clio/src/rpc/handlers/LedgerData.hpp
- /__w/clio/clio/src/rpc/handlers/LedgerData.cpp