rippled
Loading...
Searching...
No Matches
LedgerToJson.h
1//------------------------------------------------------------------------------
2/*
3 This file is part of rippled: https://github.com/ripple/rippled
4 Copyright (c) 2012, 2013 Ripple Labs Inc.
5
6 Permission to use, copy, modify, and/or distribute this software for any
7 purpose with or without fee is hereby granted, provided that the above
8 copyright notice and this permission notice appear in all copies.
9
10 THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17*/
18//==============================================================================
19
20#ifndef RIPPLE_APP_LEDGER_LEDGERTOJSON_H_INCLUDED
21#define RIPPLE_APP_LEDGER_LEDGERTOJSON_H_INCLUDED
22
23#include <xrpld/app/ledger/Ledger.h>
24#include <xrpld/app/ledger/LedgerMaster.h>
25#include <xrpld/app/misc/TxQ.h>
26#include <xrpld/rpc/Context.h>
27
28#include <xrpl/basics/chrono.h>
29#include <xrpl/json/Object.h>
30#include <xrpl/protocol/serialize.h>
31
32namespace ripple {
33
35{
37 ReadView const& l,
38 RPC::Context* ctx,
39 int o = 0,
42 : ledger(l), options(o), txQueue(std::move(q)), type(t), context(ctx)
43 {
44 if (context)
46 }
47
48 enum Options {
51 expand = 4,
52 full = 8,
53 binary = 16,
55 dumpQueue = 64
56 };
57
64};
65
70void
72
75getJson(LedgerFill const&);
76
77} // namespace ripple
78
79#endif
Represents a JSON value.
Definition: json_value.h:148
std::optional< NetClock::time_point > getCloseTimeBySeq(LedgerIndex ledgerIndex)
A view into a ledger.
Definition: ReadView.h:52
LedgerIndex seq() const
Returns the sequence number of the base ledger.
Definition: ReadView.h:119
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition: algorithm.h:26
void addJson(Json::Value &json, LedgerFill const &fill)
Given a Ledger and options, fill a Json::Object or Json::Value with a description of the ledger.
LedgerEntryType
Identifiers for on-ledger objects.
Definition: LedgerFormats.h:54
@ ltANY
A special type, matching any ledger entry type.
Definition: LedgerFormats.h:78
Json::Value getJson(LedgerFill const &fill)
Return a new Json::Value representing the ledger with given options.
ReadView const & ledger
Definition: LedgerToJson.h:58
LedgerEntryType type
Definition: LedgerToJson.h:61
LedgerFill(ReadView const &l, RPC::Context *ctx, int o=0, std::vector< TxQ::TxDetails > q={}, LedgerEntryType t=ltANY)
Definition: LedgerToJson.h:36
std::vector< TxQ::TxDetails > txQueue
Definition: LedgerToJson.h:60
RPC::Context * context
Definition: LedgerToJson.h:62
std::optional< NetClock::time_point > closeTime
Definition: LedgerToJson.h:63
The context of information needed to call an RPC.
Definition: Context.h:39
LedgerMaster & ledgerMaster
Definition: Context.h:44