1#include <xrpld/rpc/Context.h>
2#include <xrpld/rpc/GRPCHandlers.h>
3#include <xrpld/rpc/detail/RPCLedgerHelpers.h>
4#include <xrpld/rpc/handlers/LedgerEntryHelpers.h>
6#include <xrpl/basics/StringUtilities.h>
7#include <xrpl/basics/strHex.h>
8#include <xrpl/beast/core/LexicalCast.h>
9#include <xrpl/json/json_errors.h>
10#include <xrpl/ledger/CredentialHelpers.h>
11#include <xrpl/ledger/ReadView.h>
12#include <xrpl/protocol/ErrorCodes.h>
13#include <xrpl/protocol/Indexes.h>
14#include <xrpl/protocol/LedgerFormats.h>
15#include <xrpl/protocol/RPCErr.h>
16#include <xrpl/protocol/STXChainBridge.h>
17#include <xrpl/protocol/jss.h>
21static Expected<uint256, Json::Value>
25 std::string const& expectedType =
"hex string or object")
27 if (
auto const uNodeIndex = LedgerEntryHelpers::parse<uint256>(params))
32 "malformedRequest", fieldName, expectedType);
35static Expected<uint256, Json::Value>
41static Expected<uint256, Json::Value>
44 if (
auto const account = LedgerEntryHelpers::parse<AccountID>(params))
50 "malformedAddress", fieldName,
"AccountID");
53static Expected<uint256, Json::Value>
59static Expected<uint256, Json::Value>
67 if (
auto const value =
75 params, jss::asset,
"malformedRequest");
80 params, jss::asset2,
"malformedRequest");
87static Expected<uint256, Json::Value>
95 if (params[jss::bridge].isString())
106 params, jss::bridge_account,
"malformedBridgeAccount");
112 if (account.value() != bridge->door(chainType))
118static Expected<uint256, Json::Value>
124static Expected<uint256, Json::Value>
133 cred, jss::subject,
"malformedRequest");
138 cred, jss::issuer,
"malformedRequest");
144 jss::credential_type,
151 *subject, *issuer,
Slice(credType->data(), credType->size()))
155static Expected<uint256, Json::Value>
164 params, jss::account,
"malformedAddress");
169 params, jss::authorize,
"malformedAddress");
176static Expected<STArray, Json::Value>
182 "malformedAuthorizedCredentials",
183 jss::authorized_credentials,
191 "malformedAuthorizedCredentials",
192 "Invalid field '" +
std::string(jss::authorized_credentials) +
193 "', array too long."));
199 "malformedAuthorizedCredentials",
200 "Invalid field '" +
std::string(jss::authorized_credentials) +
204 STArray arr(sfAuthorizeCredentials, n);
205 for (
auto const& jo : jv)
210 "malformedAuthorizedCredentials",
211 jss::authorized_credentials,
217 {jss::issuer, jss::credential_type},
218 "malformedAuthorizedCredentials");
225 jo, jss::issuer,
"malformedAuthorizedCredentials");
231 jss::credential_type,
233 "malformedAuthorizedCredentials");
238 credential.setAccountID(sfIssuer, *issuer);
239 credential.setFieldVL(sfCredentialType, *credentialType);
246static Expected<uint256, Json::Value>
254 if ((dp.
isMember(jss::authorized) ==
255 dp.
isMember(jss::authorized_credentials)))
259 "Must have exactly one of `authorized` and "
260 "`authorized_credentials`.");
273 LedgerEntryHelpers::parse<AccountID>(dp[jss::authorized]))
278 "malformedAuthorized", jss::authorized,
"AccountID");
281 auto const& ac(dp[jss::authorized_credentials]);
283 if (!arr.has_value())
291 "malformedAuthorizedCredentials",
292 jss::authorized_credentials,
299static Expected<uint256, Json::Value>
302 auto const account = LedgerEntryHelpers::parse<AccountID>(params);
306 "malformedAddress", fieldName,
"AccountID");
312static Expected<uint256, Json::Value>
322 if (params.
isMember(jss::sub_index) &&
324 params[jss::sub_index].
isBool()))
327 "malformedRequest", jss::sub_index,
"number");
334 "Must have exactly one of `owner` and `dir_root` fields.");
341 if (
auto const uDirRoot =
342 LedgerEntryHelpers::parse<uint256>(params[jss::dir_root]))
348 "malformedDirRoot", jss::dir_root,
"hash");
354 LedgerEntryHelpers::parse<AccountID>(params[jss::owner]);
358 "malformedAddress", jss::owner,
"AccountID");
367static Expected<uint256, Json::Value>
376 params, jss::owner,
"malformedOwner");
387static Expected<uint256, Json::Value>
393static Expected<uint256, Json::Value>
399static Expected<uint256, Json::Value>
408 params, jss::owner,
"malformedOwner");
419static Expected<uint256, Json::Value>
428 params, jss::loan_broker_id,
"malformedLoanBrokerID");
432 params, jss::loan_seq,
"malformedSeq");
439static Expected<uint256, Json::Value>
448 params, jss::mpt_issuance_id,
"malformedMPTIssuanceID");
453 params, jss::account,
"malformedAccount");
460static Expected<uint256, Json::Value>
465 auto const mptIssuanceID = LedgerEntryHelpers::parse<uint192>(params);
468 "malformedMPTokenIssuance", fieldName,
"Hash192");
473static Expected<uint256, Json::Value>
479static Expected<uint256, Json::Value>
485static Expected<uint256, Json::Value>
491static Expected<uint256, Json::Value>
500 params, jss::account,
"malformedAddress");
505 params, jss::seq,
"malformedRequest");
512static Expected<uint256, Json::Value>
521 params, jss::account,
"malformedAccount");
526 params, jss::oracle_document_id,
"malformedDocumentID");
533static Expected<uint256, Json::Value>
539static Expected<uint256, Json::Value>
552 "malformedRequest", fieldName,
"hex string or object");
556 pd, jss::account,
"malformedAddress");
568static Expected<uint256, Json::Value>
581 jvRippleState, {jss::currency, jss::accounts});
587 if (!jvRippleState[jss::accounts].isArray() ||
588 jvRippleState[jss::accounts].size() != 2)
591 "malformedRequest", jss::accounts,
"length-2 array of Accounts");
595 LedgerEntryHelpers::parse<AccountID>(jvRippleState[jss::accounts][0u]);
597 LedgerEntryHelpers::parse<AccountID>(jvRippleState[jss::accounts][1u]);
601 "malformedAddress", jss::accounts,
"array of Accounts");
606 "malformedRequest",
"Cannot have a trustline to self.");
609 if (!jvRippleState[jss::currency].isString() ||
610 jvRippleState[jss::currency] ==
"" ||
611 !
to_currency(uCurrency, jvRippleState[jss::currency].asString()))
614 "malformedCurrency", jss::currency,
"Currency");
620static Expected<uint256, Json::Value>
626static Expected<uint256, Json::Value>
635 params, jss::account,
"malformedAddress");
640 params, jss::ticket_seq,
"malformedRequest");
647static Expected<uint256, Json::Value>
656 params, jss::owner,
"malformedOwner");
661 params, jss::seq,
"malformedRequest");
668static Expected<uint256, Json::Value>
683 claim_id, jss::xchain_owned_claim_id,
"malformedXChainOwnedClaimID");
693static Expected<uint256, Json::Value>
709 jss::xchain_owned_create_account_claim_id,
710 "malformedXChainOwnedCreateAccountClaimID");
740#pragma push_macro("LEDGER_ENTRY")
743#define LEDGER_ENTRY(tag, value, name, rpcName, fields) \
744 {jss::rpcName, parse##name, tag},
746#include <xrpl/protocol/detail/ledger_entries.macro>
749#pragma pop_macro("LEDGER_ENTRY")
756 auto hasMoreThanOneMember = [&]() {
759 for (
auto const& ledgerEntry : ledgerEntryParsers)
771 if (hasMoreThanOneMember)
788 for (
auto const& ledgerEntry : ledgerEntryParsers)
792 expectedType = ledgerEntry.expectedType;
797 Json::Value const& params = ledgerEntry.fieldName == jss::bridge
799 : context.
params[ledgerEntry.fieldName];
801 ledgerEntry.parseFunction(params, ledgerEntry.fieldName);
803 return result.error();
805 uNodeIndex = result.value();
814 jvResult[jss::error] =
"unknownOption";
839 bool bNodeBinary =
false;
849 if ((expectedType !=
ltANY) && (expectedType != sleNode->getType()))
861 jvResult[jss::index] =
to_string(uNodeIndex);
866 jvResult[jss::index] =
to_string(uNodeIndex);
876 org::xrpl::rpc::v1::GetLedgerEntryRequest& request = context.
params;
877 org::xrpl::rpc::v1::GetLedgerEntryResponse response;
878 grpc::Status status = grpc::Status::OK;
883 grpc::Status errorStatus;
886 errorStatus = grpc::Status(
887 grpc::StatusCode::INVALID_ARGUMENT, status.message());
892 grpc::Status(grpc::StatusCode::NOT_FOUND, status.message());
894 return {response, errorStatus};
900 grpc::Status errorStatus{
901 grpc::StatusCode::INVALID_ARGUMENT,
"index malformed"};
902 return {response, errorStatus};
908 grpc::Status errorStatus{
909 grpc::StatusCode::NOT_FOUND,
"object not found"};
910 return {response, errorStatus};
916 auto& stateObject = *response.mutable_ledger_object();
918 stateObject.set_key(request.key());
919 *(response.mutable_ledger()) = request.ledger();
920 return {response, status};
Lightweight wrapper to tag static string.
UInt size() const
Number of values in array or object.
bool isMember(char const *key) const
Return true if the object has a member named key.
Value get(UInt index, Value const &defaultValue) const
If the array contains at least index+1 elements, returns the element value, otherwise returns default...
bool isConvertibleTo(ValueType other) const
void push_back(STObject const &object)
static STObject makeInnerObject(SField const &name)
static ChainType srcChain(bool wasLockingChainSend)
Blob const & peekData() const
An immutable linear range of bytes.
static std::optional< base_uint > fromVoidChecked(T const &from)
@ uintValue
unsigned integer value
Expected< std::uint32_t, Json::Value > requiredUInt32(Json::Value const ¶ms, Json::StaticString const fieldName, std::string const &err)
Expected< AccountID, Json::Value > requiredAccountID(Json::Value const ¶ms, Json::StaticString const fieldName, std::string const &err)
Unexpected< Json::Value > missingFieldError(Json::StaticString const field, std::optional< std::string > err=std::nullopt)
Expected< uint192, Json::Value > requiredUInt192(Json::Value const ¶ms, Json::StaticString const fieldName, std::string const &err)
Expected< bool, Json::Value > hasRequired(Json::Value const ¶ms, std::initializer_list< Json::StaticString > fields, std::optional< std::string > err=std::nullopt)
Expected< Blob, Json::Value > requiredHexBlob(Json::Value const ¶ms, Json::StaticString const fieldName, std::size_t maxLength, std::string const &err)
Expected< Issue, Json::Value > requiredIssue(Json::Value const ¶ms, Json::StaticString const fieldName, std::string const &err)
Expected< STXChainBridge, Json::Value > parseBridgeFields(Json::Value const ¶ms)
Unexpected< Json::Value > malformedError(std::string const &err, std::string const &message)
Expected< uint256, Json::Value > requiredUInt256(Json::Value const ¶ms, Json::StaticString const fieldName, std::string const &err)
Unexpected< Json::Value > invalidFieldError(std::string const &err, Json::StaticString const field, std::string const &type)
Json::Value make_param_error(std::string const &message)
Returns a new json object that indicates invalid parameters.
Status ledgerFromRequest(T &ledger, GRPCContext< R > const &context)
Retrieves a ledger from a gRPC request context.
Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext const &context, Json::Value &result)
Looks up a ledger from a request and fills a Json::Value with ledger data.
Json::Value make_error(error_code_i code)
Returns a new json object that reflects the error code.
std::set< std::pair< AccountID, Slice > > makeSorted(STArray const &credentials)
Keylet oracle(AccountID const &account, std::uint32_t const &documentID) noexcept
Keylet did(AccountID const &account) noexcept
Keylet unchecked(uint256 const &key) noexcept
Any ledger entry.
Keylet depositPreauth(AccountID const &owner, AccountID const &preauthorized) noexcept
A DepositPreauth.
Keylet loanbroker(AccountID const &owner, std::uint32_t seq) noexcept
Keylet escrow(AccountID const &src, std::uint32_t seq) noexcept
An escrow entry.
Keylet bridge(STXChainBridge const &bridge, STXChainBridge::ChainType chainType)
Keylet ownerDir(AccountID const &id) noexcept
The root page of an account's directory.
Keylet mptIssuance(std::uint32_t seq, AccountID const &issuer) noexcept
Keylet amm(Asset const &issue1, Asset const &issue2) noexcept
AMM entry.
Keylet loan(uint256 const &loanBrokerID, std::uint32_t loanSeq) noexcept
Keylet offer(AccountID const &id, std::uint32_t seq) noexcept
An offer from an account.
Keylet vault(AccountID const &owner, std::uint32_t seq) noexcept
Keylet line(AccountID const &id0, AccountID const &id1, Currency const ¤cy) noexcept
The index of a trust line for a given currency.
Keylet xChainCreateAccountClaimID(STXChainBridge const &bridge, std::uint64_t seq)
Keylet mptoken(MPTID const &issuanceID, AccountID const &holder) noexcept
Keylet delegate(AccountID const &account, AccountID const &authorizedAccount) noexcept
A keylet for Delegate object.
Keylet account(AccountID const &id) noexcept
AccountID root.
Keylet permissionedDomain(AccountID const &account, std::uint32_t seq) noexcept
Keylet page(uint256 const &root, std::uint64_t index=0) noexcept
A page in a directory.
Keylet credential(AccountID const &subject, AccountID const &issuer, Slice const &credType) noexcept
Keylet xChainClaimID(STXChainBridge const &bridge, std::uint64_t seq)
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
static Expected< uint256, Json::Value > parseRippleState(Json::Value const &jvRippleState, Json::StaticString const fieldName)
static Expected< uint256, Json::Value > parseDirectoryNode(Json::Value const ¶ms, Json::StaticString const fieldName)
static Expected< uint256, Json::Value > parseXChainOwnedCreateAccountClaimID(Json::Value const &claim_id, Json::StaticString const fieldName)
static Expected< uint256, Json::Value > parseSignerList(Json::Value const ¶ms, Json::StaticString const fieldName)
Expected< uint256, Json::Value >(*)(Json::Value const &, Json::StaticString const) FunctionType
static Expected< uint256, Json::Value > parseDelegate(Json::Value const ¶ms, Json::StaticString const fieldName)
static Expected< uint256, Json::Value > parseAmendments(Json::Value const ¶ms, Json::StaticString const fieldName)
static Expected< uint256, Json::Value > parseMPToken(Json::Value const ¶ms, Json::StaticString const fieldName)
std::string to_string(base_uint< Bits, Tag > const &a)
std::string strHex(FwdIt begin, FwdIt end)
static Expected< uint256, Json::Value > parseXChainOwnedClaimID(Json::Value const &claim_id, Json::StaticString const fieldName)
static Expected< uint256, Json::Value > parseAccountRoot(Json::Value const ¶ms, Json::StaticString const fieldName)
static Expected< uint256, Json::Value > parseLedgerHashes(Json::Value const ¶ms, Json::StaticString const fieldName)
static Expected< uint256, Json::Value > parseEscrow(Json::Value const ¶ms, Json::StaticString const fieldName)
uint256 getTicketIndex(AccountID const &account, std::uint32_t uSequence)
static Expected< uint256, Json::Value > parseLoanBroker(Json::Value const ¶ms, Json::StaticString const fieldName)
static bool authorized(Port const &port, std::map< std::string, std::string > const &h)
static Expected< uint256, Json::Value > parseFeeSettings(Json::Value const ¶ms, Json::StaticString const fieldName)
static Expected< uint256, Json::Value > parsePayChannel(Json::Value const ¶ms, Json::StaticString const fieldName)
static Expected< uint256, Json::Value > parseIndex(Json::Value const ¶ms, Json::StaticString const fieldName)
static Expected< uint256, Json::Value > parseLoan(Json::Value const ¶ms, Json::StaticString const fieldName)
static Expected< uint256, Json::Value > parseMPTokenIssuance(Json::Value const ¶ms, Json::StaticString const fieldName)
static Expected< uint256, Json::Value > parseNegativeUNL(Json::Value const ¶ms, Json::StaticString const fieldName)
static Expected< uint256, Json::Value > parseBridge(Json::Value const ¶ms, Json::StaticString const fieldName)
static Expected< uint256, Json::Value > parseNFTokenPage(Json::Value const ¶ms, Json::StaticString const fieldName)
static Expected< uint256, Json::Value > parseOffer(Json::Value const ¶ms, Json::StaticString const fieldName)
static Expected< uint256, Json::Value > parseVault(Json::Value const ¶ms, Json::StaticString const fieldName)
static Expected< uint256, Json::Value > parseCheck(Json::Value const ¶ms, Json::StaticString const fieldName)
std::size_t constexpr maxCredentialsArraySize
The maximum number of credentials can be passed in array.
std::pair< org::xrpl::rpc::v1::GetLedgerEntryResponse, grpc::Status > doLedgerEntryGrpc(RPC::GRPCContext< org::xrpl::rpc::v1::GetLedgerEntryRequest > &context)
static Expected< uint256, Json::Value > parseObjectID(Json::Value const ¶ms, Json::StaticString const fieldName, std::string const &expectedType="hex string or object")
static Expected< uint256, Json::Value > parseCredential(Json::Value const &cred, Json::StaticString const fieldName)
static Expected< STArray, Json::Value > parseAuthorizeCredentials(Json::Value const &jv)
static Expected< uint256, Json::Value > parseDID(Json::Value const ¶ms, Json::StaticString const fieldName)
static Expected< uint256, Json::Value > parsePermissionedDomain(Json::Value const &pd, Json::StaticString const fieldName)
static Expected< uint256, Json::Value > parseDepositPreauth(Json::Value const &dp, Json::StaticString const fieldName)
static Expected< uint256, Json::Value > parseOracle(Json::Value const ¶ms, Json::StaticString const fieldName)
LedgerEntryType
Identifiers for on-ledger objects.
@ ltANY
A special type, matching any ledger entry type.
static Expected< uint256, Json::Value > parseAMM(Json::Value const ¶ms, Json::StaticString const fieldName)
bool to_currency(Currency &, std::string const &)
Tries to convert a string to a Currency, returns true on success.
static Expected< uint256, Json::Value > parseTicket(Json::Value const ¶ms, Json::StaticString const fieldName)
@ rpcUNEXPECTED_LEDGER_TYPE
static Expected< uint256, Json::Value > parseNFTokenOffer(Json::Value const ¶ms, Json::StaticString const fieldName)
std::size_t constexpr maxCredentialTypeLength
The maximum length of a CredentialType inside a Credential.
Json::Value doLedgerEntry(RPC::JsonContext &)
A pair of SHAMap key and LedgerEntryType.
Json::StaticString fieldName
FunctionType parseFunction
LedgerEntryType expectedType