1#include <xrpld/app/ledger/LedgerMaster.h>
2#include <xrpld/app/main/Application.h>
3#include <xrpld/app/misc/DeliverMax.h>
4#include <xrpld/app/misc/Transaction.h>
5#include <xrpld/app/rdb/backend/SQLiteDatabase.h>
6#include <xrpld/rpc/Context.h>
7#include <xrpld/rpc/Role.h>
8#include <xrpld/rpc/detail/RPCHelpers.h>
9#include <xrpld/rpc/detail/RPCLedgerHelpers.h>
10#include <xrpld/rpc/detail/SpecBridge.hpp>
11#include <xrpld/rpc/detail/SyntheticFields.h>
12#include <xrpld/rpc/detail/Tuning.h>
14#include <xrpl/basics/Log.h>
15#include <xrpl/basics/base_uint.h>
16#include <xrpl/basics/chrono.h>
17#include <xrpl/basics/strHex.h>
18#include <xrpl/beast/utility/instrumentation.h>
19#include <xrpl/json/json_value.h>
20#include <xrpl/ledger/ReadView.h>
21#include <xrpl/protocol/AccountID.h>
22#include <xrpl/protocol/ErrorCodes.h>
23#include <xrpl/protocol/RPCErr.h>
24#include <xrpl/protocol/RippleLedgerHash.h>
25#include <xrpl/protocol/jss.h>
26#include <xrpl/rdb/RelationalDatabase.h>
27#include <xrpl/resource/Fees.h>
29#include <rpcspec/Errors.hpp>
30#include <rpcspec/Ledger.hpp>
42static std::expected<DelegateFilter, json::Value>
48 if (!delegateNode.
isMember(jss::delegate_filter) ||
49 !delegateNode[jss::delegate_filter].
isString())
52 auto const& delegateFilterStr = delegateNode[jss::delegate_filter].
asString();
54 auto typeResult = [&] -> std::expected<DelegateType, json::Value> {
55 if (delegateFilterStr ==
"actor")
58 if (delegateFilterStr ==
"authorizer")
70 if (delegateNode.
isMember(jss::counter_party))
72 if (!delegateNode[jss::counter_party].isString())
115 if ((params.
isMember(jss::ledger_index_min) || params.
isMember(jss::ledger_index_max)) &&
119 rpc::injectSpecError(response, status);
123 if (params.
isMember(jss::ledger_index_min) || params.
isMember(jss::ledger_index_max))
126 params.
isMember(jss::ledger_index_min) && params[jss::ledger_index_min].
asInt() >= 0
127 ? params[jss::ledger_index_min].
asUInt()
130 params.
isMember(jss::ledger_index_max) && params[jss::ledger_index_max].
asInt() >= 0
131 ? params[jss::ledger_index_max].
asUInt()
136 if (params.
isMember(jss::ledger_hash))
138 auto& hashValue = params[jss::ledger_hash];
139 if (!hashValue.isString())
142 rpc::injectSpecError(response, status);
147 if (!hash.
parseHex(hashValue.asString()))
150 rpc::injectSpecError(response, status);
155 if (params.
isMember(jss::ledger_index))
158 if (params[jss::ledger_index].isNumeric())
160 ledger = params[jss::ledger_index].
asUInt();
166 if (ledgerStr ==
"current" || ledgerStr.
empty())
168 ledger = ::rpc::spec::LedgerShortcut::Current;
170 else if (ledgerStr ==
"closed")
172 ledger = ::rpc::spec::LedgerShortcut::Closed;
174 else if (ledgerStr ==
"validated")
176 ledger = ::rpc::spec::LedgerShortcut::Validated;
180 ::rpc::Status
const status{
RpcInvalidParams,
"ledger_index string malformed"};
181 rpc::injectSpecError(response, status);
211 [&](
auto const& ls) -> ::rpc::Status {
220 if ((ls.max > uValidatedMax && ls.max != -1) ||
221 (ls.min < uValidatedMin && ls.min != 0))
226 if (ls.min > uValidatedMin)
230 if (ls.max < uValidatedMax)
234 if (uLedgerMax < uLedgerMin)
244 auto status = getLedger(ledgerView, ls, context);
252 if (!validated || ledgerView->header().seq > uValidatedMax ||
253 ledgerView->header().seq < uValidatedMin)
257 uLedgerMin = uLedgerMax = ledgerView->header().seq;
259 return ::rpc::Status::kOK;
266 return LedgerRange{.min = uLedgerMin, .max = uLedgerMax};
280 return {result, *stat};
283 result.
ledgerRange = std::get<LedgerRange>(lgrRange);
302 auto [tx, marker] = db.oldestAccountTxPageB(options);
308 auto [tx, marker] = db.newestAccountTxPageB(options);
317 auto [tx, marker] = db.oldestAccountTxPage(options);
323 auto [tx, marker] = db.newestAccountTxPage(options);
330 JLOG(context.
j.
debug()) << __func__ <<
" : finished";
342 ::rpc::Status
const& error = res.
second;
345 rpc::injectSpecError(response, error);
350 response[jss::validated] =
true;
351 response[jss::limit] = result.
limit;
360 XRPL_ASSERT(!args.
binary,
"xrpl::populateJsonResponse : binary is not set");
362 for (
auto const& [txn, txnMeta] : *txnsData)
367 jvObj[jss::validated] =
true;
369 auto const jsonTx = (context.
apiVersion > 1 ? jss::tx_json : jss::tx);
372 jvObj[jsonTx] = txn->getJson(
378 jvObj[jss::hash] =
to_string(txn->getID());
379 jvObj[jss::ledger_index] = txn->getLedger();
380 jvObj[jss::ledger_hash] =
385 jvObj[jss::close_time_iso] =
toStringIso(*closeTime);
392 auto const& sttx = txn->getSTransaction();
403 "xrpl::populateJsonResponse : missing "
404 "transaction metadata");
412 XRPL_ASSERT(args.
binary,
"xrpl::populateJsonResponse : binary is set");
414 for (
auto const& binaryData : std::get<TxnsDataBinary>(result.
transactions))
418 jvObj[jss::tx_blob] =
strHex(std::get<0>(binaryData));
419 auto const jsonMeta = (context.
apiVersion > 1 ? jss::meta_blob : jss::meta);
420 jvObj[jsonMeta] =
strHex(std::get<1>(binaryData));
421 jvObj[jss::ledger_index] = std::get<2>(binaryData);
422 jvObj[jss::validated] =
true;
429 response[jss::marker][jss::ledger] = result.
marker->ledgerSeq;
430 response[jss::marker][jss::seq] = result.
marker->txnSeq;
433 response[jss::marker][jss::delegate] =
true;
437 JLOG(context.
j.
debug()) << __func__ <<
" : finished";
467 auto& params = context.
params;
475 if (context.
apiVersion > 1u && params.isMember(jss::binary) && !params[jss::binary].isBool())
479 if (context.
apiVersion > 1u && params.isMember(jss::forward) && !params[jss::forward].isBool())
487 args.
binary = params.isMember(jss::binary) && params[jss::binary].asBool();
488 args.
forward = params.isMember(jss::forward) && params[jss::forward].asBool();
490 if (!params.isMember(jss::account))
493 if (!params[jss::account].isString())
508 args.
ledger = std::get<std::optional<LedgerSpecifier>>(parseRes);
510 if (params.isMember(jss::marker))
512 auto& token = params[jss::marker];
513 if (!token.isMember(jss::ledger) || !token.isMember(jss::seq) ||
517 ::rpc::Status
const status{
519 "invalid marker. Provide ledger index via ledger field, and "
520 "transaction sequence number via seq field"};
521 rpc::injectSpecError(response, status);
525 .ledgerSeq = token[jss::ledger].asUInt(),
526 .txnSeq = token[jss::seq].asUInt(),
530 if (params.isMember(jss::delegate))
538 return filter.error();
548 bool const markerFromDelegate = params[jss::marker].isMember(jss::delegate) &&
549 params[jss::marker][jss::delegate].isBool() &&
550 params[jss::marker][jss::delegate].asBool();
551 if (markerFromDelegate != args.
delegate.has_value())
553 ::rpc::Status
const status{
555 "Do not mix delegate and non-delegate pagination markers in account_tx; "
556 "repeat the same `delegate` object when using a delegate marker."};
557 rpc::injectSpecError(response, status);
563 JLOG(context.
j.
debug()) << __func__ <<
" populating response";
Value & append(Value const &value)
Append value to array at the end.
std::string asString() const
Returns the unquoted string value.
bool isMember(char const *key) const
Return true if the object has a member named key.
virtual Config & config()=0
constexpr bool parseHex(std::string_view sv)
Parse a hex string into a base_uint.
bool getValidatedRange(std::uint32_t &minVal, std::uint32_t &maxVal)
Returns Ledgers we have all the nodes for and are indexed: a contiguous part of getFullValidatedRange...
UInt256 getHashBySeq(std::uint32_t index)
Get a ledger's hash by sequence number using the cache.
std::optional< NetClock::time_point > getCloseTimeBySeq(LedgerIndex ledgerIndex)
bool isValidated(ReadView const &ledger)
Tests whether a ledger is on the validated chain, using the skip list when the ledger does not alread...
std::vector< TxnMetaLedgerType > MetaTxsList
std::vector< AccountTx > AccountTxs
std::tuple< Blob, Blob, std::uint32_t > TxnMetaLedgerType
virtual RelationalDatabase & getRelationalDatabase()=0
@ UInt
unsigned integer value
@ Array
array value (ordered list)
@ Object
object value (collection of name/value pairs).
Charge const kFeeMediumBurdenRpc
static constexpr LimitRange kAccountTx
Limits for the account_tx command.
void insertDeliverMax(json::Value &txJson, TxType txnType, unsigned int apiVersion)
Copy Amount field to DeliverMax field in transaction output JSON.
void insertAllSyntheticInJson(json::Value &metadata, ReadView const &ledger, std::shared_ptr< STTx const > const &transaction, TxMeta const &transactionMeta)
Adds all synthetic fields to transaction metadata JSON.
json::Value invalidFieldError(std::string const &name)
std::optional< json::Value > readLimitField(unsigned int &limit, tuning::LimitRange const &range, JsonContext const &context)
Retrieves the limit value from a JsonContext or sets a default.
json::Value missingFieldError(std::string const &name)
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
RelationalDatabase::AccountTxs TxnsData
json::Value populateJsonResponse(std::pair< AccountTxResult, ::rpc::Status > const &res, AccountTxArgs const &args, rpc::JsonContext const &context)
json::Value doAccountTx(rpc::JsonContext &context)
RelationalDatabase::AccountTxResult AccountTxResult
std::optional< AccountID > parseBase58(std::string const &s)
Parse AccountID from checked, base58 string.
std::string strHex(FwdIt begin, FwdIt end)
static std::expected< DelegateFilter, json::Value > parseDelegateFilter(json::Value const &delegateNode)
std::pair< AccountTxResult, ::rpc::Status > doAccountTxHelp(rpc::Context &context, AccountTxArgs const &args)
RelationalDatabase::MetaTxsList TxnsDataBinary
std::variant< LedgerRange, ::rpc::spec::LedgerShortcut, std::uint32_t, uint256 > LedgerSpecifier
std::string to_string(BaseUInt< Bits, Tag > const &a)
std::string toStringIso(date::sys_time< Duration > tp)
DelegateType
Enumeration of possible delegate types that can occur during filtering in account_tx.
@ Authorizer
This account signed and submitted transactions on behalf of another account (this account is the sign...
@ Actor
Another account signed and submitted transactions on behalf of this account (this account is the owne...
json::Value rpcError(ErrorCodeI iError)
std::variant< LedgerRange, ::rpc::Status > getLedgerRange(rpc::Context &context, std::optional< LedgerSpecifier > const &ledgerSpecifier)
BaseUInt< 160, detail::AccountIDTag > AccountID
A 160-bit unsigned that uniquely identifies an account.
RelationalDatabase::TxnMetaLedgerType TxnDataBinary
std::variant< std::optional< LedgerSpecifier >, json::Value > parseLedgerArgs(rpc::Context const &context, json::Value const ¶ms)
bool isUnlimited(Role const &role)
ADMIN and IDENTIFIED roles shall have unlimited resources.
std::optional< RelationalDatabase::AccountTxMarker > marker
std::optional< DelegateFilter > delegate
std::optional< LedgerSpecifier > ledger
std::variant< AccountTxs, MetaTxsList > transactions
std::optional< AccountTxMarker > marker
The context of information needed to call an RPC.
resource::Charge & loadType
LedgerMaster & ledgerMaster