rippled
Loading...
Searching...
No Matches
RPCHelpers.h
1#ifndef XRPL_RPC_RPCHELPERS_H_INCLUDED
2#define XRPL_RPC_RPCHELPERS_H_INCLUDED
3
4#include <xrpld/app/misc/NetworkOPs.h>
5#include <xrpld/app/misc/TxQ.h>
6#include <xrpld/rpc/Context.h>
7#include <xrpld/rpc/Status.h>
8#include <xrpld/rpc/detail/Tuning.h>
9
10#include <xrpl/beast/core/SemanticVersion.h>
11#include <xrpl/proto/org/xrpl/rpc/v1/xrp_ledger.pb.h>
12#include <xrpl/protocol/ApiVersion.h>
13#include <xrpl/protocol/SecretKey.h>
14
15#include <optional>
16#include <variant>
17
18namespace Json {
19class Value;
20}
21
22namespace ripple {
23
24class ReadView;
25class Transaction;
26
27namespace RPC {
28
29struct JsonContext;
30
34
35// --> strIdent: public key, account ID, or regular seed.
36// --> bStrict: Only allow account id or public key.
37//
38// Returns a Json::objectValue, containing error information if there was one.
41 AccountID& result,
42 std::string const& strIdent,
43 bool bStrict = false);
44
53 AccountID& result,
54 std::string const& strIdent,
55 bool bStrict = false);
56
62getStartHint(std::shared_ptr<SLE const> const& sle, AccountID const& accountID);
63
70bool
72 ReadView const& ledger,
74 AccountID const& accountID);
75
76hash_set<AccountID>
77parseAccountIds(Json::Value const& jvArray);
78
79bool
81
90void
91injectSLE(Json::Value& jv, SLE const& sle);
92
100 unsigned int& limit,
101 Tuning::LimitRange const&,
102 JsonContext const&);
103
105getSeedFromRPC(Json::Value const& params, Json::Value& error);
106
108parseRippleLibSeed(Json::Value const& params);
109
112
119bool
121
124 Json::Value const& params,
125 Json::Value& error,
126 unsigned int apiVersion = apiVersionIfUnspecified);
127
128} // namespace RPC
129
130} // namespace ripple
131
132#endif
Represents a JSON value.
Definition json_value.h:131
JSON (JavaScript Object Notation).
Definition json_errors.h:6
error_code_i accountFromStringWithCode(AccountID &result, std::string const &strIdent, bool bStrict)
Decode account ID from string.
std::optional< Seed > getSeedFromRPC(Json::Value const &params, Json::Value &error)
bool isAccountObjectsValidType(LedgerEntryType const &type)
Check if the type is a valid filtering type for account_objects method.
static constexpr std::integral_constant< unsigned, Version > apiVersion
Definition ApiVersion.h:39
bool isRelatedToAccount(ReadView const &ledger, std::shared_ptr< SLE const > const &sle, AccountID const &accountID)
Tests if a SLE is owned by accountID.
void injectSLE(Json::Value &jv, SLE const &sle)
Inject JSON describing ledger entry.
std::pair< RPC::Status, LedgerEntryType > chooseLedgerEntryType(Json::Value const &params)
std::optional< Json::Value > readLimitField(unsigned int &limit, Tuning::LimitRange const &range, JsonContext const &context)
Retrieve the limit value from a JsonContext, or set a default - then restrict the limit by max and mi...
Json::Value accountFromString(AccountID &result, std::string const &strIdent, bool bStrict)
static constexpr auto apiVersionIfUnspecified
Definition ApiVersion.h:44
std::optional< AccountID > accountFromStringStrict(std::string const &account)
Get an AccountID from an account ID or public key.
hash_set< AccountID > parseAccountIds(Json::Value const &jvArray)
std::uint64_t getStartHint(std::shared_ptr< SLE const > const &sle, AccountID const &accountID)
Gets the start hint for traversing account objects.
bool isHexTxID(std::string const &txid)
std::optional< Seed > parseRippleLibSeed(Json::Value const &value)
std::optional< std::pair< PublicKey, SecretKey > > keypairForSignature(Json::Value const &params, Json::Value &error, unsigned int apiVersion)
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition algorithm.h:6
base_uint< 160, detail::AccountIDTag > AccountID
A 160-bit unsigned that uniquely identifies an account.
Definition AccountID.h:29
LedgerEntryType
Identifiers for on-ledger objects.
Represents RPC limit parameter values that have a min, default and max.