1#include <xrpld/rpc/handlers/account/AccountInfo.h>
3#include <xrpld/app/main/Application.h>
4#include <xrpld/app/misc/TxQ.h>
5#include <xrpld/rpc/Context.h>
6#include <xrpld/rpc/detail/RPCLedgerHelpers.h>
8#include <xrpl/basics/Blob.h>
9#include <xrpl/basics/Slice.h>
10#include <xrpl/basics/StringUtilities.h>
11#include <xrpl/basics/base_uint.h>
12#include <xrpl/basics/strHex.h>
13#include <xrpl/beast/utility/instrumentation.h>
14#include <xrpl/json/json_forwards.h>
15#include <xrpl/json/json_value.h>
16#include <xrpl/ledger/ReadView.h>
17#include <xrpl/ledger/helpers/AccountRootHelpers.h>
18#include <xrpl/protocol/AccountID.h>
19#include <xrpl/protocol/ErrorCodes.h>
20#include <xrpl/protocol/Feature.h>
21#include <xrpl/protocol/Indexes.h>
22#include <xrpl/protocol/LedgerFormats.h>
23#include <xrpl/protocol/SField.h>
24#include <xrpl/protocol/STLedgerEntry.h>
25#include <xrpl/protocol/SeqProxy.h>
26#include <xrpl/protocol/Units.h>
27#include <xrpl/protocol/XRPAmount.h>
28#include <xrpl/protocol/jss.h>
30#include <rpcspec/Errors.hpp>
60injectSLE(json::Value& jv,
SLE const& sle)
63 XRPL_ASSERT(sle.getType() == ltACCOUNT_ROOT,
"xrpl::rpc::injectSLE : sle is account root");
64 if (sle.isFieldPresent(sfEmailHash))
66 auto const& hash = sle.getFieldH128(sfEmailHash);
67 Blob const b(hash.begin(), hash.end());
72 jv[jss::urlgravatar] =
std::format(
"https://www.gravatar.com/avatar/{}", md5);
77writeAccountRoot(json::Value& value,
SLE const& accountRoot, ReadView
const& ledger)
80 static constexpr auto kAccountRootFlags =
81 std::to_array<std::pair<std::string_view, LedgerSpecificFlags>>({
82 {
"allowTrustLineClawback", lsfAllowTrustLineClawback},
83 {
"defaultRipple", lsfDefaultRipple},
84 {
"depositAuth", lsfDepositAuth},
85 {
"disableMasterKey", lsfDisableMaster},
86 {
"disallowIncomingCheck", lsfDisallowIncomingCheck},
87 {
"disallowIncomingNFTokenOffer", lsfDisallowIncomingNFTokenOffer},
88 {
"disallowIncomingPayChan", lsfDisallowIncomingPayChan},
89 {
"disallowIncomingTrustline", lsfDisallowIncomingTrustline},
90 {
"disallowIncomingXRP", lsfDisallowXRP},
91 {
"globalFreeze", lsfGlobalFreeze},
92 {
"noFreeze", lsfNoFreeze},
93 {
"passwordSpent", lsfPasswordSpent},
94 {
"requireAuthorization", lsfRequireAuth},
95 {
"requireDestinationTag", lsfRequireDestTag},
100 static auto const kAmendmentGatedFlags =
101 std::to_array<std::tuple<std::string_view, LedgerSpecificFlags, UInt256 const&>>(
102 {{
"allowTrustLineLocking", lsfAllowTrustLineLocking, featureTokenEscrow}});
108 kAccountRootFlags.size() + kAmendmentGatedFlags.size() == getAccountRootFlags().
size(),
109 "xrpl::rpc::writeAccountRoot",
110 "number of account flags");
113 injectSLE(jvAccepted, accountRoot);
114 value[jss::account_data] = jvAccepted;
117 for (
auto const& [name, flag] : kAccountRootFlags)
118 acctFlags[name.data()] = accountRoot.isFlag(flag);
120 for (
auto const& [name, flag, amendment] : kAmendmentGatedFlags)
122 if (ledger.rules().enabled(amendment))
123 acctFlags[name.data()] = accountRoot.isFlag(flag);
126 value[jss::account_flags] = std::move(acctFlags);
129 for (
auto const& pseudoField : pseudoFields)
131 if (accountRoot.isFieldPresent(*pseudoField))
133 std::string name = pseudoField->fieldName;
139 !name.
empty(),
"xrpl::rpc::writeAccountRoot",
"name is not empty");
143 value[jss::pseudo_account][jss::type] = name;
149[[nodiscard]] json::Value
150queueDataJson(std::vector<TxQ::TxDetails>
const& txs)
156 jvQueueData[jss::txn_count] = 0u;
160 jvQueueData[jss::txn_count] =
static_cast<json::UInt>(txs.
size());
162 auto& jvQueueTx = jvQueueData[jss::transactions];
165 std::uint32_t seqCount = 0;
166 std::uint32_t ticketCount = 0;
167 std::optional<std::uint32_t> lowestSeq;
168 std::optional<std::uint32_t> highestSeq;
169 std::optional<std::uint32_t> lowestTicket;
170 std::optional<std::uint32_t> highestTicket;
171 bool anyAuthChanged =
false;
177 for (
auto const& tx : txs)
181 if (tx.seqProxy.isSeq())
184 prevSeqProxy < tx.seqProxy,
"xrpl::rpc::queueDataJson : first sorted proxy");
185 prevSeqProxy = tx.seqProxy;
186 jvTx[jss::seq] = tx.seqProxy.value();
189 lowestSeq = tx.seqProxy.
value();
190 highestSeq = tx.seqProxy.
value();
195 prevSeqProxy < tx.seqProxy,
"xrpl::rpc::queueDataJson : second sorted proxy");
196 prevSeqProxy = tx.seqProxy;
197 jvTx[jss::ticket] = tx.seqProxy.value();
200 lowestTicket = tx.seqProxy.
value();
201 highestTicket = tx.seqProxy.
value();
204 jvTx[jss::fee_level] =
to_string(tx.feeLevel);
205 if (tx.lastValid.has_value())
206 jvTx[jss::LastLedgerSequence] = *tx.lastValid;
208 jvTx[jss::fee] =
to_string(tx.consequences.fee());
209 auto const spend = tx.consequences.potentialSpend() + tx.consequences.fee();
210 jvTx[jss::max_spend_drops] =
to_string(spend);
212 bool const authChanged = tx.consequences.isBlocker();
214 anyAuthChanged = authChanged;
215 jvTx[jss::auth_change] = authChanged;
217 jvQueueTx.
append(std::move(jvTx));
221 jvQueueData[jss::sequence_count] = seqCount;
222 if (ticketCount != 0u)
223 jvQueueData[jss::ticket_count] = ticketCount;
225 jvQueueData[jss::lowest_sequence] = *lowestSeq;
227 jvQueueData[jss::highest_sequence] = *highestSeq;
229 jvQueueData[jss::lowest_ticket] = *lowestTicket;
231 jvQueueData[jss::highest_ticket] = *highestTicket;
233 jvQueueData[jss::auth_change_queued] = anyAuthChanged;
234 jvQueueData[jss::max_spend_drops_total] =
to_string(totalSpend);
245std::expected<AccountInfoHandler::Output, ::rpc::Status>
251 if (
auto const status =
getLedger(output.
ledger, input.ledger, context);
252 status != ::rpc::Status::kOK)
254 auto const& ledger = *output.
ledger;
256 if (!input.account.has_value())
261 output.
account = *input.account;
272 if (input.queue && !ledger.open())
284 auto const& params = context.params;
285 if (context.apiVersion > 1u && params.isMember(jss::signer_lists) &&
286 !params[jss::signer_lists].isBool())
294 if (input.signerLists)
298 output.
queue = context.app.getTxQ().getAccountTxs(output.
account);
306 auto const& context =
context_.get();
332 if (context.apiVersion == 1)
334 value[jss::account_data][jss::signer_lists] = std::move(jvSignerList);
338 value[jss::signer_lists] = std::move(jvSignerList);
342 if (output.
queue.has_value())
343 value[jss::queue_data] = queueDataJson(*output.
queue);
Value & append(Value const &value)
Append value to array at the end.
static constexpr SeqProxy rawSequence(std::uint32_t v)
Factory function to return a sequence-based SeqProxy.
std::expected< Output, ::rpc::Status > process(Input const &input) const
Process the request.
std::reference_wrapper< JsonContext > context_
AccountInfoHandler(JsonContext &context)
Construct a handler for a single request.
void writeResult(json::Value &value, Output const &output) const
Write the output of process() into the response.
@ Array
array value (ordered list)
@ Object
object value (collection of name/value pairs).
Keylet signerList(AccountID const &account) noexcept
A SignerList.
Keylet account(AccountID const &id) noexcept
AccountID root.
The api_version numbers this server serves.
void injectError(ErrorCodeI code, json::Value &json)
Add or update the json update to reflect the error code.
::rpc::Status getLedger(T &ledger, UInt256 const &ledgerHash, Context const &context)
Retrieves a ledger by its hash.
void injectLedgerFields(ReadView const &ledger, Context const &context, json::Value &result)
Writes the fields that identify a ledger into a result.
constexpr XRPAmount
Convert XRP to drops (integral types).
std::vector< SField const * > const & getPseudoAccountFields()
Returns the list of fields that define an ACCOUNT_ROOT as a pseudo-account if set.
std::string toLower(std::string str)
Fold ASCII upper case letters to lower case.
std::string strHex(FwdIt begin, FwdIt end)
std::string toBase58(AccountID const &v)
Convert AccountID to base58 checked string.
std::string to_string(BaseUInt< Bits, Tag > const &a)
Slice makeSlice(std::array< T, N > const &a)
std::vector< unsigned char > Blob
Storage for linear binary data.
The data an account_info request produces, written out by writeResult().
std::shared_ptr< ReadView const > ledger
The ledger the request selected.
SLE::const_pointer accountRoot
The account root, once it was read.
std::optional< std::vector< TxQ::TxDetails > > queue
The requested queued transactions.
AccountID account
The account; written only if not found.
std::optional< SLE::const_pointer > signerList
The requested signer list, or null.
std::optional< ErrorCodeI > error
An error written with the ledger fields.