diff --git a/AMMInfo_8cpp_source.html b/AMMInfo_8cpp_source.html index 5b33f67564..b6ff049b5e 100644 --- a/AMMInfo_8cpp_source.html +++ b/AMMInfo_8cpp_source.html @@ -85,264 +85,265 @@ $(document).ready(function() { init_codefold(0); });
2#include <xrpld/app/misc/AMMUtils.h>
3#include <xrpld/rpc/Context.h>
4#include <xrpld/rpc/detail/RPCHelpers.h>
-
5
-
6#include <xrpl/json/json_value.h>
-
7#include <xrpl/ledger/ReadView.h>
-
8#include <xrpl/protocol/AMMCore.h>
-
9#include <xrpl/protocol/Issue.h>
-
10
-
11#include <grpcpp/support/status.h>
-
12
-
13namespace ripple {
-
14
-
15std::optional<AccountID>
-
-
16getAccount(Json::Value const& v, Json::Value& result)
-
17{
-
18 std::string strIdent(v.asString());
-
19 AccountID accountID;
-
20
-
21 if (auto jv = RPC::accountFromString(accountID, strIdent))
-
22 {
-
23 for (auto it = jv.begin(); it != jv.end(); ++it)
-
24 result[it.memberName()] = (*it);
-
25
-
26 return std::nullopt;
-
27 }
-
28 return std::optional<AccountID>(accountID);
-
29}
+
5#include <xrpld/rpc/detail/RPCLedgerHelpers.h>
+
6
+
7#include <xrpl/json/json_value.h>
+
8#include <xrpl/ledger/ReadView.h>
+
9#include <xrpl/protocol/AMMCore.h>
+
10#include <xrpl/protocol/Issue.h>
+
11
+
12#include <grpcpp/support/status.h>
+
13
+
14namespace ripple {
+
15
+
16std::optional<AccountID>
+
+
17getAccount(Json::Value const& v, Json::Value& result)
+
18{
+
19 std::string strIdent(v.asString());
+
20 AccountID accountID;
+
21
+
22 if (auto jv = RPC::accountFromString(accountID, strIdent))
+
23 {
+
24 for (auto it = jv.begin(); it != jv.end(); ++it)
+
25 result[it.memberName()] = (*it);
+
26
+
27 return std::nullopt;
+
28 }
+
29 return std::optional<AccountID>(accountID);
+
30}
-
30
-
31Expected<Issue, error_code_i>
-
-
32getIssue(Json::Value const& v, beast::Journal j)
-
33{
-
34 try
-
35 {
-
36 return issueFromJson(v);
-
37 }
-
38 catch (std::runtime_error const& ex)
-
39 {
-
40 JLOG(j.debug()) << "getIssue " << ex.what();
-
41 }
-
42 return Unexpected(rpcISSUE_MALFORMED);
-
43}
+
31
+
32Expected<Issue, error_code_i>
+
+
33getIssue(Json::Value const& v, beast::Journal j)
+
34{
+
35 try
+
36 {
+
37 return issueFromJson(v);
+
38 }
+
39 catch (std::runtime_error const& ex)
+
40 {
+
41 JLOG(j.debug()) << "getIssue " << ex.what();
+
42 }
+
43 return Unexpected(rpcISSUE_MALFORMED);
+
44}
-
44
-
45std::string
-
-
46to_iso8601(NetClock::time_point tp)
-
47{
-
48 // 2000-01-01 00:00:00 UTC is 946684800s from 1970-01-01 00:00:00 UTC
-
49 using namespace std::chrono;
-
50 return date::format(
-
51 "%Y-%Om-%dT%H:%M:%OS%z",
-
52 date::sys_time<system_clock::duration>(
-
53 system_clock::time_point{tp.time_since_epoch() + epoch_offset}));
-
54}
+
45
+
46std::string
+
+
47to_iso8601(NetClock::time_point tp)
+
48{
+
49 // 2000-01-01 00:00:00 UTC is 946684800s from 1970-01-01 00:00:00 UTC
+
50 using namespace std::chrono;
+
51 return date::format(
+
52 "%Y-%Om-%dT%H:%M:%OS%z",
+
53 date::sys_time<system_clock::duration>(
+
54 system_clock::time_point{tp.time_since_epoch() + epoch_offset}));
+
55}
-
55
-
56Json::Value
-
-
57doAMMInfo(RPC::JsonContext& context)
-
58{
-
59 auto const& params(context.params);
-
60 Json::Value result;
-
61
-
62 std::shared_ptr<ReadView const> ledger;
-
63 result = RPC::lookupLedger(ledger, context);
-
64 if (!ledger)
-
65 return result;
-
66
-
67 struct ValuesFromContextParams
-
68 {
-
69 std::optional<AccountID> accountID;
-
70 Issue issue1;
-
71 Issue issue2;
-
72 std::shared_ptr<SLE const> amm;
-
73 };
-
74
-
75 auto getValuesFromContextParams =
-
76 [&]() -> Expected<ValuesFromContextParams, error_code_i> {
-
77 std::optional<AccountID> accountID;
-
78 std::optional<Issue> issue1;
-
79 std::optional<Issue> issue2;
-
80 std::optional<uint256> ammID;
-
81
-
82 constexpr auto invalid = [](Json::Value const& params) -> bool {
-
83 return (params.isMember(jss::asset) !=
-
84 params.isMember(jss::asset2)) ||
-
85 (params.isMember(jss::asset) ==
-
86 params.isMember(jss::amm_account));
-
87 };
-
88
-
89 // NOTE, identical check for apVersion >= 3 below
-
90 if (context.apiVersion < 3 && invalid(params))
-
91 return Unexpected(rpcINVALID_PARAMS);
-
92
-
93 if (params.isMember(jss::asset))
-
94 {
-
95 if (auto const i = getIssue(params[jss::asset], context.j))
-
96 issue1 = *i;
-
97 else
-
98 return Unexpected(i.error());
-
99 }
-
100
-
101 if (params.isMember(jss::asset2))
-
102 {
-
103 if (auto const i = getIssue(params[jss::asset2], context.j))
-
104 issue2 = *i;
-
105 else
-
106 return Unexpected(i.error());
-
107 }
-
108
-
109 if (params.isMember(jss::amm_account))
-
110 {
-
111 auto const id = getAccount(params[jss::amm_account], result);
-
112 if (!id)
-
113 return Unexpected(rpcACT_MALFORMED);
-
114 auto const sle = ledger->read(keylet::account(*id));
-
115 if (!sle)
-
116 return Unexpected(rpcACT_MALFORMED);
-
117 ammID = sle->getFieldH256(sfAMMID);
-
118 if (ammID->isZero())
-
119 return Unexpected(rpcACT_NOT_FOUND);
-
120 }
-
121
-
122 if (params.isMember(jss::account))
-
123 {
-
124 accountID = getAccount(params[jss::account], result);
-
125 if (!accountID || !ledger->read(keylet::account(*accountID)))
-
126 return Unexpected(rpcACT_MALFORMED);
-
127 }
-
128
-
129 // NOTE, identical check for apVersion < 3 above
-
130 if (context.apiVersion >= 3 && invalid(params))
-
131 return Unexpected(rpcINVALID_PARAMS);
-
132
-
133 XRPL_ASSERT(
-
134 (issue1.has_value() == issue2.has_value()) &&
-
135 (issue1.has_value() != ammID.has_value()),
-
136 "ripple::doAMMInfo : issue1 and issue2 do match");
-
137
-
138 auto const ammKeylet = [&]() {
-
139 if (issue1 && issue2)
-
140 return keylet::amm(*issue1, *issue2);
-
141 XRPL_ASSERT(ammID, "ripple::doAMMInfo::ammKeylet : ammID is set");
-
142 return keylet::amm(*ammID);
-
143 }();
-
144 auto const amm = ledger->read(ammKeylet);
-
145 if (!amm)
-
146 return Unexpected(rpcACT_NOT_FOUND);
-
147 if (!issue1 && !issue2)
-
148 {
-
149 issue1 = (*amm)[sfAsset].get<Issue>();
-
150 issue2 = (*amm)[sfAsset2].get<Issue>();
-
151 }
-
152
-
153 return ValuesFromContextParams{
-
154 accountID, *issue1, *issue2, std::move(amm)};
-
155 };
-
156
-
157 auto const r = getValuesFromContextParams();
-
158 if (!r)
-
159 {
-
160 RPC::inject_error(r.error(), result);
-
161 return result;
-
162 }
-
163
-
164 auto const& [accountID, issue1, issue2, amm] = *r;
-
165
-
166 auto const ammAccountID = amm->getAccountID(sfAccount);
-
167
-
168 // provide funds if frozen, specify asset_frozen flag
-
169 auto const [asset1Balance, asset2Balance] = ammPoolHolds(
-
170 *ledger,
-
171 ammAccountID,
-
172 issue1,
-
173 issue2,
-
174 FreezeHandling::fhIGNORE_FREEZE,
-
175 context.j);
-
176 auto const lptAMMBalance = accountID
-
177 ? ammLPHolds(*ledger, *amm, *accountID, context.j)
-
178 : (*amm)[sfLPTokenBalance];
-
179
-
180 Json::Value ammResult;
-
181 asset1Balance.setJson(ammResult[jss::amount]);
-
182 asset2Balance.setJson(ammResult[jss::amount2]);
-
183 lptAMMBalance.setJson(ammResult[jss::lp_token]);
-
184 ammResult[jss::trading_fee] = (*amm)[sfTradingFee];
-
185 ammResult[jss::account] = to_string(ammAccountID);
-
186 Json::Value voteSlots(Json::arrayValue);
-
187 if (amm->isFieldPresent(sfVoteSlots))
-
188 {
-
189 for (auto const& voteEntry : amm->getFieldArray(sfVoteSlots))
-
190 {
-
191 Json::Value vote;
-
192 vote[jss::account] = to_string(voteEntry.getAccountID(sfAccount));
-
193 vote[jss::trading_fee] = voteEntry[sfTradingFee];
-
194 vote[jss::vote_weight] = voteEntry[sfVoteWeight];
-
195 voteSlots.append(std::move(vote));
-
196 }
-
197 }
-
198 if (voteSlots.size() > 0)
-
199 ammResult[jss::vote_slots] = std::move(voteSlots);
-
200 XRPL_ASSERT(
-
201 !ledger->rules().enabled(fixInnerObjTemplate) ||
-
202 amm->isFieldPresent(sfAuctionSlot),
-
203 "ripple::doAMMInfo : auction slot is set");
-
204 if (amm->isFieldPresent(sfAuctionSlot))
-
205 {
-
206 auto const& auctionSlot =
-
207 static_cast<STObject const&>(amm->peekAtField(sfAuctionSlot));
-
208 if (auctionSlot.isFieldPresent(sfAccount))
-
209 {
-
210 Json::Value auction;
-
211 auto const timeSlot = ammAuctionTimeSlot(
-
212 ledger->info().parentCloseTime.time_since_epoch().count(),
-
213 auctionSlot);
-
214 auction[jss::time_interval] =
-
215 timeSlot ? *timeSlot : AUCTION_SLOT_TIME_INTERVALS;
-
216 auctionSlot[sfPrice].setJson(auction[jss::price]);
-
217 auction[jss::discounted_fee] = auctionSlot[sfDiscountedFee];
-
218 auction[jss::account] =
-
219 to_string(auctionSlot.getAccountID(sfAccount));
-
220 auction[jss::expiration] = to_iso8601(NetClock::time_point{
-
221 NetClock::duration{auctionSlot[sfExpiration]}});
-
222 if (auctionSlot.isFieldPresent(sfAuthAccounts))
-
223 {
-
224 Json::Value auth;
-
225 for (auto const& acct :
-
226 auctionSlot.getFieldArray(sfAuthAccounts))
-
227 {
-
228 Json::Value jv;
-
229 jv[jss::account] = to_string(acct.getAccountID(sfAccount));
-
230 auth.append(jv);
-
231 }
-
232 auction[jss::auth_accounts] = auth;
-
233 }
-
234 ammResult[jss::auction_slot] = std::move(auction);
-
235 }
-
236 }
-
237
-
238 if (!isXRP(asset1Balance))
-
239 ammResult[jss::asset_frozen] =
-
240 isFrozen(*ledger, ammAccountID, issue1.currency, issue1.account);
-
241 if (!isXRP(asset2Balance))
-
242 ammResult[jss::asset2_frozen] =
-
243 isFrozen(*ledger, ammAccountID, issue2.currency, issue2.account);
-
244
-
245 result[jss::amm] = std::move(ammResult);
-
246 if (!result.isMember(jss::ledger_index) &&
-
247 !result.isMember(jss::ledger_hash))
-
248 result[jss::ledger_current_index] = ledger->info().seq;
-
249 result[jss::validated] = context.ledgerMaster.isValidated(*ledger);
-
250
-
251 return result;
-
252}
+
56
+
57Json::Value
+
+
58doAMMInfo(RPC::JsonContext& context)
+
59{
+
60 auto const& params(context.params);
+
61 Json::Value result;
+
62
+
63 std::shared_ptr<ReadView const> ledger;
+
64 result = RPC::lookupLedger(ledger, context);
+
65 if (!ledger)
+
66 return result;
+
67
+
68 struct ValuesFromContextParams
+
69 {
+
70 std::optional<AccountID> accountID;
+
71 Issue issue1;
+
72 Issue issue2;
+
73 std::shared_ptr<SLE const> amm;
+
74 };
+
75
+
76 auto getValuesFromContextParams =
+
77 [&]() -> Expected<ValuesFromContextParams, error_code_i> {
+
78 std::optional<AccountID> accountID;
+
79 std::optional<Issue> issue1;
+
80 std::optional<Issue> issue2;
+
81 std::optional<uint256> ammID;
+
82
+
83 constexpr auto invalid = [](Json::Value const& params) -> bool {
+
84 return (params.isMember(jss::asset) !=
+
85 params.isMember(jss::asset2)) ||
+
86 (params.isMember(jss::asset) ==
+
87 params.isMember(jss::amm_account));
+
88 };
+
89
+
90 // NOTE, identical check for apVersion >= 3 below
+
91 if (context.apiVersion < 3 && invalid(params))
+
92 return Unexpected(rpcINVALID_PARAMS);
+
93
+
94 if (params.isMember(jss::asset))
+
95 {
+
96 if (auto const i = getIssue(params[jss::asset], context.j))
+
97 issue1 = *i;
+
98 else
+
99 return Unexpected(i.error());
+
100 }
+
101
+
102 if (params.isMember(jss::asset2))
+
103 {
+
104 if (auto const i = getIssue(params[jss::asset2], context.j))
+
105 issue2 = *i;
+
106 else
+
107 return Unexpected(i.error());
+
108 }
+
109
+
110 if (params.isMember(jss::amm_account))
+
111 {
+
112 auto const id = getAccount(params[jss::amm_account], result);
+
113 if (!id)
+
114 return Unexpected(rpcACT_MALFORMED);
+
115 auto const sle = ledger->read(keylet::account(*id));
+
116 if (!sle)
+
117 return Unexpected(rpcACT_MALFORMED);
+
118 ammID = sle->getFieldH256(sfAMMID);
+
119 if (ammID->isZero())
+
120 return Unexpected(rpcACT_NOT_FOUND);
+
121 }
+
122
+
123 if (params.isMember(jss::account))
+
124 {
+
125 accountID = getAccount(params[jss::account], result);
+
126 if (!accountID || !ledger->read(keylet::account(*accountID)))
+
127 return Unexpected(rpcACT_MALFORMED);
+
128 }
+
129
+
130 // NOTE, identical check for apVersion < 3 above
+
131 if (context.apiVersion >= 3 && invalid(params))
+
132 return Unexpected(rpcINVALID_PARAMS);
+
133
+
134 XRPL_ASSERT(
+
135 (issue1.has_value() == issue2.has_value()) &&
+
136 (issue1.has_value() != ammID.has_value()),
+
137 "ripple::doAMMInfo : issue1 and issue2 do match");
+
138
+
139 auto const ammKeylet = [&]() {
+
140 if (issue1 && issue2)
+
141 return keylet::amm(*issue1, *issue2);
+
142 XRPL_ASSERT(ammID, "ripple::doAMMInfo::ammKeylet : ammID is set");
+
143 return keylet::amm(*ammID);
+
144 }();
+
145 auto const amm = ledger->read(ammKeylet);
+
146 if (!amm)
+
147 return Unexpected(rpcACT_NOT_FOUND);
+
148 if (!issue1 && !issue2)
+
149 {
+
150 issue1 = (*amm)[sfAsset].get<Issue>();
+
151 issue2 = (*amm)[sfAsset2].get<Issue>();
+
152 }
+
153
+
154 return ValuesFromContextParams{
+
155 accountID, *issue1, *issue2, std::move(amm)};
+
156 };
+
157
+
158 auto const r = getValuesFromContextParams();
+
159 if (!r)
+
160 {
+
161 RPC::inject_error(r.error(), result);
+
162 return result;
+
163 }
+
164
+
165 auto const& [accountID, issue1, issue2, amm] = *r;
+
166
+
167 auto const ammAccountID = amm->getAccountID(sfAccount);
+
168
+
169 // provide funds if frozen, specify asset_frozen flag
+
170 auto const [asset1Balance, asset2Balance] = ammPoolHolds(
+
171 *ledger,
+
172 ammAccountID,
+
173 issue1,
+
174 issue2,
+
175 FreezeHandling::fhIGNORE_FREEZE,
+
176 context.j);
+
177 auto const lptAMMBalance = accountID
+
178 ? ammLPHolds(*ledger, *amm, *accountID, context.j)
+
179 : (*amm)[sfLPTokenBalance];
+
180
+
181 Json::Value ammResult;
+
182 asset1Balance.setJson(ammResult[jss::amount]);
+
183 asset2Balance.setJson(ammResult[jss::amount2]);
+
184 lptAMMBalance.setJson(ammResult[jss::lp_token]);
+
185 ammResult[jss::trading_fee] = (*amm)[sfTradingFee];
+
186 ammResult[jss::account] = to_string(ammAccountID);
+
187 Json::Value voteSlots(Json::arrayValue);
+
188 if (amm->isFieldPresent(sfVoteSlots))
+
189 {
+
190 for (auto const& voteEntry : amm->getFieldArray(sfVoteSlots))
+
191 {
+
192 Json::Value vote;
+
193 vote[jss::account] = to_string(voteEntry.getAccountID(sfAccount));
+
194 vote[jss::trading_fee] = voteEntry[sfTradingFee];
+
195 vote[jss::vote_weight] = voteEntry[sfVoteWeight];
+
196 voteSlots.append(std::move(vote));
+
197 }
+
198 }
+
199 if (voteSlots.size() > 0)
+
200 ammResult[jss::vote_slots] = std::move(voteSlots);
+
201 XRPL_ASSERT(
+
202 !ledger->rules().enabled(fixInnerObjTemplate) ||
+
203 amm->isFieldPresent(sfAuctionSlot),
+
204 "ripple::doAMMInfo : auction slot is set");
+
205 if (amm->isFieldPresent(sfAuctionSlot))
+
206 {
+
207 auto const& auctionSlot =
+
208 static_cast<STObject const&>(amm->peekAtField(sfAuctionSlot));
+
209 if (auctionSlot.isFieldPresent(sfAccount))
+
210 {
+
211 Json::Value auction;
+
212 auto const timeSlot = ammAuctionTimeSlot(
+
213 ledger->info().parentCloseTime.time_since_epoch().count(),
+
214 auctionSlot);
+
215 auction[jss::time_interval] =
+
216 timeSlot ? *timeSlot : AUCTION_SLOT_TIME_INTERVALS;
+
217 auctionSlot[sfPrice].setJson(auction[jss::price]);
+
218 auction[jss::discounted_fee] = auctionSlot[sfDiscountedFee];
+
219 auction[jss::account] =
+
220 to_string(auctionSlot.getAccountID(sfAccount));
+
221 auction[jss::expiration] = to_iso8601(NetClock::time_point{
+
222 NetClock::duration{auctionSlot[sfExpiration]}});
+
223 if (auctionSlot.isFieldPresent(sfAuthAccounts))
+
224 {
+
225 Json::Value auth;
+
226 for (auto const& acct :
+
227 auctionSlot.getFieldArray(sfAuthAccounts))
+
228 {
+
229 Json::Value jv;
+
230 jv[jss::account] = to_string(acct.getAccountID(sfAccount));
+
231 auth.append(jv);
+
232 }
+
233 auction[jss::auth_accounts] = auth;
+
234 }
+
235 ammResult[jss::auction_slot] = std::move(auction);
+
236 }
+
237 }
+
238
+
239 if (!isXRP(asset1Balance))
+
240 ammResult[jss::asset_frozen] =
+
241 isFrozen(*ledger, ammAccountID, issue1.currency, issue1.account);
+
242 if (!isXRP(asset2Balance))
+
243 ammResult[jss::asset2_frozen] =
+
244 isFrozen(*ledger, ammAccountID, issue2.currency, issue2.account);
+
245
+
246 result[jss::amm] = std::move(ammResult);
+
247 if (!result.isMember(jss::ledger_index) &&
+
248 !result.isMember(jss::ledger_hash))
+
249 result[jss::ledger_current_index] = ledger->info().seq;
+
250 result[jss::validated] = context.ledgerMaster.isValidated(*ledger);
+
251
+
252 return result;
+
253}
-
253
-
254} // namespace ripple
+
254
+
255} // namespace ripple
Json::Value
Represents a JSON value.
Definition json_value.h:131
Json::Value::append
Value & append(Value const &value)
Append value to array at the end.
Definition json_value.cpp:978
@@ -362,7 +363,7 @@ $(document).ready(function() { init_codefold(0); });
Json::arrayValue
@ arrayValue
array value (ordered list)
Definition json_value.h:26
ripple::RPC::inject_error
void inject_error(error_code_i code, JsonValue &json)
Add or update the json update to reflect the error code.
Definition ErrorCodes.h:214
ripple::RPC::accountFromString
Json::Value accountFromString(AccountID &result, std::string const &strIdent, bool bStrict)
Definition RPCHelpers.cpp:69
-
ripple::RPC::lookupLedger
Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
Definition RPCHelpers.cpp:606
+
ripple::RPC::lookupLedger
Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
Definition RPCLedgerHelpers.cpp:305
ripple::keylet::amm
Keylet amm(Asset const &issue1, Asset const &issue2) noexcept
AMM entry.
Definition Indexes.cpp:427
ripple::keylet::account
Keylet account(AccountID const &id) noexcept
AccountID root.
Definition Indexes.cpp:165
ripple
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition algorithm.h:6
@@ -375,8 +376,8 @@ $(document).ready(function() { init_codefold(0); });
ripple::rpcACT_MALFORMED
@ rpcACT_MALFORMED
Definition ErrorCodes.h:71
ripple::rpcINVALID_PARAMS
@ rpcINVALID_PARAMS
Definition ErrorCodes.h:65
ripple::getIssue
Issue getIssue(T const &amt)
Definition AmountConversions.h:167
-
ripple::getAccount
std::optional< AccountID > getAccount(Json::Value const &v, Json::Value &result)
Definition AMMInfo.cpp:16
-
ripple::doAMMInfo
Json::Value doAMMInfo(RPC::JsonContext &context)
Definition AMMInfo.cpp:57
+
ripple::getAccount
std::optional< AccountID > getAccount(Json::Value const &v, Json::Value &result)
Definition AMMInfo.cpp:17
+
ripple::doAMMInfo
Json::Value doAMMInfo(RPC::JsonContext &context)
Definition AMMInfo.cpp:58
ripple::isFrozen
bool isFrozen(ReadView const &view, AccountID const &account, Currency const &currency, AccountID const &issuer)
Definition View.cpp:228
ripple::ammLPHolds
STAmount ammLPHolds(ReadView const &view, Currency const &cur1, Currency const &cur2, AccountID const &ammAccount, AccountID const &lpAccount, beast::Journal const j)
Get the balance of LP tokens.
Definition AMMUtils.cpp:94
ripple::issueFromJson
Issue issueFromJson(Json::Value const &v)
Definition Issue.cpp:76
@@ -384,7 +385,7 @@ $(document).ready(function() { init_codefold(0); });
ripple::ManifestDisposition::invalid
@ invalid
Timely, but invalid signature.
ripple::epoch_offset
static constexpr std::chrono::seconds epoch_offset
Clock for measuring the network time.
Definition chrono.h:36
ripple::to_string
std::string to_string(base_uint< Bits, Tag > const &a)
Definition base_uint.h:611
-
ripple::to_iso8601
std::string to_iso8601(NetClock::time_point tp)
Definition AMMInfo.cpp:46
+
ripple::to_iso8601
std::string to_iso8601(NetClock::time_point tp)
Definition AMMInfo.cpp:47
std::optional::has_value
T has_value(T... args)
diff --git a/AccountChannels_8cpp_source.html b/AccountChannels_8cpp_source.html index ca66fc4cc4..5774a5a02b 100644 --- a/AccountChannels_8cpp_source.html +++ b/AccountChannels_8cpp_source.html @@ -83,204 +83,205 @@ $(document).ready(function() { init_codefold(0); });
1#include <xrpld/rpc/Context.h>
2#include <xrpld/rpc/detail/RPCHelpers.h>
-
3#include <xrpld/rpc/detail/Tuning.h>
-
4
-
5#include <xrpl/ledger/ReadView.h>
-
6#include <xrpl/ledger/View.h>
-
7#include <xrpl/protocol/ErrorCodes.h>
-
8#include <xrpl/protocol/PublicKey.h>
-
9#include <xrpl/protocol/RPCErr.h>
-
10#include <xrpl/protocol/jss.h>
-
11#include <xrpl/resource/Fees.h>
-
12
-
13namespace ripple {
-
14
-
15void
-
-
16addChannel(Json::Value& jsonLines, SLE const& line)
-
17{
-
18 Json::Value& jDst(jsonLines.append(Json::objectValue));
-
19 jDst[jss::channel_id] = to_string(line.key());
-
20 jDst[jss::account] = to_string(line[sfAccount]);
-
21 jDst[jss::destination_account] = to_string(line[sfDestination]);
-
22 jDst[jss::amount] = line[sfAmount].getText();
-
23 jDst[jss::balance] = line[sfBalance].getText();
-
24 if (publicKeyType(line[sfPublicKey]))
-
25 {
-
26 PublicKey const pk(line[sfPublicKey]);
-
27 jDst[jss::public_key] = toBase58(TokenType::AccountPublic, pk);
-
28 jDst[jss::public_key_hex] = strHex(pk);
-
29 }
-
30 jDst[jss::settle_delay] = line[sfSettleDelay];
-
31 if (auto const& v = line[~sfExpiration])
-
32 jDst[jss::expiration] = *v;
-
33 if (auto const& v = line[~sfCancelAfter])
-
34 jDst[jss::cancel_after] = *v;
-
35 if (auto const& v = line[~sfSourceTag])
-
36 jDst[jss::source_tag] = *v;
-
37 if (auto const& v = line[~sfDestinationTag])
-
38 jDst[jss::destination_tag] = *v;
-
39}
+
3#include <xrpld/rpc/detail/RPCLedgerHelpers.h>
+
4#include <xrpld/rpc/detail/Tuning.h>
+
5
+
6#include <xrpl/ledger/ReadView.h>
+
7#include <xrpl/ledger/View.h>
+
8#include <xrpl/protocol/ErrorCodes.h>
+
9#include <xrpl/protocol/PublicKey.h>
+
10#include <xrpl/protocol/RPCErr.h>
+
11#include <xrpl/protocol/jss.h>
+
12#include <xrpl/resource/Fees.h>
+
13
+
14namespace ripple {
+
15
+
16void
+
+
17addChannel(Json::Value& jsonLines, SLE const& line)
+
18{
+
19 Json::Value& jDst(jsonLines.append(Json::objectValue));
+
20 jDst[jss::channel_id] = to_string(line.key());
+
21 jDst[jss::account] = to_string(line[sfAccount]);
+
22 jDst[jss::destination_account] = to_string(line[sfDestination]);
+
23 jDst[jss::amount] = line[sfAmount].getText();
+
24 jDst[jss::balance] = line[sfBalance].getText();
+
25 if (publicKeyType(line[sfPublicKey]))
+
26 {
+
27 PublicKey const pk(line[sfPublicKey]);
+
28 jDst[jss::public_key] = toBase58(TokenType::AccountPublic, pk);
+
29 jDst[jss::public_key_hex] = strHex(pk);
+
30 }
+
31 jDst[jss::settle_delay] = line[sfSettleDelay];
+
32 if (auto const& v = line[~sfExpiration])
+
33 jDst[jss::expiration] = *v;
+
34 if (auto const& v = line[~sfCancelAfter])
+
35 jDst[jss::cancel_after] = *v;
+
36 if (auto const& v = line[~sfSourceTag])
+
37 jDst[jss::source_tag] = *v;
+
38 if (auto const& v = line[~sfDestinationTag])
+
39 jDst[jss::destination_tag] = *v;
+
40}
-
40
-
41// {
-
42// account: <account>
-
43// ledger_hash : <ledger>
-
44// ledger_index : <ledger_index>
-
45// limit: integer // optional
-
46// marker: opaque // optional, resume previous query
-
47// }
-
48Json::Value
-
-
49doAccountChannels(RPC::JsonContext& context)
-
50{
-
51 auto const& params(context.params);
-
52 if (!params.isMember(jss::account))
-
53 return RPC::missing_field_error(jss::account);
-
54
-
55 if (!params[jss::account].isString())
-
56 return RPC::invalid_field_error(jss::account);
-
57
-
58 std::shared_ptr<ReadView const> ledger;
-
59 auto result = RPC::lookupLedger(ledger, context);
-
60 if (!ledger)
-
61 return result;
-
62
-
63 auto id = parseBase58<AccountID>(params[jss::account].asString());
-
64 if (!id)
-
65 {
-
66 return rpcError(rpcACT_MALFORMED);
-
67 }
-
68 AccountID const accountID{std::move(id.value())};
-
69
-
70 if (!ledger->exists(keylet::account(accountID)))
-
71 return rpcError(rpcACT_NOT_FOUND);
-
72
-
73 std::string strDst;
-
74 if (params.isMember(jss::destination_account))
-
75 strDst = params[jss::destination_account].asString();
-
76
-
77 auto const raDstAccount = [&]() -> std::optional<AccountID> {
-
78 return strDst.empty() ? std::nullopt : parseBase58<AccountID>(strDst);
-
79 }();
-
80 if (!strDst.empty() && !raDstAccount)
-
81 return rpcError(rpcACT_MALFORMED);
-
82
-
83 unsigned int limit;
-
84 if (auto err = readLimitField(limit, RPC::Tuning::accountChannels, context))
-
85 return *err;
-
86
-
87 Json::Value jsonChannels{Json::arrayValue};
-
88 struct VisitData
-
89 {
-
90 std::vector<std::shared_ptr<SLE const>> items;
-
91 AccountID const& accountID;
-
92 std::optional<AccountID> const& raDstAccount;
-
93 };
-
94 VisitData visitData = {{}, accountID, raDstAccount};
-
95 visitData.items.reserve(limit);
-
96 uint256 startAfter = beast::zero;
-
97 std::uint64_t startHint = 0;
-
98
-
99 if (params.isMember(jss::marker))
-
100 {
-
101 if (!params[jss::marker].isString())
-
102 return RPC::expected_field_error(jss::marker, "string");
-
103
-
104 // Marker is composed of a comma separated index and start hint. The
-
105 // former will be read as hex, and the latter using boost lexical cast.
-
106 std::stringstream marker(params[jss::marker].asString());
-
107 std::string value;
-
108 if (!std::getline(marker, value, ','))
-
109 return rpcError(rpcINVALID_PARAMS);
-
110
-
111 if (!startAfter.parseHex(value))
-
112 return rpcError(rpcINVALID_PARAMS);
-
113
-
114 if (!std::getline(marker, value, ','))
-
115 return rpcError(rpcINVALID_PARAMS);
-
116
-
117 try
-
118 {
-
119 startHint = boost::lexical_cast<std::uint64_t>(value);
-
120 }
-
121 catch (boost::bad_lexical_cast&)
-
122 {
-
123 return rpcError(rpcINVALID_PARAMS);
-
124 }
-
125
-
126 // We then must check if the object pointed to by the marker is actually
-
127 // owned by the account in the request.
-
128 auto const sle = ledger->read({ltANY, startAfter});
-
129
-
130 if (!sle)
-
131 return rpcError(rpcINVALID_PARAMS);
-
132
-
133 if (!RPC::isRelatedToAccount(*ledger, sle, accountID))
-
134 return rpcError(rpcINVALID_PARAMS);
-
135 }
-
136
-
137 auto count = 0;
-
138 std::optional<uint256> marker = {};
-
139 std::uint64_t nextHint = 0;
-
140 if (!forEachItemAfter(
-
141 *ledger,
-
142 accountID,
-
143 startAfter,
-
144 startHint,
-
145 limit + 1,
-
146 [&visitData, &accountID, &count, &limit, &marker, &nextHint](
-
147 std::shared_ptr<SLE const> const& sleCur) {
-
148 if (!sleCur)
-
149 {
-
150 // LCOV_EXCL_START
-
151 UNREACHABLE("ripple::doAccountChannels : null SLE");
-
152 return false;
-
153 // LCOV_EXCL_STOP
-
154 }
-
155
-
156 if (++count == limit)
-
157 {
-
158 marker = sleCur->key();
-
159 nextHint = RPC::getStartHint(sleCur, visitData.accountID);
-
160 }
-
161
-
162 if (count <= limit && sleCur->getType() == ltPAYCHAN &&
-
163 (*sleCur)[sfAccount] == accountID &&
-
164 (!visitData.raDstAccount ||
-
165 *visitData.raDstAccount == (*sleCur)[sfDestination]))
-
166 {
-
167 visitData.items.emplace_back(sleCur);
-
168 }
-
169
-
170 return true;
-
171 }))
-
172 {
-
173 return rpcError(rpcINVALID_PARAMS);
-
174 }
-
175
-
176 // Both conditions need to be checked because marker is set on the limit-th
-
177 // item, but if there is no item on the limit + 1 iteration, then there is
-
178 // no need to return a marker.
-
179 if (count == limit + 1 && marker)
-
180 {
-
181 result[jss::limit] = limit;
-
182 result[jss::marker] =
-
183 to_string(*marker) + "," + std::to_string(nextHint);
-
184 }
-
185
-
186 result[jss::account] = toBase58(accountID);
-
187
-
188 for (auto const& item : visitData.items)
-
189 addChannel(jsonChannels, *item);
-
190
-
191 context.loadType = Resource::feeMediumBurdenRPC;
-
192 result[jss::channels] = std::move(jsonChannels);
-
193 return result;
-
194}
+
41
+
42// {
+
43// account: <account>
+
44// ledger_hash : <ledger>
+
45// ledger_index : <ledger_index>
+
46// limit: integer // optional
+
47// marker: opaque // optional, resume previous query
+
48// }
+
49Json::Value
+
+
50doAccountChannels(RPC::JsonContext& context)
+
51{
+
52 auto const& params(context.params);
+
53 if (!params.isMember(jss::account))
+
54 return RPC::missing_field_error(jss::account);
+
55
+
56 if (!params[jss::account].isString())
+
57 return RPC::invalid_field_error(jss::account);
+
58
+
59 std::shared_ptr<ReadView const> ledger;
+
60 auto result = RPC::lookupLedger(ledger, context);
+
61 if (!ledger)
+
62 return result;
+
63
+
64 auto id = parseBase58<AccountID>(params[jss::account].asString());
+
65 if (!id)
+
66 {
+
67 return rpcError(rpcACT_MALFORMED);
+
68 }
+
69 AccountID const accountID{std::move(id.value())};
+
70
+
71 if (!ledger->exists(keylet::account(accountID)))
+
72 return rpcError(rpcACT_NOT_FOUND);
+
73
+
74 std::string strDst;
+
75 if (params.isMember(jss::destination_account))
+
76 strDst = params[jss::destination_account].asString();
+
77
+
78 auto const raDstAccount = [&]() -> std::optional<AccountID> {
+
79 return strDst.empty() ? std::nullopt : parseBase58<AccountID>(strDst);
+
80 }();
+
81 if (!strDst.empty() && !raDstAccount)
+
82 return rpcError(rpcACT_MALFORMED);
+
83
+
84 unsigned int limit;
+
85 if (auto err = readLimitField(limit, RPC::Tuning::accountChannels, context))
+
86 return *err;
+
87
+
88 Json::Value jsonChannels{Json::arrayValue};
+
89 struct VisitData
+
90 {
+
91 std::vector<std::shared_ptr<SLE const>> items;
+
92 AccountID const& accountID;
+
93 std::optional<AccountID> const& raDstAccount;
+
94 };
+
95 VisitData visitData = {{}, accountID, raDstAccount};
+
96 visitData.items.reserve(limit);
+
97 uint256 startAfter = beast::zero;
+
98 std::uint64_t startHint = 0;
+
99
+
100 if (params.isMember(jss::marker))
+
101 {
+
102 if (!params[jss::marker].isString())
+
103 return RPC::expected_field_error(jss::marker, "string");
+
104
+
105 // Marker is composed of a comma separated index and start hint. The
+
106 // former will be read as hex, and the latter using boost lexical cast.
+
107 std::stringstream marker(params[jss::marker].asString());
+
108 std::string value;
+
109 if (!std::getline(marker, value, ','))
+
110 return rpcError(rpcINVALID_PARAMS);
+
111
+
112 if (!startAfter.parseHex(value))
+
113 return rpcError(rpcINVALID_PARAMS);
+
114
+
115 if (!std::getline(marker, value, ','))
+
116 return rpcError(rpcINVALID_PARAMS);
+
117
+
118 try
+
119 {
+
120 startHint = boost::lexical_cast<std::uint64_t>(value);
+
121 }
+
122 catch (boost::bad_lexical_cast&)
+
123 {
+
124 return rpcError(rpcINVALID_PARAMS);
+
125 }
+
126
+
127 // We then must check if the object pointed to by the marker is actually
+
128 // owned by the account in the request.
+
129 auto const sle = ledger->read({ltANY, startAfter});
+
130
+
131 if (!sle)
+
132 return rpcError(rpcINVALID_PARAMS);
+
133
+
134 if (!RPC::isRelatedToAccount(*ledger, sle, accountID))
+
135 return rpcError(rpcINVALID_PARAMS);
+
136 }
+
137
+
138 auto count = 0;
+
139 std::optional<uint256> marker = {};
+
140 std::uint64_t nextHint = 0;
+
141 if (!forEachItemAfter(
+
142 *ledger,
+
143 accountID,
+
144 startAfter,
+
145 startHint,
+
146 limit + 1,
+
147 [&visitData, &accountID, &count, &limit, &marker, &nextHint](
+
148 std::shared_ptr<SLE const> const& sleCur) {
+
149 if (!sleCur)
+
150 {
+
151 // LCOV_EXCL_START
+
152 UNREACHABLE("ripple::doAccountChannels : null SLE");
+
153 return false;
+
154 // LCOV_EXCL_STOP
+
155 }
+
156
+
157 if (++count == limit)
+
158 {
+
159 marker = sleCur->key();
+
160 nextHint = RPC::getStartHint(sleCur, visitData.accountID);
+
161 }
+
162
+
163 if (count <= limit && sleCur->getType() == ltPAYCHAN &&
+
164 (*sleCur)[sfAccount] == accountID &&
+
165 (!visitData.raDstAccount ||
+
166 *visitData.raDstAccount == (*sleCur)[sfDestination]))
+
167 {
+
168 visitData.items.emplace_back(sleCur);
+
169 }
+
170
+
171 return true;
+
172 }))
+
173 {
+
174 return rpcError(rpcINVALID_PARAMS);
+
175 }
+
176
+
177 // Both conditions need to be checked because marker is set on the limit-th
+
178 // item, but if there is no item on the limit + 1 iteration, then there is
+
179 // no need to return a marker.
+
180 if (count == limit + 1 && marker)
+
181 {
+
182 result[jss::limit] = limit;
+
183 result[jss::marker] =
+
184 to_string(*marker) + "," + std::to_string(nextHint);
+
185 }
+
186
+
187 result[jss::account] = toBase58(accountID);
+
188
+
189 for (auto const& item : visitData.items)
+
190 addChannel(jsonChannels, *item);
+
191
+
192 context.loadType = Resource::feeMediumBurdenRPC;
+
193 result[jss::channels] = std::move(jsonChannels);
+
194 return result;
+
195}
-
195
-
196} // namespace ripple
+
196
+
197} // namespace ripple
Json::Value
Represents a JSON value.
Definition json_value.h:131
@@ -299,14 +300,14 @@ $(document).ready(function() { init_codefold(0); });
ripple::RPC::invalid_field_error
Json::Value invalid_field_error(std::string const &name)
Definition ErrorCodes.h:306
ripple::RPC::isRelatedToAccount
bool isRelatedToAccount(ReadView const &ledger, std::shared_ptr< SLE const > const &sle, AccountID const &accountID)
Tests if a SLE is owned by accountID.
Definition RPCHelpers.cpp:96
ripple::RPC::expected_field_error
Json::Value expected_field_error(std::string const &name, std::string const &type)
Definition ErrorCodes.h:330
-
ripple::RPC::lookupLedger
Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
Definition RPCHelpers.cpp:606
+
ripple::RPC::lookupLedger
Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
Definition RPCLedgerHelpers.cpp:305
ripple::RPC::getStartHint
std::uint64_t getStartHint(std::shared_ptr< SLE const > const &sle, AccountID const &accountID)
Gets the start hint for traversing account objects.
Definition RPCHelpers.cpp:79
ripple::RPC::missing_field_error
Json::Value missing_field_error(std::string const &name)
Definition ErrorCodes.h:264
ripple::Resource::feeMediumBurdenRPC
Charge const feeMediumBurdenRPC
ripple::keylet::account
Keylet account(AccountID const &id) noexcept
AccountID root.
Definition Indexes.cpp:165
ripple
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition algorithm.h:6
ripple::toBase58
std::string toBase58(AccountID const &v)
Convert AccountID to base58 checked string.
Definition AccountID.cpp:95
-
ripple::addChannel
void addChannel(Json::Value &jsonLines, SLE const &line)
Definition AccountChannels.cpp:16
+
ripple::addChannel
void addChannel(Json::Value &jsonLines, SLE const &line)
Definition AccountChannels.cpp:17
ripple::rpcACT_NOT_FOUND
@ rpcACT_NOT_FOUND
Definition ErrorCodes.h:51
ripple::rpcACT_MALFORMED
@ rpcACT_MALFORMED
Definition ErrorCodes.h:71
@@ -317,7 +318,7 @@ $(document).ready(function() { init_codefold(0); });
ripple::forEachItemAfter
bool forEachItemAfter(ReadView const &view, Keylet const &root, uint256 const &after, std::uint64_t const hint, unsigned int limit, std::function< bool(std::shared_ptr< SLE const > const &)> const &f)
Iterate all items after an item in the given directory.
Definition View.cpp:665
ripple::to_string
std::string to_string(base_uint< Bits, Tag > const &a)
Definition base_uint.h:611
ripple::ltANY
@ ltANY
A special type, matching any ledger entry type.
Definition LedgerFormats.h:59
-
ripple::doAccountChannels
Json::Value doAccountChannels(RPC::JsonContext &context)
Definition AccountChannels.cpp:49
+
ripple::doAccountChannels
Json::Value doAccountChannels(RPC::JsonContext &context)
Definition AccountChannels.cpp:50
ripple::Keylet::key
uint256 key
Definition Keylet.h:21
diff --git a/AccountCurrenciesHandler_8cpp_source.html b/AccountCurrenciesHandler_8cpp_source.html index a34ccae238..6297d856e2 100644 --- a/AccountCurrenciesHandler_8cpp_source.html +++ b/AccountCurrenciesHandler_8cpp_source.html @@ -83,7 +83,7 @@ $(document).ready(function() { init_codefold(0); });
1#include <xrpld/app/paths/TrustLine.h>
2#include <xrpld/rpc/Context.h>
-
3#include <xrpld/rpc/detail/RPCHelpers.h>
+
3#include <xrpld/rpc/detail/RPCLedgerHelpers.h>
4
5#include <xrpl/ledger/ReadView.h>
6#include <xrpl/protocol/ErrorCodes.h>
@@ -173,7 +173,7 @@ $(document).ready(function() { init_codefold(0); });
Json::arrayValue
@ arrayValue
array value (ordered list)
Definition json_value.h:26
ripple::RPC::invalid_field_error
Json::Value invalid_field_error(std::string const &name)
Definition ErrorCodes.h:306
ripple::RPC::inject_error
void inject_error(error_code_i code, JsonValue &json)
Add or update the json update to reflect the error code.
Definition ErrorCodes.h:214
-
ripple::RPC::lookupLedger
Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
Definition RPCHelpers.cpp:606
+
ripple::RPC::lookupLedger
Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
Definition RPCLedgerHelpers.cpp:305
ripple::RPC::missing_field_error
Json::Value missing_field_error(std::string const &name)
Definition ErrorCodes.h:264
ripple::keylet::account
Keylet account(AccountID const &id) noexcept
AccountID root.
Definition Indexes.cpp:165
ripple
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition algorithm.h:6
diff --git a/AccountInfo_8cpp_source.html b/AccountInfo_8cpp_source.html index 9579704576..8eb5e5edff 100644 --- a/AccountInfo_8cpp_source.html +++ b/AccountInfo_8cpp_source.html @@ -86,279 +86,280 @@ $(document).ready(function() { init_codefold(0); });
3#include <xrpld/rpc/Context.h>
4#include <xrpld/rpc/GRPCHandlers.h>
5#include <xrpld/rpc/detail/RPCHelpers.h>
-
6
-
7#include <xrpl/json/json_value.h>
-
8#include <xrpl/ledger/ReadView.h>
-
9#include <xrpl/protocol/ErrorCodes.h>
-
10#include <xrpl/protocol/Indexes.h>
-
11#include <xrpl/protocol/UintTypes.h>
-
12#include <xrpl/protocol/jss.h>
-
13
-
14namespace ripple {
-
15
-
16// {
-
17// account: <ident>,
-
18// ledger_hash : <ledger>
-
19// ledger_index : <ledger_index>
-
20// signer_lists : <bool> // optional (default false)
-
21// // if true return SignerList(s).
-
22// queue : <bool> // optional (default false)
-
23// // if true return information about transactions
-
24// // in the current TxQ, only if the requested
-
25// // ledger is open. Otherwise if true, returns an
-
26// // error.
-
27// }
-
28
-
29// TODO(tom): what is that "default"?
-
30Json::Value
-
-
31doAccountInfo(RPC::JsonContext& context)
-
32{
-
33 auto& params = context.params;
-
34
-
35 std::string strIdent;
-
36 if (params.isMember(jss::account))
-
37 {
-
38 if (!params[jss::account].isString())
-
39 return RPC::invalid_field_error(jss::account);
-
40 strIdent = params[jss::account].asString();
-
41 }
-
42 else if (params.isMember(jss::ident))
-
43 {
-
44 if (!params[jss::ident].isString())
-
45 return RPC::invalid_field_error(jss::ident);
-
46 strIdent = params[jss::ident].asString();
-
47 }
-
48 else
-
49 return RPC::missing_field_error(jss::account);
-
50
-
51 std::shared_ptr<ReadView const> ledger;
-
52 auto result = RPC::lookupLedger(ledger, context);
-
53
-
54 if (!ledger)
-
55 return result;
-
56
-
57 // Get info on account.
-
58 auto id = parseBase58<AccountID>(strIdent);
-
59 if (!id)
-
60 {
-
61 RPC::inject_error(rpcACT_MALFORMED, result);
-
62 return result;
-
63 }
-
64 auto const accountID{std::move(id.value())};
-
65
-
66 static constexpr std::
-
67 array<std::pair<std::string_view, LedgerSpecificFlags>, 9>
-
68 lsFlags{
-
69 {{"defaultRipple", lsfDefaultRipple},
-
70 {"depositAuth", lsfDepositAuth},
-
71 {"disableMasterKey", lsfDisableMaster},
-
72 {"disallowIncomingXRP", lsfDisallowXRP},
-
73 {"globalFreeze", lsfGlobalFreeze},
-
74 {"noFreeze", lsfNoFreeze},
-
75 {"passwordSpent", lsfPasswordSpent},
-
76 {"requireAuthorization", lsfRequireAuth},
-
77 {"requireDestinationTag", lsfRequireDestTag}}};
-
78
-
79 static constexpr std::
-
80 array<std::pair<std::string_view, LedgerSpecificFlags>, 4>
-
81 disallowIncomingFlags{
-
82 {{"disallowIncomingNFTokenOffer",
-
83 lsfDisallowIncomingNFTokenOffer},
-
84 {"disallowIncomingCheck", lsfDisallowIncomingCheck},
-
85 {"disallowIncomingPayChan", lsfDisallowIncomingPayChan},
-
86 {"disallowIncomingTrustline", lsfDisallowIncomingTrustline}}};
-
87
-
88 static constexpr std::pair<std::string_view, LedgerSpecificFlags>
-
89 allowTrustLineClawbackFlag{
-
90 "allowTrustLineClawback", lsfAllowTrustLineClawback};
-
91
-
92 static constexpr std::pair<std::string_view, LedgerSpecificFlags>
-
93 allowTrustLineLockingFlag{
-
94 "allowTrustLineLocking", lsfAllowTrustLineLocking};
-
95
-
96 auto const sleAccepted = ledger->read(keylet::account(accountID));
-
97 if (sleAccepted)
-
98 {
-
99 auto const queue =
-
100 params.isMember(jss::queue) && params[jss::queue].asBool();
-
101
-
102 if (queue && !ledger->open())
-
103 {
-
104 // It doesn't make sense to request the queue
-
105 // with any closed or validated ledger.
-
106 RPC::inject_error(rpcINVALID_PARAMS, result);
-
107 return result;
-
108 }
-
109
-
110 Json::Value jvAccepted(Json::objectValue);
-
111 RPC::injectSLE(jvAccepted, *sleAccepted);
-
112 result[jss::account_data] = jvAccepted;
-
113
-
114 Json::Value acctFlags{Json::objectValue};
-
115 for (auto const& lsf : lsFlags)
-
116 acctFlags[lsf.first.data()] = sleAccepted->isFlag(lsf.second);
-
117
-
118 if (ledger->rules().enabled(featureDisallowIncoming))
-
119 {
-
120 for (auto const& lsf : disallowIncomingFlags)
-
121 acctFlags[lsf.first.data()] = sleAccepted->isFlag(lsf.second);
-
122 }
-
123
-
124 if (ledger->rules().enabled(featureClawback))
-
125 acctFlags[allowTrustLineClawbackFlag.first.data()] =
-
126 sleAccepted->isFlag(allowTrustLineClawbackFlag.second);
-
127
-
128 if (ledger->rules().enabled(featureTokenEscrow))
-
129 acctFlags[allowTrustLineLockingFlag.first.data()] =
-
130 sleAccepted->isFlag(allowTrustLineLockingFlag.second);
-
131
-
132 result[jss::account_flags] = std::move(acctFlags);
-
133
-
134 // The document[https://xrpl.org/account_info.html#account_info] states
-
135 // that signer_lists is a bool, however assigning any string value
-
136 // works. Do not allow this. This check is for api Version 2 onwards
-
137 // only
-
138 if (context.apiVersion > 1u && params.isMember(jss::signer_lists) &&
-
139 !params[jss::signer_lists].isBool())
-
140 {
-
141 RPC::inject_error(rpcINVALID_PARAMS, result);
-
142 return result;
-
143 }
-
144
-
145 // Return SignerList(s) if that is requested.
-
146 if (params.isMember(jss::signer_lists) &&
-
147 params[jss::signer_lists].asBool())
-
148 {
-
149 // We put the SignerList in an array because of an anticipated
-
150 // future when we support multiple signer lists on one account.
-
151 Json::Value jvSignerList = Json::arrayValue;
-
152
-
153 // This code will need to be revisited if in the future we support
-
154 // multiple SignerLists on one account.
-
155 auto const sleSigners = ledger->read(keylet::signers(accountID));
-
156 if (sleSigners)
-
157 jvSignerList.append(sleSigners->getJson(JsonOptions::none));
-
158
-
159 // Documentation states this is returned as part of the account_info
-
160 // response, but previously the code put it under account_data. We
-
161 // can move this to the documentated location from apiVersion 2
-
162 // onwards.
-
163 if (context.apiVersion == 1)
-
164 {
-
165 result[jss::account_data][jss::signer_lists] =
-
166 std::move(jvSignerList);
-
167 }
-
168 else
-
169 {
-
170 result[jss::signer_lists] = std::move(jvSignerList);
-
171 }
-
172 }
-
173 // Return queue info if that is requested
-
174 if (queue)
-
175 {
-
176 Json::Value jvQueueData = Json::objectValue;
-
177
-
178 auto const txs = context.app.getTxQ().getAccountTxs(accountID);
-
179 if (!txs.empty())
-
180 {
-
181 jvQueueData[jss::txn_count] =
-
182 static_cast<Json::UInt>(txs.size());
-
183
-
184 auto& jvQueueTx = jvQueueData[jss::transactions];
-
185 jvQueueTx = Json::arrayValue;
-
186
-
187 std::uint32_t seqCount = 0;
-
188 std::uint32_t ticketCount = 0;
-
189 std::optional<std::uint32_t> lowestSeq;
-
190 std::optional<std::uint32_t> highestSeq;
-
191 std::optional<std::uint32_t> lowestTicket;
-
192 std::optional<std::uint32_t> highestTicket;
-
193 bool anyAuthChanged = false;
-
194 XRPAmount totalSpend(0);
-
195
-
196 // We expect txs to be returned sorted by SeqProxy. Verify
-
197 // that with a couple of asserts.
-
198 SeqProxy prevSeqProxy = SeqProxy::sequence(0);
-
199 for (auto const& tx : txs)
-
200 {
-
201 Json::Value jvTx = Json::objectValue;
-
202
-
203 if (tx.seqProxy.isSeq())
-
204 {
-
205 XRPL_ASSERT(
-
206 prevSeqProxy < tx.seqProxy,
-
207 "rpple::doAccountInfo : first sorted proxy");
-
208 prevSeqProxy = tx.seqProxy;
-
209 jvTx[jss::seq] = tx.seqProxy.value();
-
210 ++seqCount;
-
211 if (!lowestSeq)
-
212 lowestSeq = tx.seqProxy.value();
-
213 highestSeq = tx.seqProxy.value();
-
214 }
-
215 else
-
216 {
-
217 XRPL_ASSERT(
-
218 prevSeqProxy < tx.seqProxy,
-
219 "rpple::doAccountInfo : second sorted proxy");
-
220 prevSeqProxy = tx.seqProxy;
-
221 jvTx[jss::ticket] = tx.seqProxy.value();
-
222 ++ticketCount;
-
223 if (!lowestTicket)
-
224 lowestTicket = tx.seqProxy.value();
-
225 highestTicket = tx.seqProxy.value();
-
226 }
-
227
-
228 jvTx[jss::fee_level] = to_string(tx.feeLevel);
-
229 if (tx.lastValid)
-
230 jvTx[jss::LastLedgerSequence] = *tx.lastValid;
-
231
-
232 jvTx[jss::fee] = to_string(tx.consequences.fee());
-
233 auto const spend = tx.consequences.potentialSpend() +
-
234 tx.consequences.fee();
-
235 jvTx[jss::max_spend_drops] = to_string(spend);
-
236 totalSpend += spend;
-
237 bool const authChanged = tx.consequences.isBlocker();
-
238 if (authChanged)
-
239 anyAuthChanged = authChanged;
-
240 jvTx[jss::auth_change] = authChanged;
-
241
-
242 jvQueueTx.append(std::move(jvTx));
-
243 }
-
244
-
245 if (seqCount)
-
246 jvQueueData[jss::sequence_count] = seqCount;
-
247 if (ticketCount)
-
248 jvQueueData[jss::ticket_count] = ticketCount;
-
249 if (lowestSeq)
-
250 jvQueueData[jss::lowest_sequence] = *lowestSeq;
-
251 if (highestSeq)
-
252 jvQueueData[jss::highest_sequence] = *highestSeq;
-
253 if (lowestTicket)
-
254 jvQueueData[jss::lowest_ticket] = *lowestTicket;
-
255 if (highestTicket)
-
256 jvQueueData[jss::highest_ticket] = *highestTicket;
-
257
-
258 jvQueueData[jss::auth_change_queued] = anyAuthChanged;
-
259 jvQueueData[jss::max_spend_drops_total] = to_string(totalSpend);
-
260 }
-
261 else
-
262 jvQueueData[jss::txn_count] = 0u;
-
263
-
264 result[jss::queue_data] = std::move(jvQueueData);
-
265 }
-
266 }
-
267 else
-
268 {
-
269 result[jss::account] = toBase58(accountID);
-
270 RPC::inject_error(rpcACT_NOT_FOUND, result);
-
271 }
-
272
-
273 return result;
-
274}
+
6#include <xrpld/rpc/detail/RPCLedgerHelpers.h>
+
7
+
8#include <xrpl/json/json_value.h>
+
9#include <xrpl/ledger/ReadView.h>
+
10#include <xrpl/protocol/ErrorCodes.h>
+
11#include <xrpl/protocol/Indexes.h>
+
12#include <xrpl/protocol/UintTypes.h>
+
13#include <xrpl/protocol/jss.h>
+
14
+
15namespace ripple {
+
16
+
17// {
+
18// account: <ident>,
+
19// ledger_hash : <ledger>
+
20// ledger_index : <ledger_index>
+
21// signer_lists : <bool> // optional (default false)
+
22// // if true return SignerList(s).
+
23// queue : <bool> // optional (default false)
+
24// // if true return information about transactions
+
25// // in the current TxQ, only if the requested
+
26// // ledger is open. Otherwise if true, returns an
+
27// // error.
+
28// }
+
29
+
30// TODO(tom): what is that "default"?
+
31Json::Value
+
+
32doAccountInfo(RPC::JsonContext& context)
+
33{
+
34 auto& params = context.params;
+
35
+
36 std::string strIdent;
+
37 if (params.isMember(jss::account))
+
38 {
+
39 if (!params[jss::account].isString())
+
40 return RPC::invalid_field_error(jss::account);
+
41 strIdent = params[jss::account].asString();
+
42 }
+
43 else if (params.isMember(jss::ident))
+
44 {
+
45 if (!params[jss::ident].isString())
+
46 return RPC::invalid_field_error(jss::ident);
+
47 strIdent = params[jss::ident].asString();
+
48 }
+
49 else
+
50 return RPC::missing_field_error(jss::account);
+
51
+
52 std::shared_ptr<ReadView const> ledger;
+
53 auto result = RPC::lookupLedger(ledger, context);
+
54
+
55 if (!ledger)
+
56 return result;
+
57
+
58 // Get info on account.
+
59 auto id = parseBase58<AccountID>(strIdent);
+
60 if (!id)
+
61 {
+
62 RPC::inject_error(rpcACT_MALFORMED, result);
+
63 return result;
+
64 }
+
65 auto const accountID{std::move(id.value())};
+
66
+
67 static constexpr std::
+
68 array<std::pair<std::string_view, LedgerSpecificFlags>, 9>
+
69 lsFlags{
+
70 {{"defaultRipple", lsfDefaultRipple},
+
71 {"depositAuth", lsfDepositAuth},
+
72 {"disableMasterKey", lsfDisableMaster},
+
73 {"disallowIncomingXRP", lsfDisallowXRP},
+
74 {"globalFreeze", lsfGlobalFreeze},
+
75 {"noFreeze", lsfNoFreeze},
+
76 {"passwordSpent", lsfPasswordSpent},
+
77 {"requireAuthorization", lsfRequireAuth},
+
78 {"requireDestinationTag", lsfRequireDestTag}}};
+
79
+
80 static constexpr std::
+
81 array<std::pair<std::string_view, LedgerSpecificFlags>, 4>
+
82 disallowIncomingFlags{
+
83 {{"disallowIncomingNFTokenOffer",
+
84 lsfDisallowIncomingNFTokenOffer},
+
85 {"disallowIncomingCheck", lsfDisallowIncomingCheck},
+
86 {"disallowIncomingPayChan", lsfDisallowIncomingPayChan},
+
87 {"disallowIncomingTrustline", lsfDisallowIncomingTrustline}}};
+
88
+
89 static constexpr std::pair<std::string_view, LedgerSpecificFlags>
+
90 allowTrustLineClawbackFlag{
+
91 "allowTrustLineClawback", lsfAllowTrustLineClawback};
+
92
+
93 static constexpr std::pair<std::string_view, LedgerSpecificFlags>
+
94 allowTrustLineLockingFlag{
+
95 "allowTrustLineLocking", lsfAllowTrustLineLocking};
+
96
+
97 auto const sleAccepted = ledger->read(keylet::account(accountID));
+
98 if (sleAccepted)
+
99 {
+
100 auto const queue =
+
101 params.isMember(jss::queue) && params[jss::queue].asBool();
+
102
+
103 if (queue && !ledger->open())
+
104 {
+
105 // It doesn't make sense to request the queue
+
106 // with any closed or validated ledger.
+
107 RPC::inject_error(rpcINVALID_PARAMS, result);
+
108 return result;
+
109 }
+
110
+
111 Json::Value jvAccepted(Json::objectValue);
+
112 RPC::injectSLE(jvAccepted, *sleAccepted);
+
113 result[jss::account_data] = jvAccepted;
+
114
+
115 Json::Value acctFlags{Json::objectValue};
+
116 for (auto const& lsf : lsFlags)
+
117 acctFlags[lsf.first.data()] = sleAccepted->isFlag(lsf.second);
+
118
+
119 if (ledger->rules().enabled(featureDisallowIncoming))
+
120 {
+
121 for (auto const& lsf : disallowIncomingFlags)
+
122 acctFlags[lsf.first.data()] = sleAccepted->isFlag(lsf.second);
+
123 }
+
124
+
125 if (ledger->rules().enabled(featureClawback))
+
126 acctFlags[allowTrustLineClawbackFlag.first.data()] =
+
127 sleAccepted->isFlag(allowTrustLineClawbackFlag.second);
+
128
+
129 if (ledger->rules().enabled(featureTokenEscrow))
+
130 acctFlags[allowTrustLineLockingFlag.first.data()] =
+
131 sleAccepted->isFlag(allowTrustLineLockingFlag.second);
+
132
+
133 result[jss::account_flags] = std::move(acctFlags);
+
134
+
135 // The document[https://xrpl.org/account_info.html#account_info] states
+
136 // that signer_lists is a bool, however assigning any string value
+
137 // works. Do not allow this. This check is for api Version 2 onwards
+
138 // only
+
139 if (context.apiVersion > 1u && params.isMember(jss::signer_lists) &&
+
140 !params[jss::signer_lists].isBool())
+
141 {
+
142 RPC::inject_error(rpcINVALID_PARAMS, result);
+
143 return result;
+
144 }
+
145
+
146 // Return SignerList(s) if that is requested.
+
147 if (params.isMember(jss::signer_lists) &&
+
148 params[jss::signer_lists].asBool())
+
149 {
+
150 // We put the SignerList in an array because of an anticipated
+
151 // future when we support multiple signer lists on one account.
+
152 Json::Value jvSignerList = Json::arrayValue;
+
153
+
154 // This code will need to be revisited if in the future we support
+
155 // multiple SignerLists on one account.
+
156 auto const sleSigners = ledger->read(keylet::signers(accountID));
+
157 if (sleSigners)
+
158 jvSignerList.append(sleSigners->getJson(JsonOptions::none));
+
159
+
160 // Documentation states this is returned as part of the account_info
+
161 // response, but previously the code put it under account_data. We
+
162 // can move this to the documentated location from apiVersion 2
+
163 // onwards.
+
164 if (context.apiVersion == 1)
+
165 {
+
166 result[jss::account_data][jss::signer_lists] =
+
167 std::move(jvSignerList);
+
168 }
+
169 else
+
170 {
+
171 result[jss::signer_lists] = std::move(jvSignerList);
+
172 }
+
173 }
+
174 // Return queue info if that is requested
+
175 if (queue)
+
176 {
+
177 Json::Value jvQueueData = Json::objectValue;
+
178
+
179 auto const txs = context.app.getTxQ().getAccountTxs(accountID);
+
180 if (!txs.empty())
+
181 {
+
182 jvQueueData[jss::txn_count] =
+
183 static_cast<Json::UInt>(txs.size());
+
184
+
185 auto& jvQueueTx = jvQueueData[jss::transactions];
+
186 jvQueueTx = Json::arrayValue;
+
187
+
188 std::uint32_t seqCount = 0;
+
189 std::uint32_t ticketCount = 0;
+
190 std::optional<std::uint32_t> lowestSeq;
+
191 std::optional<std::uint32_t> highestSeq;
+
192 std::optional<std::uint32_t> lowestTicket;
+
193 std::optional<std::uint32_t> highestTicket;
+
194 bool anyAuthChanged = false;
+
195 XRPAmount totalSpend(0);
+
196
+
197 // We expect txs to be returned sorted by SeqProxy. Verify
+
198 // that with a couple of asserts.
+
199 SeqProxy prevSeqProxy = SeqProxy::sequence(0);
+
200 for (auto const& tx : txs)
+
201 {
+
202 Json::Value jvTx = Json::objectValue;
+
203
+
204 if (tx.seqProxy.isSeq())
+
205 {
+
206 XRPL_ASSERT(
+
207 prevSeqProxy < tx.seqProxy,
+
208 "rpple::doAccountInfo : first sorted proxy");
+
209 prevSeqProxy = tx.seqProxy;
+
210 jvTx[jss::seq] = tx.seqProxy.value();
+
211 ++seqCount;
+
212 if (!lowestSeq)
+
213 lowestSeq = tx.seqProxy.value();
+
214 highestSeq = tx.seqProxy.value();
+
215 }
+
216 else
+
217 {
+
218 XRPL_ASSERT(
+
219 prevSeqProxy < tx.seqProxy,
+
220 "rpple::doAccountInfo : second sorted proxy");
+
221 prevSeqProxy = tx.seqProxy;
+
222 jvTx[jss::ticket] = tx.seqProxy.value();
+
223 ++ticketCount;
+
224 if (!lowestTicket)
+
225 lowestTicket = tx.seqProxy.value();
+
226 highestTicket = tx.seqProxy.value();
+
227 }
+
228
+
229 jvTx[jss::fee_level] = to_string(tx.feeLevel);
+
230 if (tx.lastValid)
+
231 jvTx[jss::LastLedgerSequence] = *tx.lastValid;
+
232
+
233 jvTx[jss::fee] = to_string(tx.consequences.fee());
+
234 auto const spend = tx.consequences.potentialSpend() +
+
235 tx.consequences.fee();
+
236 jvTx[jss::max_spend_drops] = to_string(spend);
+
237 totalSpend += spend;
+
238 bool const authChanged = tx.consequences.isBlocker();
+
239 if (authChanged)
+
240 anyAuthChanged = authChanged;
+
241 jvTx[jss::auth_change] = authChanged;
+
242
+
243 jvQueueTx.append(std::move(jvTx));
+
244 }
+
245
+
246 if (seqCount)
+
247 jvQueueData[jss::sequence_count] = seqCount;
+
248 if (ticketCount)
+
249 jvQueueData[jss::ticket_count] = ticketCount;
+
250 if (lowestSeq)
+
251 jvQueueData[jss::lowest_sequence] = *lowestSeq;
+
252 if (highestSeq)
+
253 jvQueueData[jss::highest_sequence] = *highestSeq;
+
254 if (lowestTicket)
+
255 jvQueueData[jss::lowest_ticket] = *lowestTicket;
+
256 if (highestTicket)
+
257 jvQueueData[jss::highest_ticket] = *highestTicket;
+
258
+
259 jvQueueData[jss::auth_change_queued] = anyAuthChanged;
+
260 jvQueueData[jss::max_spend_drops_total] = to_string(totalSpend);
+
261 }
+
262 else
+
263 jvQueueData[jss::txn_count] = 0u;
+
264
+
265 result[jss::queue_data] = std::move(jvQueueData);
+
266 }
+
267 }
+
268 else
+
269 {
+
270 result[jss::account] = toBase58(accountID);
+
271 RPC::inject_error(rpcACT_NOT_FOUND, result);
+
272 }
+
273
+
274 return result;
+
275}
-
275
-
276} // namespace ripple
+
276
+
277} // namespace ripple
Json::Value
Represents a JSON value.
Definition json_value.h:131
Json::Value::append
Value & append(Value const &value)
Append value to array at the end.
Definition json_value.cpp:978
@@ -373,9 +374,9 @@ $(document).ready(function() { init_codefold(0); });
Json::objectValue
@ objectValue
object value (collection of name/value pairs).
Definition json_value.h:27
Json::UInt
unsigned int UInt
Definition json_forwards.h:8
ripple::RPC::invalid_field_error
Json::Value invalid_field_error(std::string const &name)
Definition ErrorCodes.h:306
-
ripple::RPC::injectSLE
void injectSLE(Json::Value &jv, SLE const &sle)
Inject JSON describing ledger entry.
Definition RPCHelpers.cpp:657
+
ripple::RPC::injectSLE
void injectSLE(Json::Value &jv, SLE const &sle)
Inject JSON describing ledger entry.
Definition RPCHelpers.cpp:150
ripple::RPC::inject_error
void inject_error(error_code_i code, JsonValue &json)
Add or update the json update to reflect the error code.
Definition ErrorCodes.h:214
-
ripple::RPC::lookupLedger
Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
Definition RPCHelpers.cpp:606
+
ripple::RPC::lookupLedger
Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
Definition RPCLedgerHelpers.cpp:305
ripple::RPC::missing_field_error
Json::Value missing_field_error(std::string const &name)
Definition ErrorCodes.h:264
ripple::keylet::account
Keylet account(AccountID const &id) noexcept
AccountID root.
Definition Indexes.cpp:165
ripple::keylet::signers
Keylet signers(AccountID const &account) noexcept
A SignerList.
Definition Indexes.cpp:311
@@ -400,7 +401,7 @@ $(document).ready(function() { init_codefold(0); });
ripple::lsfGlobalFreeze
@ lsfGlobalFreeze
Definition LedgerFormats.h:114
ripple::to_string
std::string to_string(base_uint< Bits, Tag > const &a)
Definition base_uint.h:611
-
ripple::doAccountInfo
Json::Value doAccountInfo(RPC::JsonContext &context)
Definition AccountInfo.cpp:31
+
ripple::doAccountInfo
Json::Value doAccountInfo(RPC::JsonContext &context)
Definition AccountInfo.cpp:32
diff --git a/AccountLines_8cpp_source.html b/AccountLines_8cpp_source.html index 6844dc605b..f644785272 100644 --- a/AccountLines_8cpp_source.html +++ b/AccountLines_8cpp_source.html @@ -84,249 +84,250 @@ $(document).ready(function() { init_codefold(0); });
1#include <xrpld/app/paths/TrustLine.h>
2#include <xrpld/rpc/Context.h>
3#include <xrpld/rpc/detail/RPCHelpers.h>
-
4#include <xrpld/rpc/detail/Tuning.h>
-
5
-
6#include <xrpl/ledger/ReadView.h>
-
7#include <xrpl/protocol/ErrorCodes.h>
-
8#include <xrpl/protocol/RPCErr.h>
-
9#include <xrpl/protocol/jss.h>
-
10#include <xrpl/resource/Fees.h>
-
11
-
12namespace ripple {
-
13
-
14void
-
-
15addLine(Json::Value& jsonLines, RPCTrustLine const& line)
-
16{
-
17 STAmount const& saBalance(line.getBalance());
-
18 STAmount const& saLimit(line.getLimit());
-
19 STAmount const& saLimitPeer(line.getLimitPeer());
-
20 Json::Value& jPeer(jsonLines.append(Json::objectValue));
-
21
-
22 jPeer[jss::account] = to_string(line.getAccountIDPeer());
-
23 // Amount reported is positive if current account holds other
-
24 // account's IOUs.
-
25 //
-
26 // Amount reported is negative if other account holds current
-
27 // account's IOUs.
-
28 jPeer[jss::balance] = saBalance.getText();
-
29 jPeer[jss::currency] = to_string(saBalance.issue().currency);
-
30 jPeer[jss::limit] = saLimit.getText();
-
31 jPeer[jss::limit_peer] = saLimitPeer.getText();
-
32 jPeer[jss::quality_in] = line.getQualityIn().value;
-
33 jPeer[jss::quality_out] = line.getQualityOut().value;
-
34 if (line.getAuth())
-
35 jPeer[jss::authorized] = true;
-
36 if (line.getAuthPeer())
-
37 jPeer[jss::peer_authorized] = true;
-
38 if (line.getNoRipple())
-
39 jPeer[jss::no_ripple] = true;
-
40 if (line.getNoRipplePeer())
-
41 jPeer[jss::no_ripple_peer] = true;
-
42 if (line.getFreeze())
-
43 jPeer[jss::freeze] = true;
-
44 if (line.getFreezePeer())
-
45 jPeer[jss::freeze_peer] = true;
-
46 if (line.getDeepFreeze())
-
47 jPeer[jss::deep_freeze] = true;
-
48 if (line.getDeepFreezePeer())
-
49 jPeer[jss::deep_freeze_peer] = true;
-
50}
+
4#include <xrpld/rpc/detail/RPCLedgerHelpers.h>
+
5#include <xrpld/rpc/detail/Tuning.h>
+
6
+
7#include <xrpl/ledger/ReadView.h>
+
8#include <xrpl/protocol/ErrorCodes.h>
+
9#include <xrpl/protocol/RPCErr.h>
+
10#include <xrpl/protocol/jss.h>
+
11#include <xrpl/resource/Fees.h>
+
12
+
13namespace ripple {
+
14
+
15void
+
+
16addLine(Json::Value& jsonLines, RPCTrustLine const& line)
+
17{
+
18 STAmount const& saBalance(line.getBalance());
+
19 STAmount const& saLimit(line.getLimit());
+
20 STAmount const& saLimitPeer(line.getLimitPeer());
+
21 Json::Value& jPeer(jsonLines.append(Json::objectValue));
+
22
+
23 jPeer[jss::account] = to_string(line.getAccountIDPeer());
+
24 // Amount reported is positive if current account holds other
+
25 // account's IOUs.
+
26 //
+
27 // Amount reported is negative if other account holds current
+
28 // account's IOUs.
+
29 jPeer[jss::balance] = saBalance.getText();
+
30 jPeer[jss::currency] = to_string(saBalance.issue().currency);
+
31 jPeer[jss::limit] = saLimit.getText();
+
32 jPeer[jss::limit_peer] = saLimitPeer.getText();
+
33 jPeer[jss::quality_in] = line.getQualityIn().value;
+
34 jPeer[jss::quality_out] = line.getQualityOut().value;
+
35 if (line.getAuth())
+
36 jPeer[jss::authorized] = true;
+
37 if (line.getAuthPeer())
+
38 jPeer[jss::peer_authorized] = true;
+
39 if (line.getNoRipple())
+
40 jPeer[jss::no_ripple] = true;
+
41 if (line.getNoRipplePeer())
+
42 jPeer[jss::no_ripple_peer] = true;
+
43 if (line.getFreeze())
+
44 jPeer[jss::freeze] = true;
+
45 if (line.getFreezePeer())
+
46 jPeer[jss::freeze_peer] = true;
+
47 if (line.getDeepFreeze())
+
48 jPeer[jss::deep_freeze] = true;
+
49 if (line.getDeepFreezePeer())
+
50 jPeer[jss::deep_freeze_peer] = true;
+
51}
-
51
-
52// {
-
53// account: <account>
-
54// ledger_hash : <ledger>
-
55// ledger_index : <ledger_index>
-
56// limit: integer // optional
-
57// marker: opaque // optional, resume previous query
-
58// ignore_default: bool // do not return lines in default state (on
-
59// this account's side)
-
60// }
-
61Json::Value
-
-
62doAccountLines(RPC::JsonContext& context)
-
63{
-
64 auto const& params(context.params);
-
65 if (!params.isMember(jss::account))
-
66 return RPC::missing_field_error(jss::account);
-
67
-
68 if (!params[jss::account].isString())
-
69 return RPC::invalid_field_error(jss::account);
-
70
-
71 std::shared_ptr<ReadView const> ledger;
-
72 auto result = RPC::lookupLedger(ledger, context);
-
73 if (!ledger)
-
74 return result;
-
75
-
76 auto id = parseBase58<AccountID>(params[jss::account].asString());
-
77 if (!id)
-
78 {
-
79 RPC::inject_error(rpcACT_MALFORMED, result);
-
80 return result;
-
81 }
-
82 auto const accountID{std::move(id.value())};
-
83
-
84 if (!ledger->exists(keylet::account(accountID)))
-
85 return rpcError(rpcACT_NOT_FOUND);
-
86
-
87 std::string strPeer;
-
88 if (params.isMember(jss::peer))
-
89 strPeer = params[jss::peer].asString();
-
90
-
91 auto const raPeerAccount = [&]() -> std::optional<AccountID> {
-
92 return strPeer.empty() ? std::nullopt : parseBase58<AccountID>(strPeer);
-
93 }();
-
94 if (!strPeer.empty() && !raPeerAccount)
-
95 {
-
96 RPC::inject_error(rpcACT_MALFORMED, result);
-
97 return result;
-
98 }
-
99
-
100 unsigned int limit;
-
101 if (auto err = readLimitField(limit, RPC::Tuning::accountLines, context))
-
102 return *err;
-
103
-
104 // this flag allows the requester to ask incoming trustlines in default
-
105 // state be omitted
-
106 bool ignoreDefault = params.isMember(jss::ignore_default) &&
-
107 params[jss::ignore_default].asBool();
-
108
-
109 Json::Value& jsonLines(result[jss::lines] = Json::arrayValue);
-
110 struct VisitData
-
111 {
-
112 std::vector<RPCTrustLine> items;
-
113 AccountID const& accountID;
-
114 std::optional<AccountID> const& raPeerAccount;
-
115 bool ignoreDefault;
-
116 uint32_t foundCount;
-
117 };
-
118 VisitData visitData = {{}, accountID, raPeerAccount, ignoreDefault, 0};
-
119 uint256 startAfter = beast::zero;
-
120 std::uint64_t startHint = 0;
-
121
-
122 if (params.isMember(jss::marker))
-
123 {
-
124 if (!params[jss::marker].isString())
-
125 return RPC::expected_field_error(jss::marker, "string");
-
126
-
127 // Marker is composed of a comma separated index and start hint. The
-
128 // former will be read as hex, and the latter using boost lexical cast.
-
129 std::stringstream marker(params[jss::marker].asString());
-
130 std::string value;
-
131 if (!std::getline(marker, value, ','))
-
132 return rpcError(rpcINVALID_PARAMS);
-
133
-
134 if (!startAfter.parseHex(value))
-
135 return rpcError(rpcINVALID_PARAMS);
-
136
-
137 if (!std::getline(marker, value, ','))
-
138 return rpcError(rpcINVALID_PARAMS);
-
139
-
140 try
-
141 {
-
142 startHint = boost::lexical_cast<std::uint64_t>(value);
-
143 }
-
144 catch (boost::bad_lexical_cast&)
-
145 {
-
146 return rpcError(rpcINVALID_PARAMS);
-
147 }
-
148
-
149 // We then must check if the object pointed to by the marker is actually
-
150 // owned by the account in the request.
-
151 auto const sle = ledger->read({ltANY, startAfter});
-
152
-
153 if (!sle)
-
154 return rpcError(rpcINVALID_PARAMS);
-
155
-
156 if (!RPC::isRelatedToAccount(*ledger, sle, accountID))
-
157 return rpcError(rpcINVALID_PARAMS);
-
158 }
-
159
-
160 auto count = 0;
-
161 std::optional<uint256> marker = {};
-
162 std::uint64_t nextHint = 0;
-
163 {
-
164 if (!forEachItemAfter(
-
165 *ledger,
-
166 accountID,
-
167 startAfter,
-
168 startHint,
-
169 limit + 1,
-
170 [&visitData, &count, &marker, &limit, &nextHint](
-
171 std::shared_ptr<SLE const> const& sleCur) {
-
172 if (!sleCur)
-
173 {
-
174 // LCOV_EXCL_START
-
175 UNREACHABLE("ripple::doAccountLines : null SLE");
-
176 return false;
-
177 // LCOV_EXCL_STOP
-
178 }
-
179
-
180 if (++count == limit)
-
181 {
-
182 marker = sleCur->key();
-
183 nextHint =
-
184 RPC::getStartHint(sleCur, visitData.accountID);
-
185 }
-
186
-
187 if (sleCur->getType() != ltRIPPLE_STATE)
-
188 return true;
-
189
-
190 bool ignore = false;
-
191 if (visitData.ignoreDefault)
-
192 {
-
193 if (sleCur->getFieldAmount(sfLowLimit).getIssuer() ==
-
194 visitData.accountID)
-
195 ignore =
-
196 !(sleCur->getFieldU32(sfFlags) & lsfLowReserve);
-
197 else
-
198 ignore = !(
-
199 sleCur->getFieldU32(sfFlags) & lsfHighReserve);
-
200 }
-
201
-
202 if (!ignore && count <= limit)
-
203 {
-
204 auto const line =
-
205 RPCTrustLine::makeItem(visitData.accountID, sleCur);
-
206
-
207 if (line &&
-
208 (!visitData.raPeerAccount ||
-
209 *visitData.raPeerAccount ==
-
210 line->getAccountIDPeer()))
-
211 {
-
212 visitData.items.emplace_back(*line);
-
213 }
-
214 }
-
215
-
216 return true;
-
217 }))
-
218 {
-
219 return rpcError(rpcINVALID_PARAMS);
-
220 }
-
221 }
-
222
-
223 // Both conditions need to be checked because marker is set on the limit-th
-
224 // item, but if there is no item on the limit + 1 iteration, then there is
-
225 // no need to return a marker.
-
226 if (count == limit + 1 && marker)
-
227 {
-
228 result[jss::limit] = limit;
-
229 result[jss::marker] =
-
230 to_string(*marker) + "," + std::to_string(nextHint);
-
231 }
-
232
-
233 result[jss::account] = toBase58(accountID);
-
234
-
235 for (auto const& item : visitData.items)
-
236 addLine(jsonLines, item);
-
237
-
238 context.loadType = Resource::feeMediumBurdenRPC;
-
239 return result;
-
240}
+
52
+
53// {
+
54// account: <account>
+
55// ledger_hash : <ledger>
+
56// ledger_index : <ledger_index>
+
57// limit: integer // optional
+
58// marker: opaque // optional, resume previous query
+
59// ignore_default: bool // do not return lines in default state (on
+
60// this account's side)
+
61// }
+
62Json::Value
+
+
63doAccountLines(RPC::JsonContext& context)
+
64{
+
65 auto const& params(context.params);
+
66 if (!params.isMember(jss::account))
+
67 return RPC::missing_field_error(jss::account);
+
68
+
69 if (!params[jss::account].isString())
+
70 return RPC::invalid_field_error(jss::account);
+
71
+
72 std::shared_ptr<ReadView const> ledger;
+
73 auto result = RPC::lookupLedger(ledger, context);
+
74 if (!ledger)
+
75 return result;
+
76
+
77 auto id = parseBase58<AccountID>(params[jss::account].asString());
+
78 if (!id)
+
79 {
+
80 RPC::inject_error(rpcACT_MALFORMED, result);
+
81 return result;
+
82 }
+
83 auto const accountID{std::move(id.value())};
+
84
+
85 if (!ledger->exists(keylet::account(accountID)))
+
86 return rpcError(rpcACT_NOT_FOUND);
+
87
+
88 std::string strPeer;
+
89 if (params.isMember(jss::peer))
+
90 strPeer = params[jss::peer].asString();
+
91
+
92 auto const raPeerAccount = [&]() -> std::optional<AccountID> {
+
93 return strPeer.empty() ? std::nullopt : parseBase58<AccountID>(strPeer);
+
94 }();
+
95 if (!strPeer.empty() && !raPeerAccount)
+
96 {
+
97 RPC::inject_error(rpcACT_MALFORMED, result);
+
98 return result;
+
99 }
+
100
+
101 unsigned int limit;
+
102 if (auto err = readLimitField(limit, RPC::Tuning::accountLines, context))
+
103 return *err;
+
104
+
105 // this flag allows the requester to ask incoming trustlines in default
+
106 // state be omitted
+
107 bool ignoreDefault = params.isMember(jss::ignore_default) &&
+
108 params[jss::ignore_default].asBool();
+
109
+
110 Json::Value& jsonLines(result[jss::lines] = Json::arrayValue);
+
111 struct VisitData
+
112 {
+
113 std::vector<RPCTrustLine> items;
+
114 AccountID const& accountID;
+
115 std::optional<AccountID> const& raPeerAccount;
+
116 bool ignoreDefault;
+
117 uint32_t foundCount;
+
118 };
+
119 VisitData visitData = {{}, accountID, raPeerAccount, ignoreDefault, 0};
+
120 uint256 startAfter = beast::zero;
+
121 std::uint64_t startHint = 0;
+
122
+
123 if (params.isMember(jss::marker))
+
124 {
+
125 if (!params[jss::marker].isString())
+
126 return RPC::expected_field_error(jss::marker, "string");
+
127
+
128 // Marker is composed of a comma separated index and start hint. The
+
129 // former will be read as hex, and the latter using boost lexical cast.
+
130 std::stringstream marker(params[jss::marker].asString());
+
131 std::string value;
+
132 if (!std::getline(marker, value, ','))
+
133 return rpcError(rpcINVALID_PARAMS);
+
134
+
135 if (!startAfter.parseHex(value))
+
136 return rpcError(rpcINVALID_PARAMS);
+
137
+
138 if (!std::getline(marker, value, ','))
+
139 return rpcError(rpcINVALID_PARAMS);
+
140
+
141 try
+
142 {
+
143 startHint = boost::lexical_cast<std::uint64_t>(value);
+
144 }
+
145 catch (boost::bad_lexical_cast&)
+
146 {
+
147 return rpcError(rpcINVALID_PARAMS);
+
148 }
+
149
+
150 // We then must check if the object pointed to by the marker is actually
+
151 // owned by the account in the request.
+
152 auto const sle = ledger->read({ltANY, startAfter});
+
153
+
154 if (!sle)
+
155 return rpcError(rpcINVALID_PARAMS);
+
156
+
157 if (!RPC::isRelatedToAccount(*ledger, sle, accountID))
+
158 return rpcError(rpcINVALID_PARAMS);
+
159 }
+
160
+
161 auto count = 0;
+
162 std::optional<uint256> marker = {};
+
163 std::uint64_t nextHint = 0;
+
164 {
+
165 if (!forEachItemAfter(
+
166 *ledger,
+
167 accountID,
+
168 startAfter,
+
169 startHint,
+
170 limit + 1,
+
171 [&visitData, &count, &marker, &limit, &nextHint](
+
172 std::shared_ptr<SLE const> const& sleCur) {
+
173 if (!sleCur)
+
174 {
+
175 // LCOV_EXCL_START
+
176 UNREACHABLE("ripple::doAccountLines : null SLE");
+
177 return false;
+
178 // LCOV_EXCL_STOP
+
179 }
+
180
+
181 if (++count == limit)
+
182 {
+
183 marker = sleCur->key();
+
184 nextHint =
+
185 RPC::getStartHint(sleCur, visitData.accountID);
+
186 }
+
187
+
188 if (sleCur->getType() != ltRIPPLE_STATE)
+
189 return true;
+
190
+
191 bool ignore = false;
+
192 if (visitData.ignoreDefault)
+
193 {
+
194 if (sleCur->getFieldAmount(sfLowLimit).getIssuer() ==
+
195 visitData.accountID)
+
196 ignore =
+
197 !(sleCur->getFieldU32(sfFlags) & lsfLowReserve);
+
198 else
+
199 ignore = !(
+
200 sleCur->getFieldU32(sfFlags) & lsfHighReserve);
+
201 }
+
202
+
203 if (!ignore && count <= limit)
+
204 {
+
205 auto const line =
+
206 RPCTrustLine::makeItem(visitData.accountID, sleCur);
+
207
+
208 if (line &&
+
209 (!visitData.raPeerAccount ||
+
210 *visitData.raPeerAccount ==
+
211 line->getAccountIDPeer()))
+
212 {
+
213 visitData.items.emplace_back(*line);
+
214 }
+
215 }
+
216
+
217 return true;
+
218 }))
+
219 {
+
220 return rpcError(rpcINVALID_PARAMS);
+
221 }
+
222 }
+
223
+
224 // Both conditions need to be checked because marker is set on the limit-th
+
225 // item, but if there is no item on the limit + 1 iteration, then there is
+
226 // no need to return a marker.
+
227 if (count == limit + 1 && marker)
+
228 {
+
229 result[jss::limit] = limit;
+
230 result[jss::marker] =
+
231 to_string(*marker) + "," + std::to_string(nextHint);
+
232 }
+
233
+
234 result[jss::account] = toBase58(accountID);
+
235
+
236 for (auto const& item : visitData.items)
+
237 addLine(jsonLines, item);
+
238
+
239 context.loadType = Resource::feeMediumBurdenRPC;
+
240 return result;
+
241}
-
241
-
242} // namespace ripple
+
242
+
243} // namespace ripple
Json::Value
Represents a JSON value.
Definition json_value.h:131
@@ -350,18 +351,18 @@ $(document).ready(function() { init_codefold(0); });
ripple::RPC::isRelatedToAccount
bool isRelatedToAccount(ReadView const &ledger, std::shared_ptr< SLE const > const &sle, AccountID const &accountID)
Tests if a SLE is owned by accountID.
Definition RPCHelpers.cpp:96
ripple::RPC::inject_error
void inject_error(error_code_i code, JsonValue &json)
Add or update the json update to reflect the error code.
Definition ErrorCodes.h:214
ripple::RPC::expected_field_error
Json::Value expected_field_error(std::string const &name, std::string const &type)
Definition ErrorCodes.h:330
-
ripple::RPC::lookupLedger
Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
Definition RPCHelpers.cpp:606
+
ripple::RPC::lookupLedger
Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
Definition RPCLedgerHelpers.cpp:305
ripple::RPC::getStartHint
std::uint64_t getStartHint(std::shared_ptr< SLE const > const &sle, AccountID const &accountID)
Gets the start hint for traversing account objects.
Definition RPCHelpers.cpp:79
ripple::RPC::missing_field_error
Json::Value missing_field_error(std::string const &name)
Definition ErrorCodes.h:264
ripple::Resource::feeMediumBurdenRPC
Charge const feeMediumBurdenRPC
ripple::keylet::account
Keylet account(AccountID const &id) noexcept
AccountID root.
Definition Indexes.cpp:165
ripple
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition algorithm.h:6
ripple::toBase58
std::string toBase58(AccountID const &v)
Convert AccountID to base58 checked string.
Definition AccountID.cpp:95
-
ripple::addLine
void addLine(Json::Value &jsonLines, RPCTrustLine const &line)
Definition AccountLines.cpp:15
+
ripple::addLine
void addLine(Json::Value &jsonLines, RPCTrustLine const &line)
Definition AccountLines.cpp:16
ripple::rpcACT_NOT_FOUND
@ rpcACT_NOT_FOUND
Definition ErrorCodes.h:51
ripple::rpcACT_MALFORMED
@ rpcACT_MALFORMED
Definition ErrorCodes.h:71
ripple::rpcINVALID_PARAMS
@ rpcINVALID_PARAMS
Definition ErrorCodes.h:65
-
ripple::doAccountLines
Json::Value doAccountLines(RPC::JsonContext &context)
Definition AccountLines.cpp:62
+
ripple::doAccountLines
Json::Value doAccountLines(RPC::JsonContext &context)
Definition AccountLines.cpp:63
ripple::rpcError
Json::Value rpcError(int iError)
Definition RPCErr.cpp:12
diff --git a/AccountObjects_8cpp_source.html b/AccountObjects_8cpp_source.html index 922114ea2d..59b17a38c9 100644 --- a/AccountObjects_8cpp_source.html +++ b/AccountObjects_8cpp_source.html @@ -84,304 +84,509 @@ $(document).ready(function() { init_codefold(0); });
1#include <xrpld/app/tx/detail/NFTokenUtils.h>
2#include <xrpld/rpc/Context.h>
3#include <xrpld/rpc/detail/RPCHelpers.h>
-
4#include <xrpld/rpc/detail/Tuning.h>
-
5
-
6#include <xrpl/ledger/ReadView.h>
-
7#include <xrpl/protocol/ErrorCodes.h>
-
8#include <xrpl/protocol/Indexes.h>
-
9#include <xrpl/protocol/LedgerFormats.h>
-
10#include <xrpl/protocol/RPCErr.h>
-
11#include <xrpl/protocol/jss.h>
-
12#include <xrpl/protocol/nftPageMask.h>
-
13#include <xrpl/resource/Fees.h>
-
14
-
15#include <string>
-
16
-
17namespace ripple {
-
18
-
30Json::Value
-
-
31doAccountNFTs(RPC::JsonContext& context)
-
32{
-
33 auto const& params = context.params;
-
34 if (!params.isMember(jss::account))
-
35 return RPC::missing_field_error(jss::account);
-
36
-
37 if (!params[jss::account].isString())
-
38 return RPC::invalid_field_error(jss::account);
-
39
-
40 auto id = parseBase58<AccountID>(params[jss::account].asString());
-
41 if (!id)
-
42 {
-
43 return rpcError(rpcACT_MALFORMED);
-
44 }
-
45
-
46 std::shared_ptr<ReadView const> ledger;
-
47 auto result = RPC::lookupLedger(ledger, context);
-
48 if (ledger == nullptr)
-
49 return result;
-
50 auto const accountID{id.value()};
-
51
-
52 if (!ledger->exists(keylet::account(accountID)))
-
53 return rpcError(rpcACT_NOT_FOUND);
-
54
-
55 unsigned int limit;
-
56 if (auto err = readLimitField(limit, RPC::Tuning::accountNFTokens, context))
-
57 return *err;
-
58
-
59 uint256 marker;
-
60 bool const markerSet = params.isMember(jss::marker);
-
61
-
62 if (markerSet)
-
63 {
-
64 auto const& m = params[jss::marker];
-
65 if (!m.isString())
-
66 return RPC::expected_field_error(jss::marker, "string");
-
67
-
68 if (!marker.parseHex(m.asString()))
-
69 return RPC::invalid_field_error(jss::marker);
-
70 }
-
71
-
72 auto const first = keylet::nftpage(keylet::nftpage_min(accountID), marker);
-
73 auto const last = keylet::nftpage_max(accountID);
-
74
-
75 auto cp = ledger->read(Keylet(
-
76 ltNFTOKEN_PAGE,
-
77 ledger->succ(first.key, last.key.next()).value_or(last.key)));
-
78
-
79 std::uint32_t cnt = 0;
-
80 auto& nfts = (result[jss::account_nfts] = Json::arrayValue);
-
81
-
82 // Continue iteration from the current page:
-
83 bool pastMarker = marker.isZero();
-
84 bool markerFound = false;
-
85 uint256 const maskedMarker = marker & nft::pageMask;
-
86 while (cp)
-
87 {
-
88 auto arr = cp->getFieldArray(sfNFTokens);
-
89
-
90 for (auto const& o : arr)
-
91 {
-
92 // Scrolling past the marker gets weird. We need to look at
-
93 // a couple of conditions.
-
94 //
-
95 // 1. If the low 96-bits don't match, then we compare only
-
96 // against the low 96-bits, since that's what determines
-
97 // the sort order of the pages.
-
98 //
-
99 // 2. However, within one page there can be a number of
-
100 // NFTokenIDs that all have the same low 96 bits. If we're
-
101 // in that case then we need to compare against the full
-
102 // 256 bits.
-
103 uint256 const nftokenID = o[sfNFTokenID];
-
104 uint256 const maskedNftokenID = nftokenID & nft::pageMask;
-
105
-
106 if (!pastMarker)
-
107 {
-
108 if (maskedNftokenID < maskedMarker)
-
109 continue;
-
110
-
111 if (maskedNftokenID == maskedMarker && nftokenID < marker)
-
112 continue;
-
113
-
114 if (nftokenID == marker)
-
115 {
-
116 markerFound = true;
-
117 continue;
-
118 }
-
119 }
-
120
-
121 if (markerSet && !markerFound)
-
122 return RPC::invalid_field_error(jss::marker);
-
123
-
124 pastMarker = true;
-
125
-
126 {
-
127 Json::Value& obj = nfts.append(o.getJson(JsonOptions::none));
-
128
-
129 // Pull out the components of the nft ID.
-
130 obj[sfFlags.jsonName] = nft::getFlags(nftokenID);
-
131 obj[sfIssuer.jsonName] = to_string(nft::getIssuer(nftokenID));
-
132 obj[sfNFTokenTaxon.jsonName] =
-
133 nft::toUInt32(nft::getTaxon(nftokenID));
-
134 obj[jss::nft_serial] = nft::getSerial(nftokenID);
-
135 if (std::uint16_t xferFee = {nft::getTransferFee(nftokenID)})
-
136 obj[sfTransferFee.jsonName] = xferFee;
-
137 }
-
138
-
139 if (++cnt == limit)
-
140 {
-
141 result[jss::limit] = limit;
-
142 result[jss::marker] = to_string(o.getFieldH256(sfNFTokenID));
-
143 return result;
-
144 }
-
145 }
-
146
-
147 if (auto npm = (*cp)[~sfNextPageMin])
-
148 cp = ledger->read(Keylet(ltNFTOKEN_PAGE, *npm));
-
149 else
-
150 cp = nullptr;
-
151 }
-
152
-
153 if (markerSet && !markerFound)
-
154 return RPC::invalid_field_error(jss::marker);
-
155
-
156 result[jss::account] = toBase58(accountID);
-
157 context.loadType = Resource::feeMediumBurdenRPC;
-
158 return result;
-
159}
+
4#include <xrpld/rpc/detail/RPCLedgerHelpers.h>
+
5#include <xrpld/rpc/detail/Tuning.h>
+
6
+
7#include <xrpl/ledger/ReadView.h>
+
8#include <xrpl/protocol/ErrorCodes.h>
+
9#include <xrpl/protocol/Indexes.h>
+
10#include <xrpl/protocol/LedgerFormats.h>
+
11#include <xrpl/protocol/RPCErr.h>
+
12#include <xrpl/protocol/jss.h>
+
13#include <xrpl/protocol/nftPageMask.h>
+
14#include <xrpl/resource/Fees.h>
+
15
+
16#include <string>
+
17
+
18namespace ripple {
+
19
+
31Json::Value
+
+
32doAccountNFTs(RPC::JsonContext& context)
+
33{
+
34 auto const& params = context.params;
+
35 if (!params.isMember(jss::account))
+
36 return RPC::missing_field_error(jss::account);
+
37
+
38 if (!params[jss::account].isString())
+
39 return RPC::invalid_field_error(jss::account);
+
40
+
41 auto id = parseBase58<AccountID>(params[jss::account].asString());
+
42 if (!id)
+
43 {
+
44 return rpcError(rpcACT_MALFORMED);
+
45 }
+
46
+
47 std::shared_ptr<ReadView const> ledger;
+
48 auto result = RPC::lookupLedger(ledger, context);
+
49 if (ledger == nullptr)
+
50 return result;
+
51 auto const accountID{id.value()};
+
52
+
53 if (!ledger->exists(keylet::account(accountID)))
+
54 return rpcError(rpcACT_NOT_FOUND);
+
55
+
56 unsigned int limit;
+
57 if (auto err = readLimitField(limit, RPC::Tuning::accountNFTokens, context))
+
58 return *err;
+
59
+
60 uint256 marker;
+
61 bool const markerSet = params.isMember(jss::marker);
+
62
+
63 if (markerSet)
+
64 {
+
65 auto const& m = params[jss::marker];
+
66 if (!m.isString())
+
67 return RPC::expected_field_error(jss::marker, "string");
+
68
+
69 if (!marker.parseHex(m.asString()))
+
70 return RPC::invalid_field_error(jss::marker);
+
71 }
+
72
+
73 auto const first = keylet::nftpage(keylet::nftpage_min(accountID), marker);
+
74 auto const last = keylet::nftpage_max(accountID);
+
75
+
76 auto cp = ledger->read(Keylet(
+
77 ltNFTOKEN_PAGE,
+
78 ledger->succ(first.key, last.key.next()).value_or(last.key)));
+
79
+
80 std::uint32_t cnt = 0;
+
81 auto& nfts = (result[jss::account_nfts] = Json::arrayValue);
+
82
+
83 // Continue iteration from the current page:
+
84 bool pastMarker = marker.isZero();
+
85 bool markerFound = false;
+
86 uint256 const maskedMarker = marker & nft::pageMask;
+
87 while (cp)
+
88 {
+
89 auto arr = cp->getFieldArray(sfNFTokens);
+
90
+
91 for (auto const& o : arr)
+
92 {
+
93 // Scrolling past the marker gets weird. We need to look at
+
94 // a couple of conditions.
+
95 //
+
96 // 1. If the low 96-bits don't match, then we compare only
+
97 // against the low 96-bits, since that's what determines
+
98 // the sort order of the pages.
+
99 //
+
100 // 2. However, within one page there can be a number of
+
101 // NFTokenIDs that all have the same low 96 bits. If we're
+
102 // in that case then we need to compare against the full
+
103 // 256 bits.
+
104 uint256 const nftokenID = o[sfNFTokenID];
+
105 uint256 const maskedNftokenID = nftokenID & nft::pageMask;
+
106
+
107 if (!pastMarker)
+
108 {
+
109 if (maskedNftokenID < maskedMarker)
+
110 continue;
+
111
+
112 if (maskedNftokenID == maskedMarker && nftokenID < marker)
+
113 continue;
+
114
+
115 if (nftokenID == marker)
+
116 {
+
117 markerFound = true;
+
118 continue;
+
119 }
+
120 }
+
121
+
122 if (markerSet && !markerFound)
+
123 return RPC::invalid_field_error(jss::marker);
+
124
+
125 pastMarker = true;
+
126
+
127 {
+
128 Json::Value& obj = nfts.append(o.getJson(JsonOptions::none));
+
129
+
130 // Pull out the components of the nft ID.
+
131 obj[sfFlags.jsonName] = nft::getFlags(nftokenID);
+
132 obj[sfIssuer.jsonName] = to_string(nft::getIssuer(nftokenID));
+
133 obj[sfNFTokenTaxon.jsonName] =
+
134 nft::toUInt32(nft::getTaxon(nftokenID));
+
135 obj[jss::nft_serial] = nft::getSerial(nftokenID);
+
136 if (std::uint16_t xferFee = {nft::getTransferFee(nftokenID)})
+
137 obj[sfTransferFee.jsonName] = xferFee;
+
138 }
+
139
+
140 if (++cnt == limit)
+
141 {
+
142 result[jss::limit] = limit;
+
143 result[jss::marker] = to_string(o.getFieldH256(sfNFTokenID));
+
144 return result;
+
145 }
+
146 }
+
147
+
148 if (auto npm = (*cp)[~sfNextPageMin])
+
149 cp = ledger->read(Keylet(ltNFTOKEN_PAGE, *npm));
+
150 else
+
151 cp = nullptr;
+
152 }
+
153
+
154 if (markerSet && !markerFound)
+
155 return RPC::invalid_field_error(jss::marker);
+
156
+
157 result[jss::account] = toBase58(accountID);
+
158 context.loadType = Resource::feeMediumBurdenRPC;
+
159 return result;
+
160}
-
160
-
161Json::Value
-
-
162doAccountObjects(RPC::JsonContext& context)
-
163{
-
164 auto const& params = context.params;
-
165 if (!params.isMember(jss::account))
-
166 return RPC::missing_field_error(jss::account);
-
167
-
168 if (!params[jss::account].isString())
-
169 return RPC::invalid_field_error(jss::account);
-
170
-
171 std::shared_ptr<ReadView const> ledger;
-
172 auto result = RPC::lookupLedger(ledger, context);
-
173 if (ledger == nullptr)
-
174 return result;
+
161
+
162bool
+
+
163getAccountObjects(
+
164 ReadView const& ledger,
+
165 AccountID const& account,
+
166 std::optional<std::vector<LedgerEntryType>> const& typeFilter,
+
167 uint256 dirIndex,
+
168 uint256 entryIndex,
+
169 std::uint32_t const limit,
+
170 Json::Value& jvResult)
+
171{
+
172 // check if dirIndex is valid
+
173 if (!dirIndex.isZero() && !ledger.read({ltDIR_NODE, dirIndex}))
+
174 return false;
175
-
176 auto const id = parseBase58<AccountID>(params[jss::account].asString());
-
177 if (!id)
-
178 {
-
179 RPC::inject_error(rpcACT_MALFORMED, result);
-
180 return result;
-
181 }
-
182 auto const accountID{id.value()};
-
183
-
184 if (!ledger->exists(keylet::account(accountID)))
-
185 return rpcError(rpcACT_NOT_FOUND);
-
186
-
187 std::optional<std::vector<LedgerEntryType>> typeFilter;
+
176 auto typeMatchesFilter = [](std::vector<LedgerEntryType> const& typeFilter,
+
177 LedgerEntryType ledgerType) {
+
178 auto it = std::find(typeFilter.begin(), typeFilter.end(), ledgerType);
+
179 return it != typeFilter.end();
+
180 };
+
181
+
182 // if dirIndex != 0, then all NFTs have already been returned. only
+
183 // iterate NFT pages if the filter says so AND dirIndex == 0
+
184 bool iterateNFTPages =
+
185 (!typeFilter.has_value() ||
+
186 typeMatchesFilter(typeFilter.value(), ltNFTOKEN_PAGE)) &&
+
187 dirIndex == beast::zero;
188
-
189 if (params.isMember(jss::deletion_blockers_only) &&
-
190 params[jss::deletion_blockers_only].asBool())
-
191 {
-
192 struct
-
193 {
-
194 Json::StaticString name;
-
195 LedgerEntryType type;
-
196 } static constexpr deletionBlockers[] = {
-
197 {jss::check, ltCHECK},
-
198 {jss::escrow, ltESCROW},
-
199 {jss::nft_page, ltNFTOKEN_PAGE},
-
200 {jss::payment_channel, ltPAYCHAN},
-
201 {jss::state, ltRIPPLE_STATE},
-
202 {jss::xchain_owned_claim_id, ltXCHAIN_OWNED_CLAIM_ID},
-
203 {jss::xchain_owned_create_account_claim_id,
-
204 ltXCHAIN_OWNED_CREATE_ACCOUNT_CLAIM_ID},
-
205 {jss::bridge, ltBRIDGE},
-
206 {jss::mpt_issuance, ltMPTOKEN_ISSUANCE},
-
207 {jss::mptoken, ltMPTOKEN},
-
208 {jss::permissioned_domain, ltPERMISSIONED_DOMAIN},
-
209 {jss::vault, ltVAULT},
-
210 };
-
211
-
212 typeFilter.emplace();
-
213 typeFilter->reserve(std::size(deletionBlockers));
-
214
-
215 for (auto [name, type] : deletionBlockers)
-
216 {
-
217 if (params.isMember(jss::type) && name != params[jss::type])
-
218 {
-
219 continue;
-
220 }
+
189 Keylet const firstNFTPage = keylet::nftpage_min(account);
+
190
+
191 // we need to check the marker to see if it is an NFTTokenPage index.
+
192 if (iterateNFTPages && entryIndex != beast::zero)
+
193 {
+
194 // if it is we will try to iterate the pages up to the limit
+
195 // and then change over to the owner directory
+
196
+
197 if (firstNFTPage.key != (entryIndex & ~nft::pageMask))
+
198 iterateNFTPages = false;
+
199 }
+
200
+
201 auto& jvObjects = (jvResult[jss::account_objects] = Json::arrayValue);
+
202
+
203 // this is a mutable version of limit, used to seamlessly switch
+
204 // to iterating directory entries when nftokenpages are exhausted
+
205 uint32_t mlimit = limit;
+
206
+
207 // iterate NFTokenPages preferentially
+
208 if (iterateNFTPages)
+
209 {
+
210 Keylet const first = entryIndex == beast::zero
+
211 ? firstNFTPage
+
212 : Keylet{ltNFTOKEN_PAGE, entryIndex};
+
213
+
214 Keylet const last = keylet::nftpage_max(account);
+
215
+
216 // current key
+
217 uint256 ck = ledger.succ(first.key, last.key.next()).value_or(last.key);
+
218
+
219 // current page
+
220 auto cp = ledger.read(Keylet{ltNFTOKEN_PAGE, ck});
221
-
222 typeFilter->push_back(type);
-
223 }
-
224 }
-
225 else
-
226 {
-
227 auto [rpcStatus, type] = RPC::chooseLedgerEntryType(params);
-
228
-
229 if (!RPC::isAccountObjectsValidType(type))
-
230 return RPC::invalid_field_error(jss::type);
-
231
-
232 if (rpcStatus)
-
233 {
-
234 result.clear();
-
235 rpcStatus.inject(result);
-
236 return result;
-
237 }
-
238 else if (type != ltANY)
-
239 {
-
240 typeFilter = std::vector<LedgerEntryType>({type});
-
241 }
-
242 }
+
222 while (cp)
+
223 {
+
224 jvObjects.append(cp->getJson(JsonOptions::none));
+
225 auto const npm = (*cp)[~sfNextPageMin];
+
226 if (npm)
+
227 cp = ledger.read(Keylet(ltNFTOKEN_PAGE, *npm));
+
228 else
+
229 cp = nullptr;
+
230
+
231 if (--mlimit == 0)
+
232 {
+
233 if (cp)
+
234 {
+
235 jvResult[jss::limit] = limit;
+
236 jvResult[jss::marker] = std::string("0,") + to_string(ck);
+
237 return true;
+
238 }
+
239 }
+
240
+
241 if (!npm)
+
242 break;
243
-
244 unsigned int limit;
-
245 if (auto err = readLimitField(limit, RPC::Tuning::accountObjects, context))
-
246 return *err;
-
247
-
248 uint256 dirIndex;
-
249 uint256 entryIndex;
-
250 if (params.isMember(jss::marker))
-
251 {
-
252 auto const& marker = params[jss::marker];
-
253 if (!marker.isString())
-
254 return RPC::expected_field_error(jss::marker, "string");
-
255
-
256 auto const& markerStr = marker.asString();
-
257 auto const& idx = markerStr.find(',');
-
258 if (idx == std::string::npos)
-
259 return RPC::invalid_field_error(jss::marker);
-
260
-
261 if (!dirIndex.parseHex(markerStr.substr(0, idx)))
-
262 return RPC::invalid_field_error(jss::marker);
-
263
-
264 if (!entryIndex.parseHex(markerStr.substr(idx + 1)))
-
265 return RPC::invalid_field_error(jss::marker);
-
266 }
-
267
-
268 if (!RPC::getAccountObjects(
-
269 *ledger,
-
270 accountID,
-
271 typeFilter,
-
272 dirIndex,
-
273 entryIndex,
-
274 limit,
-
275 result))
-
276 return RPC::invalid_field_error(jss::marker);
-
277
-
278 result[jss::account] = toBase58(accountID);
-
279 context.loadType = Resource::feeMediumBurdenRPC;
-
280 return result;
-
281}
+
244 ck = *npm;
+
245 }
+
246
+
247 // if execution reaches here then we're about to transition
+
248 // to iterating the root directory (and the conventional
+
249 // behaviour of this RPC function.) Therefore we should
+
250 // zero entryIndex so as not to terribly confuse things.
+
251 entryIndex = beast::zero;
+
252 }
+
253
+
254 auto const root = keylet::ownerDir(account);
+
255 auto found = false;
+
256
+
257 if (dirIndex.isZero())
+
258 {
+
259 dirIndex = root.key;
+
260 found = true;
+
261 }
+
262
+
263 auto dir = ledger.read({ltDIR_NODE, dirIndex});
+
264 if (!dir)
+
265 {
+
266 // it's possible the user had nftoken pages but no
+
267 // directory entries. If there's no nftoken page, we will
+
268 // give empty array for account_objects.
+
269 if (mlimit >= limit)
+
270 jvResult[jss::account_objects] = Json::arrayValue;
+
271
+
272 // non-zero dirIndex validity was checked in the beginning of this
+
273 // function; by this point, it should be zero. This function returns
+
274 // true regardless of nftoken page presence; if absent, account_objects
+
275 // is already set as an empty array. Notice we will only return false in
+
276 // this function when entryIndex can not be found, indicating an invalid
+
277 // marker error.
+
278 return true;
+
279 }
+
280
+
281 std::uint32_t i = 0;
+
282 for (;;)
+
283 {
+
284 auto const& entries = dir->getFieldV256(sfIndexes);
+
285 auto iter = entries.begin();
+
286
+
287 if (!found)
+
288 {
+
289 iter = std::find(iter, entries.end(), entryIndex);
+
290 if (iter == entries.end())
+
291 return false;
+
292
+
293 found = true;
+
294 }
+
295
+
296 // it's possible that the returned NFTPages exactly filled the
+
297 // response. Check for that condition.
+
298 if (i == mlimit && mlimit < limit)
+
299 {
+
300 jvResult[jss::limit] = limit;
+
301 jvResult[jss::marker] =
+
302 to_string(dirIndex) + ',' + to_string(*iter);
+
303 return true;
+
304 }
+
305
+
306 for (; iter != entries.end(); ++iter)
+
307 {
+
308 auto const sleNode = ledger.read(keylet::child(*iter));
+
309
+
310 if (!typeFilter.has_value() ||
+
311 typeMatchesFilter(typeFilter.value(), sleNode->getType()))
+
312 {
+
313 jvObjects.append(sleNode->getJson(JsonOptions::none));
+
314 }
+
315
+
316 if (++i == mlimit)
+
317 {
+
318 if (++iter != entries.end())
+
319 {
+
320 jvResult[jss::limit] = limit;
+
321 jvResult[jss::marker] =
+
322 to_string(dirIndex) + ',' + to_string(*iter);
+
323 return true;
+
324 }
+
325
+
326 break;
+
327 }
+
328 }
+
329
+
330 auto const nodeIndex = dir->getFieldU64(sfIndexNext);
+
331 if (nodeIndex == 0)
+
332 return true;
+
333
+
334 dirIndex = keylet::page(root, nodeIndex).key;
+
335 dir = ledger.read({ltDIR_NODE, dirIndex});
+
336 if (!dir)
+
337 return true;
+
338
+
339 if (i == mlimit)
+
340 {
+
341 auto const& e = dir->getFieldV256(sfIndexes);
+
342 if (!e.empty())
+
343 {
+
344 jvResult[jss::limit] = limit;
+
345 jvResult[jss::marker] =
+
346 to_string(dirIndex) + ',' + to_string(*e.begin());
+
347 }
+
348
+
349 return true;
+
350 }
+
351 }
+
352}
-
282
-
283} // namespace ripple
+
353
+
354Json::Value
+
+
355doAccountObjects(RPC::JsonContext& context)
+
356{
+
357 auto const& params = context.params;
+
358 if (!params.isMember(jss::account))
+
359 return RPC::missing_field_error(jss::account);
+
360
+
361 if (!params[jss::account].isString())
+
362 return RPC::invalid_field_error(jss::account);
+
363
+
364 std::shared_ptr<ReadView const> ledger;
+
365 auto result = RPC::lookupLedger(ledger, context);
+
366 if (ledger == nullptr)
+
367 return result;
+
368
+
369 auto const id = parseBase58<AccountID>(params[jss::account].asString());
+
370 if (!id)
+
371 {
+
372 RPC::inject_error(rpcACT_MALFORMED, result);
+
373 return result;
+
374 }
+
375 auto const accountID{id.value()};
+
376
+
377 if (!ledger->exists(keylet::account(accountID)))
+
378 return rpcError(rpcACT_NOT_FOUND);
+
379
+
380 std::optional<std::vector<LedgerEntryType>> typeFilter;
+
381
+
382 if (params.isMember(jss::deletion_blockers_only) &&
+
383 params[jss::deletion_blockers_only].asBool())
+
384 {
+
385 struct
+
386 {
+
387 Json::StaticString name;
+
388 LedgerEntryType type;
+
389 } static constexpr deletionBlockers[] = {
+
390 {jss::check, ltCHECK},
+
391 {jss::escrow, ltESCROW},
+
392 {jss::nft_page, ltNFTOKEN_PAGE},
+
393 {jss::payment_channel, ltPAYCHAN},
+
394 {jss::state, ltRIPPLE_STATE},
+
395 {jss::xchain_owned_claim_id, ltXCHAIN_OWNED_CLAIM_ID},
+
396 {jss::xchain_owned_create_account_claim_id,
+
397 ltXCHAIN_OWNED_CREATE_ACCOUNT_CLAIM_ID},
+
398 {jss::bridge, ltBRIDGE},
+
399 {jss::mpt_issuance, ltMPTOKEN_ISSUANCE},
+
400 {jss::mptoken, ltMPTOKEN},
+
401 {jss::permissioned_domain, ltPERMISSIONED_DOMAIN},
+
402 {jss::vault, ltVAULT},
+
403 };
+
404
+
405 typeFilter.emplace();
+
406 typeFilter->reserve(std::size(deletionBlockers));
+
407
+
408 for (auto [name, type] : deletionBlockers)
+
409 {
+
410 if (params.isMember(jss::type) && name != params[jss::type])
+
411 {
+
412 continue;
+
413 }
+
414
+
415 typeFilter->push_back(type);
+
416 }
+
417 }
+
418 else
+
419 {
+
420 auto [rpcStatus, type] = RPC::chooseLedgerEntryType(params);
+
421
+
422 if (!RPC::isAccountObjectsValidType(type))
+
423 return RPC::invalid_field_error(jss::type);
+
424
+
425 if (rpcStatus)
+
426 {
+
427 result.clear();
+
428 rpcStatus.inject(result);
+
429 return result;
+
430 }
+
431 else if (type != ltANY)
+
432 {
+
433 typeFilter = std::vector<LedgerEntryType>({type});
+
434 }
+
435 }
+
436
+
437 unsigned int limit;
+
438 if (auto err = readLimitField(limit, RPC::Tuning::accountObjects, context))
+
439 return *err;
+
440
+
441 uint256 dirIndex;
+
442 uint256 entryIndex;
+
443 if (params.isMember(jss::marker))
+
444 {
+
445 auto const& marker = params[jss::marker];
+
446 if (!marker.isString())
+
447 return RPC::expected_field_error(jss::marker, "string");
+
448
+
449 auto const& markerStr = marker.asString();
+
450 auto const& idx = markerStr.find(',');
+
451 if (idx == std::string::npos)
+
452 return RPC::invalid_field_error(jss::marker);
+
453
+
454 if (!dirIndex.parseHex(markerStr.substr(0, idx)))
+
455 return RPC::invalid_field_error(jss::marker);
+
456
+
457 if (!entryIndex.parseHex(markerStr.substr(idx + 1)))
+
458 return RPC::invalid_field_error(jss::marker);
+
459 }
+
460
+
461 if (!getAccountObjects(
+
462 *ledger,
+
463 accountID,
+
464 typeFilter,
+
465 dirIndex,
+
466 entryIndex,
+
467 limit,
+
468 result))
+
469 return RPC::invalid_field_error(jss::marker);
+
470
+
471 result[jss::account] = toBase58(accountID);
+
472 context.loadType = Resource::feeMediumBurdenRPC;
+
473 return result;
+
474}
+
+
475
+
476} // namespace ripple
+ +
std::vector::begin
T begin(T... args)
Json::StaticString
Lightweight wrapper to tag static string.
Definition json_value.h:45
Json::Value
Represents a JSON value.
Definition json_value.h:131
Json::Value::append
Value & append(Value const &value)
Append value to array at the end.
Definition json_value.cpp:978
+
ripple::ReadView
A view into a ledger.
Definition ReadView.h:32
+
ripple::ReadView::read
virtual std::shared_ptr< SLE const > read(Keylet const &k) const =0
Return the state item associated with a key.
+
ripple::ReadView::succ
virtual std::optional< key_type > succ(key_type const &key, std::optional< key_type > const &last=std::nullopt) const =0
Return the key of the next state item.
ripple::base_uint< 256 >
+
ripple::base_uint::next
base_uint next() const
Definition base_uint.h:436
ripple::base_uint::parseHex
constexpr bool parseHex(std::string_view sv)
Parse a hex string into a base_uint.
Definition base_uint.h:484
ripple::base_uint::isZero
bool isZero() const
Definition base_uint.h:521
std::optional::emplace
T emplace(T... args)
+
std::vector::end
T end(T... args)
+
std::find
T find(T... args)
std::is_same_v
T is_same_v
Json::arrayValue
@ arrayValue
array value (ordered list)
Definition json_value.h:26
ripple::RPC::Tuning::accountNFTokens
static LimitRange constexpr accountNFTokens
Limits for the account_nftokens command, in pages.
Definition src/xrpld/rpc/detail/Tuning.h:39
ripple::RPC::Tuning::accountObjects
static LimitRange constexpr accountObjects
Limits for the account_objects command.
Definition src/xrpld/rpc/detail/Tuning.h:24
ripple::RPC::invalid_field_error
Json::Value invalid_field_error(std::string const &name)
Definition ErrorCodes.h:306
-
ripple::RPC::isAccountObjectsValidType
bool isAccountObjectsValidType(LedgerEntryType const &type)
Check if the type is a valid filtering type for account_objects method.
Definition RPCHelpers.cpp:976
+
ripple::RPC::isAccountObjectsValidType
bool isAccountObjectsValidType(LedgerEntryType const &type)
Check if the type is a valid filtering type for account_objects method.
Definition RPCHelpers.cpp:469
ripple::RPC::inject_error
void inject_error(error_code_i code, JsonValue &json)
Add or update the json update to reflect the error code.
Definition ErrorCodes.h:214
-
ripple::RPC::chooseLedgerEntryType
std::pair< RPC::Status, LedgerEntryType > chooseLedgerEntryType(Json::Value const &params)
Definition RPCHelpers.cpp:921
-
ripple::RPC::getAccountObjects
bool getAccountObjects(ReadView const &ledger, AccountID const &account, std::optional< std::vector< LedgerEntryType > > const &typeFilter, uint256 dirIndex, uint256 entryIndex, std::uint32_t const limit, Json::Value &jvResult)
Gathers all objects for an account in a ledger.
Definition RPCHelpers.cpp:134
+
ripple::RPC::chooseLedgerEntryType
std::pair< RPC::Status, LedgerEntryType > chooseLedgerEntryType(Json::Value const &params)
Definition RPCHelpers.cpp:414
ripple::RPC::expected_field_error
Json::Value expected_field_error(std::string const &name, std::string const &type)
Definition ErrorCodes.h:330
-
ripple::RPC::lookupLedger
Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
Definition RPCHelpers.cpp:606
+
ripple::RPC::lookupLedger
Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
Definition RPCLedgerHelpers.cpp:305
ripple::RPC::missing_field_error
Json::Value missing_field_error(std::string const &name)
Definition ErrorCodes.h:264
ripple::Resource::feeMediumBurdenRPC
Charge const feeMediumBurdenRPC
+
ripple::keylet::child
Keylet child(uint256 const &key) noexcept
Any item that can be in an owner dir.
Definition Indexes.cpp:171
ripple::keylet::nftpage
Keylet nftpage(Keylet const &k, uint256 const &token)
Definition Indexes.cpp:400
ripple::keylet::account
Keylet account(AccountID const &id) noexcept
AccountID root.
Definition Indexes.cpp:165
+
ripple::keylet::page
Keylet page(uint256 const &root, std::uint64_t index=0) noexcept
A page in a directory.
Definition Indexes.cpp:361
ripple::keylet::nftpage_min
Keylet nftpage_min(AccountID const &owner)
NFT page keylets.
Definition Indexes.cpp:384
ripple::keylet::nftpage_max
Keylet nftpage_max(AccountID const &owner)
A keylet for the owner's last possible NFT page.
Definition Indexes.cpp:392
+
ripple::keylet::ownerDir
Keylet ownerDir(AccountID const &id) noexcept
The root page of an account's directory.
Definition Indexes.cpp:355
ripple::nft::getTransferFee
std::uint16_t getTransferFee(uint256 const &id)
Definition nft.h:49
ripple::nft::getFlags
std::uint16_t getFlags(uint256 const &id)
Definition nft.h:41
ripple::nft::toUInt32
std::uint32_t toUInt32(Taxon t)
Definition nft.h:29
@@ -394,20 +599,24 @@ $(document).ready(function() { init_codefold(0); });
ripple::rpcACT_NOT_FOUND
@ rpcACT_NOT_FOUND
Definition ErrorCodes.h:51
ripple::rpcACT_MALFORMED
@ rpcACT_MALFORMED
Definition ErrorCodes.h:71
ripple::rpcError
Json::Value rpcError(int iError)
Definition RPCErr.cpp:12
-
ripple::doAccountObjects
Json::Value doAccountObjects(RPC::JsonContext &context)
Definition AccountObjects.cpp:162
-
ripple::doAccountNFTs
Json::Value doAccountNFTs(RPC::JsonContext &context)
General RPC command that can retrieve objects in the account root.
Definition AccountObjects.cpp:31
+
ripple::doAccountObjects
Json::Value doAccountObjects(RPC::JsonContext &context)
Definition AccountObjects.cpp:355
+
ripple::doAccountNFTs
Json::Value doAccountNFTs(RPC::JsonContext &context)
General RPC command that can retrieve objects in the account root.
Definition AccountObjects.cpp:32
+
ripple::getAccountObjects
bool getAccountObjects(ReadView const &ledger, AccountID const &account, std::optional< std::vector< LedgerEntryType > > const &typeFilter, uint256 dirIndex, uint256 entryIndex, std::uint32_t const limit, Json::Value &jvResult)
Definition AccountObjects.cpp:163
ripple::to_string
std::string to_string(base_uint< Bits, Tag > const &a)
Definition base_uint.h:611
ripple::LedgerEntryType
LedgerEntryType
Identifiers for on-ledger objects.
Definition LedgerFormats.h:35
ripple::ltANY
@ ltANY
A special type, matching any ledger entry type.
Definition LedgerFormats.h:59
+
ripple::root
Number root(Number f, unsigned d)
Definition Number.cpp:617
std::size
T size(T... args)
ripple::Keylet
A pair of SHAMap key and LedgerEntryType.
Definition Keylet.h:20
+
ripple::Keylet::key
uint256 key
Definition Keylet.h:21
ripple::RPC::Context::loadType
Resource::Charge & loadType
Definition Context.h:23
+
diff --git a/AccountOffers_8cpp_source.html b/AccountOffers_8cpp_source.html index 9cb6a70b54..1553eb6a93 100644 --- a/AccountOffers_8cpp_source.html +++ b/AccountOffers_8cpp_source.html @@ -83,174 +83,175 @@ $(document).ready(function() { init_codefold(0); });
1#include <xrpld/rpc/Context.h>
2#include <xrpld/rpc/detail/RPCHelpers.h>
-
3#include <xrpld/rpc/detail/Tuning.h>
-
4
-
5#include <xrpl/json/json_value.h>
-
6#include <xrpl/ledger/ReadView.h>
-
7#include <xrpl/ledger/View.h>
-
8#include <xrpl/protocol/ErrorCodes.h>
-
9#include <xrpl/protocol/RPCErr.h>
-
10#include <xrpl/protocol/jss.h>
-
11#include <xrpl/resource/Fees.h>
-
12
-
13namespace ripple {
-
14
-
15void
-
-
16appendOfferJson(std::shared_ptr<SLE const> const& offer, Json::Value& offers)
-
17{
-
18 STAmount dirRate =
-
19 amountFromQuality(getQuality(offer->getFieldH256(sfBookDirectory)));
-
20 Json::Value& obj(offers.append(Json::objectValue));
-
21 offer->getFieldAmount(sfTakerPays).setJson(obj[jss::taker_pays]);
-
22 offer->getFieldAmount(sfTakerGets).setJson(obj[jss::taker_gets]);
-
23 obj[jss::seq] = offer->getFieldU32(sfSequence);
-
24 obj[jss::flags] = offer->getFieldU32(sfFlags);
-
25 obj[jss::quality] = dirRate.getText();
-
26 if (offer->isFieldPresent(sfExpiration))
-
27 obj[jss::expiration] = offer->getFieldU32(sfExpiration);
-
28};
+
3#include <xrpld/rpc/detail/RPCLedgerHelpers.h>
+
4#include <xrpld/rpc/detail/Tuning.h>
+
5
+
6#include <xrpl/json/json_value.h>
+
7#include <xrpl/ledger/ReadView.h>
+
8#include <xrpl/ledger/View.h>
+
9#include <xrpl/protocol/ErrorCodes.h>
+
10#include <xrpl/protocol/RPCErr.h>
+
11#include <xrpl/protocol/jss.h>
+
12#include <xrpl/resource/Fees.h>
+
13
+
14namespace ripple {
+
15
+
16void
+
+
17appendOfferJson(std::shared_ptr<SLE const> const& offer, Json::Value& offers)
+
18{
+
19 STAmount dirRate =
+
20 amountFromQuality(getQuality(offer->getFieldH256(sfBookDirectory)));
+
21 Json::Value& obj(offers.append(Json::objectValue));
+
22 offer->getFieldAmount(sfTakerPays).setJson(obj[jss::taker_pays]);
+
23 offer->getFieldAmount(sfTakerGets).setJson(obj[jss::taker_gets]);
+
24 obj[jss::seq] = offer->getFieldU32(sfSequence);
+
25 obj[jss::flags] = offer->getFieldU32(sfFlags);
+
26 obj[jss::quality] = dirRate.getText();
+
27 if (offer->isFieldPresent(sfExpiration))
+
28 obj[jss::expiration] = offer->getFieldU32(sfExpiration);
+
29};
-
29
-
30// {
-
31// account: <account>
-
32// ledger_hash : <ledger>
-
33// ledger_index : <ledger_index>
-
34// limit: integer // optional
-
35// marker: opaque // optional, resume previous query
-
36// }
-
37Json::Value
-
-
38doAccountOffers(RPC::JsonContext& context)
-
39{
-
40 auto const& params(context.params);
-
41 if (!params.isMember(jss::account))
-
42 return RPC::missing_field_error(jss::account);
-
43
-
44 if (!params[jss::account].isString())
-
45 return RPC::invalid_field_error(jss::account);
-
46
-
47 std::shared_ptr<ReadView const> ledger;
-
48 auto result = RPC::lookupLedger(ledger, context);
-
49 if (!ledger)
-
50 return result;
-
51
-
52 auto id = parseBase58<AccountID>(params[jss::account].asString());
-
53 if (!id)
-
54 {
-
55 RPC::inject_error(rpcACT_MALFORMED, result);
-
56 return result;
-
57 }
-
58 auto const accountID{std::move(id.value())};
-
59
-
60 // Get info on account.
-
61 result[jss::account] = toBase58(accountID);
-
62
-
63 if (!ledger->exists(keylet::account(accountID)))
-
64 return rpcError(rpcACT_NOT_FOUND);
-
65
-
66 unsigned int limit;
-
67 if (auto err = readLimitField(limit, RPC::Tuning::accountOffers, context))
-
68 return *err;
-
69
-
70 Json::Value& jsonOffers(result[jss::offers] = Json::arrayValue);
-
71 std::vector<std::shared_ptr<SLE const>> offers;
-
72 uint256 startAfter = beast::zero;
-
73 std::uint64_t startHint = 0;
-
74
-
75 if (params.isMember(jss::marker))
-
76 {
-
77 if (!params[jss::marker].isString())
-
78 return RPC::expected_field_error(jss::marker, "string");
-
79
-
80 // Marker is composed of a comma separated index and start hint. The
-
81 // former will be read as hex, and the latter using boost lexical cast.
-
82 std::stringstream marker(params[jss::marker].asString());
-
83 std::string value;
-
84 if (!std::getline(marker, value, ','))
-
85 return RPC::invalid_field_error(jss::marker);
-
86
-
87 if (!startAfter.parseHex(value))
-
88 return RPC::invalid_field_error(jss::marker);
-
89
-
90 if (!std::getline(marker, value, ','))
-
91 return RPC::invalid_field_error(jss::marker);
-
92
-
93 try
-
94 {
-
95 startHint = boost::lexical_cast<std::uint64_t>(value);
-
96 }
-
97 catch (boost::bad_lexical_cast&)
-
98 {
-
99 return RPC::invalid_field_error(jss::marker);
-
100 }
-
101
-
102 // We then must check if the object pointed to by the marker is actually
-
103 // owned by the account in the request.
-
104 auto const sle = ledger->read({ltANY, startAfter});
-
105
-
106 if (!sle)
-
107 return rpcError(rpcINVALID_PARAMS);
-
108
-
109 if (!RPC::isRelatedToAccount(*ledger, sle, accountID))
-
110 return rpcError(rpcINVALID_PARAMS);
-
111 }
-
112
-
113 auto count = 0;
-
114 std::optional<uint256> marker = {};
-
115 std::uint64_t nextHint = 0;
-
116 if (!forEachItemAfter(
-
117 *ledger,
-
118 accountID,
-
119 startAfter,
-
120 startHint,
-
121 limit + 1,
-
122 [&offers, &count, &marker, &limit, &nextHint, &accountID](
-
123 std::shared_ptr<SLE const> const& sle) {
-
124 if (!sle)
-
125 {
-
126 // LCOV_EXCL_START
-
127 UNREACHABLE("ripple::doAccountOffers : null SLE");
-
128 return false;
-
129 // LCOV_EXCL_STOP
-
130 }
-
131
-
132 if (++count == limit)
-
133 {
-
134 marker = sle->key();
-
135 nextHint = RPC::getStartHint(sle, accountID);
-
136 }
-
137
-
138 if (count <= limit && sle->getType() == ltOFFER)
-
139 {
-
140 offers.emplace_back(sle);
-
141 }
-
142
-
143 return true;
-
144 }))
-
145 {
-
146 return rpcError(rpcINVALID_PARAMS);
-
147 }
-
148
-
149 // Both conditions need to be checked because marker is set on the limit-th
-
150 // item, but if there is no item on the limit + 1 iteration, then there is
-
151 // no need to return a marker.
-
152 if (count == limit + 1 && marker)
-
153 {
-
154 result[jss::limit] = limit;
-
155 result[jss::marker] =
-
156 to_string(*marker) + "," + std::to_string(nextHint);
-
157 }
-
158
-
159 for (auto const& offer : offers)
-
160 appendOfferJson(offer, jsonOffers);
-
161
-
162 context.loadType = Resource::feeMediumBurdenRPC;
-
163 return result;
-
164}
+
30
+
31// {
+
32// account: <account>
+
33// ledger_hash : <ledger>
+
34// ledger_index : <ledger_index>
+
35// limit: integer // optional
+
36// marker: opaque // optional, resume previous query
+
37// }
+
38Json::Value
+
+
39doAccountOffers(RPC::JsonContext& context)
+
40{
+
41 auto const& params(context.params);
+
42 if (!params.isMember(jss::account))
+
43 return RPC::missing_field_error(jss::account);
+
44
+
45 if (!params[jss::account].isString())
+
46 return RPC::invalid_field_error(jss::account);
+
47
+
48 std::shared_ptr<ReadView const> ledger;
+
49 auto result = RPC::lookupLedger(ledger, context);
+
50 if (!ledger)
+
51 return result;
+
52
+
53 auto id = parseBase58<AccountID>(params[jss::account].asString());
+
54 if (!id)
+
55 {
+
56 RPC::inject_error(rpcACT_MALFORMED, result);
+
57 return result;
+
58 }
+
59 auto const accountID{std::move(id.value())};
+
60
+
61 // Get info on account.
+
62 result[jss::account] = toBase58(accountID);
+
63
+
64 if (!ledger->exists(keylet::account(accountID)))
+
65 return rpcError(rpcACT_NOT_FOUND);
+
66
+
67 unsigned int limit;
+
68 if (auto err = readLimitField(limit, RPC::Tuning::accountOffers, context))
+
69 return *err;
+
70
+
71 Json::Value& jsonOffers(result[jss::offers] = Json::arrayValue);
+
72 std::vector<std::shared_ptr<SLE const>> offers;
+
73 uint256 startAfter = beast::zero;
+
74 std::uint64_t startHint = 0;
+
75
+
76 if (params.isMember(jss::marker))
+
77 {
+
78 if (!params[jss::marker].isString())
+
79 return RPC::expected_field_error(jss::marker, "string");
+
80
+
81 // Marker is composed of a comma separated index and start hint. The
+
82 // former will be read as hex, and the latter using boost lexical cast.
+
83 std::stringstream marker(params[jss::marker].asString());
+
84 std::string value;
+
85 if (!std::getline(marker, value, ','))
+
86 return RPC::invalid_field_error(jss::marker);
+
87
+
88 if (!startAfter.parseHex(value))
+
89 return RPC::invalid_field_error(jss::marker);
+
90
+
91 if (!std::getline(marker, value, ','))
+
92 return RPC::invalid_field_error(jss::marker);
+
93
+
94 try
+
95 {
+
96 startHint = boost::lexical_cast<std::uint64_t>(value);
+
97 }
+
98 catch (boost::bad_lexical_cast&)
+
99 {
+
100 return RPC::invalid_field_error(jss::marker);
+
101 }
+
102
+
103 // We then must check if the object pointed to by the marker is actually
+
104 // owned by the account in the request.
+
105 auto const sle = ledger->read({ltANY, startAfter});
+
106
+
107 if (!sle)
+
108 return rpcError(rpcINVALID_PARAMS);
+
109
+
110 if (!RPC::isRelatedToAccount(*ledger, sle, accountID))
+
111 return rpcError(rpcINVALID_PARAMS);
+
112 }
+
113
+
114 auto count = 0;
+
115 std::optional<uint256> marker = {};
+
116 std::uint64_t nextHint = 0;
+
117 if (!forEachItemAfter(
+
118 *ledger,
+
119 accountID,
+
120 startAfter,
+
121 startHint,
+
122 limit + 1,
+
123 [&offers, &count, &marker, &limit, &nextHint, &accountID](
+
124 std::shared_ptr<SLE const> const& sle) {
+
125 if (!sle)
+
126 {
+
127 // LCOV_EXCL_START
+
128 UNREACHABLE("ripple::doAccountOffers : null SLE");
+
129 return false;
+
130 // LCOV_EXCL_STOP
+
131 }
+
132
+
133 if (++count == limit)
+
134 {
+
135 marker = sle->key();
+
136 nextHint = RPC::getStartHint(sle, accountID);
+
137 }
+
138
+
139 if (count <= limit && sle->getType() == ltOFFER)
+
140 {
+
141 offers.emplace_back(sle);
+
142 }
+
143
+
144 return true;
+
145 }))
+
146 {
+
147 return rpcError(rpcINVALID_PARAMS);
+
148 }
+
149
+
150 // Both conditions need to be checked because marker is set on the limit-th
+
151 // item, but if there is no item on the limit + 1 iteration, then there is
+
152 // no need to return a marker.
+
153 if (count == limit + 1 && marker)
+
154 {
+
155 result[jss::limit] = limit;
+
156 result[jss::marker] =
+
157 to_string(*marker) + "," + std::to_string(nextHint);
+
158 }
+
159
+
160 for (auto const& offer : offers)
+
161 appendOfferJson(offer, jsonOffers);
+
162
+
163 context.loadType = Resource::feeMediumBurdenRPC;
+
164 return result;
+
165}
-
165
-
166} // namespace ripple
+
166
+
167} // namespace ripple
Json::Value
Represents a JSON value.
Definition json_value.h:131
@@ -267,7 +268,7 @@ $(document).ready(function() { init_codefold(0); });
ripple::RPC::isRelatedToAccount
bool isRelatedToAccount(ReadView const &ledger, std::shared_ptr< SLE const > const &sle, AccountID const &accountID)
Tests if a SLE is owned by accountID.
Definition RPCHelpers.cpp:96
ripple::RPC::inject_error
void inject_error(error_code_i code, JsonValue &json)
Add or update the json update to reflect the error code.
Definition ErrorCodes.h:214
ripple::RPC::expected_field_error
Json::Value expected_field_error(std::string const &name, std::string const &type)
Definition ErrorCodes.h:330
-
ripple::RPC::lookupLedger
Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
Definition RPCHelpers.cpp:606
+
ripple::RPC::lookupLedger
Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
Definition RPCLedgerHelpers.cpp:305
ripple::RPC::getStartHint
std::uint64_t getStartHint(std::shared_ptr< SLE const > const &sle, AccountID const &accountID)
Gets the start hint for traversing account objects.
Definition RPCHelpers.cpp:79
ripple::RPC::missing_field_error
Json::Value missing_field_error(std::string const &name)
Definition ErrorCodes.h:264
ripple::Resource::feeMediumBurdenRPC
Charge const feeMediumBurdenRPC
@@ -281,10 +282,10 @@ $(document).ready(function() { init_codefold(0); });
ripple::amountFromQuality
STAmount amountFromQuality(std::uint64_t rate)
Definition STAmount.cpp:965
ripple::rpcError
Json::Value rpcError(int iError)
Definition RPCErr.cpp:12
ripple::forEachItemAfter
bool forEachItemAfter(ReadView const &view, Keylet const &root, uint256 const &after, std::uint64_t const hint, unsigned int limit, std::function< bool(std::shared_ptr< SLE const > const &)> const &f)
Iterate all items after an item in the given directory.
Definition View.cpp:665
-
ripple::doAccountOffers
Json::Value doAccountOffers(RPC::JsonContext &context)
Definition AccountOffers.cpp:38
+
ripple::doAccountOffers
Json::Value doAccountOffers(RPC::JsonContext &context)
Definition AccountOffers.cpp:39
ripple::to_string
std::string to_string(base_uint< Bits, Tag > const &a)
Definition base_uint.h:611
ripple::ltANY
@ ltANY
A special type, matching any ledger entry type.
Definition LedgerFormats.h:59
-
ripple::appendOfferJson
void appendOfferJson(std::shared_ptr< SLE const > const &offer, Json::Value &offers)
Definition AccountOffers.cpp:16
+
ripple::appendOfferJson
void appendOfferJson(std::shared_ptr< SLE const > const &offer, Json::Value &offers)
Definition AccountOffers.cpp:17
ripple::RPC::Context::loadType
Resource::Charge & loadType
Definition Context.h:23
diff --git a/AccountTx_8cpp_source.html b/AccountTx_8cpp_source.html index 485db96ae5..086572ca03 100644 --- a/AccountTx_8cpp_source.html +++ b/AccountTx_8cpp_source.html @@ -592,9 +592,9 @@ $(document).ready(function() { init_codefold(0); });
ripple::RPC::Tuning::accountTx
static LimitRange constexpr accountTx
Limits for the account_tx command.
Definition src/xrpld/rpc/detail/Tuning.h:30
ripple::RPC::invalid_field_error
Json::Value invalid_field_error(std::string const &name)
Definition ErrorCodes.h:306
ripple::RPC::insertNFTSyntheticInJson
void insertNFTSyntheticInJson(Json::Value &, std::shared_ptr< STTx const > const &, TxMeta const &)
Adds common synthetic fields to transaction-related JSON responses.
Definition NFTSyntheticSerializer.cpp:15
- +
ripple::RPC::insertMPTokenIssuanceID
void insertMPTokenIssuanceID(Json::Value &response, std::shared_ptr< STTx const > const &transaction, TxMeta const &transactionMeta)
Definition MPTokenIssuanceID.cpp:45
-
ripple::RPC::readLimitField
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...
Definition RPCHelpers.cpp:682
+
ripple::RPC::readLimitField
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...
Definition RPCHelpers.cpp:175
ripple::RPC::insertDeliverMax
void insertDeliverMax(Json::Value &tx_json, TxType txnType, unsigned int apiVersion)
Copy Amount field to DeliverMax field in transaction output JSON.
Definition DeliverMax.cpp:9
ripple::RPC::missing_field_error
Json::Value missing_field_error(std::string const &name)
Definition ErrorCodes.h:264
ripple::Resource::feeMediumBurdenRPC
Charge const feeMediumBurdenRPC
diff --git a/BookOffers_8cpp_source.html b/BookOffers_8cpp_source.html index 58378e5f3e..d11951df02 100644 --- a/BookOffers_8cpp_source.html +++ b/BookOffers_8cpp_source.html @@ -86,219 +86,220 @@ $(document).ready(function() { init_codefold(0); });
3#include <xrpld/rpc/BookChanges.h>
4#include <xrpld/rpc/Context.h>
5#include <xrpld/rpc/detail/RPCHelpers.h>
-
6
-
7#include <xrpl/basics/Log.h>
-
8#include <xrpl/ledger/ReadView.h>
-
9#include <xrpl/protocol/ErrorCodes.h>
-
10#include <xrpl/protocol/RPCErr.h>
-
11#include <xrpl/protocol/UintTypes.h>
-
12#include <xrpl/protocol/jss.h>
-
13#include <xrpl/resource/Fees.h>
-
14
-
15namespace ripple {
-
16
-
17Json::Value
-
-
18doBookOffers(RPC::JsonContext& context)
-
19{
-
20 // VFALCO TODO Here is a terrible place for this kind of business
-
21 // logic. It needs to be moved elsewhere and documented,
-
22 // and encapsulated into a function.
-
23 if (context.app.getJobQueue().getJobCountGE(jtCLIENT) > 200)
-
24 return rpcError(rpcTOO_BUSY);
-
25
-
26 std::shared_ptr<ReadView const> lpLedger;
-
27 auto jvResult = RPC::lookupLedger(lpLedger, context);
-
28
-
29 if (!lpLedger)
-
30 return jvResult;
-
31
-
32 if (!context.params.isMember(jss::taker_pays))
-
33 return RPC::missing_field_error(jss::taker_pays);
-
34
-
35 if (!context.params.isMember(jss::taker_gets))
-
36 return RPC::missing_field_error(jss::taker_gets);
-
37
-
38 Json::Value const& taker_pays = context.params[jss::taker_pays];
-
39 Json::Value const& taker_gets = context.params[jss::taker_gets];
-
40
-
41 if (!taker_pays.isObjectOrNull())
-
42 return RPC::object_field_error(jss::taker_pays);
-
43
-
44 if (!taker_gets.isObjectOrNull())
-
45 return RPC::object_field_error(jss::taker_gets);
-
46
-
47 if (!taker_pays.isMember(jss::currency))
-
48 return RPC::missing_field_error("taker_pays.currency");
-
49
-
50 if (!taker_pays[jss::currency].isString())
-
51 return RPC::expected_field_error("taker_pays.currency", "string");
-
52
-
53 if (!taker_gets.isMember(jss::currency))
-
54 return RPC::missing_field_error("taker_gets.currency");
-
55
-
56 if (!taker_gets[jss::currency].isString())
-
57 return RPC::expected_field_error("taker_gets.currency", "string");
-
58
-
59 Currency pay_currency;
-
60
-
61 if (!to_currency(pay_currency, taker_pays[jss::currency].asString()))
-
62 {
-
63 JLOG(context.j.info()) << "Bad taker_pays currency.";
-
64 return RPC::make_error(
-
65 rpcSRC_CUR_MALFORMED,
-
66 "Invalid field 'taker_pays.currency', bad currency.");
-
67 }
-
68
-
69 Currency get_currency;
-
70
-
71 if (!to_currency(get_currency, taker_gets[jss::currency].asString()))
-
72 {
-
73 JLOG(context.j.info()) << "Bad taker_gets currency.";
-
74 return RPC::make_error(
-
75 rpcDST_AMT_MALFORMED,
-
76 "Invalid field 'taker_gets.currency', bad currency.");
-
77 }
-
78
-
79 AccountID pay_issuer;
-
80
-
81 if (taker_pays.isMember(jss::issuer))
-
82 {
-
83 if (!taker_pays[jss::issuer].isString())
-
84 return RPC::expected_field_error("taker_pays.issuer", "string");
-
85
-
86 if (!to_issuer(pay_issuer, taker_pays[jss::issuer].asString()))
-
87 return RPC::make_error(
-
88 rpcSRC_ISR_MALFORMED,
-
89 "Invalid field 'taker_pays.issuer', bad issuer.");
-
90
-
91 if (pay_issuer == noAccount())
-
92 return RPC::make_error(
-
93 rpcSRC_ISR_MALFORMED,
-
94 "Invalid field 'taker_pays.issuer', bad issuer account one.");
-
95 }
-
96 else
-
97 {
-
98 pay_issuer = xrpAccount();
-
99 }
-
100
-
101 if (isXRP(pay_currency) && !isXRP(pay_issuer))
-
102 return RPC::make_error(
-
103 rpcSRC_ISR_MALFORMED,
-
104 "Unneeded field 'taker_pays.issuer' for "
-
105 "XRP currency specification.");
-
106
-
107 if (!isXRP(pay_currency) && isXRP(pay_issuer))
-
108 return RPC::make_error(
-
109 rpcSRC_ISR_MALFORMED,
-
110 "Invalid field 'taker_pays.issuer', expected non-XRP issuer.");
-
111
-
112 AccountID get_issuer;
-
113
-
114 if (taker_gets.isMember(jss::issuer))
-
115 {
-
116 if (!taker_gets[jss::issuer].isString())
-
117 return RPC::expected_field_error("taker_gets.issuer", "string");
-
118
-
119 if (!to_issuer(get_issuer, taker_gets[jss::issuer].asString()))
-
120 return RPC::make_error(
-
121 rpcDST_ISR_MALFORMED,
-
122 "Invalid field 'taker_gets.issuer', bad issuer.");
-
123
-
124 if (get_issuer == noAccount())
-
125 return RPC::make_error(
-
126 rpcDST_ISR_MALFORMED,
-
127 "Invalid field 'taker_gets.issuer', bad issuer account one.");
-
128 }
-
129 else
-
130 {
-
131 get_issuer = xrpAccount();
-
132 }
-
133
-
134 if (isXRP(get_currency) && !isXRP(get_issuer))
-
135 return RPC::make_error(
-
136 rpcDST_ISR_MALFORMED,
-
137 "Unneeded field 'taker_gets.issuer' for "
-
138 "XRP currency specification.");
-
139
-
140 if (!isXRP(get_currency) && isXRP(get_issuer))
-
141 return RPC::make_error(
-
142 rpcDST_ISR_MALFORMED,
-
143 "Invalid field 'taker_gets.issuer', expected non-XRP issuer.");
-
144
-
145 std::optional<AccountID> takerID;
-
146 if (context.params.isMember(jss::taker))
-
147 {
-
148 if (!context.params[jss::taker].isString())
-
149 return RPC::expected_field_error(jss::taker, "string");
-
150
-
151 takerID = parseBase58<AccountID>(context.params[jss::taker].asString());
-
152 if (!takerID)
-
153 return RPC::invalid_field_error(jss::taker);
-
154 }
-
155
-
156 std::optional<uint256> domain;
-
157 if (context.params.isMember(jss::domain))
-
158 {
-
159 uint256 num;
-
160 if (!context.params[jss::domain].isString() ||
-
161 !num.parseHex(context.params[jss::domain].asString()))
-
162 {
-
163 return RPC::make_error(
-
164 rpcDOMAIN_MALFORMED, "Unable to parse domain.");
-
165 }
-
166 else
-
167 {
-
168 domain = num;
-
169 }
-
170 }
-
171
-
172 if (pay_currency == get_currency && pay_issuer == get_issuer)
-
173 {
-
174 JLOG(context.j.info()) << "taker_gets same as taker_pays.";
-
175 return RPC::make_error(rpcBAD_MARKET);
-
176 }
-
177
-
178 unsigned int limit;
-
179 if (auto err = readLimitField(limit, RPC::Tuning::bookOffers, context))
-
180 return *err;
-
181
-
182 bool const bProof(context.params.isMember(jss::proof));
-
183
-
184 Json::Value const jvMarker(
-
185 context.params.isMember(jss::marker) ? context.params[jss::marker]
-
186 : Json::Value(Json::nullValue));
-
187
-
188 context.netOps.getBookPage(
-
189 lpLedger,
-
190 {{pay_currency, pay_issuer}, {get_currency, get_issuer}, domain},
-
191 takerID ? *takerID : beast::zero,
-
192 bProof,
-
193 limit,
-
194 jvMarker,
-
195 jvResult);
-
196
-
197 context.loadType = Resource::feeMediumBurdenRPC;
-
198
-
199 return jvResult;
-
200}
+
6#include <xrpld/rpc/detail/RPCLedgerHelpers.h>
+
7
+
8#include <xrpl/basics/Log.h>
+
9#include <xrpl/ledger/ReadView.h>
+
10#include <xrpl/protocol/ErrorCodes.h>
+
11#include <xrpl/protocol/RPCErr.h>
+
12#include <xrpl/protocol/UintTypes.h>
+
13#include <xrpl/protocol/jss.h>
+
14#include <xrpl/resource/Fees.h>
+
15
+
16namespace ripple {
+
17
+
18Json::Value
+
+
19doBookOffers(RPC::JsonContext& context)
+
20{
+
21 // VFALCO TODO Here is a terrible place for this kind of business
+
22 // logic. It needs to be moved elsewhere and documented,
+
23 // and encapsulated into a function.
+
24 if (context.app.getJobQueue().getJobCountGE(jtCLIENT) > 200)
+
25 return rpcError(rpcTOO_BUSY);
+
26
+
27 std::shared_ptr<ReadView const> lpLedger;
+
28 auto jvResult = RPC::lookupLedger(lpLedger, context);
+
29
+
30 if (!lpLedger)
+
31 return jvResult;
+
32
+
33 if (!context.params.isMember(jss::taker_pays))
+
34 return RPC::missing_field_error(jss::taker_pays);
+
35
+
36 if (!context.params.isMember(jss::taker_gets))
+
37 return RPC::missing_field_error(jss::taker_gets);
+
38
+
39 Json::Value const& taker_pays = context.params[jss::taker_pays];
+
40 Json::Value const& taker_gets = context.params[jss::taker_gets];
+
41
+
42 if (!taker_pays.isObjectOrNull())
+
43 return RPC::object_field_error(jss::taker_pays);
+
44
+
45 if (!taker_gets.isObjectOrNull())
+
46 return RPC::object_field_error(jss::taker_gets);
+
47
+
48 if (!taker_pays.isMember(jss::currency))
+
49 return RPC::missing_field_error("taker_pays.currency");
+
50
+
51 if (!taker_pays[jss::currency].isString())
+
52 return RPC::expected_field_error("taker_pays.currency", "string");
+
53
+
54 if (!taker_gets.isMember(jss::currency))
+
55 return RPC::missing_field_error("taker_gets.currency");
+
56
+
57 if (!taker_gets[jss::currency].isString())
+
58 return RPC::expected_field_error("taker_gets.currency", "string");
+
59
+
60 Currency pay_currency;
+
61
+
62 if (!to_currency(pay_currency, taker_pays[jss::currency].asString()))
+
63 {
+
64 JLOG(context.j.info()) << "Bad taker_pays currency.";
+
65 return RPC::make_error(
+
66 rpcSRC_CUR_MALFORMED,
+
67 "Invalid field 'taker_pays.currency', bad currency.");
+
68 }
+
69
+
70 Currency get_currency;
+
71
+
72 if (!to_currency(get_currency, taker_gets[jss::currency].asString()))
+
73 {
+
74 JLOG(context.j.info()) << "Bad taker_gets currency.";
+
75 return RPC::make_error(
+
76 rpcDST_AMT_MALFORMED,
+
77 "Invalid field 'taker_gets.currency', bad currency.");
+
78 }
+
79
+
80 AccountID pay_issuer;
+
81
+
82 if (taker_pays.isMember(jss::issuer))
+
83 {
+
84 if (!taker_pays[jss::issuer].isString())
+
85 return RPC::expected_field_error("taker_pays.issuer", "string");
+
86
+
87 if (!to_issuer(pay_issuer, taker_pays[jss::issuer].asString()))
+
88 return RPC::make_error(
+
89 rpcSRC_ISR_MALFORMED,
+
90 "Invalid field 'taker_pays.issuer', bad issuer.");
+
91
+
92 if (pay_issuer == noAccount())
+
93 return RPC::make_error(
+
94 rpcSRC_ISR_MALFORMED,
+
95 "Invalid field 'taker_pays.issuer', bad issuer account one.");
+
96 }
+
97 else
+
98 {
+
99 pay_issuer = xrpAccount();
+
100 }
+
101
+
102 if (isXRP(pay_currency) && !isXRP(pay_issuer))
+
103 return RPC::make_error(
+
104 rpcSRC_ISR_MALFORMED,
+
105 "Unneeded field 'taker_pays.issuer' for "
+
106 "XRP currency specification.");
+
107
+
108 if (!isXRP(pay_currency) && isXRP(pay_issuer))
+
109 return RPC::make_error(
+
110 rpcSRC_ISR_MALFORMED,
+
111 "Invalid field 'taker_pays.issuer', expected non-XRP issuer.");
+
112
+
113 AccountID get_issuer;
+
114
+
115 if (taker_gets.isMember(jss::issuer))
+
116 {
+
117 if (!taker_gets[jss::issuer].isString())
+
118 return RPC::expected_field_error("taker_gets.issuer", "string");
+
119
+
120 if (!to_issuer(get_issuer, taker_gets[jss::issuer].asString()))
+
121 return RPC::make_error(
+
122 rpcDST_ISR_MALFORMED,
+
123 "Invalid field 'taker_gets.issuer', bad issuer.");
+
124
+
125 if (get_issuer == noAccount())
+
126 return RPC::make_error(
+
127 rpcDST_ISR_MALFORMED,
+
128 "Invalid field 'taker_gets.issuer', bad issuer account one.");
+
129 }
+
130 else
+
131 {
+
132 get_issuer = xrpAccount();
+
133 }
+
134
+
135 if (isXRP(get_currency) && !isXRP(get_issuer))
+
136 return RPC::make_error(
+
137 rpcDST_ISR_MALFORMED,
+
138 "Unneeded field 'taker_gets.issuer' for "
+
139 "XRP currency specification.");
+
140
+
141 if (!isXRP(get_currency) && isXRP(get_issuer))
+
142 return RPC::make_error(
+
143 rpcDST_ISR_MALFORMED,
+
144 "Invalid field 'taker_gets.issuer', expected non-XRP issuer.");
+
145
+
146 std::optional<AccountID> takerID;
+
147 if (context.params.isMember(jss::taker))
+
148 {
+
149 if (!context.params[jss::taker].isString())
+
150 return RPC::expected_field_error(jss::taker, "string");
+
151
+
152 takerID = parseBase58<AccountID>(context.params[jss::taker].asString());
+
153 if (!takerID)
+
154 return RPC::invalid_field_error(jss::taker);
+
155 }
+
156
+
157 std::optional<uint256> domain;
+
158 if (context.params.isMember(jss::domain))
+
159 {
+
160 uint256 num;
+
161 if (!context.params[jss::domain].isString() ||
+
162 !num.parseHex(context.params[jss::domain].asString()))
+
163 {
+
164 return RPC::make_error(
+
165 rpcDOMAIN_MALFORMED, "Unable to parse domain.");
+
166 }
+
167 else
+
168 {
+
169 domain = num;
+
170 }
+
171 }
+
172
+
173 if (pay_currency == get_currency && pay_issuer == get_issuer)
+
174 {
+
175 JLOG(context.j.info()) << "taker_gets same as taker_pays.";
+
176 return RPC::make_error(rpcBAD_MARKET);
+
177 }
+
178
+
179 unsigned int limit;
+
180 if (auto err = readLimitField(limit, RPC::Tuning::bookOffers, context))
+
181 return *err;
+
182
+
183 bool const bProof(context.params.isMember(jss::proof));
+
184
+
185 Json::Value const jvMarker(
+
186 context.params.isMember(jss::marker) ? context.params[jss::marker]
+
187 : Json::Value(Json::nullValue));
+
188
+
189 context.netOps.getBookPage(
+
190 lpLedger,
+
191 {{pay_currency, pay_issuer}, {get_currency, get_issuer}, domain},
+
192 takerID ? *takerID : beast::zero,
+
193 bProof,
+
194 limit,
+
195 jvMarker,
+
196 jvResult);
+
197
+
198 context.loadType = Resource::feeMediumBurdenRPC;
+
199
+
200 return jvResult;
+
201}
-
201
-
202Json::Value
-
-
203doBookChanges(RPC::JsonContext& context)
-
204{
-
205 std::shared_ptr<ReadView const> ledger;
-
206
-
207 Json::Value result = RPC::lookupLedger(ledger, context);
-
208 if (ledger == nullptr)
-
209 return result;
-
210
-
211 return RPC::computeBookChanges(ledger);
-
212}
+
202
+
203Json::Value
+
+
204doBookChanges(RPC::JsonContext& context)
+
205{
+
206 std::shared_ptr<ReadView const> ledger;
+
207
+
208 Json::Value result = RPC::lookupLedger(ledger, context);
+
209 if (ledger == nullptr)
+
210 return result;
+
211
+
212 return RPC::computeBookChanges(ledger);
+
213}
-
213
-
214} // namespace ripple
+
214
+
215} // namespace ripple
Json::Value
Represents a JSON value.
Definition json_value.h:131
Json::Value::isObjectOrNull
bool isObjectOrNull() const
Definition json_value.cpp:1133
Json::Value::isString
bool isString() const
Definition json_value.cpp:1109
@@ -317,7 +318,7 @@ $(document).ready(function() { init_codefold(0); });
ripple::RPC::invalid_field_error
Json::Value invalid_field_error(std::string const &name)
Definition ErrorCodes.h:306
ripple::RPC::object_field_error
Json::Value object_field_error(std::string const &name)
Definition ErrorCodes.h:282
ripple::RPC::expected_field_error
Json::Value expected_field_error(std::string const &name, std::string const &type)
Definition ErrorCodes.h:330
-
ripple::RPC::lookupLedger
Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
Definition RPCHelpers.cpp:606
+
ripple::RPC::lookupLedger
Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
Definition RPCLedgerHelpers.cpp:305
ripple::RPC::missing_field_error
Json::Value missing_field_error(std::string const &name)
Definition ErrorCodes.h:264
ripple::Resource::feeMediumBurdenRPC
Charge const feeMediumBurdenRPC
ripple
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition algorithm.h:6
@@ -332,9 +333,9 @@ $(document).ready(function() { init_codefold(0); });
ripple::rpcSRC_ISR_MALFORMED
@ rpcSRC_ISR_MALFORMED
Definition ErrorCodes.h:106
ripple::rpcDST_AMT_MALFORMED
@ rpcDST_AMT_MALFORMED
Definition ErrorCodes.h:87
ripple::rpcSRC_CUR_MALFORMED
@ rpcSRC_CUR_MALFORMED
Definition ErrorCodes.h:105
-
ripple::doBookChanges
Json::Value doBookChanges(RPC::JsonContext &context)
Definition BookOffers.cpp:203
+
ripple::doBookChanges
Json::Value doBookChanges(RPC::JsonContext &context)
Definition BookOffers.cpp:204
ripple::rpcError
Json::Value rpcError(int iError)
Definition RPCErr.cpp:12
-
ripple::doBookOffers
Json::Value doBookOffers(RPC::JsonContext &context)
Definition BookOffers.cpp:18
+
ripple::doBookOffers
Json::Value doBookOffers(RPC::JsonContext &context)
Definition BookOffers.cpp:19
ripple::jtCLIENT
@ jtCLIENT
Definition Job.h:26
ripple::to_currency
bool to_currency(Currency &, std::string const &)
Tries to convert a string to a Currency, returns true on success.
Definition UintTypes.cpp:65
diff --git a/Config__test_8cpp_source.html b/Config__test_8cpp_source.html index 8b54050d5b..aad6d11a6b 100644 --- a/Config__test_8cpp_source.html +++ b/Config__test_8cpp_source.html @@ -1310,7 +1310,7 @@ $(document).ready(function() { init_codefold(0); });
1183 BEAST_EXPECT(cfg.IPS_FIXED[6] == "12.34.12.123 12345");
1184 BEAST_EXPECT(cfg.IPS_FIXED[7] == "12.34.12.123 12345");
1185
-
1186 // all ipv6 should be ignored by colon replacer, howsoever formated
+
1186 // all ipv6 should be ignored by colon replacer, howsoever formatted
1187 BEAST_EXPECT(cfg.IPS_FIXED[8] == "::");
1188 BEAST_EXPECT(cfg.IPS_FIXED[9] == "2001:db8::");
1189 BEAST_EXPECT(cfg.IPS_FIXED[10] == "::1");
diff --git a/DepositAuthorized_8cpp_source.html b/DepositAuthorized_8cpp_source.html index 1212866887..5fac706cf4 100644 --- a/DepositAuthorized_8cpp_source.html +++ b/DepositAuthorized_8cpp_source.html @@ -82,7 +82,7 @@ $(document).ready(function() { init_codefold(0); });
1#include <xrpld/rpc/Context.h>
-
2#include <xrpld/rpc/detail/RPCHelpers.h>
+
2#include <xrpld/rpc/detail/RPCLedgerHelpers.h>
3
4#include <xrpl/ledger/CredentialHelpers.h>
5#include <xrpl/ledger/ReadView.h>
@@ -277,7 +277,7 @@ $(document).ready(function() { init_codefold(0); });
ripple::RPC::make_error
Json::Value make_error(error_code_i code)
Returns a new json object that reflects the error code.
Definition ErrorCodes.cpp:172
ripple::RPC::inject_error
void inject_error(error_code_i code, JsonValue &json)
Add or update the json update to reflect the error code.
Definition ErrorCodes.h:214
ripple::RPC::expected_field_message
std::string expected_field_message(std::string const &name, std::string const &type)
Definition ErrorCodes.h:318
-
ripple::RPC::lookupLedger
Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
Definition RPCHelpers.cpp:606
+
ripple::RPC::lookupLedger
Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
Definition RPCLedgerHelpers.cpp:305
ripple::RPC::missing_field_error
Json::Value missing_field_error(std::string const &name)
Definition ErrorCodes.h:264
ripple::credentials::checkExpired
bool checkExpired(std::shared_ptr< SLE const > const &sleCredential, NetClock::time_point const &closed)
Definition CredentialHelpers.cpp:12
ripple::keylet::credential
Keylet credential(AccountID const &subject, AccountID const &issuer, Slice const &credType) noexcept
Definition Indexes.cpp:534
diff --git a/GRPCHandlers_8h_source.html b/GRPCHandlers_8h_source.html index 2a32382ca7..b73172657c 100644 --- a/GRPCHandlers_8h_source.html +++ b/GRPCHandlers_8h_source.html @@ -122,7 +122,7 @@ $(document).ready(function() { init_codefold(0); });
ripple::doLedgerGrpc
std::pair< org::xrpl::rpc::v1::GetLedgerResponse, grpc::Status > doLedgerGrpc(RPC::GRPCContext< org::xrpl::rpc::v1::GetLedgerRequest > &context)
Definition LedgerHandler.cpp:81
ripple::doLedgerEntryGrpc
std::pair< org::xrpl::rpc::v1::GetLedgerEntryResponse, grpc::Status > doLedgerEntryGrpc(RPC::GRPCContext< org::xrpl::rpc::v1::GetLedgerEntryRequest > &context)
Definition LedgerEntry.cpp:818
ripple::doLedgerDiffGrpc
std::pair< org::xrpl::rpc::v1::GetLedgerDiffResponse, grpc::Status > doLedgerDiffGrpc(RPC::GRPCContext< org::xrpl::rpc::v1::GetLedgerDiffRequest > &context)
Definition LedgerDiff.cpp:6
-
ripple::doLedgerDataGrpc
std::pair< org::xrpl::rpc::v1::GetLedgerDataResponse, grpc::Status > doLedgerDataGrpc(RPC::GRPCContext< org::xrpl::rpc::v1::GetLedgerDataRequest > &context)
Definition LedgerData.cpp:117
+
ripple::doLedgerDataGrpc
std::pair< org::xrpl::rpc::v1::GetLedgerDataResponse, grpc::Status > doLedgerDataGrpc(RPC::GRPCContext< org::xrpl::rpc::v1::GetLedgerDataRequest > &context)
Definition LedgerData.cpp:118
diff --git a/GRPCServer_8cpp_source.html b/GRPCServer_8cpp_source.html index 796da720ca..346f580070 100644 --- a/GRPCServer_8cpp_source.html +++ b/GRPCServer_8cpp_source.html @@ -841,7 +841,7 @@ $(document).ready(function() { init_codefold(0); });
ripple::jtRPC
@ jtRPC
Definition Job.h:33
ripple::doLedgerDiffGrpc
std::pair< org::xrpl::rpc::v1::GetLedgerDiffResponse, grpc::Status > doLedgerDiffGrpc(RPC::GRPCContext< org::xrpl::rpc::v1::GetLedgerDiffRequest > &context)
Definition LedgerDiff.cpp:6
-
ripple::doLedgerDataGrpc
std::pair< org::xrpl::rpc::v1::GetLedgerDataResponse, grpc::Status > doLedgerDataGrpc(RPC::GRPCContext< org::xrpl::rpc::v1::GetLedgerDataRequest > &context)
Definition LedgerData.cpp:117
+
ripple::doLedgerDataGrpc
std::pair< org::xrpl::rpc::v1::GetLedgerDataResponse, grpc::Status > doLedgerDataGrpc(RPC::GRPCContext< org::xrpl::rpc::v1::GetLedgerDataRequest > &context)
Definition LedgerData.cpp:118
std
STL namespace.
diff --git a/GatewayBalances_8cpp_source.html b/GatewayBalances_8cpp_source.html index f51b60484b..1aa9ad25da 100644 --- a/GatewayBalances_8cpp_source.html +++ b/GatewayBalances_8cpp_source.html @@ -84,7 +84,7 @@ $(document).ready(function() { init_codefold(0); });
1#include <xrpld/app/main/Application.h>
2#include <xrpld/app/paths/TrustLine.h>
3#include <xrpld/rpc/Context.h>
-
4#include <xrpld/rpc/detail/RPCHelpers.h>
+
4#include <xrpld/rpc/detail/RPCLedgerHelpers.h>
5
6#include <xrpl/ledger/ReadView.h>
7#include <xrpl/protocol/AccountID.h>
@@ -373,7 +373,7 @@ $(document).ready(function() { init_codefold(0); });
std::set::insert
T insert(T... args)
ripple::RPC::inject_error
void inject_error(error_code_i code, JsonValue &json)
Add or update the json update to reflect the error code.
Definition ErrorCodes.h:214
-
ripple::RPC::lookupLedger
Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
Definition RPCHelpers.cpp:606
+
ripple::RPC::lookupLedger
Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
Definition RPCLedgerHelpers.cpp:305
ripple::RPC::missing_field_error
Json::Value missing_field_error(std::string const &name)
Definition ErrorCodes.h:264
ripple::Resource::feeHeavyBurdenRPC
Charge const feeHeavyBurdenRPC
ripple::credentials::valid
TER valid(STTx const &tx, ReadView const &view, AccountID const &src, beast::Journal j)
Definition CredentialHelpers.cpp:137
diff --git a/GetAggregatePrice_8cpp_source.html b/GetAggregatePrice_8cpp_source.html index a45dd7f620..19e113aedc 100644 --- a/GetAggregatePrice_8cpp_source.html +++ b/GetAggregatePrice_8cpp_source.html @@ -84,7 +84,7 @@ $(document).ready(function() { init_codefold(0); });
1#include <xrpld/app/ledger/LedgerMaster.h>
2#include <xrpld/app/main/Application.h>
3#include <xrpld/rpc/Context.h>
-
4#include <xrpld/rpc/detail/RPCHelpers.h>
+
4#include <xrpld/rpc/detail/RPCLedgerHelpers.h>
5
6#include <xrpl/json/json_value.h>
7#include <xrpl/ledger/ReadView.h>
@@ -468,7 +468,7 @@ $(document).ready(function() { init_codefold(0); });
std::make_optional
T make_optional(T... args)
beast::lexicalCastChecked
bool lexicalCastChecked(Out &out, In in)
Intelligently convert from one type to another.
Definition LexicalCast.h:181
ripple::RPC::inject_error
void inject_error(error_code_i code, JsonValue &json)
Add or update the json update to reflect the error code.
Definition ErrorCodes.h:214
-
ripple::RPC::lookupLedger
Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
Definition RPCHelpers.cpp:606
+
ripple::RPC::lookupLedger
Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
Definition RPCLedgerHelpers.cpp:305
ripple::RPC::missing_field_error
Json::Value missing_field_error(std::string const &name)
Definition ErrorCodes.h:264
ripple::keylet::oracle
Keylet oracle(AccountID const &account, std::uint32_t const &documentID) noexcept
Definition Indexes.cpp:501
ripple
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition algorithm.h:6
diff --git a/Handler_8cpp_source.html b/Handler_8cpp_source.html index a928d93874..4a7b95ef1b 100644 --- a/Handler_8cpp_source.html +++ b/Handler_8cpp_source.html @@ -424,26 +424,26 @@ $(document).ready(function() { init_codefold(0); });
ripple::doGetAggregatePrice
Json::Value doGetAggregatePrice(RPC::JsonContext &context)
oracles: array of {account, oracle_document_id} base_asset: is the asset to be priced quote_asset: is...
Definition GetAggregatePrice.cpp:134
ripple::doSubmitMultiSigned
Json::Value doSubmitMultiSigned(RPC::JsonContext &)
Definition SubmitMultiSigned.cpp:15
ripple::doLedgerEntry
Json::Value doLedgerEntry(RPC::JsonContext &)
Definition LedgerEntry.cpp:682
-
ripple::doNFTBuyOffers
Json::Value doNFTBuyOffers(RPC::JsonContext &)
Definition NFTOffers.cpp:146
+
ripple::doNFTBuyOffers
Json::Value doNFTBuyOffers(RPC::JsonContext &)
Definition NFTOffers.cpp:147
ripple::doChannelAuthorize
Json::Value doChannelAuthorize(RPC::JsonContext &)
Definition PayChanClaim.cpp:23
-
ripple::doNoRippleCheck
Json::Value doNoRippleCheck(RPC::JsonContext &)
Definition NoRippleCheck.cpp:43
+
ripple::doNoRippleCheck
Json::Value doNoRippleCheck(RPC::JsonContext &)
Definition NoRippleCheck.cpp:44
ripple::doTransactionEntry
Json::Value doTransactionEntry(RPC::JsonContext &)
Definition TransactionEntry.cpp:19
ripple::doConsensusInfo
Json::Value doConsensusInfo(RPC::JsonContext &context)
Definition ConsensusInfo.cpp:11
-
ripple::doBookChanges
Json::Value doBookChanges(RPC::JsonContext &context)
Definition BookOffers.cpp:203
+
ripple::doBookChanges
Json::Value doBookChanges(RPC::JsonContext &context)
Definition BookOffers.cpp:204
ripple::doLedgerRequest
Json::Value doLedgerRequest(RPC::JsonContext &)
Definition LedgerRequest.cpp:17
ripple::doSimulate
Json::Value doSimulate(RPC::JsonContext &)
Definition Simulate.cpp:301
ripple::doPeerReservationsAdd
Json::Value doPeerReservationsAdd(RPC::JsonContext &)
Definition Reservations.cpp:17
ripple::doLedgerCleaner
Json::Value doLedgerCleaner(RPC::JsonContext &)
Definition LedgerCleanerHandler.cpp:11
ripple::doSign
Json::Value doSign(RPC::JsonContext &)
Definition SignHandler.cpp:15
ripple::doAccountTxJson
Json::Value doAccountTxJson(RPC::JsonContext &context)
Definition AccountTx.cpp:391
-
ripple::doAccountLines
Json::Value doAccountLines(RPC::JsonContext &context)
Definition AccountLines.cpp:62
+
ripple::doAccountLines
Json::Value doAccountLines(RPC::JsonContext &context)
Definition AccountLines.cpp:63
ripple::doTxJson
Json::Value doTxJson(RPC::JsonContext &)
Definition Tx.cpp:266
-
ripple::doAMMInfo
Json::Value doAMMInfo(RPC::JsonContext &context)
Definition AMMInfo.cpp:57
+
ripple::doAMMInfo
Json::Value doAMMInfo(RPC::JsonContext &context)
Definition AMMInfo.cpp:58
ripple::doPeerReservationsList
Json::Value doPeerReservationsList(RPC::JsonContext &)
Definition Reservations.cpp:97
ripple::doServerInfo
Json::Value doServerInfo(RPC::JsonContext &)
Definition ServerInfo.cpp:12
ripple::doFee
Json::Value doFee(RPC::JsonContext &context)
Definition Fee1.cpp:11
ripple::doConnect
Json::Value doConnect(RPC::JsonContext &context)
Definition Connect.cpp:20
-
ripple::doNFTSellOffers
Json::Value doNFTSellOffers(RPC::JsonContext &)
Definition NFTOffers.cpp:132
+
ripple::doNFTSellOffers
Json::Value doNFTSellOffers(RPC::JsonContext &)
Definition NFTOffers.cpp:133
ripple::doDepositAuthorized
Json::Value doDepositAuthorized(RPC::JsonContext &context)
Definition DepositAuthorized.cpp:22
ripple::doStop
Json::Value doStop(RPC::JsonContext &)
Definition Stop.cpp:13
ripple::doLedgerClosed
Json::Value doLedgerClosed(RPC::JsonContext &)
Definition LedgerClosed.cpp:11
@@ -451,9 +451,9 @@ $(document).ready(function() { init_codefold(0); });
ripple::doSubmit
Json::Value doSubmit(RPC::JsonContext &)
Definition Submit.cpp:26
ripple::doServerDefinitions
Json::Value doServerDefinitions(RPC::JsonContext &)
Definition ServerDefinitions.cpp:279
ripple::doSubscribe
Json::Value doSubscribe(RPC::JsonContext &)
Definition Subscribe.cpp:19
-
ripple::doAccountObjects
Json::Value doAccountObjects(RPC::JsonContext &context)
Definition AccountObjects.cpp:162
+
ripple::doAccountObjects
Json::Value doAccountObjects(RPC::JsonContext &context)
Definition AccountObjects.cpp:355
ripple::doFeature
Json::Value doFeature(RPC::JsonContext &context)
Definition Feature1.cpp:17
-
ripple::doAccountNFTs
Json::Value doAccountNFTs(RPC::JsonContext &context)
General RPC command that can retrieve objects in the account root.
Definition AccountObjects.cpp:31
+
ripple::doAccountNFTs
Json::Value doAccountNFTs(RPC::JsonContext &context)
General RPC command that can retrieve objects in the account root.
Definition AccountObjects.cpp:32
ripple::doFetchInfo
Json::Value doFetchInfo(RPC::JsonContext &context)
Definition FetchInfo.cpp:11
ripple::doLedgerHeader
Json::Value doLedgerHeader(RPC::JsonContext &)
Definition xrpld/rpc/handlers/LedgerHeader.cpp:15
ripple::doRandom
Json::Value doRandom(RPC::JsonContext &)
Definition Random.cpp:20
@@ -461,25 +461,25 @@ $(document).ready(function() { init_codefold(0); });
ripple::doManifest
Json::Value doManifest(RPC::JsonContext &context)
Definition DoManifest.cpp:13
ripple::doPing
Json::Value doPing(RPC::JsonContext &)
Definition Ping.cpp:14
ripple::doBlackList
Json::Value doBlackList(RPC::JsonContext &context)
Definition BlackList.cpp:10
-
ripple::doLedgerData
Json::Value doLedgerData(RPC::JsonContext &)
Definition LedgerData.cpp:27
+
ripple::doLedgerData
Json::Value doLedgerData(RPC::JsonContext &)
Definition LedgerData.cpp:28
ripple::doValidatorListSites
Json::Value doValidatorListSites(RPC::JsonContext &)
Definition ValidatorListSites.cpp:10
ripple::doSignFor
Json::Value doSignFor(RPC::JsonContext &)
Definition SignFor.cpp:16
ripple::doLedgerCurrent
Json::Value doLedgerCurrent(RPC::JsonContext &)
Definition LedgerCurrent.cpp:11
-
ripple::doAccountOffers
Json::Value doAccountOffers(RPC::JsonContext &context)
Definition AccountOffers.cpp:38
+
ripple::doAccountOffers
Json::Value doAccountOffers(RPC::JsonContext &context)
Definition AccountOffers.cpp:39
ripple::doValidatorInfo
Json::Value doValidatorInfo(RPC::JsonContext &)
Definition ValidatorInfo.cpp:14
ripple::doGatewayBalances
Json::Value doGatewayBalances(RPC::JsonContext &context)
Definition GatewayBalances.cpp:35
ripple::range
ClosedInterval< T > range(T low, T high)
Create a closed range interval.
Definition RangeSet.h:35
ripple::doRipplePathFind
Json::Value doRipplePathFind(RPC::JsonContext &)
Definition RipplePathFind.cpp:14
-
ripple::doBookOffers
Json::Value doBookOffers(RPC::JsonContext &context)
Definition BookOffers.cpp:18
+
ripple::doBookOffers
Json::Value doBookOffers(RPC::JsonContext &context)
Definition BookOffers.cpp:19
ripple::doAccountCurrencies
Json::Value doAccountCurrencies(RPC::JsonContext &context)
Definition AccountCurrenciesHandler.cpp:13
-
ripple::doAccountInfo
Json::Value doAccountInfo(RPC::JsonContext &context)
Definition AccountInfo.cpp:31
+
ripple::doAccountInfo
Json::Value doAccountInfo(RPC::JsonContext &context)
Definition AccountInfo.cpp:32
ripple::doLogRotate
Json::Value doLogRotate(RPC::JsonContext &)
Definition LogRotate.cpp:10
ripple::doCanDelete
Json::Value doCanDelete(RPC::JsonContext &context)
Definition CanDelete.cpp:16
ripple::doWalletPropose
Json::Value doWalletPropose(RPC::JsonContext &)
Definition WalletPropose.cpp:49
ripple::doVaultInfo
Json::Value doVaultInfo(RPC::JsonContext &)
Definition VaultInfo.cpp:60
-
ripple::doAccountChannels
Json::Value doAccountChannels(RPC::JsonContext &context)
Definition AccountChannels.cpp:49
+
ripple::doAccountChannels
Json::Value doAccountChannels(RPC::JsonContext &context)
Definition AccountChannels.cpp:50
ripple::doPeerReservationsDel
Json::Value doPeerReservationsDel(RPC::JsonContext &)
Definition Reservations.cpp:70
ripple::doValidators
Json::Value doValidators(RPC::JsonContext &)
Definition Validators.cpp:10
ripple::doOwnerInfo
Json::Value doOwnerInfo(RPC::JsonContext &)
Definition OwnerInfo.cpp:16
diff --git a/Handlers_8h_source.html b/Handlers_8h_source.html index 14f7113aae..d8157a2546 100644 --- a/Handlers_8h_source.html +++ b/Handlers_8h_source.html @@ -248,26 +248,26 @@ $(document).ready(function() { init_codefold(0); });
ripple::doGetAggregatePrice
Json::Value doGetAggregatePrice(RPC::JsonContext &context)
oracles: array of {account, oracle_document_id} base_asset: is the asset to be priced quote_asset: is...
Definition GetAggregatePrice.cpp:134
ripple::doSubmitMultiSigned
Json::Value doSubmitMultiSigned(RPC::JsonContext &)
Definition SubmitMultiSigned.cpp:15
ripple::doLedgerEntry
Json::Value doLedgerEntry(RPC::JsonContext &)
Definition LedgerEntry.cpp:682
-
ripple::doNFTBuyOffers
Json::Value doNFTBuyOffers(RPC::JsonContext &)
Definition NFTOffers.cpp:146
+
ripple::doNFTBuyOffers
Json::Value doNFTBuyOffers(RPC::JsonContext &)
Definition NFTOffers.cpp:147
ripple::doChannelAuthorize
Json::Value doChannelAuthorize(RPC::JsonContext &)
Definition PayChanClaim.cpp:23
-
ripple::doNoRippleCheck
Json::Value doNoRippleCheck(RPC::JsonContext &)
Definition NoRippleCheck.cpp:43
+
ripple::doNoRippleCheck
Json::Value doNoRippleCheck(RPC::JsonContext &)
Definition NoRippleCheck.cpp:44
ripple::doTransactionEntry
Json::Value doTransactionEntry(RPC::JsonContext &)
Definition TransactionEntry.cpp:19
ripple::doConsensusInfo
Json::Value doConsensusInfo(RPC::JsonContext &context)
Definition ConsensusInfo.cpp:11
-
ripple::doBookChanges
Json::Value doBookChanges(RPC::JsonContext &context)
Definition BookOffers.cpp:203
+
ripple::doBookChanges
Json::Value doBookChanges(RPC::JsonContext &context)
Definition BookOffers.cpp:204
ripple::doLedgerRequest
Json::Value doLedgerRequest(RPC::JsonContext &)
Definition LedgerRequest.cpp:17
ripple::doSimulate
Json::Value doSimulate(RPC::JsonContext &)
Definition Simulate.cpp:301
ripple::doPeerReservationsAdd
Json::Value doPeerReservationsAdd(RPC::JsonContext &)
Definition Reservations.cpp:17
ripple::doLedgerCleaner
Json::Value doLedgerCleaner(RPC::JsonContext &)
Definition LedgerCleanerHandler.cpp:11
ripple::doSign
Json::Value doSign(RPC::JsonContext &)
Definition SignHandler.cpp:15
ripple::doAccountTxJson
Json::Value doAccountTxJson(RPC::JsonContext &context)
Definition AccountTx.cpp:391
-
ripple::doAccountLines
Json::Value doAccountLines(RPC::JsonContext &context)
Definition AccountLines.cpp:62
+
ripple::doAccountLines
Json::Value doAccountLines(RPC::JsonContext &context)
Definition AccountLines.cpp:63
ripple::doTxJson
Json::Value doTxJson(RPC::JsonContext &)
Definition Tx.cpp:266
-
ripple::doAMMInfo
Json::Value doAMMInfo(RPC::JsonContext &context)
Definition AMMInfo.cpp:57
+
ripple::doAMMInfo
Json::Value doAMMInfo(RPC::JsonContext &context)
Definition AMMInfo.cpp:58
ripple::doPeerReservationsList
Json::Value doPeerReservationsList(RPC::JsonContext &)
Definition Reservations.cpp:97
ripple::doServerInfo
Json::Value doServerInfo(RPC::JsonContext &)
Definition ServerInfo.cpp:12
ripple::doFee
Json::Value doFee(RPC::JsonContext &context)
Definition Fee1.cpp:11
ripple::doConnect
Json::Value doConnect(RPC::JsonContext &context)
Definition Connect.cpp:20
-
ripple::doNFTSellOffers
Json::Value doNFTSellOffers(RPC::JsonContext &)
Definition NFTOffers.cpp:132
+
ripple::doNFTSellOffers
Json::Value doNFTSellOffers(RPC::JsonContext &)
Definition NFTOffers.cpp:133
ripple::doDepositAuthorized
Json::Value doDepositAuthorized(RPC::JsonContext &context)
Definition DepositAuthorized.cpp:22
ripple::doStop
Json::Value doStop(RPC::JsonContext &)
Definition Stop.cpp:13
ripple::doLedgerClosed
Json::Value doLedgerClosed(RPC::JsonContext &)
Definition LedgerClosed.cpp:11
@@ -275,9 +275,9 @@ $(document).ready(function() { init_codefold(0); });
ripple::doSubmit
Json::Value doSubmit(RPC::JsonContext &)
Definition Submit.cpp:26
ripple::doServerDefinitions
Json::Value doServerDefinitions(RPC::JsonContext &)
Definition ServerDefinitions.cpp:279
ripple::doSubscribe
Json::Value doSubscribe(RPC::JsonContext &)
Definition Subscribe.cpp:19
-
ripple::doAccountObjects
Json::Value doAccountObjects(RPC::JsonContext &context)
Definition AccountObjects.cpp:162
+
ripple::doAccountObjects
Json::Value doAccountObjects(RPC::JsonContext &context)
Definition AccountObjects.cpp:355
ripple::doFeature
Json::Value doFeature(RPC::JsonContext &context)
Definition Feature1.cpp:17
-
ripple::doAccountNFTs
Json::Value doAccountNFTs(RPC::JsonContext &context)
General RPC command that can retrieve objects in the account root.
Definition AccountObjects.cpp:31
+
ripple::doAccountNFTs
Json::Value doAccountNFTs(RPC::JsonContext &context)
General RPC command that can retrieve objects in the account root.
Definition AccountObjects.cpp:32
ripple::doFetchInfo
Json::Value doFetchInfo(RPC::JsonContext &context)
Definition FetchInfo.cpp:11
ripple::doLedgerHeader
Json::Value doLedgerHeader(RPC::JsonContext &)
Definition xrpld/rpc/handlers/LedgerHeader.cpp:15
ripple::doPause
Json::Value doPause(RPC::JsonContext &)
@@ -286,22 +286,22 @@ $(document).ready(function() { init_codefold(0); });
ripple::doManifest
Json::Value doManifest(RPC::JsonContext &context)
Definition DoManifest.cpp:13
ripple::doPing
Json::Value doPing(RPC::JsonContext &)
Definition Ping.cpp:14
ripple::doBlackList
Json::Value doBlackList(RPC::JsonContext &context)
Definition BlackList.cpp:10
-
ripple::doLedgerData
Json::Value doLedgerData(RPC::JsonContext &)
Definition LedgerData.cpp:27
+
ripple::doLedgerData
Json::Value doLedgerData(RPC::JsonContext &)
Definition LedgerData.cpp:28
ripple::doValidatorListSites
Json::Value doValidatorListSites(RPC::JsonContext &)
Definition ValidatorListSites.cpp:10
ripple::doSignFor
Json::Value doSignFor(RPC::JsonContext &)
Definition SignFor.cpp:16
ripple::doLedgerCurrent
Json::Value doLedgerCurrent(RPC::JsonContext &)
Definition LedgerCurrent.cpp:11
-
ripple::doAccountOffers
Json::Value doAccountOffers(RPC::JsonContext &context)
Definition AccountOffers.cpp:38
+
ripple::doAccountOffers
Json::Value doAccountOffers(RPC::JsonContext &context)
Definition AccountOffers.cpp:39
ripple::doValidatorInfo
Json::Value doValidatorInfo(RPC::JsonContext &)
Definition ValidatorInfo.cpp:14
ripple::doGatewayBalances
Json::Value doGatewayBalances(RPC::JsonContext &context)
Definition GatewayBalances.cpp:35
ripple::doRipplePathFind
Json::Value doRipplePathFind(RPC::JsonContext &)
Definition RipplePathFind.cpp:14
-
ripple::doBookOffers
Json::Value doBookOffers(RPC::JsonContext &context)
Definition BookOffers.cpp:18
+
ripple::doBookOffers
Json::Value doBookOffers(RPC::JsonContext &context)
Definition BookOffers.cpp:19
ripple::doAccountCurrencies
Json::Value doAccountCurrencies(RPC::JsonContext &context)
Definition AccountCurrenciesHandler.cpp:13
-
ripple::doAccountInfo
Json::Value doAccountInfo(RPC::JsonContext &context)
Definition AccountInfo.cpp:31
+
ripple::doAccountInfo
Json::Value doAccountInfo(RPC::JsonContext &context)
Definition AccountInfo.cpp:32
ripple::doLogRotate
Json::Value doLogRotate(RPC::JsonContext &)
Definition LogRotate.cpp:10
ripple::doCanDelete
Json::Value doCanDelete(RPC::JsonContext &context)
Definition CanDelete.cpp:16
ripple::doWalletPropose
Json::Value doWalletPropose(RPC::JsonContext &)
Definition WalletPropose.cpp:49
ripple::doVaultInfo
Json::Value doVaultInfo(RPC::JsonContext &)
Definition VaultInfo.cpp:60
-
ripple::doAccountChannels
Json::Value doAccountChannels(RPC::JsonContext &context)
Definition AccountChannels.cpp:49
+
ripple::doAccountChannels
Json::Value doAccountChannels(RPC::JsonContext &context)
Definition AccountChannels.cpp:50
ripple::doPeerReservationsDel
Json::Value doPeerReservationsDel(RPC::JsonContext &)
Definition Reservations.cpp:70
ripple::doValidators
Json::Value doValidators(RPC::JsonContext &)
Definition Validators.cpp:10
ripple::doOwnerInfo
Json::Value doOwnerInfo(RPC::JsonContext &)
Definition OwnerInfo.cpp:16
diff --git a/KeyGeneration__test_8cpp_source.html b/KeyGeneration__test_8cpp_source.html index d99fcade4c..71db791287 100644 --- a/KeyGeneration__test_8cpp_source.html +++ b/KeyGeneration__test_8cpp_source.html @@ -1031,7 +1031,7 @@ $(document).ready(function() { init_codefold(0); });
ripple::RPC::contains_error
bool contains_error(Json::Value const &json)
Returns true if the json contains an rpc error specification.
Definition ErrorCodes.cpp:188
ripple::RPC::strong_brain_strings
static key_strings const strong_brain_strings
Definition KeyGeneration_test.cpp:64
ripple::RPC::secp256k1_strings
static key_strings const secp256k1_strings
Definition KeyGeneration_test.cpp:36
-
ripple::RPC::keypairForSignature
std::optional< std::pair< PublicKey, SecretKey > > keypairForSignature(Json::Value const &params, Json::Value &error, unsigned int apiVersion)
Definition RPCHelpers.cpp:785
+
ripple::RPC::keypairForSignature
std::optional< std::pair< PublicKey, SecretKey > > keypairForSignature(Json::Value const &params, Json::Value &error, unsigned int apiVersion)
Definition RPCHelpers.cpp:278
ripple
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition algorithm.h:6
ripple::toBase58
std::string toBase58(AccountID const &v)
Convert AccountID to base58 checked string.
Definition AccountID.cpp:95
diff --git a/LedgerData_8cpp_source.html b/LedgerData_8cpp_source.html index 374503e277..39bffa1da2 100644 --- a/LedgerData_8cpp_source.html +++ b/LedgerData_8cpp_source.html @@ -86,199 +86,200 @@ $(document).ready(function() { init_codefold(0); });
3#include <xrpld/rpc/GRPCHandlers.h>
4#include <xrpld/rpc/Role.h>
5#include <xrpld/rpc/detail/RPCHelpers.h>
-
6#include <xrpld/rpc/detail/Tuning.h>
-
7
-
8#include <xrpl/ledger/ReadView.h>
-
9#include <xrpl/protocol/ErrorCodes.h>
-
10#include <xrpl/protocol/LedgerFormats.h>
-
11#include <xrpl/protocol/jss.h>
-
12
-
13namespace ripple {
-
14
-
15// Get state nodes from a ledger
-
16// Inputs:
-
17// limit: integer, maximum number of entries
-
18// marker: opaque, resume point
-
19// binary: boolean, format
-
20// type: string // optional, defaults to all ledger node types
-
21// Outputs:
-
22// ledger_hash: chosen ledger's hash
-
23// ledger_index: chosen ledger's index
-
24// state: array of state nodes
-
25// marker: resume point, if any
-
26Json::Value
-
-
27doLedgerData(RPC::JsonContext& context)
-
28{
-
29 std::shared_ptr<ReadView const> lpLedger;
-
30 auto const& params = context.params;
-
31
-
32 auto jvResult = RPC::lookupLedger(lpLedger, context);
-
33 if (!lpLedger)
-
34 return jvResult;
-
35
-
36 bool const isMarker = params.isMember(jss::marker);
-
37 ReadView::key_type key = ReadView::key_type();
-
38 if (isMarker)
-
39 {
-
40 Json::Value const& jMarker = params[jss::marker];
-
41 if (!(jMarker.isString() && key.parseHex(jMarker.asString())))
-
42 return RPC::expected_field_error(jss::marker, "valid");
-
43 }
-
44
-
45 bool const isBinary = params[jss::binary].asBool();
-
46
-
47 int limit = -1;
-
48 if (params.isMember(jss::limit))
-
49 {
-
50 Json::Value const& jLimit = params[jss::limit];
-
51 if (!jLimit.isIntegral())
-
52 return RPC::expected_field_error(jss::limit, "integer");
-
53
-
54 limit = jLimit.asInt();
-
55 }
-
56
-
57 auto maxLimit = RPC::Tuning::pageLength(isBinary);
-
58 if ((limit < 0) || ((limit > maxLimit) && (!isUnlimited(context.role))))
-
59 limit = maxLimit;
-
60
-
61 jvResult[jss::ledger_hash] = to_string(lpLedger->info().hash);
-
62 jvResult[jss::ledger_index] = lpLedger->info().seq;
-
63
-
64 if (!isMarker)
-
65 {
-
66 // Return base ledger data on first query
-
67 jvResult[jss::ledger] = getJson(LedgerFill(
-
68 *lpLedger, &context, isBinary ? LedgerFill::Options::binary : 0));
-
69 }
-
70
-
71 auto [rpcStatus, type] = RPC::chooseLedgerEntryType(params);
-
72 if (rpcStatus)
-
73 {
-
74 jvResult.clear();
-
75 rpcStatus.inject(jvResult);
-
76 return jvResult;
-
77 }
-
78 Json::Value& nodes = jvResult[jss::state];
-
79 if (nodes.type() == Json::nullValue)
-
80 {
-
81 nodes = Json::Value(Json::arrayValue);
-
82 }
-
83
-
84 auto e = lpLedger->sles.end();
-
85 for (auto i = lpLedger->sles.upper_bound(key); i != e; ++i)
-
86 {
-
87 auto sle = lpLedger->read(keylet::unchecked((*i)->key()));
-
88 if (limit-- <= 0)
-
89 {
-
90 // Stop processing before the current key.
-
91 auto k = sle->key();
-
92 jvResult[jss::marker] = to_string(--k);
-
93 break;
-
94 }
-
95
-
96 if (type == ltANY || sle->getType() == type)
-
97 {
-
98 if (isBinary)
-
99 {
-
100 Json::Value& entry = nodes.append(Json::objectValue);
-
101 entry[jss::data] = serializeHex(*sle);
-
102 entry[jss::index] = to_string(sle->key());
-
103 }
-
104 else
-
105 {
-
106 Json::Value& entry =
-
107 nodes.append(sle->getJson(JsonOptions::none));
-
108 entry[jss::index] = to_string(sle->key());
-
109 }
-
110 }
-
111 }
-
112
-
113 return jvResult;
-
114}
+
6#include <xrpld/rpc/detail/RPCLedgerHelpers.h>
+
7#include <xrpld/rpc/detail/Tuning.h>
+
8
+
9#include <xrpl/ledger/ReadView.h>
+
10#include <xrpl/protocol/ErrorCodes.h>
+
11#include <xrpl/protocol/LedgerFormats.h>
+
12#include <xrpl/protocol/jss.h>
+
13
+
14namespace ripple {
+
15
+
16// Get state nodes from a ledger
+
17// Inputs:
+
18// limit: integer, maximum number of entries
+
19// marker: opaque, resume point
+
20// binary: boolean, format
+
21// type: string // optional, defaults to all ledger node types
+
22// Outputs:
+
23// ledger_hash: chosen ledger's hash
+
24// ledger_index: chosen ledger's index
+
25// state: array of state nodes
+
26// marker: resume point, if any
+
27Json::Value
+
+
28doLedgerData(RPC::JsonContext& context)
+
29{
+
30 std::shared_ptr<ReadView const> lpLedger;
+
31 auto const& params = context.params;
+
32
+
33 auto jvResult = RPC::lookupLedger(lpLedger, context);
+
34 if (!lpLedger)
+
35 return jvResult;
+
36
+
37 bool const isMarker = params.isMember(jss::marker);
+
38 ReadView::key_type key = ReadView::key_type();
+
39 if (isMarker)
+
40 {
+
41 Json::Value const& jMarker = params[jss::marker];
+
42 if (!(jMarker.isString() && key.parseHex(jMarker.asString())))
+
43 return RPC::expected_field_error(jss::marker, "valid");
+
44 }
+
45
+
46 bool const isBinary = params[jss::binary].asBool();
+
47
+
48 int limit = -1;
+
49 if (params.isMember(jss::limit))
+
50 {
+
51 Json::Value const& jLimit = params[jss::limit];
+
52 if (!jLimit.isIntegral())
+
53 return RPC::expected_field_error(jss::limit, "integer");
+
54
+
55 limit = jLimit.asInt();
+
56 }
+
57
+
58 auto maxLimit = RPC::Tuning::pageLength(isBinary);
+
59 if ((limit < 0) || ((limit > maxLimit) && (!isUnlimited(context.role))))
+
60 limit = maxLimit;
+
61
+
62 jvResult[jss::ledger_hash] = to_string(lpLedger->info().hash);
+
63 jvResult[jss::ledger_index] = lpLedger->info().seq;
+
64
+
65 if (!isMarker)
+
66 {
+
67 // Return base ledger data on first query
+
68 jvResult[jss::ledger] = getJson(LedgerFill(
+
69 *lpLedger, &context, isBinary ? LedgerFill::Options::binary : 0));
+
70 }
+
71
+
72 auto [rpcStatus, type] = RPC::chooseLedgerEntryType(params);
+
73 if (rpcStatus)
+
74 {
+
75 jvResult.clear();
+
76 rpcStatus.inject(jvResult);
+
77 return jvResult;
+
78 }
+
79 Json::Value& nodes = jvResult[jss::state];
+
80 if (nodes.type() == Json::nullValue)
+
81 {
+
82 nodes = Json::Value(Json::arrayValue);
+
83 }
+
84
+
85 auto e = lpLedger->sles.end();
+
86 for (auto i = lpLedger->sles.upper_bound(key); i != e; ++i)
+
87 {
+
88 auto sle = lpLedger->read(keylet::unchecked((*i)->key()));
+
89 if (limit-- <= 0)
+
90 {
+
91 // Stop processing before the current key.
+
92 auto k = sle->key();
+
93 jvResult[jss::marker] = to_string(--k);
+
94 break;
+
95 }
+
96
+
97 if (type == ltANY || sle->getType() == type)
+
98 {
+
99 if (isBinary)
+
100 {
+
101 Json::Value& entry = nodes.append(Json::objectValue);
+
102 entry[jss::data] = serializeHex(*sle);
+
103 entry[jss::index] = to_string(sle->key());
+
104 }
+
105 else
+
106 {
+
107 Json::Value& entry =
+
108 nodes.append(sle->getJson(JsonOptions::none));
+
109 entry[jss::index] = to_string(sle->key());
+
110 }
+
111 }
+
112 }
+
113
+
114 return jvResult;
+
115}
-
115
-
116std::pair<org::xrpl::rpc::v1::GetLedgerDataResponse, grpc::Status>
-
-
117doLedgerDataGrpc(
-
118 RPC::GRPCContext<org::xrpl::rpc::v1::GetLedgerDataRequest>& context)
-
119{
-
120 org::xrpl::rpc::v1::GetLedgerDataRequest& request = context.params;
-
121 org::xrpl::rpc::v1::GetLedgerDataResponse response;
-
122 grpc::Status status = grpc::Status::OK;
-
123
-
124 std::shared_ptr<ReadView const> ledger;
-
125 if (auto status = RPC::ledgerFromRequest(ledger, context))
-
126 {
-
127 grpc::Status errorStatus;
-
128 if (status.toErrorCode() == rpcINVALID_PARAMS)
-
129 {
-
130 errorStatus = grpc::Status(
-
131 grpc::StatusCode::INVALID_ARGUMENT, status.message());
-
132 }
-
133 else
-
134 {
-
135 errorStatus =
-
136 grpc::Status(grpc::StatusCode::NOT_FOUND, status.message());
-
137 }
-
138 return {response, errorStatus};
-
139 }
-
140
-
141 uint256 startKey;
-
142 if (auto key = uint256::fromVoidChecked(request.marker()))
-
143 {
-
144 startKey = *key;
-
145 }
-
146 else if (request.marker().size() != 0)
-
147 {
-
148 grpc::Status errorStatus{
-
149 grpc::StatusCode::INVALID_ARGUMENT, "marker malformed"};
-
150 return {response, errorStatus};
-
151 }
-
152
-
153 auto e = ledger->sles.end();
-
154 if (request.end_marker().size() != 0)
-
155 {
-
156 auto const key = uint256::fromVoidChecked(request.end_marker());
-
157
-
158 if (!key)
-
159 return {
-
160 response,
-
161 {grpc::StatusCode::INVALID_ARGUMENT, "end marker malformed"}};
-
162
-
163 if (*key < startKey)
-
164 return {
-
165 response,
-
166 {grpc::StatusCode::INVALID_ARGUMENT,
-
167 "end marker out of range"}};
-
168
-
169 e = ledger->sles.upper_bound(*key);
-
170 }
-
171
-
172 int maxLimit = RPC::Tuning::pageLength(true);
-
173
-
174 for (auto i = ledger->sles.upper_bound(startKey); i != e; ++i)
-
175 {
-
176 auto sle = ledger->read(keylet::unchecked((*i)->key()));
-
177 if (maxLimit-- <= 0)
-
178 {
-
179 // Stop processing before the current key.
-
180 auto k = sle->key();
-
181 --k;
-
182 response.set_marker(k.data(), k.size());
-
183 break;
-
184 }
-
185 auto stateObject = response.mutable_ledger_objects()->add_objects();
-
186 Serializer s;
-
187 sle->add(s);
-
188 stateObject->set_data(s.peekData().data(), s.getLength());
-
189 stateObject->set_key(sle->key().data(), sle->key().size());
-
190 }
-
191 return {response, status};
-
192}
+
116
+
117std::pair<org::xrpl::rpc::v1::GetLedgerDataResponse, grpc::Status>
+
+
118doLedgerDataGrpc(
+
119 RPC::GRPCContext<org::xrpl::rpc::v1::GetLedgerDataRequest>& context)
+
120{
+
121 org::xrpl::rpc::v1::GetLedgerDataRequest& request = context.params;
+
122 org::xrpl::rpc::v1::GetLedgerDataResponse response;
+
123 grpc::Status status = grpc::Status::OK;
+
124
+
125 std::shared_ptr<ReadView const> ledger;
+
126 if (auto status = RPC::ledgerFromRequest(ledger, context))
+
127 {
+
128 grpc::Status errorStatus;
+
129 if (status.toErrorCode() == rpcINVALID_PARAMS)
+
130 {
+
131 errorStatus = grpc::Status(
+
132 grpc::StatusCode::INVALID_ARGUMENT, status.message());
+
133 }
+
134 else
+
135 {
+
136 errorStatus =
+
137 grpc::Status(grpc::StatusCode::NOT_FOUND, status.message());
+
138 }
+
139 return {response, errorStatus};
+
140 }
+
141
+
142 uint256 startKey;
+
143 if (auto key = uint256::fromVoidChecked(request.marker()))
+
144 {
+
145 startKey = *key;
+
146 }
+
147 else if (request.marker().size() != 0)
+
148 {
+
149 grpc::Status errorStatus{
+
150 grpc::StatusCode::INVALID_ARGUMENT, "marker malformed"};
+
151 return {response, errorStatus};
+
152 }
+
153
+
154 auto e = ledger->sles.end();
+
155 if (request.end_marker().size() != 0)
+
156 {
+
157 auto const key = uint256::fromVoidChecked(request.end_marker());
+
158
+
159 if (!key)
+
160 return {
+
161 response,
+
162 {grpc::StatusCode::INVALID_ARGUMENT, "end marker malformed"}};
+
163
+
164 if (*key < startKey)
+
165 return {
+
166 response,
+
167 {grpc::StatusCode::INVALID_ARGUMENT,
+
168 "end marker out of range"}};
+
169
+
170 e = ledger->sles.upper_bound(*key);
+
171 }
+
172
+
173 int maxLimit = RPC::Tuning::pageLength(true);
+
174
+
175 for (auto i = ledger->sles.upper_bound(startKey); i != e; ++i)
+
176 {
+
177 auto sle = ledger->read(keylet::unchecked((*i)->key()));
+
178 if (maxLimit-- <= 0)
+
179 {
+
180 // Stop processing before the current key.
+
181 auto k = sle->key();
+
182 --k;
+
183 response.set_marker(k.data(), k.size());
+
184 break;
+
185 }
+
186 auto stateObject = response.mutable_ledger_objects()->add_objects();
+
187 Serializer s;
+
188 sle->add(s);
+
189 stateObject->set_data(s.peekData().data(), s.getLength());
+
190 stateObject->set_key(sle->key().data(), sle->key().size());
+
191 }
+
192 return {response, status};
+
193}
-
193
-
194} // namespace ripple
+
194
+
195} // namespace ripple
Json::Value
Represents a JSON value.
Definition json_value.h:131
Json::Value::append
Value & append(Value const &value)
Append value to array at the end.
Definition json_value.cpp:978
Json::Value::asInt
Int asInt() const
Definition json_value.cpp:507
@@ -298,20 +299,20 @@ $(document).ready(function() { init_codefold(0); });
Json::arrayValue
@ arrayValue
array value (ordered list)
Definition json_value.h:26
Json::objectValue
@ objectValue
object value (collection of name/value pairs).
Definition json_value.h:27
ripple::RPC::Tuning::pageLength
int constexpr pageLength(bool isBinary)
Maximum number of pages in a LedgerData response.
Definition src/xrpld/rpc/detail/Tuning.h:59
-
ripple::RPC::ledgerFromRequest
Status ledgerFromRequest(T &ledger, GRPCContext< R > &context)
Definition RPCHelpers.cpp:392
-
ripple::RPC::chooseLedgerEntryType
std::pair< RPC::Status, LedgerEntryType > chooseLedgerEntryType(Json::Value const &params)
Definition RPCHelpers.cpp:921
+
ripple::RPC::ledgerFromRequest
Status ledgerFromRequest(T &ledger, GRPCContext< R > &context)
Definition RPCLedgerHelpers.cpp:91
+
ripple::RPC::chooseLedgerEntryType
std::pair< RPC::Status, LedgerEntryType > chooseLedgerEntryType(Json::Value const &params)
Definition RPCHelpers.cpp:414
ripple::RPC::expected_field_error
Json::Value expected_field_error(std::string const &name, std::string const &type)
Definition ErrorCodes.h:330
-
ripple::RPC::lookupLedger
Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
Definition RPCHelpers.cpp:606
+
ripple::RPC::lookupLedger
Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
Definition RPCLedgerHelpers.cpp:305
ripple::keylet::unchecked
Keylet unchecked(uint256 const &key) noexcept
Any ledger entry.
Definition Indexes.cpp:349
ripple
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition algorithm.h:6
ripple::rpcINVALID_PARAMS
@ rpcINVALID_PARAMS
Definition ErrorCodes.h:65
ripple::serializeHex
std::string serializeHex(STObject const &o)
Serialize an object to a hex string.
Definition serialize.h:22
ripple::isUnlimited
bool isUnlimited(Role const &role)
ADMIN and IDENTIFIED roles shall have unlimited resources.
Definition Role.cpp:106
-
ripple::doLedgerData
Json::Value doLedgerData(RPC::JsonContext &)
Definition LedgerData.cpp:27
+
ripple::doLedgerData
Json::Value doLedgerData(RPC::JsonContext &)
Definition LedgerData.cpp:28
ripple::to_string
std::string to_string(base_uint< Bits, Tag > const &a)
Definition base_uint.h:611
ripple::ltANY
@ ltANY
A special type, matching any ledger entry type.
Definition LedgerFormats.h:59
ripple::getJson
Json::Value getJson(LedgerFill const &fill)
Return a new Json::Value representing the ledger with given options.
Definition LedgerToJson.cpp:338
-
ripple::doLedgerDataGrpc
std::pair< org::xrpl::rpc::v1::GetLedgerDataResponse, grpc::Status > doLedgerDataGrpc(RPC::GRPCContext< org::xrpl::rpc::v1::GetLedgerDataRequest > &context)
Definition LedgerData.cpp:117
+
ripple::doLedgerDataGrpc
std::pair< org::xrpl::rpc::v1::GetLedgerDataResponse, grpc::Status > doLedgerDataGrpc(RPC::GRPCContext< org::xrpl::rpc::v1::GetLedgerDataRequest > &context)
Definition LedgerData.cpp:118
diff --git a/LedgerDiff_8cpp_source.html b/LedgerDiff_8cpp_source.html index 459b410901..8ed7df21a9 100644 --- a/LedgerDiff_8cpp_source.html +++ b/LedgerDiff_8cpp_source.html @@ -82,7 +82,7 @@ $(document).ready(function() { init_codefold(0); });
1#include <xrpld/rpc/GRPCHandlers.h>
-
2#include <xrpld/rpc/detail/RPCHelpers.h>
+
2#include <xrpld/rpc/detail/RPCLedgerHelpers.h>
3
4namespace ripple {
5std::pair<org::xrpl::rpc::v1::GetLedgerDiffResponse, grpc::Status>
@@ -175,7 +175,7 @@ $(document).ready(function() { init_codefold(0); });
std::is_same_v
T is_same_v
std::numeric_limits::max
T max(T... args)
-
ripple::RPC::ledgerFromSpecifier
Status ledgerFromSpecifier(T &ledger, org::xrpl::rpc::v1::LedgerSpecifier const &specifier, Context &context)
Definition RPCHelpers.cpp:418
+
ripple::RPC::ledgerFromSpecifier
Status ledgerFromSpecifier(T &ledger, org::xrpl::rpc::v1::LedgerSpecifier const &specifier, Context &context)
Definition RPCLedgerHelpers.cpp:117
ripple
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition algorithm.h:6
ripple::doLedgerDiffGrpc
std::pair< org::xrpl::rpc::v1::GetLedgerDiffResponse, grpc::Status > doLedgerDiffGrpc(RPC::GRPCContext< org::xrpl::rpc::v1::GetLedgerDiffRequest > &context)
Definition LedgerDiff.cpp:6
diff --git a/LedgerEntry_8cpp_source.html b/LedgerEntry_8cpp_source.html index 1d47665b2d..c2be30e41a 100644 --- a/LedgerEntry_8cpp_source.html +++ b/LedgerEntry_8cpp_source.html @@ -83,7 +83,7 @@ $(document).ready(function() { init_codefold(0); });
1#include <xrpld/rpc/Context.h>
2#include <xrpld/rpc/GRPCHandlers.h>
-
3#include <xrpld/rpc/detail/RPCHelpers.h>
+
3#include <xrpld/rpc/detail/RPCLedgerHelpers.h>
4#include <xrpld/rpc/handlers/LedgerEntryHelpers.h>
5
6#include <xrpl/basics/StringUtilities.h>
@@ -1057,10 +1057,10 @@ $(document).ready(function() { init_codefold(0); });
ripple::LedgerEntryHelpers::requiredUInt32
Expected< std::uint32_t, Json::Value > requiredUInt32(Json::Value const &params, Json::StaticString const fieldName, std::string const &err)
Definition LedgerEntryHelpers.h:169
ripple::LedgerEntryHelpers::requiredUInt192
Expected< uint192, Json::Value > requiredUInt192(Json::Value const &params, Json::StaticString const fieldName, std::string const &err)
Definition LedgerEntryHelpers.h:213
ripple::LedgerEntryHelpers::requiredHexBlob
Expected< Blob, Json::Value > requiredHexBlob(Json::Value const &params, Json::StaticString const fieldName, std::size_t maxLength, std::string const &err)
Definition LedgerEntryHelpers.h:134
-
ripple::RPC::ledgerFromRequest
Status ledgerFromRequest(T &ledger, GRPCContext< R > &context)
Definition RPCHelpers.cpp:392
+
ripple::RPC::ledgerFromRequest
Status ledgerFromRequest(T &ledger, GRPCContext< R > &context)
Definition RPCLedgerHelpers.cpp:91
ripple::RPC::make_error
Json::Value make_error(error_code_i code)
Returns a new json object that reflects the error code.
Definition ErrorCodes.cpp:172
ripple::RPC::make_param_error
Json::Value make_param_error(std::string const &message)
Returns a new json object that indicates invalid parameters.
Definition ErrorCodes.h:252
-
ripple::RPC::lookupLedger
Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
Definition RPCHelpers.cpp:606
+
ripple::RPC::lookupLedger
Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
Definition RPCLedgerHelpers.cpp:305
ripple::credentials::makeSorted
std::set< std::pair< AccountID, Slice > > makeSorted(STArray const &credentials)
Definition CredentialHelpers.cpp:245
ripple::keylet::mptoken
Keylet mptoken(MPTID const &issuanceID, AccountID const &holder) noexcept
Definition Indexes.cpp:521
ripple::keylet::oracle
Keylet oracle(AccountID const &account, std::uint32_t const &documentID) noexcept
Definition Indexes.cpp:501
diff --git a/LedgerHandler_8cpp_source.html b/LedgerHandler_8cpp_source.html index 75c52c0d0b..2786896a94 100644 --- a/LedgerHandler_8cpp_source.html +++ b/LedgerHandler_8cpp_source.html @@ -86,7 +86,7 @@ $(document).ready(function() { init_codefold(0); });
3#include <xrpld/app/misc/LoadFeeTrack.h>
4#include <xrpld/rpc/GRPCHandlers.h>
5#include <xrpld/rpc/Role.h>
-
6#include <xrpld/rpc/detail/RPCHelpers.h>
+
6#include <xrpld/rpc/detail/RPCLedgerHelpers.h>
7#include <xrpld/rpc/handlers/LedgerHandler.h>
8
9#include <xrpl/protocol/ErrorCodes.h>
@@ -415,8 +415,8 @@ $(document).ready(function() { init_codefold(0); });
std::is_same_v
T is_same_v
std::numeric_limits::max
T max(T... args)
-
ripple::RPC::ledgerFromRequest
Status ledgerFromRequest(T &ledger, GRPCContext< R > &context)
Definition RPCHelpers.cpp:392
-
ripple::RPC::lookupLedger
Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
Definition RPCHelpers.cpp:606
+
ripple::RPC::ledgerFromRequest
Status ledgerFromRequest(T &ledger, GRPCContext< R > &context)
Definition RPCLedgerHelpers.cpp:91
+
ripple::RPC::lookupLedger
Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
Definition RPCLedgerHelpers.cpp:305
ripple::Resource::feeMediumBurdenRPC
Charge const feeMediumBurdenRPC
ripple::Resource::feeHeavyBurdenRPC
Charge const feeHeavyBurdenRPC
ripple::keylet::quality
Keylet quality(Keylet const &k, std::uint64_t q) noexcept
The initial directory page for a specific quality.
Definition Indexes.cpp:261
diff --git a/LedgerRequest_8cpp_source.html b/LedgerRequest_8cpp_source.html index 7e0fdc6a8c..9a90722f40 100644 --- a/LedgerRequest_8cpp_source.html +++ b/LedgerRequest_8cpp_source.html @@ -83,7 +83,7 @@ $(document).ready(function() { init_codefold(0); });
1#include <xrpld/app/ledger/LedgerToJson.h>
2#include <xrpld/rpc/Context.h>
-
3#include <xrpld/rpc/detail/RPCHelpers.h>
+
3#include <xrpld/rpc/detail/RPCLedgerHelpers.h>
4
5#include <xrpl/protocol/ErrorCodes.h>
6#include <xrpl/protocol/jss.h>
diff --git a/NFTOffers_8cpp_source.html b/NFTOffers_8cpp_source.html index 2100b48287..487e031005 100644 --- a/NFTOffers_8cpp_source.html +++ b/NFTOffers_8cpp_source.html @@ -83,171 +83,172 @@ $(document).ready(function() { init_codefold(0); });
1#include <xrpld/rpc/Context.h>
2#include <xrpld/rpc/detail/RPCHelpers.h>
-
3#include <xrpld/rpc/detail/Tuning.h>
-
4
-
5#include <xrpl/json/json_value.h>
-
6#include <xrpl/ledger/ReadView.h>
-
7#include <xrpl/ledger/View.h>
-
8#include <xrpl/protocol/ErrorCodes.h>
-
9#include <xrpl/protocol/RPCErr.h>
-
10#include <xrpl/protocol/jss.h>
-
11#include <xrpl/resource/Fees.h>
-
12
-
13namespace ripple {
-
14
-
15static void
-
-
16appendNftOfferJson(
-
17 Application const& app,
-
18 std::shared_ptr<SLE const> const& offer,
-
19 Json::Value& offers)
-
20{
-
21 Json::Value& obj(offers.append(Json::objectValue));
-
22
-
23 obj[jss::nft_offer_index] = to_string(offer->key());
-
24 obj[jss::flags] = (*offer)[sfFlags];
-
25 obj[jss::owner] = toBase58(offer->getAccountID(sfOwner));
-
26
-
27 if (offer->isFieldPresent(sfDestination))
-
28 obj[jss::destination] = toBase58(offer->getAccountID(sfDestination));
-
29
-
30 if (offer->isFieldPresent(sfExpiration))
-
31 obj[jss::expiration] = offer->getFieldU32(sfExpiration);
-
32
-
33 offer->getFieldAmount(sfAmount).setJson(obj[jss::amount]);
-
34}
+
3#include <xrpld/rpc/detail/RPCLedgerHelpers.h>
+
4#include <xrpld/rpc/detail/Tuning.h>
+
5
+
6#include <xrpl/json/json_value.h>
+
7#include <xrpl/ledger/ReadView.h>
+
8#include <xrpl/ledger/View.h>
+
9#include <xrpl/protocol/ErrorCodes.h>
+
10#include <xrpl/protocol/RPCErr.h>
+
11#include <xrpl/protocol/jss.h>
+
12#include <xrpl/resource/Fees.h>
+
13
+
14namespace ripple {
+
15
+
16static void
+
+
17appendNftOfferJson(
+
18 Application const& app,
+
19 std::shared_ptr<SLE const> const& offer,
+
20 Json::Value& offers)
+
21{
+
22 Json::Value& obj(offers.append(Json::objectValue));
+
23
+
24 obj[jss::nft_offer_index] = to_string(offer->key());
+
25 obj[jss::flags] = (*offer)[sfFlags];
+
26 obj[jss::owner] = toBase58(offer->getAccountID(sfOwner));
+
27
+
28 if (offer->isFieldPresent(sfDestination))
+
29 obj[jss::destination] = toBase58(offer->getAccountID(sfDestination));
+
30
+
31 if (offer->isFieldPresent(sfExpiration))
+
32 obj[jss::expiration] = offer->getFieldU32(sfExpiration);
+
33
+
34 offer->getFieldAmount(sfAmount).setJson(obj[jss::amount]);
+
35}
-
35
-
36// {
-
37// nft_id: <token hash>
-
38// ledger_hash : <ledger>
-
39// ledger_index : <ledger_index>
-
40// limit: integer // optional
-
41// marker: opaque // optional, resume previous query
-
42// }
-
43static Json::Value
-
-
44enumerateNFTOffers(
-
45 RPC::JsonContext& context,
-
46 uint256 const& nftId,
-
47 Keylet const& directory)
-
48{
-
49 unsigned int limit;
-
50 if (auto err = readLimitField(limit, RPC::Tuning::nftOffers, context))
-
51 return *err;
-
52
-
53 std::shared_ptr<ReadView const> ledger;
-
54
-
55 if (auto result = RPC::lookupLedger(ledger, context); !ledger)
-
56 return result;
-
57
-
58 if (!ledger->exists(directory))
-
59 return rpcError(rpcOBJECT_NOT_FOUND);
-
60
-
61 Json::Value result;
-
62 result[jss::nft_id] = to_string(nftId);
-
63
-
64 Json::Value& jsonOffers(result[jss::offers] = Json::arrayValue);
-
65
-
66 std::vector<std::shared_ptr<SLE const>> offers;
-
67 unsigned int reserve(limit);
-
68 uint256 startAfter;
-
69 std::uint64_t startHint = 0;
-
70
-
71 if (context.params.isMember(jss::marker))
-
72 {
-
73 // We have a start point. Use limit - 1 from the result and use the
-
74 // very last one for the resume.
-
75 Json::Value const& marker(context.params[jss::marker]);
-
76
-
77 if (!marker.isString())
-
78 return RPC::expected_field_error(jss::marker, "string");
-
79
-
80 if (!startAfter.parseHex(marker.asString()))
-
81 return rpcError(rpcINVALID_PARAMS);
-
82
-
83 auto const sle = ledger->read(keylet::nftoffer(startAfter));
-
84
-
85 if (!sle || nftId != sle->getFieldH256(sfNFTokenID))
-
86 return rpcError(rpcINVALID_PARAMS);
-
87
-
88 startHint = sle->getFieldU64(sfNFTokenOfferNode);
-
89 appendNftOfferJson(context.app, sle, jsonOffers);
-
90 offers.reserve(reserve);
-
91 }
-
92 else
-
93 {
-
94 // We have no start point, limit should be one higher than requested.
-
95 offers.reserve(++reserve);
-
96 }
-
97
-
98 if (!forEachItemAfter(
-
99 *ledger,
-
100 directory,
-
101 startAfter,
-
102 startHint,
-
103 reserve,
-
104 [&offers](std::shared_ptr<SLE const> const& offer) {
-
105 if (offer->getType() == ltNFTOKEN_OFFER)
-
106 {
-
107 offers.emplace_back(offer);
-
108 return true;
-
109 }
-
110
-
111 return false;
-
112 }))
-
113 {
-
114 return rpcError(rpcINVALID_PARAMS);
-
115 }
-
116
-
117 if (offers.size() == reserve)
-
118 {
-
119 result[jss::limit] = limit;
-
120 result[jss::marker] = to_string(offers.back()->key());
-
121 offers.pop_back();
-
122 }
-
123
-
124 for (auto const& offer : offers)
-
125 appendNftOfferJson(context.app, offer, jsonOffers);
-
126
-
127 context.loadType = Resource::feeMediumBurdenRPC;
-
128 return result;
-
129}
+
36
+
37// {
+
38// nft_id: <token hash>
+
39// ledger_hash : <ledger>
+
40// ledger_index : <ledger_index>
+
41// limit: integer // optional
+
42// marker: opaque // optional, resume previous query
+
43// }
+
44static Json::Value
+
+
45enumerateNFTOffers(
+
46 RPC::JsonContext& context,
+
47 uint256 const& nftId,
+
48 Keylet const& directory)
+
49{
+
50 unsigned int limit;
+
51 if (auto err = readLimitField(limit, RPC::Tuning::nftOffers, context))
+
52 return *err;
+
53
+
54 std::shared_ptr<ReadView const> ledger;
+
55
+
56 if (auto result = RPC::lookupLedger(ledger, context); !ledger)
+
57 return result;
+
58
+
59 if (!ledger->exists(directory))
+
60 return rpcError(rpcOBJECT_NOT_FOUND);
+
61
+
62 Json::Value result;
+
63 result[jss::nft_id] = to_string(nftId);
+
64
+
65 Json::Value& jsonOffers(result[jss::offers] = Json::arrayValue);
+
66
+
67 std::vector<std::shared_ptr<SLE const>> offers;
+
68 unsigned int reserve(limit);
+
69 uint256 startAfter;
+
70 std::uint64_t startHint = 0;
+
71
+
72 if (context.params.isMember(jss::marker))
+
73 {
+
74 // We have a start point. Use limit - 1 from the result and use the
+
75 // very last one for the resume.
+
76 Json::Value const& marker(context.params[jss::marker]);
+
77
+
78 if (!marker.isString())
+
79 return RPC::expected_field_error(jss::marker, "string");
+
80
+
81 if (!startAfter.parseHex(marker.asString()))
+
82 return rpcError(rpcINVALID_PARAMS);
+
83
+
84 auto const sle = ledger->read(keylet::nftoffer(startAfter));
+
85
+
86 if (!sle || nftId != sle->getFieldH256(sfNFTokenID))
+
87 return rpcError(rpcINVALID_PARAMS);
+
88
+
89 startHint = sle->getFieldU64(sfNFTokenOfferNode);
+
90 appendNftOfferJson(context.app, sle, jsonOffers);
+
91 offers.reserve(reserve);
+
92 }
+
93 else
+
94 {
+
95 // We have no start point, limit should be one higher than requested.
+
96 offers.reserve(++reserve);
+
97 }
+
98
+
99 if (!forEachItemAfter(
+
100 *ledger,
+
101 directory,
+
102 startAfter,
+
103 startHint,
+
104 reserve,
+
105 [&offers](std::shared_ptr<SLE const> const& offer) {
+
106 if (offer->getType() == ltNFTOKEN_OFFER)
+
107 {
+
108 offers.emplace_back(offer);
+
109 return true;
+
110 }
+
111
+
112 return false;
+
113 }))
+
114 {
+
115 return rpcError(rpcINVALID_PARAMS);
+
116 }
+
117
+
118 if (offers.size() == reserve)
+
119 {
+
120 result[jss::limit] = limit;
+
121 result[jss::marker] = to_string(offers.back()->key());
+
122 offers.pop_back();
+
123 }
+
124
+
125 for (auto const& offer : offers)
+
126 appendNftOfferJson(context.app, offer, jsonOffers);
+
127
+
128 context.loadType = Resource::feeMediumBurdenRPC;
+
129 return result;
+
130}
-
130
-
131Json::Value
-
-
132doNFTSellOffers(RPC::JsonContext& context)
-
133{
-
134 if (!context.params.isMember(jss::nft_id))
-
135 return RPC::missing_field_error(jss::nft_id);
-
136
-
137 uint256 nftId;
-
138
-
139 if (!nftId.parseHex(context.params[jss::nft_id].asString()))
-
140 return RPC::invalid_field_error(jss::nft_id);
-
141
-
142 return enumerateNFTOffers(context, nftId, keylet::nft_sells(nftId));
-
143}
+
131
+
132Json::Value
+
+
133doNFTSellOffers(RPC::JsonContext& context)
+
134{
+
135 if (!context.params.isMember(jss::nft_id))
+
136 return RPC::missing_field_error(jss::nft_id);
+
137
+
138 uint256 nftId;
+
139
+
140 if (!nftId.parseHex(context.params[jss::nft_id].asString()))
+
141 return RPC::invalid_field_error(jss::nft_id);
+
142
+
143 return enumerateNFTOffers(context, nftId, keylet::nft_sells(nftId));
+
144}
-
144
-
145Json::Value
-
-
146doNFTBuyOffers(RPC::JsonContext& context)
-
147{
-
148 if (!context.params.isMember(jss::nft_id))
-
149 return RPC::missing_field_error(jss::nft_id);
-
150
-
151 uint256 nftId;
-
152
-
153 if (!nftId.parseHex(context.params[jss::nft_id].asString()))
-
154 return RPC::invalid_field_error(jss::nft_id);
-
155
-
156 return enumerateNFTOffers(context, nftId, keylet::nft_buys(nftId));
-
157}
+
145
+
146Json::Value
+
+
147doNFTBuyOffers(RPC::JsonContext& context)
+
148{
+
149 if (!context.params.isMember(jss::nft_id))
+
150 return RPC::missing_field_error(jss::nft_id);
+
151
+
152 uint256 nftId;
+
153
+
154 if (!nftId.parseHex(context.params[jss::nft_id].asString()))
+
155 return RPC::invalid_field_error(jss::nft_id);
+
156
+
157 return enumerateNFTOffers(context, nftId, keylet::nft_buys(nftId));
+
158}
-
158
-
159} // namespace ripple
+
159
+
160} // namespace ripple
Json::Value
Represents a JSON value.
Definition json_value.h:131
Json::Value::isString
bool isString() const
Definition json_value.cpp:1109
Json::Value::asString
std::string asString() const
Returns the unquoted string value.
Definition json_value.cpp:471
@@ -261,7 +262,7 @@ $(document).ready(function() { init_codefold(0); });
ripple::RPC::Tuning::nftOffers
static LimitRange constexpr nftOffers
Limits for the nft_buy_offers & nft_sell_offers commands.
Definition src/xrpld/rpc/detail/Tuning.h:42
ripple::RPC::invalid_field_error
Json::Value invalid_field_error(std::string const &name)
Definition ErrorCodes.h:306
ripple::RPC::expected_field_error
Json::Value expected_field_error(std::string const &name, std::string const &type)
Definition ErrorCodes.h:330
-
ripple::RPC::lookupLedger
Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
Definition RPCHelpers.cpp:606
+
ripple::RPC::lookupLedger
Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
Definition RPCLedgerHelpers.cpp:305
ripple::RPC::missing_field_error
Json::Value missing_field_error(std::string const &name)
Definition ErrorCodes.h:264
ripple::Resource::feeMediumBurdenRPC
Charge const feeMediumBurdenRPC
ripple::keylet::nft_buys
Keylet nft_buys(uint256 const &id) noexcept
The directory of buy offers for the specified NFT.
Definition Indexes.cpp:415
@@ -269,13 +270,13 @@ $(document).ready(function() { init_codefold(0); });
ripple::keylet::nftoffer
Keylet nftoffer(AccountID const &owner, std::uint32_t seq)
An offer from an account to buy or sell an NFT.
Definition Indexes.cpp:408
ripple
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition algorithm.h:6
ripple::toBase58
std::string toBase58(AccountID const &v)
Convert AccountID to base58 checked string.
Definition AccountID.cpp:95
-
ripple::enumerateNFTOffers
static Json::Value enumerateNFTOffers(RPC::JsonContext &context, uint256 const &nftId, Keylet const &directory)
Definition NFTOffers.cpp:44
-
ripple::doNFTBuyOffers
Json::Value doNFTBuyOffers(RPC::JsonContext &)
Definition NFTOffers.cpp:146
+
ripple::enumerateNFTOffers
static Json::Value enumerateNFTOffers(RPC::JsonContext &context, uint256 const &nftId, Keylet const &directory)
Definition NFTOffers.cpp:45
+
ripple::doNFTBuyOffers
Json::Value doNFTBuyOffers(RPC::JsonContext &)
Definition NFTOffers.cpp:147
ripple::rpcOBJECT_NOT_FOUND
@ rpcOBJECT_NOT_FOUND
Definition ErrorCodes.h:124
ripple::rpcINVALID_PARAMS
@ rpcINVALID_PARAMS
Definition ErrorCodes.h:65
ripple::rpcError
Json::Value rpcError(int iError)
Definition RPCErr.cpp:12
-
ripple::doNFTSellOffers
Json::Value doNFTSellOffers(RPC::JsonContext &)
Definition NFTOffers.cpp:132
-
ripple::appendNftOfferJson
static void appendNftOfferJson(Application const &app, std::shared_ptr< SLE const > const &offer, Json::Value &offers)
Definition NFTOffers.cpp:16
+
ripple::doNFTSellOffers
Json::Value doNFTSellOffers(RPC::JsonContext &)
Definition NFTOffers.cpp:133
+
ripple::appendNftOfferJson
static void appendNftOfferJson(Application const &app, std::shared_ptr< SLE const > const &offer, Json::Value &offers)
Definition NFTOffers.cpp:17
ripple::forEachItemAfter
bool forEachItemAfter(ReadView const &view, Keylet const &root, uint256 const &after, std::uint64_t const hint, unsigned int limit, std::function< bool(std::shared_ptr< SLE const > const &)> const &f)
Iterate all items after an item in the given directory.
Definition View.cpp:665
ripple::to_string
std::string to_string(base_uint< Bits, Tag > const &a)
Definition base_uint.h:611
diff --git a/NoRippleCheck_8cpp_source.html b/NoRippleCheck_8cpp_source.html index 0d742daac9..0ec4130c63 100644 --- a/NoRippleCheck_8cpp_source.html +++ b/NoRippleCheck_8cpp_source.html @@ -86,192 +86,193 @@ $(document).ready(function() { init_codefold(0); });
3#include <xrpld/app/paths/TrustLine.h>
4#include <xrpld/rpc/Context.h>
5#include <xrpld/rpc/detail/RPCHelpers.h>
-
6#include <xrpld/rpc/detail/Tuning.h>
-
7
-
8#include <xrpl/ledger/ReadView.h>
-
9#include <xrpl/protocol/ErrorCodes.h>
-
10#include <xrpl/protocol/RPCErr.h>
-
11#include <xrpl/protocol/TxFlags.h>
-
12#include <xrpl/protocol/jss.h>
-
13
-
14namespace ripple {
-
15
-
16static void
-
-
17fillTransaction(
-
18 RPC::JsonContext& context,
-
19 Json::Value& txArray,
-
20 AccountID const& accountID,
-
21 std::uint32_t& sequence,
-
22 ReadView const& ledger)
-
23{
-
24 txArray["Sequence"] = Json::UInt(sequence++);
-
25 txArray["Account"] = toBase58(accountID);
-
26 auto& fees = ledger.fees();
-
27 // Convert the reference transaction cost in fee units to drops
-
28 // scaled to represent the current fee load.
-
29 txArray["Fee"] =
-
30 scaleFeeLoad(fees.base, context.app.getFeeTrack(), fees, false)
-
31 .jsonClipped();
-
32}
+
6#include <xrpld/rpc/detail/RPCLedgerHelpers.h>
+
7#include <xrpld/rpc/detail/Tuning.h>
+
8
+
9#include <xrpl/ledger/ReadView.h>
+
10#include <xrpl/protocol/ErrorCodes.h>
+
11#include <xrpl/protocol/RPCErr.h>
+
12#include <xrpl/protocol/TxFlags.h>
+
13#include <xrpl/protocol/jss.h>
+
14
+
15namespace ripple {
+
16
+
17static void
+
+
18fillTransaction(
+
19 RPC::JsonContext& context,
+
20 Json::Value& txArray,
+
21 AccountID const& accountID,
+
22 std::uint32_t& sequence,
+
23 ReadView const& ledger)
+
24{
+
25 txArray["Sequence"] = Json::UInt(sequence++);
+
26 txArray["Account"] = toBase58(accountID);
+
27 auto& fees = ledger.fees();
+
28 // Convert the reference transaction cost in fee units to drops
+
29 // scaled to represent the current fee load.
+
30 txArray["Fee"] =
+
31 scaleFeeLoad(fees.base, context.app.getFeeTrack(), fees, false)
+
32 .jsonClipped();
+
33}
-
33
-
34// {
-
35// account: <account>
-
36// ledger_hash : <ledger>
-
37// ledger_index : <ledger_index>
-
38// limit: integer // optional, number of problems
-
39// role: gateway|user // account role to assume
-
40// transactions: true // optional, reccommend transactions
-
41// }
-
42Json::Value
-
-
43doNoRippleCheck(RPC::JsonContext& context)
-
44{
-
45 auto const& params(context.params);
-
46 if (!params.isMember(jss::account))
-
47 return RPC::missing_field_error("account");
-
48
-
49 if (!params.isMember("role"))
-
50 return RPC::missing_field_error("role");
-
51
-
52 if (!params[jss::account].isString())
-
53 return RPC::invalid_field_error(jss::account);
-
54
-
55 bool roleGateway = false;
-
56 {
-
57 std::string const role = params["role"].asString();
-
58 if (role == "gateway")
-
59 roleGateway = true;
-
60 else if (role != "user")
-
61 return RPC::invalid_field_error("role");
-
62 }
-
63
-
64 unsigned int limit;
-
65 if (auto err = readLimitField(limit, RPC::Tuning::noRippleCheck, context))
-
66 return *err;
-
67
-
68 bool transactions = false;
-
69 if (params.isMember(jss::transactions))
-
70 transactions = params["transactions"].asBool();
-
71
-
72 // The document[https://xrpl.org/noripple_check.html#noripple_check] states
-
73 // that transactions params is a boolean value, however, assigning any
-
74 // string value works. Do not allow this. This check is for api Version 2
-
75 // onwards only
-
76 if (context.apiVersion > 1u && params.isMember(jss::transactions) &&
-
77 !params[jss::transactions].isBool())
-
78 {
-
79 return RPC::invalid_field_error(jss::transactions);
-
80 }
-
81
-
82 std::shared_ptr<ReadView const> ledger;
-
83 auto result = RPC::lookupLedger(ledger, context);
-
84 if (!ledger)
-
85 return result;
-
86
-
87 Json::Value dummy;
-
88 Json::Value& jvTransactions =
-
89 transactions ? (result[jss::transactions] = Json::arrayValue) : dummy;
-
90
-
91 auto id = parseBase58<AccountID>(params[jss::account].asString());
-
92 if (!id)
-
93 {
-
94 RPC::inject_error(rpcACT_MALFORMED, result);
-
95 return result;
-
96 }
-
97 auto const accountID{std::move(id.value())};
-
98 auto const sle = ledger->read(keylet::account(accountID));
-
99 if (!sle)
-
100 return rpcError(rpcACT_NOT_FOUND);
-
101
-
102 std::uint32_t seq = sle->getFieldU32(sfSequence);
-
103
-
104 Json::Value& problems = (result["problems"] = Json::arrayValue);
-
105
-
106 bool bDefaultRipple = sle->getFieldU32(sfFlags) & lsfDefaultRipple;
-
107
-
108 if (bDefaultRipple & !roleGateway)
-
109 {
-
110 problems.append(
-
111 "You appear to have set your default ripple flag even though you "
-
112 "are not a gateway. This is not recommended unless you are "
-
113 "experimenting");
-
114 }
-
115 else if (roleGateway & !bDefaultRipple)
-
116 {
-
117 problems.append("You should immediately set your default ripple flag");
-
118 if (transactions)
-
119 {
-
120 Json::Value& tx = jvTransactions.append(Json::objectValue);
-
121 tx["TransactionType"] = jss::AccountSet;
-
122 tx["SetFlag"] = 8;
-
123 fillTransaction(context, tx, accountID, seq, *ledger);
-
124 }
-
125 }
-
126
-
127 forEachItemAfter(
-
128 *ledger,
-
129 accountID,
-
130 uint256(),
-
131 0,
-
132 limit,
-
133 [&](std::shared_ptr<SLE const> const& ownedItem) {
-
134 if (ownedItem->getType() == ltRIPPLE_STATE)
-
135 {
-
136 bool const bLow = accountID ==
-
137 ownedItem->getFieldAmount(sfLowLimit).getIssuer();
-
138
-
139 bool const bNoRipple = ownedItem->getFieldU32(sfFlags) &
-
140 (bLow ? lsfLowNoRipple : lsfHighNoRipple);
-
141
-
142 std::string problem;
-
143 bool needFix = false;
-
144 if (bNoRipple & roleGateway)
-
145 {
-
146 problem = "You should clear the no ripple flag on your ";
-
147 needFix = true;
-
148 }
-
149 else if (!roleGateway & !bNoRipple)
-
150 {
-
151 problem =
-
152 "You should probably set the no ripple flag on your ";
-
153 needFix = true;
-
154 }
-
155 if (needFix)
-
156 {
-
157 AccountID peer =
-
158 ownedItem
-
159 ->getFieldAmount(bLow ? sfHighLimit : sfLowLimit)
-
160 .getIssuer();
-
161 STAmount peerLimit = ownedItem->getFieldAmount(
-
162 bLow ? sfHighLimit : sfLowLimit);
-
163 problem += to_string(peerLimit.getCurrency());
-
164 problem += " line to ";
-
165 problem += to_string(peerLimit.getIssuer());
-
166 problems.append(problem);
-
167
-
168 STAmount limitAmount(ownedItem->getFieldAmount(
-
169 bLow ? sfLowLimit : sfHighLimit));
-
170 limitAmount.setIssuer(peer);
-
171
-
172 Json::Value& tx = jvTransactions.append(Json::objectValue);
-
173 tx["TransactionType"] = jss::TrustSet;
-
174 tx["LimitAmount"] = limitAmount.getJson(JsonOptions::none);
-
175 tx["Flags"] = bNoRipple ? tfClearNoRipple : tfSetNoRipple;
-
176 fillTransaction(context, tx, accountID, seq, *ledger);
-
177
-
178 return true;
-
179 }
-
180 }
-
181 return false;
-
182 });
-
183
-
184 return result;
-
185}
+
34
+
35// {
+
36// account: <account>
+
37// ledger_hash : <ledger>
+
38// ledger_index : <ledger_index>
+
39// limit: integer // optional, number of problems
+
40// role: gateway|user // account role to assume
+
41// transactions: true // optional, reccommend transactions
+
42// }
+
43Json::Value
+
+
44doNoRippleCheck(RPC::JsonContext& context)
+
45{
+
46 auto const& params(context.params);
+
47 if (!params.isMember(jss::account))
+
48 return RPC::missing_field_error("account");
+
49
+
50 if (!params.isMember("role"))
+
51 return RPC::missing_field_error("role");
+
52
+
53 if (!params[jss::account].isString())
+
54 return RPC::invalid_field_error(jss::account);
+
55
+
56 bool roleGateway = false;
+
57 {
+
58 std::string const role = params["role"].asString();
+
59 if (role == "gateway")
+
60 roleGateway = true;
+
61 else if (role != "user")
+
62 return RPC::invalid_field_error("role");
+
63 }
+
64
+
65 unsigned int limit;
+
66 if (auto err = readLimitField(limit, RPC::Tuning::noRippleCheck, context))
+
67 return *err;
+
68
+
69 bool transactions = false;
+
70 if (params.isMember(jss::transactions))
+
71 transactions = params["transactions"].asBool();
+
72
+
73 // The document[https://xrpl.org/noripple_check.html#noripple_check] states
+
74 // that transactions params is a boolean value, however, assigning any
+
75 // string value works. Do not allow this. This check is for api Version 2
+
76 // onwards only
+
77 if (context.apiVersion > 1u && params.isMember(jss::transactions) &&
+
78 !params[jss::transactions].isBool())
+
79 {
+
80 return RPC::invalid_field_error(jss::transactions);
+
81 }
+
82
+
83 std::shared_ptr<ReadView const> ledger;
+
84 auto result = RPC::lookupLedger(ledger, context);
+
85 if (!ledger)
+
86 return result;
+
87
+
88 Json::Value dummy;
+
89 Json::Value& jvTransactions =
+
90 transactions ? (result[jss::transactions] = Json::arrayValue) : dummy;
+
91
+
92 auto id = parseBase58<AccountID>(params[jss::account].asString());
+
93 if (!id)
+
94 {
+
95 RPC::inject_error(rpcACT_MALFORMED, result);
+
96 return result;
+
97 }
+
98 auto const accountID{std::move(id.value())};
+
99 auto const sle = ledger->read(keylet::account(accountID));
+
100 if (!sle)
+
101 return rpcError(rpcACT_NOT_FOUND);
+
102
+
103 std::uint32_t seq = sle->getFieldU32(sfSequence);
+
104
+
105 Json::Value& problems = (result["problems"] = Json::arrayValue);
+
106
+
107 bool bDefaultRipple = sle->getFieldU32(sfFlags) & lsfDefaultRipple;
+
108
+
109 if (bDefaultRipple & !roleGateway)
+
110 {
+
111 problems.append(
+
112 "You appear to have set your default ripple flag even though you "
+
113 "are not a gateway. This is not recommended unless you are "
+
114 "experimenting");
+
115 }
+
116 else if (roleGateway & !bDefaultRipple)
+
117 {
+
118 problems.append("You should immediately set your default ripple flag");
+
119 if (transactions)
+
120 {
+
121 Json::Value& tx = jvTransactions.append(Json::objectValue);
+
122 tx["TransactionType"] = jss::AccountSet;
+
123 tx["SetFlag"] = 8;
+
124 fillTransaction(context, tx, accountID, seq, *ledger);
+
125 }
+
126 }
+
127
+
128 forEachItemAfter(
+
129 *ledger,
+
130 accountID,
+
131 uint256(),
+
132 0,
+
133 limit,
+
134 [&](std::shared_ptr<SLE const> const& ownedItem) {
+
135 if (ownedItem->getType() == ltRIPPLE_STATE)
+
136 {
+
137 bool const bLow = accountID ==
+
138 ownedItem->getFieldAmount(sfLowLimit).getIssuer();
+
139
+
140 bool const bNoRipple = ownedItem->getFieldU32(sfFlags) &
+
141 (bLow ? lsfLowNoRipple : lsfHighNoRipple);
+
142
+
143 std::string problem;
+
144 bool needFix = false;
+
145 if (bNoRipple & roleGateway)
+
146 {
+
147 problem = "You should clear the no ripple flag on your ";
+
148 needFix = true;
+
149 }
+
150 else if (!roleGateway & !bNoRipple)
+
151 {
+
152 problem =
+
153 "You should probably set the no ripple flag on your ";
+
154 needFix = true;
+
155 }
+
156 if (needFix)
+
157 {
+
158 AccountID peer =
+
159 ownedItem
+
160 ->getFieldAmount(bLow ? sfHighLimit : sfLowLimit)
+
161 .getIssuer();
+
162 STAmount peerLimit = ownedItem->getFieldAmount(
+
163 bLow ? sfHighLimit : sfLowLimit);
+
164 problem += to_string(peerLimit.getCurrency());
+
165 problem += " line to ";
+
166 problem += to_string(peerLimit.getIssuer());
+
167 problems.append(problem);
+
168
+
169 STAmount limitAmount(ownedItem->getFieldAmount(
+
170 bLow ? sfLowLimit : sfHighLimit));
+
171 limitAmount.setIssuer(peer);
+
172
+
173 Json::Value& tx = jvTransactions.append(Json::objectValue);
+
174 tx["TransactionType"] = jss::TrustSet;
+
175 tx["LimitAmount"] = limitAmount.getJson(JsonOptions::none);
+
176 tx["Flags"] = bNoRipple ? tfClearNoRipple : tfSetNoRipple;
+
177 fillTransaction(context, tx, accountID, seq, *ledger);
+
178
+
179 return true;
+
180 }
+
181 }
+
182 return false;
+
183 });
+
184
+
185 return result;
+
186}
-
186
-
187} // namespace ripple
+
187
+
188} // namespace ripple
Json::Value
Represents a JSON value.
Definition json_value.h:131
Json::Value::append
Value & append(Value const &value)
Append value to array at the end.
Definition json_value.cpp:978
@@ -292,12 +293,12 @@ $(document).ready(function() { init_codefold(0); });
ripple::RPC::Tuning::noRippleCheck
static LimitRange constexpr noRippleCheck
Limits for the no_ripple_check command.
Definition src/xrpld/rpc/detail/Tuning.h:36
ripple::RPC::invalid_field_error
Json::Value invalid_field_error(std::string const &name)
Definition ErrorCodes.h:306
ripple::RPC::inject_error
void inject_error(error_code_i code, JsonValue &json)
Add or update the json update to reflect the error code.
Definition ErrorCodes.h:214
-
ripple::RPC::lookupLedger
Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
Definition RPCHelpers.cpp:606
+
ripple::RPC::lookupLedger
Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
Definition RPCLedgerHelpers.cpp:305
ripple::RPC::missing_field_error
Json::Value missing_field_error(std::string const &name)
Definition ErrorCodes.h:264
ripple::keylet::account
Keylet account(AccountID const &id) noexcept
AccountID root.
Definition Indexes.cpp:165
ripple
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition algorithm.h:6
ripple::toBase58
std::string toBase58(AccountID const &v)
Convert AccountID to base58 checked string.
Definition AccountID.cpp:95
-
ripple::doNoRippleCheck
Json::Value doNoRippleCheck(RPC::JsonContext &)
Definition NoRippleCheck.cpp:43
+
ripple::doNoRippleCheck
Json::Value doNoRippleCheck(RPC::JsonContext &)
Definition NoRippleCheck.cpp:44
ripple::rpcACT_NOT_FOUND
@ rpcACT_NOT_FOUND
Definition ErrorCodes.h:51
ripple::rpcACT_MALFORMED
@ rpcACT_MALFORMED
Definition ErrorCodes.h:71
ripple::uint256
base_uint< 256 > uint256
Definition base_uint.h:539
@@ -308,7 +309,7 @@ $(document).ready(function() { init_codefold(0); });
ripple::to_string
std::string to_string(base_uint< Bits, Tag > const &a)
Definition base_uint.h:611
ripple::scaleFeeLoad
XRPAmount scaleFeeLoad(XRPAmount fee, LoadFeeTrack const &feeTrack, Fees const &fees, bool bUnlimited)
Definition LoadFeeTrack.cpp:65
ripple::tfSetNoRipple
constexpr std::uint32_t tfSetNoRipple
Definition TxFlags.h:97
-
ripple::fillTransaction
static void fillTransaction(RPC::JsonContext &context, Json::Value &txArray, AccountID const &accountID, std::uint32_t &sequence, ReadView const &ledger)
Definition NoRippleCheck.cpp:17
+
ripple::fillTransaction
static void fillTransaction(RPC::JsonContext &context, Json::Value &txArray, AccountID const &accountID, std::uint32_t &sequence, ReadView const &ledger)
Definition NoRippleCheck.cpp:18
ripple::RPC::Context::apiVersion
unsigned int apiVersion
Definition Context.h:30
diff --git a/PayChanClaim_8cpp_source.html b/PayChanClaim_8cpp_source.html index 8cc4d52985..bb63774e65 100644 --- a/PayChanClaim_8cpp_source.html +++ b/PayChanClaim_8cpp_source.html @@ -248,7 +248,7 @@ $(document).ready(function() { init_codefold(0); });
ripple::RPC::contains_error
bool contains_error(Json::Value const &json)
Returns true if the json contains an rpc error specification.
Definition ErrorCodes.cpp:188
ripple::RPC::make_error
Json::Value make_error(error_code_i code)
Returns a new json object that reflects the error code.
Definition ErrorCodes.cpp:172
ripple::RPC::missing_field_error
Json::Value missing_field_error(std::string const &name)
Definition ErrorCodes.h:264
-
ripple::RPC::keypairForSignature
std::optional< std::pair< PublicKey, SecretKey > > keypairForSignature(Json::Value const &params, Json::Value &error, unsigned int apiVersion)
Definition RPCHelpers.cpp:785
+
ripple::RPC::keypairForSignature
std::optional< std::pair< PublicKey, SecretKey > > keypairForSignature(Json::Value const &params, Json::Value &error, unsigned int apiVersion)
Definition RPCHelpers.cpp:278
ripple
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition algorithm.h:6
ripple::doChannelVerify
Json::Value doChannelVerify(RPC::JsonContext &)
Definition PayChanClaim.cpp:94
diff --git a/PermissionedDEX__test_8cpp_source.html b/PermissionedDEX__test_8cpp_source.html index 509887ca13..2fd484fa65 100644 --- a/PermissionedDEX__test_8cpp_source.html +++ b/PermissionedDEX__test_8cpp_source.html @@ -1071,8 +1071,8 @@ $(document).ready(function() { init_codefold(0); });
966 {
967 testcase("Remove unfunded offer");
968
-
969 // checking that an unfunded offer will be implictly removed by a
-
970 // successfuly payment tx
+
969 // checking that an unfunded offer will be implicitly removed by a
+
970 // successful payment tx
971 Env env(*this, features);
972 auto const& [gw, domainOwner, alice, bob, carol, USD, domainID, credType] =
973 PermissionedDEX(env);
diff --git a/RPCHelpers_8cpp_source.html b/RPCHelpers_8cpp_source.html index a80dfe4191..189ba57d90 100644 --- a/RPCHelpers_8cpp_source.html +++ b/RPCHelpers_8cpp_source.html @@ -223,1044 +223,382 @@ $(document).ready(function() { init_codefold(0); });
131}
132
-
133bool
+
133hash_set<AccountID>
-
134getAccountObjects(
-
135 ReadView const& ledger,
-
136 AccountID const& account,
-
137 std::optional<std::vector<LedgerEntryType>> const& typeFilter,
-
138 uint256 dirIndex,
-
139 uint256 entryIndex,
-
140 std::uint32_t const limit,
-
141 Json::Value& jvResult)
-
142{
-
143 // check if dirIndex is valid
-
144 if (!dirIndex.isZero() && !ledger.read({ltDIR_NODE, dirIndex}))
-
145 return false;
-
146
-
147 auto typeMatchesFilter = [](std::vector<LedgerEntryType> const& typeFilter,
-
148 LedgerEntryType ledgerType) {
-
149 auto it = std::find(typeFilter.begin(), typeFilter.end(), ledgerType);
-
150 return it != typeFilter.end();
-
151 };
-
152
-
153 // if dirIndex != 0, then all NFTs have already been returned. only
-
154 // iterate NFT pages if the filter says so AND dirIndex == 0
-
155 bool iterateNFTPages =
-
156 (!typeFilter.has_value() ||
-
157 typeMatchesFilter(typeFilter.value(), ltNFTOKEN_PAGE)) &&
-
158 dirIndex == beast::zero;
-
159
-
160 Keylet const firstNFTPage = keylet::nftpage_min(account);
-
161
-
162 // we need to check the marker to see if it is an NFTTokenPage index.
-
163 if (iterateNFTPages && entryIndex != beast::zero)
-
164 {
-
165 // if it is we will try to iterate the pages up to the limit
-
166 // and then change over to the owner directory
-
167
-
168 if (firstNFTPage.key != (entryIndex & ~nft::pageMask))
-
169 iterateNFTPages = false;
-
170 }
-
171
-
172 auto& jvObjects = (jvResult[jss::account_objects] = Json::arrayValue);
+
134parseAccountIds(Json::Value const& jvArray)
+
135{
+
136 hash_set<AccountID> result;
+
137 for (auto const& jv : jvArray)
+
138 {
+
139 if (!jv.isString())
+
140 return hash_set<AccountID>();
+
141 auto const id = parseBase58<AccountID>(jv.asString());
+
142 if (!id)
+
143 return hash_set<AccountID>();
+
144 result.insert(*id);
+
145 }
+
146 return result;
+
147}
+
+
148
+
149void
+
+
150injectSLE(Json::Value& jv, SLE const& sle)
+
151{
+
152 jv = sle.getJson(JsonOptions::none);
+
153 if (sle.getType() == ltACCOUNT_ROOT)
+
154 {
+
155 if (sle.isFieldPresent(sfEmailHash))
+
156 {
+
157 auto const& hash = sle.getFieldH128(sfEmailHash);
+
158 Blob const b(hash.begin(), hash.end());
+
159 std::string md5 = strHex(makeSlice(b));
+
160 boost::to_lower(md5);
+
161 // VFALCO TODO Give a name and move this constant
+
162 // to a more visible location. Also
+
163 // shouldn't this be https?
+
164 jv[jss::urlgravatar] =
+
165 str(boost::format("http://www.gravatar.com/avatar/%s") % md5);
+
166 }
+
167 }
+
168 else
+
169 {
+
170 jv[jss::Invalid] = true;
+
171 }
+
172}
+
173
-
174 // this is a mutable version of limit, used to seamlessly switch
-
175 // to iterating directory entries when nftokenpages are exhausted
-
176 uint32_t mlimit = limit;
-
177
-
178 // iterate NFTokenPages preferentially
-
179 if (iterateNFTPages)
-
180 {
-
181 Keylet const first = entryIndex == beast::zero
-
182 ? firstNFTPage
-
183 : Keylet{ltNFTOKEN_PAGE, entryIndex};
+
174std::optional<Json::Value>
+
+
175readLimitField(
+
176 unsigned int& limit,
+
177 Tuning::LimitRange const& range,
+
178 JsonContext const& context)
+
179{
+
180 limit = range.rdefault;
+
181 if (!context.params.isMember(jss::limit) ||
+
182 context.params[jss::limit].isNull())
+
183 return std::nullopt;
184
-
185 Keylet const last = keylet::nftpage_max(account);
-
186
-
187 // current key
-
188 uint256 ck = ledger.succ(first.key, last.key.next()).value_or(last.key);
-
189
-
190 // current page
-
191 auto cp = ledger.read(Keylet{ltNFTOKEN_PAGE, ck});
+
185 auto const& jvLimit = context.params[jss::limit];
+
186 if (!(jvLimit.isUInt() || (jvLimit.isInt() && jvLimit.asInt() >= 0)))
+
187 return RPC::expected_field_error(jss::limit, "unsigned integer");
+
188
+
189 limit = jvLimit.asUInt();
+
190 if (limit == 0)
+
191 return RPC::invalid_field_error(jss::limit);
192
-
193 while (cp)
-
194 {
-
195 jvObjects.append(cp->getJson(JsonOptions::none));
-
196 auto const npm = (*cp)[~sfNextPageMin];
-
197 if (npm)
-
198 cp = ledger.read(Keylet(ltNFTOKEN_PAGE, *npm));
-
199 else
-
200 cp = nullptr;
-
201
-
202 if (--mlimit == 0)
-
203 {
-
204 if (cp)
-
205 {
-
206 jvResult[jss::limit] = limit;
-
207 jvResult[jss::marker] = std::string("0,") + to_string(ck);
-
208 return true;
-
209 }
-
210 }
-
211
-
212 if (!npm)
-
213 break;
+
193 if (!isUnlimited(context.role))
+
194 limit = std::max(range.rmin, std::min(range.rmax, limit));
+
195
+
196 return std::nullopt;
+
197}
+
+
198
+
199std::optional<Seed>
+
+
200parseRippleLibSeed(Json::Value const& value)
+
201{
+
202 // ripple-lib encodes seed used to generate an Ed25519 wallet in a
+
203 // non-standard way. While rippled never encode seeds that way, we
+
204 // try to detect such keys to avoid user confusion.
+
205 if (!value.isString())
+
206 return std::nullopt;
+
207
+
208 auto const result = decodeBase58Token(value.asString(), TokenType::None);
+
209
+
210 if (result.size() == 18 &&
+
211 static_cast<std::uint8_t>(result[0]) == std::uint8_t(0xE1) &&
+
212 static_cast<std::uint8_t>(result[1]) == std::uint8_t(0x4B))
+
213 return Seed(makeSlice(result.substr(2)));
214
-
215 ck = *npm;
-
216 }
+
215 return std::nullopt;
+
216}
+
217
-
218 // if execution reaches here then we're about to transition
-
219 // to iterating the root directory (and the conventional
-
220 // behaviour of this RPC function.) Therefore we should
-
221 // zero entryIndex so as not to terribly confuse things.
-
222 entryIndex = beast::zero;
-
223 }
+
218std::optional<Seed>
+
+
219getSeedFromRPC(Json::Value const& params, Json::Value& error)
+
220{
+
221 using string_to_seed_t =
+
222 std::function<std::optional<Seed>(std::string const&)>;
+
223 using seed_match_t = std::pair<char const*, string_to_seed_t>;
224
-
225 auto const root = keylet::ownerDir(account);
-
226 auto found = false;
-
227
-
228 if (dirIndex.isZero())
-
229 {
-
230 dirIndex = root.key;
-
231 found = true;
-
232 }
-
233
-
234 auto dir = ledger.read({ltDIR_NODE, dirIndex});
-
235 if (!dir)
-
236 {
-
237 // it's possible the user had nftoken pages but no
-
238 // directory entries. If there's no nftoken page, we will
-
239 // give empty array for account_objects.
-
240 if (mlimit >= limit)
-
241 jvResult[jss::account_objects] = Json::arrayValue;
-
242
-
243 // non-zero dirIndex validity was checked in the beginning of this
-
244 // function; by this point, it should be zero. This function returns
-
245 // true regardless of nftoken page presence; if absent, account_objects
-
246 // is already set as an empty array. Notice we will only return false in
-
247 // this function when entryIndex can not be found, indicating an invalid
-
248 // marker error.
-
249 return true;
-
250 }
-
251
-
252 std::uint32_t i = 0;
-
253 for (;;)
-
254 {
-
255 auto const& entries = dir->getFieldV256(sfIndexes);
-
256 auto iter = entries.begin();
+
225 static seed_match_t const seedTypes[]{
+
226 {jss::passphrase.c_str(),
+
227 [](std::string const& s) { return parseGenericSeed(s); }},
+
228 {jss::seed.c_str(),
+
229 [](std::string const& s) { return parseBase58<Seed>(s); }},
+
230 {jss::seed_hex.c_str(), [](std::string const& s) {
+
231 uint128 i;
+
232 if (i.parseHex(s))
+
233 return std::optional<Seed>(Slice(i.data(), i.size()));
+
234 return std::optional<Seed>{};
+
235 }}};
+
236
+
237 // Identify which seed type is in use.
+
238 seed_match_t const* seedType = nullptr;
+
239 int count = 0;
+
240 for (auto const& t : seedTypes)
+
241 {
+
242 if (params.isMember(t.first))
+
243 {
+
244 ++count;
+
245 seedType = &t;
+
246 }
+
247 }
+
248
+
249 if (count != 1)
+
250 {
+
251 error = RPC::make_param_error(
+
252 "Exactly one of the following must be specified: " +
+
253 std::string(jss::passphrase) + ", " + std::string(jss::seed) +
+
254 " or " + std::string(jss::seed_hex));
+
255 return std::nullopt;
+
256 }
257
-
258 if (!found)
-
259 {
-
260 iter = std::find(iter, entries.end(), entryIndex);
-
261 if (iter == entries.end())
-
262 return false;
-
263
-
264 found = true;
-
265 }
-
266
-
267 // it's possible that the returned NFTPages exactly filled the
-
268 // response. Check for that condition.
-
269 if (i == mlimit && mlimit < limit)
-
270 {
-
271 jvResult[jss::limit] = limit;
-
272 jvResult[jss::marker] =
-
273 to_string(dirIndex) + ',' + to_string(*iter);
-
274 return true;
-
275 }
+
258 // Make sure a string is present
+
259 auto const& param = params[seedType->first];
+
260 if (!param.isString())
+
261 {
+
262 error = RPC::expected_field_error(seedType->first, "string");
+
263 return std::nullopt;
+
264 }
+
265
+
266 auto const fieldContents = param.asString();
+
267
+
268 // Convert string to seed.
+
269 std::optional<Seed> seed = seedType->second(fieldContents);
+
270
+
271 if (!seed)
+
272 error = rpcError(rpcBAD_SEED);
+
273
+
274 return seed;
+
275}
+
276
-
277 for (; iter != entries.end(); ++iter)
-
278 {
-
279 auto const sleNode = ledger.read(keylet::child(*iter));
-
280
-
281 if (!typeFilter.has_value() ||
-
282 typeMatchesFilter(typeFilter.value(), sleNode->getType()))
-
283 {
-
284 jvObjects.append(sleNode->getJson(JsonOptions::none));
-
285 }
-
286
-
287 if (++i == mlimit)
-
288 {
-
289 if (++iter != entries.end())
-
290 {
-
291 jvResult[jss::limit] = limit;
-
292 jvResult[jss::marker] =
-
293 to_string(dirIndex) + ',' + to_string(*iter);
-
294 return true;
-
295 }
-
296
-
297 break;
-
298 }
-
299 }
-
300
-
301 auto const nodeIndex = dir->getFieldU64(sfIndexNext);
-
302 if (nodeIndex == 0)
-
303 return true;
-
304
-
305 dirIndex = keylet::page(root, nodeIndex).key;
-
306 dir = ledger.read({ltDIR_NODE, dirIndex});
-
307 if (!dir)
-
308 return true;
+
277std::optional<std::pair<PublicKey, SecretKey>>
+
+
278keypairForSignature(
+
279 Json::Value const& params,
+
280 Json::Value& error,
+
281 unsigned int apiVersion)
+
282{
+
283 bool const has_key_type = params.isMember(jss::key_type);
+
284
+
285 // All of the secret types we allow, but only one at a time.
+
286 static char const* const secretTypes[]{
+
287 jss::passphrase.c_str(),
+
288 jss::secret.c_str(),
+
289 jss::seed.c_str(),
+
290 jss::seed_hex.c_str()};
+
291
+
292 // Identify which secret type is in use.
+
293 char const* secretType = nullptr;
+
294 int count = 0;
+
295 for (auto t : secretTypes)
+
296 {
+
297 if (params.isMember(t))
+
298 {
+
299 ++count;
+
300 secretType = t;
+
301 }
+
302 }
+
303
+
304 if (count == 0 || secretType == nullptr)
+
305 {
+
306 error = RPC::missing_field_error(jss::secret);
+
307 return {};
+
308 }
309
-
310 if (i == mlimit)
-
311 {
-
312 auto const& e = dir->getFieldV256(sfIndexes);
-
313 if (!e.empty())
-
314 {
-
315 jvResult[jss::limit] = limit;
-
316 jvResult[jss::marker] =
-
317 to_string(dirIndex) + ',' + to_string(*e.begin());
-
318 }
+
310 if (count > 1)
+
311 {
+
312 error = RPC::make_param_error(
+
313 "Exactly one of the following must be specified: " +
+
314 std::string(jss::passphrase) + ", " + std::string(jss::secret) +
+
315 ", " + std::string(jss::seed) + " or " +
+
316 std::string(jss::seed_hex));
+
317 return {};
+
318 }
319
-
320 return true;
-
321 }
-
322 }
-
323}
-
-
324
-
325namespace {
-
326
-
327bool
-
328isValidatedOld(LedgerMaster& ledgerMaster, bool standalone)
-
329{
-
330 if (standalone)
-
331 return false;
+
320 std::optional<KeyType> keyType;
+
321 std::optional<Seed> seed;
+
322
+
323 if (has_key_type)
+
324 {
+
325 if (!params[jss::key_type].isString())
+
326 {
+
327 error = RPC::expected_field_error(jss::key_type, "string");
+
328 return {};
+
329 }
+
330
+
331 keyType = keyTypeFromString(params[jss::key_type].asString());
332
-
333 return ledgerMaster.getValidatedLedgerAge() > Tuning::maxValidatedLedgerAge;
-
334}
-
335
-
336template <class T>
-
337Status
-
338ledgerFromRequest(T& ledger, JsonContext& context)
-
339{
-
340 ledger.reset();
+
333 if (!keyType)
+
334 {
+
335 if (apiVersion > 1u)
+
336 error = RPC::make_error(rpcBAD_KEY_TYPE);
+
337 else
+
338 error = RPC::invalid_field_error(jss::key_type);
+
339 return {};
+
340 }
341
-
342 auto& params = context.params;
-
343
-
344 auto indexValue = params[jss::ledger_index];
-
345 auto hashValue = params[jss::ledger_hash];
-
346
-
347 // We need to support the legacy "ledger" field.
-
348 auto& legacyLedger = params[jss::ledger];
-
349 if (legacyLedger)
-
350 {
-
351 if (legacyLedger.asString().size() > 12)
-
352 hashValue = legacyLedger;
-
353 else
-
354 indexValue = legacyLedger;
-
355 }
-
356
-
357 if (!hashValue.isNull())
-
358 {
-
359 if (!hashValue.isString())
-
360 return {rpcINVALID_PARAMS, "ledgerHashNotString"};
+
342 // using strcmp as pointers may not match (see
+
343 // https://developercommunity.visualstudio.com/t/assigning-constexpr-char--to-static-cha/10021357?entry=problem)
+
344 if (strcmp(secretType, jss::secret.c_str()) == 0)
+
345 {
+
346 error = RPC::make_param_error(
+
347 "The secret field is not allowed if " +
+
348 std::string(jss::key_type) + " is used.");
+
349 return {};
+
350 }
+
351 }
+
352
+
353 // ripple-lib encodes seed used to generate an Ed25519 wallet in a
+
354 // non-standard way. While we never encode seeds that way, we try
+
355 // to detect such keys to avoid user confusion.
+
356 // using strcmp as pointers may not match (see
+
357 // https://developercommunity.visualstudio.com/t/assigning-constexpr-char--to-static-cha/10021357?entry=problem)
+
358 if (strcmp(secretType, jss::seed_hex.c_str()) != 0)
+
359 {
+
360 seed = RPC::parseRippleLibSeed(params[secretType]);
361
-
362 uint256 ledgerHash;
-
363 if (!ledgerHash.parseHex(hashValue.asString()))
-
364 return {rpcINVALID_PARAMS, "ledgerHashMalformed"};
-
365 return getLedger(ledger, ledgerHash, context);
-
366 }
-
367
-
368 if (!indexValue.isConvertibleTo(Json::stringValue))
-
369 return {rpcINVALID_PARAMS, "ledgerIndexMalformed"};
-
370
-
371 auto const index = indexValue.asString();
+
362 if (seed)
+
363 {
+
364 // If the user passed in an Ed25519 seed but *explicitly*
+
365 // requested another key type, return an error.
+
366 if (keyType.value_or(KeyType::ed25519) != KeyType::ed25519)
+
367 {
+
368 error = RPC::make_error(
+
369 rpcBAD_SEED, "Specified seed is for an Ed25519 wallet.");
+
370 return {};
+
371 }
372
-
373 if (index == "current" || index.empty())
-
374 return getLedger(ledger, LedgerShortcut::CURRENT, context);
-
375
-
376 if (index == "validated")
-
377 return getLedger(ledger, LedgerShortcut::VALIDATED, context);
-
378
-
379 if (index == "closed")
-
380 return getLedger(ledger, LedgerShortcut::CLOSED, context);
-
381
-
382 std::uint32_t val;
-
383 if (!beast::lexicalCastChecked(val, index))
-
384 return {rpcINVALID_PARAMS, "ledgerIndexMalformed"};
-
385
-
386 return getLedger(ledger, val, context);
-
387}
-
388} // namespace
-
389
-
390template <class T, class R>
-
391Status
-
-
392ledgerFromRequest(T& ledger, GRPCContext<R>& context)
-
393{
-
394 R& request = context.params;
-
395 return ledgerFromSpecifier(ledger, request.ledger(), context);
-
396}
-
-
397
-
398// explicit instantiation of above function
-
399template Status
-
400ledgerFromRequest<>(
-
401 std::shared_ptr<ReadView const>&,
-
402 GRPCContext<org::xrpl::rpc::v1::GetLedgerEntryRequest>&);
+
373 keyType = KeyType::ed25519;
+
374 }
+
375 }
+
376
+
377 if (!keyType)
+
378 keyType = KeyType::secp256k1;
+
379
+
380 if (!seed)
+
381 {
+
382 if (has_key_type)
+
383 seed = getSeedFromRPC(params, error);
+
384 else
+
385 {
+
386 if (!params[jss::secret].isString())
+
387 {
+
388 error = RPC::expected_field_error(jss::secret, "string");
+
389 return {};
+
390 }
+
391
+
392 seed = parseGenericSeed(params[jss::secret].asString());
+
393 }
+
394 }
+
395
+
396 if (!seed)
+
397 {
+
398 if (!contains_error(error))
+
399 {
+
400 error = RPC::make_error(
+
401 rpcBAD_SEED, RPC::invalid_field_message(secretType));
+
402 }
403
-
404// explicit instantiation of above function
-
405template Status
-
406ledgerFromRequest<>(
-
407 std::shared_ptr<ReadView const>&,
-
408 GRPCContext<org::xrpl::rpc::v1::GetLedgerDataRequest>&);
+
404 return {};
+
405 }
+
406
+
407 if (keyType != KeyType::secp256k1 && keyType != KeyType::ed25519)
+
408 LogicError("keypairForSignature: invalid key type");
409
-
410// explicit instantiation of above function
-
411template Status
-
412ledgerFromRequest<>(
-
413 std::shared_ptr<ReadView const>&,
-
414 GRPCContext<org::xrpl::rpc::v1::GetLedgerRequest>&);
-
415
-
416template <class T>
-
417Status
-
-
418ledgerFromSpecifier(
-
419 T& ledger,
-
420 org::xrpl::rpc::v1::LedgerSpecifier const& specifier,
-
421 Context& context)
-
422{
-
423 ledger.reset();
-
424
-
425 using LedgerCase = org::xrpl::rpc::v1::LedgerSpecifier::LedgerCase;
-
426 LedgerCase ledgerCase = specifier.ledger_case();
-
427 switch (ledgerCase)
-
428 {
-
429 case LedgerCase::kHash: {
-
430 if (auto hash = uint256::fromVoidChecked(specifier.hash()))
-
431 {
-
432 return getLedger(ledger, *hash, context);
-
433 }
-
434 return {rpcINVALID_PARAMS, "ledgerHashMalformed"};
-
435 }
-
436 case LedgerCase::kSequence:
-
437 return getLedger(ledger, specifier.sequence(), context);
-
438 case LedgerCase::kShortcut:
-
439 [[fallthrough]];
-
440 case LedgerCase::LEDGER_NOT_SET: {
-
441 auto const shortcut = specifier.shortcut();
-
442 if (shortcut ==
-
443 org::xrpl::rpc::v1::LedgerSpecifier::SHORTCUT_VALIDATED)
-
444 {
-
445 return getLedger(ledger, LedgerShortcut::VALIDATED, context);
-
446 }
-
447 else
-
448 {
-
449 if (shortcut ==
-
450 org::xrpl::rpc::v1::LedgerSpecifier::SHORTCUT_CURRENT ||
-
451 shortcut ==
-
452 org::xrpl::rpc::v1::LedgerSpecifier::
-
453 SHORTCUT_UNSPECIFIED)
-
454 {
-
455 return getLedger(ledger, LedgerShortcut::CURRENT, context);
-
456 }
-
457 else if (
-
458 shortcut ==
-
459 org::xrpl::rpc::v1::LedgerSpecifier::SHORTCUT_CLOSED)
-
460 {
-
461 return getLedger(ledger, LedgerShortcut::CLOSED, context);
-
462 }
-
463 }
-
464 }
-
465 }
-
466
-
467 return Status::OK;
-
468}
+
410 return generateKeyPair(*keyType, *seed);
+
411}
-
469
-
470template <class T>
-
471Status
-
-
472getLedger(T& ledger, uint256 const& ledgerHash, Context& context)
-
473{
-
474 ledger = context.ledgerMaster.getLedgerByHash(ledgerHash);
-
475 if (ledger == nullptr)
-
476 return {rpcLGR_NOT_FOUND, "ledgerNotFound"};
-
477 return Status::OK;
-
478}
+
412
+
413std::pair<RPC::Status, LedgerEntryType>
+
+
414chooseLedgerEntryType(Json::Value const& params)
+
415{
+
416 std::pair<RPC::Status, LedgerEntryType> result{RPC::Status::OK, ltANY};
+
417 if (params.isMember(jss::type))
+
418 {
+
419 static constexpr auto types = std::to_array<
+
420 std::tuple<char const*, char const*, LedgerEntryType>>({
+
421#pragma push_macro("LEDGER_ENTRY")
+
422#undef LEDGER_ENTRY
+
423
+
424#define LEDGER_ENTRY(tag, value, name, rpcName, ...) \
+
425 {jss::name, jss::rpcName, tag},
+
426
+
427#include <xrpl/protocol/detail/ledger_entries.macro>
+
428
+
429#undef LEDGER_ENTRY
+
430#pragma pop_macro("LEDGER_ENTRY")
+
431 });
+
432
+
433 auto const& p = params[jss::type];
+
434 if (!p.isString())
+
435 {
+
436 result.first = RPC::Status{
+
437 rpcINVALID_PARAMS, "Invalid field 'type', not string."};
+
438 XRPL_ASSERT(
+
439 result.first.type() == RPC::Status::Type::error_code_i,
+
440 "ripple::RPC::chooseLedgerEntryType : first valid result type");
+
441 return result;
+
442 }
+
443
+
444 // Use the passed in parameter to find a ledger type based on matching
+
445 // against the canonical name (case-insensitive) or the RPC name
+
446 // (case-sensitive).
+
447 auto const filter = p.asString();
+
448 auto const iter =
+
449 std::ranges::find_if(types, [&filter](decltype(types.front())& t) {
+
450 return boost::iequals(std::get<0>(t), filter) ||
+
451 std::get<1>(t) == filter;
+
452 });
+
453 if (iter == types.end())
+
454 {
+
455 result.first =
+
456 RPC::Status{rpcINVALID_PARAMS, "Invalid field 'type'."};
+
457 XRPL_ASSERT(
+
458 result.first.type() == RPC::Status::Type::error_code_i,
+
459 "ripple::RPC::chooseLedgerEntryType : second valid result "
+
460 "type");
+
461 return result;
+
462 }
+
463 result.second = std::get<2>(*iter);
+
464 }
+
465 return result;
+
466}
-
479
-
480template <class T>
-
481Status
-
-
482getLedger(T& ledger, uint32_t ledgerIndex, Context& context)
-
483{
-
484 ledger = context.ledgerMaster.getLedgerBySeq(ledgerIndex);
-
485 if (ledger == nullptr)
-
486 {
-
487 auto cur = context.ledgerMaster.getCurrentLedger();
-
488 if (cur->info().seq == ledgerIndex)
-
489 {
-
490 ledger = cur;
-
491 }
-
492 }
-
493
-
494 if (ledger == nullptr)
-
495 return {rpcLGR_NOT_FOUND, "ledgerNotFound"};
-
496
-
497 if (ledger->info().seq > context.ledgerMaster.getValidLedgerIndex() &&
-
498 isValidatedOld(context.ledgerMaster, context.app.config().standalone()))
-
499 {
-
500 ledger.reset();
-
501 if (context.apiVersion == 1)
-
502 return {rpcNO_NETWORK, "InsufficientNetworkMode"};
-
503 return {rpcNOT_SYNCED, "notSynced"};
-
504 }
-
505
-
506 return Status::OK;
-
507}
+
467
+
468bool
+
+
469isAccountObjectsValidType(LedgerEntryType const& type)
+
470{
+
471 switch (type)
+
472 {
+
473 case LedgerEntryType::ltAMENDMENTS:
+
474 case LedgerEntryType::ltDIR_NODE:
+
475 case LedgerEntryType::ltFEE_SETTINGS:
+
476 case LedgerEntryType::ltLEDGER_HASHES:
+
477 case LedgerEntryType::ltNEGATIVE_UNL:
+
478 return false;
+
479 default:
+
480 return true;
+
481 }
+
482}
-
508
-
509template <class T>
-
510Status
-
-
511getLedger(T& ledger, LedgerShortcut shortcut, Context& context)
-
512{
-
513 if (isValidatedOld(context.ledgerMaster, context.app.config().standalone()))
-
514 {
-
515 if (context.apiVersion == 1)
-
516 return {rpcNO_NETWORK, "InsufficientNetworkMode"};
-
517 return {rpcNOT_SYNCED, "notSynced"};
-
518 }
-
519
-
520 if (shortcut == LedgerShortcut::VALIDATED)
-
521 {
-
522 ledger = context.ledgerMaster.getValidatedLedger();
-
523 if (ledger == nullptr)
-
524 {
-
525 if (context.apiVersion == 1)
-
526 return {rpcNO_NETWORK, "InsufficientNetworkMode"};
-
527 return {rpcNOT_SYNCED, "notSynced"};
-
528 }
-
529
-
530 XRPL_ASSERT(
-
531 !ledger->open(), "ripple::RPC::getLedger : validated is not open");
-
532 }
-
533 else
-
534 {
-
535 if (shortcut == LedgerShortcut::CURRENT)
-
536 {
-
537 ledger = context.ledgerMaster.getCurrentLedger();
-
538 XRPL_ASSERT(
-
539 ledger->open(), "ripple::RPC::getLedger : current is open");
-
540 }
-
541 else if (shortcut == LedgerShortcut::CLOSED)
-
542 {
-
543 ledger = context.ledgerMaster.getClosedLedger();
-
544 XRPL_ASSERT(
-
545 !ledger->open(), "ripple::RPC::getLedger : closed is not open");
-
546 }
-
547 else
-
548 {
-
549 return {rpcINVALID_PARAMS, "ledgerIndexMalformed"};
-
550 }
-
551
-
552 if (ledger == nullptr)
-
553 {
-
554 if (context.apiVersion == 1)
-
555 return {rpcNO_NETWORK, "InsufficientNetworkMode"};
-
556 return {rpcNOT_SYNCED, "notSynced"};
-
557 }
-
558
-
559 static auto const minSequenceGap = 10;
-
560
-
561 if (ledger->info().seq + minSequenceGap <
-
562 context.ledgerMaster.getValidLedgerIndex())
-
563 {
-
564 ledger.reset();
-
565 if (context.apiVersion == 1)
-
566 return {rpcNO_NETWORK, "InsufficientNetworkMode"};
-
567 return {rpcNOT_SYNCED, "notSynced"};
-
568 }
-
569 }
-
570 return Status::OK;
-
571}
-
-
572
-
573// Explicit instantiation of above three functions
-
574template Status
-
575getLedger<>(std::shared_ptr<ReadView const>&, uint32_t, Context&);
-
576
-
577template Status
-
578getLedger<>(
-
579 std::shared_ptr<ReadView const>&,
-
580 LedgerShortcut shortcut,
-
581 Context&);
-
582
-
583template Status
-
584getLedger<>(std::shared_ptr<ReadView const>&, uint256 const&, Context&);
-
585
-
586// The previous version of the lookupLedger command would accept the
-
587// "ledger_index" argument as a string and silently treat it as a request to
-
588// return the current ledger which, while not strictly wrong, could cause a lot
-
589// of confusion.
-
590//
-
591// The code now robustly validates the input and ensures that the only possible
-
592// values for the "ledger_index" parameter are the index of a ledger passed as
-
593// an integer or one of the strings "current", "closed" or "validated".
-
594// Additionally, the code ensures that the value passed in "ledger_hash" is a
-
595// string and a valid hash. Invalid values will return an appropriate error
-
596// code.
-
597//
-
598// In the absence of the "ledger_hash" or "ledger_index" parameters, the code
-
599// assumes that "ledger_index" has the value "current".
-
600//
-
601// Returns a Json::objectValue. If there was an error, it will be in that
-
602// return value. Otherwise, the object contains the field "validated" and
-
603// optionally the fields "ledger_hash", "ledger_index" and
-
604// "ledger_current_index", if they are defined.
-
605Status
-
-
606lookupLedger(
-
607 std::shared_ptr<ReadView const>& ledger,
-
608 JsonContext& context,
-
609 Json::Value& result)
-
610{
-
611 if (auto status = ledgerFromRequest(ledger, context))
-
612 return status;
-
613
-
614 auto& info = ledger->info();
-
615
-
616 if (!ledger->open())
-
617 {
-
618 result[jss::ledger_hash] = to_string(info.hash);
-
619 result[jss::ledger_index] = info.seq;
-
620 }
-
621 else
-
622 {
-
623 result[jss::ledger_current_index] = info.seq;
-
624 }
-
625
-
626 result[jss::validated] = context.ledgerMaster.isValidated(*ledger);
-
627 return Status::OK;
-
628}
-
-
629
-
630Json::Value
-
-
631lookupLedger(std::shared_ptr<ReadView const>& ledger, JsonContext& context)
-
632{
-
633 Json::Value result;
-
634 if (auto status = lookupLedger(ledger, context, result))
-
635 status.inject(result);
-
636
-
637 return result;
-
638}
-
-
639
-
640hash_set<AccountID>
-
-
641parseAccountIds(Json::Value const& jvArray)
-
642{
-
643 hash_set<AccountID> result;
-
644 for (auto const& jv : jvArray)
-
645 {
-
646 if (!jv.isString())
-
647 return hash_set<AccountID>();
-
648 auto const id = parseBase58<AccountID>(jv.asString());
-
649 if (!id)
-
650 return hash_set<AccountID>();
-
651 result.insert(*id);
-
652 }
-
653 return result;
-
654}
-
-
655
-
656void
-
-
657injectSLE(Json::Value& jv, SLE const& sle)
-
658{
-
659 jv = sle.getJson(JsonOptions::none);
-
660 if (sle.getType() == ltACCOUNT_ROOT)
-
661 {
-
662 if (sle.isFieldPresent(sfEmailHash))
-
663 {
-
664 auto const& hash = sle.getFieldH128(sfEmailHash);
-
665 Blob const b(hash.begin(), hash.end());
-
666 std::string md5 = strHex(makeSlice(b));
-
667 boost::to_lower(md5);
-
668 // VFALCO TODO Give a name and move this constant
-
669 // to a more visible location. Also
-
670 // shouldn't this be https?
-
671 jv[jss::urlgravatar] =
-
672 str(boost::format("http://www.gravatar.com/avatar/%s") % md5);
-
673 }
-
674 }
-
675 else
-
676 {
-
677 jv[jss::Invalid] = true;
-
678 }
-
679}
-
-
680
-
681std::optional<Json::Value>
-
-
682readLimitField(
-
683 unsigned int& limit,
-
684 Tuning::LimitRange const& range,
-
685 JsonContext const& context)
-
686{
-
687 limit = range.rdefault;
-
688 if (!context.params.isMember(jss::limit) ||
-
689 context.params[jss::limit].isNull())
-
690 return std::nullopt;
-
691
-
692 auto const& jvLimit = context.params[jss::limit];
-
693 if (!(jvLimit.isUInt() || (jvLimit.isInt() && jvLimit.asInt() >= 0)))
-
694 return RPC::expected_field_error(jss::limit, "unsigned integer");
-
695
-
696 limit = jvLimit.asUInt();
-
697 if (limit == 0)
-
698 return RPC::invalid_field_error(jss::limit);
-
699
-
700 if (!isUnlimited(context.role))
-
701 limit = std::max(range.rmin, std::min(range.rmax, limit));
-
702
-
703 return std::nullopt;
-
704}
-
-
705
-
706std::optional<Seed>
-
-
707parseRippleLibSeed(Json::Value const& value)
-
708{
-
709 // ripple-lib encodes seed used to generate an Ed25519 wallet in a
-
710 // non-standard way. While rippled never encode seeds that way, we
-
711 // try to detect such keys to avoid user confusion.
-
712 if (!value.isString())
-
713 return std::nullopt;
-
714
-
715 auto const result = decodeBase58Token(value.asString(), TokenType::None);
-
716
-
717 if (result.size() == 18 &&
-
718 static_cast<std::uint8_t>(result[0]) == std::uint8_t(0xE1) &&
-
719 static_cast<std::uint8_t>(result[1]) == std::uint8_t(0x4B))
-
720 return Seed(makeSlice(result.substr(2)));
-
721
-
722 return std::nullopt;
-
723}
-
-
724
-
725std::optional<Seed>
-
-
726getSeedFromRPC(Json::Value const& params, Json::Value& error)
-
727{
-
728 using string_to_seed_t =
-
729 std::function<std::optional<Seed>(std::string const&)>;
-
730 using seed_match_t = std::pair<char const*, string_to_seed_t>;
-
731
-
732 static seed_match_t const seedTypes[]{
-
733 {jss::passphrase.c_str(),
-
734 [](std::string const& s) { return parseGenericSeed(s); }},
-
735 {jss::seed.c_str(),
-
736 [](std::string const& s) { return parseBase58<Seed>(s); }},
-
737 {jss::seed_hex.c_str(), [](std::string const& s) {
-
738 uint128 i;
-
739 if (i.parseHex(s))
-
740 return std::optional<Seed>(Slice(i.data(), i.size()));
-
741 return std::optional<Seed>{};
-
742 }}};
-
743
-
744 // Identify which seed type is in use.
-
745 seed_match_t const* seedType = nullptr;
-
746 int count = 0;
-
747 for (auto const& t : seedTypes)
-
748 {
-
749 if (params.isMember(t.first))
-
750 {
-
751 ++count;
-
752 seedType = &t;
-
753 }
-
754 }
-
755
-
756 if (count != 1)
-
757 {
-
758 error = RPC::make_param_error(
-
759 "Exactly one of the following must be specified: " +
-
760 std::string(jss::passphrase) + ", " + std::string(jss::seed) +
-
761 " or " + std::string(jss::seed_hex));
-
762 return std::nullopt;
-
763 }
-
764
-
765 // Make sure a string is present
-
766 auto const& param = params[seedType->first];
-
767 if (!param.isString())
-
768 {
-
769 error = RPC::expected_field_error(seedType->first, "string");
-
770 return std::nullopt;
-
771 }
-
772
-
773 auto const fieldContents = param.asString();
-
774
-
775 // Convert string to seed.
-
776 std::optional<Seed> seed = seedType->second(fieldContents);
-
777
-
778 if (!seed)
-
779 error = rpcError(rpcBAD_SEED);
-
780
-
781 return seed;
-
782}
-
-
783
-
784std::optional<std::pair<PublicKey, SecretKey>>
-
-
785keypairForSignature(
-
786 Json::Value const& params,
-
787 Json::Value& error,
-
788 unsigned int apiVersion)
-
789{
-
790 bool const has_key_type = params.isMember(jss::key_type);
-
791
-
792 // All of the secret types we allow, but only one at a time.
-
793 static char const* const secretTypes[]{
-
794 jss::passphrase.c_str(),
-
795 jss::secret.c_str(),
-
796 jss::seed.c_str(),
-
797 jss::seed_hex.c_str()};
-
798
-
799 // Identify which secret type is in use.
-
800 char const* secretType = nullptr;
-
801 int count = 0;
-
802 for (auto t : secretTypes)
-
803 {
-
804 if (params.isMember(t))
-
805 {
-
806 ++count;
-
807 secretType = t;
-
808 }
-
809 }
-
810
-
811 if (count == 0 || secretType == nullptr)
-
812 {
-
813 error = RPC::missing_field_error(jss::secret);
-
814 return {};
-
815 }
-
816
-
817 if (count > 1)
-
818 {
-
819 error = RPC::make_param_error(
-
820 "Exactly one of the following must be specified: " +
-
821 std::string(jss::passphrase) + ", " + std::string(jss::secret) +
-
822 ", " + std::string(jss::seed) + " or " +
-
823 std::string(jss::seed_hex));
-
824 return {};
-
825 }
-
826
-
827 std::optional<KeyType> keyType;
-
828 std::optional<Seed> seed;
-
829
-
830 if (has_key_type)
-
831 {
-
832 if (!params[jss::key_type].isString())
-
833 {
-
834 error = RPC::expected_field_error(jss::key_type, "string");
-
835 return {};
-
836 }
-
837
-
838 keyType = keyTypeFromString(params[jss::key_type].asString());
-
839
-
840 if (!keyType)
-
841 {
-
842 if (apiVersion > 1u)
-
843 error = RPC::make_error(rpcBAD_KEY_TYPE);
-
844 else
-
845 error = RPC::invalid_field_error(jss::key_type);
-
846 return {};
-
847 }
-
848
-
849 // using strcmp as pointers may not match (see
-
850 // https://developercommunity.visualstudio.com/t/assigning-constexpr-char--to-static-cha/10021357?entry=problem)
-
851 if (strcmp(secretType, jss::secret.c_str()) == 0)
-
852 {
-
853 error = RPC::make_param_error(
-
854 "The secret field is not allowed if " +
-
855 std::string(jss::key_type) + " is used.");
-
856 return {};
-
857 }
-
858 }
-
859
-
860 // ripple-lib encodes seed used to generate an Ed25519 wallet in a
-
861 // non-standard way. While we never encode seeds that way, we try
-
862 // to detect such keys to avoid user confusion.
-
863 // using strcmp as pointers may not match (see
-
864 // https://developercommunity.visualstudio.com/t/assigning-constexpr-char--to-static-cha/10021357?entry=problem)
-
865 if (strcmp(secretType, jss::seed_hex.c_str()) != 0)
-
866 {
-
867 seed = RPC::parseRippleLibSeed(params[secretType]);
-
868
-
869 if (seed)
-
870 {
-
871 // If the user passed in an Ed25519 seed but *explicitly*
-
872 // requested another key type, return an error.
-
873 if (keyType.value_or(KeyType::ed25519) != KeyType::ed25519)
-
874 {
-
875 error = RPC::make_error(
-
876 rpcBAD_SEED, "Specified seed is for an Ed25519 wallet.");
-
877 return {};
-
878 }
-
879
-
880 keyType = KeyType::ed25519;
-
881 }
-
882 }
-
883
-
884 if (!keyType)
-
885 keyType = KeyType::secp256k1;
-
886
-
887 if (!seed)
-
888 {
-
889 if (has_key_type)
-
890 seed = getSeedFromRPC(params, error);
-
891 else
-
892 {
-
893 if (!params[jss::secret].isString())
-
894 {
-
895 error = RPC::expected_field_error(jss::secret, "string");
-
896 return {};
-
897 }
-
898
-
899 seed = parseGenericSeed(params[jss::secret].asString());
-
900 }
-
901 }
-
902
-
903 if (!seed)
-
904 {
-
905 if (!contains_error(error))
-
906 {
-
907 error = RPC::make_error(
-
908 rpcBAD_SEED, RPC::invalid_field_message(secretType));
-
909 }
-
910
-
911 return {};
-
912 }
-
913
-
914 if (keyType != KeyType::secp256k1 && keyType != KeyType::ed25519)
-
915 LogicError("keypairForSignature: invalid key type");
-
916
-
917 return generateKeyPair(*keyType, *seed);
-
918}
-
-
919
-
920std::pair<RPC::Status, LedgerEntryType>
-
-
921chooseLedgerEntryType(Json::Value const& params)
-
922{
-
923 std::pair<RPC::Status, LedgerEntryType> result{RPC::Status::OK, ltANY};
-
924 if (params.isMember(jss::type))
-
925 {
-
926 static constexpr auto types = std::to_array<
-
927 std::tuple<char const*, char const*, LedgerEntryType>>({
-
928#pragma push_macro("LEDGER_ENTRY")
-
929#undef LEDGER_ENTRY
-
930
-
931#define LEDGER_ENTRY(tag, value, name, rpcName, ...) \
-
932 {jss::name, jss::rpcName, tag},
-
933
-
934#include <xrpl/protocol/detail/ledger_entries.macro>
-
935
-
936#undef LEDGER_ENTRY
-
937#pragma pop_macro("LEDGER_ENTRY")
-
938 });
-
939
-
940 auto const& p = params[jss::type];
-
941 if (!p.isString())
-
942 {
-
943 result.first = RPC::Status{
-
944 rpcINVALID_PARAMS, "Invalid field 'type', not string."};
-
945 XRPL_ASSERT(
-
946 result.first.type() == RPC::Status::Type::error_code_i,
-
947 "ripple::RPC::chooseLedgerEntryType : first valid result type");
-
948 return result;
-
949 }
-
950
-
951 // Use the passed in parameter to find a ledger type based on matching
-
952 // against the canonical name (case-insensitive) or the RPC name
-
953 // (case-sensitive).
-
954 auto const filter = p.asString();
-
955 auto const iter =
-
956 std::ranges::find_if(types, [&filter](decltype(types.front())& t) {
-
957 return boost::iequals(std::get<0>(t), filter) ||
-
958 std::get<1>(t) == filter;
-
959 });
-
960 if (iter == types.end())
-
961 {
-
962 result.first =
-
963 RPC::Status{rpcINVALID_PARAMS, "Invalid field 'type'."};
-
964 XRPL_ASSERT(
-
965 result.first.type() == RPC::Status::Type::error_code_i,
-
966 "ripple::RPC::chooseLedgerEntryType : second valid result "
-
967 "type");
-
968 return result;
-
969 }
-
970 result.second = std::get<2>(*iter);
-
971 }
-
972 return result;
-
973}
-
-
974
-
975bool
-
-
976isAccountObjectsValidType(LedgerEntryType const& type)
-
977{
-
978 switch (type)
-
979 {
-
980 case LedgerEntryType::ltAMENDMENTS:
-
981 case LedgerEntryType::ltDIR_NODE:
-
982 case LedgerEntryType::ltFEE_SETTINGS:
-
983 case LedgerEntryType::ltLEDGER_HASHES:
-
984 case LedgerEntryType::ltNEGATIVE_UNL:
-
985 return false;
-
986 default:
-
987 return true;
-
988 }
-
989}
-
-
990
-
991std::variant<std::shared_ptr<Ledger const>, Json::Value>
-
-
992getLedgerByContext(RPC::JsonContext& context)
-
993{
-
994 auto const hasHash = context.params.isMember(jss::ledger_hash);
-
995 auto const hasIndex = context.params.isMember(jss::ledger_index);
-
996 std::uint32_t ledgerIndex = 0;
-
997
-
998 auto& ledgerMaster = context.app.getLedgerMaster();
-
999 LedgerHash ledgerHash;
-
1000
-
1001 if ((hasHash && hasIndex) || !(hasHash || hasIndex))
-
1002 {
-
1003 return RPC::make_param_error(
-
1004 "Exactly one of ledger_hash and ledger_index can be set.");
-
1005 }
-
1006
-
1007 context.loadType = Resource::feeHeavyBurdenRPC;
-
1008
-
1009 if (hasHash)
-
1010 {
-
1011 auto const& jsonHash = context.params[jss::ledger_hash];
-
1012 if (!jsonHash.isString() || !ledgerHash.parseHex(jsonHash.asString()))
-
1013 return RPC::invalid_field_error(jss::ledger_hash);
-
1014 }
-
1015 else
-
1016 {
-
1017 auto const& jsonIndex = context.params[jss::ledger_index];
-
1018 if (!jsonIndex.isInt())
-
1019 return RPC::invalid_field_error(jss::ledger_index);
-
1020
-
1021 // We need a validated ledger to get the hash from the sequence
-
1022 if (ledgerMaster.getValidatedLedgerAge() >
-
1023 RPC::Tuning::maxValidatedLedgerAge)
-
1024 {
-
1025 if (context.apiVersion == 1)
-
1026 return rpcError(rpcNO_CURRENT);
-
1027 return rpcError(rpcNOT_SYNCED);
-
1028 }
-
1029
-
1030 ledgerIndex = jsonIndex.asInt();
-
1031 auto ledger = ledgerMaster.getValidatedLedger();
-
1032
-
1033 if (ledgerIndex >= ledger->info().seq)
-
1034 return RPC::make_param_error("Ledger index too large");
-
1035 if (ledgerIndex <= 0)
-
1036 return RPC::make_param_error("Ledger index too small");
-
1037
-
1038 auto const j = context.app.journal("RPCHandler");
-
1039 // Try to get the hash of the desired ledger from the validated
-
1040 // ledger
-
1041 auto neededHash = hashOfSeq(*ledger, ledgerIndex, j);
-
1042 if (!neededHash)
-
1043 {
-
1044 // Find a ledger more likely to have the hash of the desired
-
1045 // ledger
-
1046 auto const refIndex = getCandidateLedger(ledgerIndex);
-
1047 auto refHash = hashOfSeq(*ledger, refIndex, j);
-
1048 XRPL_ASSERT(
-
1049 refHash,
-
1050 "ripple::RPC::getLedgerByContext : nonzero ledger hash");
-
1051
-
1052 ledger = ledgerMaster.getLedgerByHash(*refHash);
-
1053 if (!ledger)
-
1054 {
-
1055 // We don't have the ledger we need to figure out which
-
1056 // ledger they want. Try to get it.
-
1057
-
1058 if (auto il = context.app.getInboundLedgers().acquire(
-
1059 *refHash, refIndex, InboundLedger::Reason::GENERIC))
-
1060 {
-
1061 Json::Value jvResult = RPC::make_error(
-
1062 rpcLGR_NOT_FOUND,
-
1063 "acquiring ledger containing requested index");
-
1064 jvResult[jss::acquiring] =
-
1065 getJson(LedgerFill(*il, &context));
-
1066 return jvResult;
-
1067 }
-
1068
-
1069 if (auto il = context.app.getInboundLedgers().find(*refHash))
-
1070 {
-
1071 Json::Value jvResult = RPC::make_error(
-
1072 rpcLGR_NOT_FOUND,
-
1073 "acquiring ledger containing requested index");
-
1074 jvResult[jss::acquiring] = il->getJson(0);
-
1075 return jvResult;
-
1076 }
-
1077
-
1078 // Likely the app is shutting down
-
1079 return Json::Value();
-
1080 }
-
1081
-
1082 neededHash = hashOfSeq(*ledger, ledgerIndex, j);
-
1083 }
-
1084 XRPL_ASSERT(
-
1085 neededHash,
-
1086 "ripple::RPC::getLedgerByContext : nonzero needed hash");
-
1087 ledgerHash = neededHash ? *neededHash : beast::zero; // kludge
-
1088 }
-
1089
-
1090 // Try to get the desired ledger
-
1091 // Verify all nodes even if we think we have it
-
1092 auto ledger = context.app.getInboundLedgers().acquire(
-
1093 ledgerHash, ledgerIndex, InboundLedger::Reason::GENERIC);
-
1094
-
1095 // In standalone mode, accept the ledger from the ledger cache
-
1096 if (!ledger && context.app.config().standalone())
-
1097 ledger = ledgerMaster.getLedgerByHash(ledgerHash);
-
1098
-
1099 if (ledger)
-
1100 return ledger;
-
1101
-
1102 if (auto il = context.app.getInboundLedgers().find(ledgerHash))
-
1103 return il->getJson(0);
-
1104
-
1105 return RPC::make_error(
-
1106 rpcNOT_READY, "findCreate failed to return an inbound ledger");
-
1107}
-
-
1108
-
1109} // namespace RPC
-
1110} // namespace ripple
+
483
+
484} // namespace RPC
+
485} // namespace ripple
-
std::vector::begin
T begin(T... args)
Json::Value
Represents a JSON value.
Definition json_value.h:131
Json::Value::isString
bool isString() const
Definition json_value.cpp:1109
Json::Value::asString
std::string asString() const
Returns the unquoted string value.
Definition json_value.cpp:471
Json::Value::isNull
bool isNull() const
isNull() tests to see if this field is null.
Definition json_value.cpp:1067
Json::Value::isMember
bool isMember(char const *key) const
Return true if the object has a member named key.
Definition json_value.cpp:1030
-
ripple::Application::config
virtual Config & config()=0
-
ripple::Application::journal
virtual beast::Journal journal(std::string const &name)=0
-
ripple::Application::getInboundLedgers
virtual InboundLedgers & getInboundLedgers()=0
-
ripple::Application::getLedgerMaster
virtual LedgerMaster & getLedgerMaster()=0
-
ripple::Config::standalone
bool standalone() const
Definition Config.h:317
- -
ripple::InboundLedgers::acquire
virtual std::shared_ptr< Ledger const > acquire(uint256 const &hash, std::uint32_t seq, InboundLedger::Reason)=0
-
ripple::InboundLedgers::find
virtual std::shared_ptr< InboundLedger > find(LedgerHash const &hash)=0
- -
ripple::LedgerMaster::getValidatedLedger
std::shared_ptr< Ledger const > getValidatedLedger()
Definition LedgerMaster.cpp:1546
-
ripple::LedgerMaster::getCurrentLedger
std::shared_ptr< ReadView const > getCurrentLedger()
Definition LedgerMaster.cpp:1540
-
ripple::LedgerMaster::isValidated
bool isValidated(ReadView const &ledger)
Definition LedgerMaster.cpp:480
-
ripple::LedgerMaster::getClosedLedger
std::shared_ptr< Ledger const > getClosedLedger()
Definition LedgerMaster.h:60
-
ripple::LedgerMaster::getLedgerBySeq
std::shared_ptr< Ledger const > getLedgerBySeq(std::uint32_t index)
Definition LedgerMaster.cpp:1689
-
ripple::LedgerMaster::getLedgerByHash
std::shared_ptr< Ledger const > getLedgerByHash(uint256 const &hash)
Definition LedgerMaster.cpp:1725
-
ripple::LedgerMaster::getValidLedgerIndex
LedgerIndex getValidLedgerIndex()
Definition LedgerMaster.cpp:110
ripple::ReadView
A view into a ledger.
Definition ReadView.h:32
-
ripple::ReadView::read
virtual std::shared_ptr< SLE const > read(Keylet const &k) const =0
Return the state item associated with a key.
-
ripple::ReadView::succ
virtual std::optional< key_type > succ(key_type const &key, std::optional< key_type > const &last=std::nullopt) const =0
Return the key of the next state item.
ripple::STLedgerEntry::getType
LedgerEntryType getType() const
Definition STLedgerEntry.h:106
ripple::STLedgerEntry::getJson
Json::Value getJson(JsonOptions options=JsonOptions::none) const override
Definition STLedgerEntry.cpp:116
@@ -1269,80 +607,49 @@ $(document).ready(function() { init_codefold(0); });
ripple::Seed
Seeds are used to generate deterministic secret keys.
Definition Seed.h:15
ripple::Slice
An immutable linear range of bytes.
Definition Slice.h:27
ripple::base_uint< 160, detail::AccountIDTag >
-
ripple::base_uint::next
base_uint next() const
Definition base_uint.h:436
-
ripple::base_uint< 256 >::fromVoidChecked
static std::optional< base_uint > fromVoidChecked(T const &from)
Definition base_uint.h:307
ripple::base_uint::data
pointer data()
Definition base_uint.h:106
ripple::base_uint::size
static constexpr std::size_t size()
Definition base_uint.h:507
ripple::base_uint::parseHex
constexpr bool parseHex(std::string_view sv)
Parse a hex string into a base_uint.
Definition base_uint.h:484
-
ripple::base_uint::isZero
bool isZero() const
Definition base_uint.h:521
-
std::vector::end
T end(T... args)
-
std::find
T find(T... args)
+
std::ranges::find_if
T find_if(T... args)
std::unordered_set::insert
T insert(T... args)
std::is_same_v
T is_same_v
std::max
T max(T... args)
std::min
T min(T... args)
-
Json::stringValue
@ stringValue
UTF-8 string value.
Definition json_value.h:24
-
Json::arrayValue
@ arrayValue
array value (ordered list)
Definition json_value.h:26
Json::objectValue
@ objectValue
object value (collection of name/value pairs).
Definition json_value.h:27
-
beast::lexicalCastChecked
bool lexicalCastChecked(Out &out, In in)
Intelligently convert from one type to another.
Definition LexicalCast.h:181
-
ripple::NodeStore::Status
Status
Return codes from Backend operations.
Definition nodestore/Types.h:25
- -
ripple::RPC::ledgerFromRequest
Status ledgerFromRequest(T &ledger, GRPCContext< R > &context)
Definition RPCHelpers.cpp:392
ripple::RPC::accountFromStringWithCode
error_code_i accountFromStringWithCode(AccountID &result, std::string const &strIdent, bool bStrict)
Decode account ID from string.
Definition RPCHelpers.cpp:41
ripple::RPC::contains_error
bool contains_error(Json::Value const &json)
Returns true if the json contains an rpc error specification.
Definition ErrorCodes.cpp:188
-
ripple::RPC::getSeedFromRPC
std::optional< Seed > getSeedFromRPC(Json::Value const &params, Json::Value &error)
Definition RPCHelpers.cpp:726
+
ripple::RPC::getSeedFromRPC
std::optional< Seed > getSeedFromRPC(Json::Value const &params, Json::Value &error)
Definition RPCHelpers.cpp:219
ripple::RPC::make_error
Json::Value make_error(error_code_i code)
Returns a new json object that reflects the error code.
Definition ErrorCodes.cpp:172
-
ripple::RPC::getLedgerByContext
std::variant< std::shared_ptr< Ledger const >, Json::Value > getLedgerByContext(RPC::JsonContext &context)
Return a ledger based on ledger_hash or ledger_index, or an RPC error.
Definition RPCHelpers.cpp:992
ripple::RPC::invalid_field_error
Json::Value invalid_field_error(std::string const &name)
Definition ErrorCodes.h:306
-
ripple::RPC::isAccountObjectsValidType
bool isAccountObjectsValidType(LedgerEntryType const &type)
Check if the type is a valid filtering type for account_objects method.
Definition RPCHelpers.cpp:976
+
ripple::RPC::isAccountObjectsValidType
bool isAccountObjectsValidType(LedgerEntryType const &type)
Check if the type is a valid filtering type for account_objects method.
Definition RPCHelpers.cpp:469
ripple::RPC::apiVersion
static constexpr std::integral_constant< unsigned, Version > apiVersion
Definition ApiVersion.h:39
ripple::RPC::isRelatedToAccount
bool isRelatedToAccount(ReadView const &ledger, std::shared_ptr< SLE const > const &sle, AccountID const &accountID)
Tests if a SLE is owned by accountID.
Definition RPCHelpers.cpp:96
- -
ripple::RPC::injectSLE
void injectSLE(Json::Value &jv, SLE const &sle)
Inject JSON describing ledger entry.
Definition RPCHelpers.cpp:657
+
ripple::RPC::injectSLE
void injectSLE(Json::Value &jv, SLE const &sle)
Inject JSON describing ledger entry.
Definition RPCHelpers.cpp:150
ripple::RPC::make_param_error
Json::Value make_param_error(std::string const &message)
Returns a new json object that indicates invalid parameters.
Definition ErrorCodes.h:252
-
ripple::RPC::getLedger
Status getLedger(T &ledger, uint256 const &ledgerHash, Context &context)
Get ledger by hash If there is no error in the return value, the ledger pointer will have been filled...
Definition RPCHelpers.cpp:472
-
ripple::RPC::chooseLedgerEntryType
std::pair< RPC::Status, LedgerEntryType > chooseLedgerEntryType(Json::Value const &params)
Definition RPCHelpers.cpp:921
+
ripple::RPC::chooseLedgerEntryType
std::pair< RPC::Status, LedgerEntryType > chooseLedgerEntryType(Json::Value const &params)
Definition RPCHelpers.cpp:414
ripple::RPC::invalid_field_message
std::string invalid_field_message(std::string const &name)
Definition ErrorCodes.h:294
-
ripple::RPC::getAccountObjects
bool getAccountObjects(ReadView const &ledger, AccountID const &account, std::optional< std::vector< LedgerEntryType > > const &typeFilter, uint256 dirIndex, uint256 entryIndex, std::uint32_t const limit, Json::Value &jvResult)
Gathers all objects for an account in a ledger.
Definition RPCHelpers.cpp:134
-
ripple::RPC::readLimitField
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...
Definition RPCHelpers.cpp:682
+
ripple::RPC::readLimitField
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...
Definition RPCHelpers.cpp:175
ripple::RPC::accountFromString
Json::Value accountFromString(AccountID &result, std::string const &strIdent, bool bStrict)
Definition RPCHelpers.cpp:69
ripple::RPC::expected_field_error
Json::Value expected_field_error(std::string const &name, std::string const &type)
Definition ErrorCodes.h:330
-
ripple::RPC::lookupLedger
Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
Definition RPCHelpers.cpp:606
-
ripple::RPC::ledgerFromSpecifier
Status ledgerFromSpecifier(T &ledger, org::xrpl::rpc::v1::LedgerSpecifier const &specifier, Context &context)
Definition RPCHelpers.cpp:418
ripple::RPC::accountFromStringStrict
std::optional< AccountID > accountFromStringStrict(std::string const &account)
Get an AccountID from an account ID or public key.
Definition RPCHelpers.cpp:25
-
ripple::RPC::parseAccountIds
hash_set< AccountID > parseAccountIds(Json::Value const &jvArray)
Definition RPCHelpers.cpp:641
+
ripple::RPC::parseAccountIds
hash_set< AccountID > parseAccountIds(Json::Value const &jvArray)
Definition RPCHelpers.cpp:134
ripple::RPC::getStartHint
std::uint64_t getStartHint(std::shared_ptr< SLE const > const &sle, AccountID const &accountID)
Gets the start hint for traversing account objects.
Definition RPCHelpers.cpp:79
ripple::RPC::missing_field_error
Json::Value missing_field_error(std::string const &name)
Definition ErrorCodes.h:264
-
ripple::RPC::parseRippleLibSeed
std::optional< Seed > parseRippleLibSeed(Json::Value const &value)
Definition RPCHelpers.cpp:707
-
ripple::RPC::keypairForSignature
std::optional< std::pair< PublicKey, SecretKey > > keypairForSignature(Json::Value const &params, Json::Value &error, unsigned int apiVersion)
Definition RPCHelpers.cpp:785
-
ripple::Resource::feeHeavyBurdenRPC
Charge const feeHeavyBurdenRPC
-
ripple::keylet::child
Keylet child(uint256 const &key) noexcept
Any item that can be in an owner dir.
Definition Indexes.cpp:171
-
ripple::keylet::page
Keylet page(uint256 const &root, std::uint64_t index=0) noexcept
A page in a directory.
Definition Indexes.cpp:361
-
ripple::keylet::nftpage_min
Keylet nftpage_min(AccountID const &owner)
NFT page keylets.
Definition Indexes.cpp:384
-
ripple::keylet::nftpage_max
Keylet nftpage_max(AccountID const &owner)
A keylet for the owner's last possible NFT page.
Definition Indexes.cpp:392
-
ripple::keylet::ownerDir
Keylet ownerDir(AccountID const &id) noexcept
The root page of an account's directory.
Definition Indexes.cpp:355
+
ripple::RPC::parseRippleLibSeed
std::optional< Seed > parseRippleLibSeed(Json::Value const &value)
Definition RPCHelpers.cpp:200
+
ripple::RPC::keypairForSignature
std::optional< std::pair< PublicKey, SecretKey > > keypairForSignature(Json::Value const &params, Json::Value &error, unsigned int apiVersion)
Definition RPCHelpers.cpp:278
ripple::keylet::signers
Keylet signers(AccountID const &account) noexcept
A SignerList.
Definition Indexes.cpp:311
-
ripple::nft::pageMask
uint256 constexpr pageMask(std::string_view("0000000000000000000000000000000000000000ffffffffffffffffffffffff"))
ripple
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition algorithm.h:6
ripple::keyTypeFromString
std::optional< KeyType > keyTypeFromString(std::string const &s)
Definition KeyType.h:15
-
ripple::getCandidateLedger
LedgerIndex getCandidateLedger(LedgerIndex requested)
Find a ledger index from which we could easily get the requested ledger.
Definition View.h:410
-
ripple::rpcNO_NETWORK
@ rpcNO_NETWORK
Definition ErrorCodes.h:47
ripple::rpcACT_MALFORMED
@ rpcACT_MALFORMED
Definition ErrorCodes.h:71
ripple::rpcBAD_KEY_TYPE
@ rpcBAD_KEY_TYPE
Definition ErrorCodes.h:114
-
ripple::rpcNOT_READY
@ rpcNOT_READY
Definition ErrorCodes.h:41
ripple::rpcSUCCESS
@ rpcSUCCESS
Definition ErrorCodes.h:25
-
ripple::rpcNO_CURRENT
@ rpcNO_CURRENT
Definition ErrorCodes.h:46
ripple::rpcINVALID_PARAMS
@ rpcINVALID_PARAMS
Definition ErrorCodes.h:65
-
ripple::rpcLGR_NOT_FOUND
@ rpcLGR_NOT_FOUND
Definition ErrorCodes.h:53
ripple::rpcBAD_SEED
@ rpcBAD_SEED
Definition ErrorCodes.h:80
-
ripple::rpcNOT_SYNCED
@ rpcNOT_SYNCED
Definition ErrorCodes.h:48
ripple::generateKeyPair
std::pair< PublicKey, SecretKey > generateKeyPair(KeyType type, Seed const &seed)
Generate a key pair deterministically.
Definition SecretKey.cpp:350
-
ripple::uint256
base_uint< 256 > uint256
Definition base_uint.h:539
-
ripple::hashOfSeq
std::optional< uint256 > hashOfSeq(ReadView const &ledger, LedgerIndex seq, beast::Journal journal)
Return the hash of a ledger by sequence.
Definition View.cpp:942
ripple::calcAccountID
AccountID calcAccountID(PublicKey const &pk)
Definition AccountID.cpp:149
ripple::rpcError
Json::Value rpcError(int iError)
Definition RPCErr.cpp:12
ripple::isUnlimited
bool isUnlimited(Role const &role)
ADMIN and IDENTIFIED roles shall have unlimited resources.
Definition Role.cpp:106
@@ -1351,13 +658,9 @@ $(document).ready(function() { init_codefold(0); });
ripple::makeSlice
std::enable_if_t< std::is_same< T, char >::value||std::is_same< T, unsigned char >::value, Slice > makeSlice(std::array< T, N > const &a)
Definition Slice.h:225
-
ripple::to_string
std::string to_string(base_uint< Bits, Tag > const &a)
Definition base_uint.h:611
ripple::range
ClosedInterval< T > range(T low, T high)
Create a closed range interval.
Definition RangeSet.h:35
ripple::LedgerEntryType
LedgerEntryType
Identifiers for on-ledger objects.
Definition LedgerFormats.h:35
ripple::ltANY
@ ltANY
A special type, matching any ledger entry type.
Definition LedgerFormats.h:59
-
ripple::root
Number root(Number f, unsigned d)
Definition Number.cpp:617
-
ripple::getJson
Json::Value getJson(LedgerFill const &fill)
Return a new Json::Value representing the ledger with given options.
Definition LedgerToJson.cpp:338
-
ripple::HashPrefix::ledgerMaster
@ ledgerMaster
ledger master data for signing
ripple::parseGenericSeed
std::optional< Seed > parseGenericSeed(std::string const &str, bool rfc1751=true)
Attempt to parse a string as a seed.
Definition Seed.cpp:78
ripple::LogicError
void LogicError(std::string const &how) noexcept
Called when faulty logic causes a broken invariant.
Definition libxrpl/basics/contract.cpp:18
@@ -1366,15 +669,7 @@ $(document).ready(function() { init_codefold(0); });
ripple::Keylet
A pair of SHAMap key and LedgerEntryType.
Definition Keylet.h:20
ripple::Keylet::key
uint256 key
Definition Keylet.h:21
- -
ripple::RPC::Context
The context of information needed to call an RPC.
Definition Context.h:20
-
ripple::RPC::Context::apiVersion
unsigned int apiVersion
Definition Context.h:30
-
ripple::RPC::Context::loadType
Resource::Charge & loadType
Definition Context.h:23
-
ripple::RPC::Context::app
Application & app
Definition Context.h:22
-
ripple::RPC::Context::ledgerMaster
LedgerMaster & ledgerMaster
Definition Context.h:25
- -
ripple::RPC::Status
Status represents the results of an operation that might fail.
Definition Status.h:21
@@ -1384,8 +679,7 @@ $(document).ready(function() { init_codefold(0); });
std::optional::value_or
T value_or(T... args)
- - +
diff --git a/RPCHelpers_8h_source.html b/RPCHelpers_8h_source.html index ac377b6468..a363d6ffc3 100644 --- a/RPCHelpers_8h_source.html +++ b/RPCHelpers_8h_source.html @@ -139,135 +139,75 @@ $(document).ready(function() { init_codefold(0); });
73 std::shared_ptr<SLE const> const& sle,
74 AccountID const& accountID);
75
-
85bool
-
86getAccountObjects(
-
87 ReadView const& ledger,
-
88 AccountID const& account,
-
89 std::optional<std::vector<LedgerEntryType>> const& typeFilter,
-
90 uint256 dirIndex,
-
91 uint256 entryIndex,
-
92 std::uint32_t const limit,
-
93 Json::Value& jvResult);
-
94
-
99template <class T>
-
100Status
-
101getLedger(T& ledger, uint256 const& ledgerHash, Context& context);
-
102
-
107template <class T>
-
108Status
-
109getLedger(T& ledger, uint32_t ledgerIndex, Context& context);
-
110
-
111enum LedgerShortcut { CURRENT, CLOSED, VALIDATED };
-
116template <class T>
-
117Status
-
118getLedger(T& ledger, LedgerShortcut shortcut, Context& context);
-
119
-
126Json::Value
-
127lookupLedger(std::shared_ptr<ReadView const>&, JsonContext&);
-
128
-
134Status
-
135lookupLedger(
-
136 std::shared_ptr<ReadView const>&,
-
137 JsonContext&,
-
138 Json::Value& result);
-
139
-
140template <class T, class R>
-
141Status
-
142ledgerFromRequest(T& ledger, GRPCContext<R>& context);
-
143
-
144template <class T>
-
145Status
-
146ledgerFromSpecifier(
-
147 T& ledger,
-
148 org::xrpl::rpc::v1::LedgerSpecifier const& specifier,
-
149 Context& context);
-
150
-
151hash_set<AccountID>
-
152parseAccountIds(Json::Value const& jvArray);
-
153
-
154bool
-
155isHexTxID(std::string const& txid);
-
156
-
165void
-
166injectSLE(Json::Value& jv, SLE const& sle);
-
167
-
173std::optional<Json::Value>
-
174readLimitField(
-
175 unsigned int& limit,
-
176 Tuning::LimitRange const&,
-
177 JsonContext const&);
-
178
-
179std::optional<Seed>
-
180getSeedFromRPC(Json::Value const& params, Json::Value& error);
-
181
-
182std::optional<Seed>
-
183parseRippleLibSeed(Json::Value const& params);
-
184
-
185std::pair<RPC::Status, LedgerEntryType>
-
186chooseLedgerEntryType(Json::Value const& params);
-
187
-
194bool
-
195isAccountObjectsValidType(LedgerEntryType const& type);
-
196
-
199std::variant<std::shared_ptr<Ledger const>, Json::Value>
-
200getLedgerByContext(RPC::JsonContext& context);
-
201
-
202std::optional<std::pair<PublicKey, SecretKey>>
-
203keypairForSignature(
-
204 Json::Value const& params,
-
205 Json::Value& error,
-
206 unsigned int apiVersion = apiVersionIfUnspecified);
-
207
-
208} // namespace RPC
-
209
-
210} // namespace ripple
-
211
-
212#endif
+
76hash_set<AccountID>
+
77parseAccountIds(Json::Value const& jvArray);
+
78
+
79bool
+
80isHexTxID(std::string const& txid);
+
81
+
90void
+
91injectSLE(Json::Value& jv, SLE const& sle);
+
92
+
98std::optional<Json::Value>
+
99readLimitField(
+
100 unsigned int& limit,
+
101 Tuning::LimitRange const&,
+
102 JsonContext const&);
+
103
+
104std::optional<Seed>
+
105getSeedFromRPC(Json::Value const& params, Json::Value& error);
+
106
+
107std::optional<Seed>
+
108parseRippleLibSeed(Json::Value const& params);
+
109
+
110std::pair<RPC::Status, LedgerEntryType>
+
111chooseLedgerEntryType(Json::Value const& params);
+
112
+
119bool
+
120isAccountObjectsValidType(LedgerEntryType const& type);
+
121
+
122std::optional<std::pair<PublicKey, SecretKey>>
+
123keypairForSignature(
+
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
Json::Value
Represents a JSON value.
Definition json_value.h:131
Json
JSON (JavaScript Object Notation).
Definition json_errors.h:6
-
ripple::NodeStore::Status
Status
Return codes from Backend operations.
Definition nodestore/Types.h:25
-
ripple::RPC::ledgerFromRequest
Status ledgerFromRequest(T &ledger, GRPCContext< R > &context)
Definition RPCHelpers.cpp:392
ripple::RPC::accountFromStringWithCode
error_code_i accountFromStringWithCode(AccountID &result, std::string const &strIdent, bool bStrict)
Decode account ID from string.
Definition RPCHelpers.cpp:41
-
ripple::RPC::getSeedFromRPC
std::optional< Seed > getSeedFromRPC(Json::Value const &params, Json::Value &error)
Definition RPCHelpers.cpp:726
-
ripple::RPC::getLedgerByContext
std::variant< std::shared_ptr< Ledger const >, Json::Value > getLedgerByContext(RPC::JsonContext &context)
Return a ledger based on ledger_hash or ledger_index, or an RPC error.
Definition RPCHelpers.cpp:992
-
ripple::RPC::isAccountObjectsValidType
bool isAccountObjectsValidType(LedgerEntryType const &type)
Check if the type is a valid filtering type for account_objects method.
Definition RPCHelpers.cpp:976
+
ripple::RPC::getSeedFromRPC
std::optional< Seed > getSeedFromRPC(Json::Value const &params, Json::Value &error)
Definition RPCHelpers.cpp:219
+
ripple::RPC::isAccountObjectsValidType
bool isAccountObjectsValidType(LedgerEntryType const &type)
Check if the type is a valid filtering type for account_objects method.
Definition RPCHelpers.cpp:469
ripple::RPC::apiVersion
static constexpr std::integral_constant< unsigned, Version > apiVersion
Definition ApiVersion.h:39
ripple::RPC::isRelatedToAccount
bool isRelatedToAccount(ReadView const &ledger, std::shared_ptr< SLE const > const &sle, AccountID const &accountID)
Tests if a SLE is owned by accountID.
Definition RPCHelpers.cpp:96
- - - - -
ripple::RPC::injectSLE
void injectSLE(Json::Value &jv, SLE const &sle)
Inject JSON describing ledger entry.
Definition RPCHelpers.cpp:657
-
ripple::RPC::getLedger
Status getLedger(T &ledger, uint256 const &ledgerHash, Context &context)
Get ledger by hash If there is no error in the return value, the ledger pointer will have been filled...
Definition RPCHelpers.cpp:472
-
ripple::RPC::chooseLedgerEntryType
std::pair< RPC::Status, LedgerEntryType > chooseLedgerEntryType(Json::Value const &params)
Definition RPCHelpers.cpp:921
-
ripple::RPC::getAccountObjects
bool getAccountObjects(ReadView const &ledger, AccountID const &account, std::optional< std::vector< LedgerEntryType > > const &typeFilter, uint256 dirIndex, uint256 entryIndex, std::uint32_t const limit, Json::Value &jvResult)
Gathers all objects for an account in a ledger.
Definition RPCHelpers.cpp:134
-
ripple::RPC::readLimitField
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...
Definition RPCHelpers.cpp:682
+
ripple::RPC::injectSLE
void injectSLE(Json::Value &jv, SLE const &sle)
Inject JSON describing ledger entry.
Definition RPCHelpers.cpp:150
+
ripple::RPC::chooseLedgerEntryType
std::pair< RPC::Status, LedgerEntryType > chooseLedgerEntryType(Json::Value const &params)
Definition RPCHelpers.cpp:414
+
ripple::RPC::readLimitField
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...
Definition RPCHelpers.cpp:175
ripple::RPC::accountFromString
Json::Value accountFromString(AccountID &result, std::string const &strIdent, bool bStrict)
Definition RPCHelpers.cpp:69
ripple::RPC::apiVersionIfUnspecified
static constexpr auto apiVersionIfUnspecified
Definition ApiVersion.h:44
-
ripple::RPC::lookupLedger
Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
Definition RPCHelpers.cpp:606
-
ripple::RPC::ledgerFromSpecifier
Status ledgerFromSpecifier(T &ledger, org::xrpl::rpc::v1::LedgerSpecifier const &specifier, Context &context)
Definition RPCHelpers.cpp:418
ripple::RPC::accountFromStringStrict
std::optional< AccountID > accountFromStringStrict(std::string const &account)
Get an AccountID from an account ID or public key.
Definition RPCHelpers.cpp:25
-
ripple::RPC::parseAccountIds
hash_set< AccountID > parseAccountIds(Json::Value const &jvArray)
Definition RPCHelpers.cpp:641
+
ripple::RPC::parseAccountIds
hash_set< AccountID > parseAccountIds(Json::Value const &jvArray)
Definition RPCHelpers.cpp:134
ripple::RPC::getStartHint
std::uint64_t getStartHint(std::shared_ptr< SLE const > const &sle, AccountID const &accountID)
Gets the start hint for traversing account objects.
Definition RPCHelpers.cpp:79
ripple::RPC::isHexTxID
bool isHexTxID(std::string const &txid)
-
ripple::RPC::parseRippleLibSeed
std::optional< Seed > parseRippleLibSeed(Json::Value const &value)
Definition RPCHelpers.cpp:707
-
ripple::RPC::keypairForSignature
std::optional< std::pair< PublicKey, SecretKey > > keypairForSignature(Json::Value const &params, Json::Value &error, unsigned int apiVersion)
Definition RPCHelpers.cpp:785
+
ripple::RPC::parseRippleLibSeed
std::optional< Seed > parseRippleLibSeed(Json::Value const &value)
Definition RPCHelpers.cpp:200
+
ripple::RPC::keypairForSignature
std::optional< std::pair< PublicKey, SecretKey > > keypairForSignature(Json::Value const &params, Json::Value &error, unsigned int apiVersion)
Definition RPCHelpers.cpp:278
ripple
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition algorithm.h:6
ripple::AccountID
base_uint< 160, detail::AccountIDTag > AccountID
A 160-bit unsigned that uniquely identifies an account.
Definition AccountID.h:29
-
ripple::uint256
base_uint< 256 > uint256
Definition base_uint.h:539
ripple::LedgerEntryType
LedgerEntryType
Identifiers for on-ledger objects.
Definition LedgerFormats.h:35
ripple::RPC::Tuning::LimitRange
Represents RPC limit parameter values that have a min, default and max.
Definition src/xrpld/rpc/detail/Tuning.h:13
- -
diff --git a/RPCHelpers__test_8cpp_source.html b/RPCHelpers__test_8cpp_source.html index 4da646a919..4c3508ad9e 100644 --- a/RPCHelpers__test_8cpp_source.html +++ b/RPCHelpers__test_8cpp_source.html @@ -171,7 +171,7 @@ $(document).ready(function() { init_codefold(0); });
ripple::test::RPCHelpers_test::run
void run() override
Runs the suite.
Definition RPCHelpers_test.cpp:67
ripple::test::jtx::rpc
Set the expected result code for a JTx The test will fail if the code doesn't match.
Definition rpc.h:16
Json::objectValue
@ objectValue
object value (collection of name/value pairs).
Definition json_value.h:27
-
ripple::RPC::chooseLedgerEntryType
std::pair< RPC::Status, LedgerEntryType > chooseLedgerEntryType(Json::Value const &params)
Definition RPCHelpers.cpp:921
+
ripple::RPC::chooseLedgerEntryType
std::pair< RPC::Status, LedgerEntryType > chooseLedgerEntryType(Json::Value const &params)
Definition RPCHelpers.cpp:414
ripple
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition algorithm.h:6
ripple::RPC::Status
Status represents the results of an operation that might fail.
Definition Status.h:21
ripple::RPC::Status::OK
static constexpr Code OK
Definition Status.h:27
diff --git a/RPCLedgerHelpers_8cpp_source.html b/RPCLedgerHelpers_8cpp_source.html new file mode 100644 index 0000000000..d28d3cb2dc --- /dev/null +++ b/RPCLedgerHelpers_8cpp_source.html @@ -0,0 +1,627 @@ + + + + + + + +rippled: RPCLedgerHelpers.cpp Source File + + + + + + + + + +
+
+ + + + + + +
+
rippled +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
RPCLedgerHelpers.cpp
+
+
+
1#include <xrpld/app/ledger/LedgerMaster.h>
+
2#include <xrpld/app/ledger/LedgerToJson.h>
+
3#include <xrpld/app/ledger/OpenLedger.h>
+
4#include <xrpld/app/misc/Transaction.h>
+
5#include <xrpld/app/paths/TrustLine.h>
+
6#include <xrpld/app/rdb/RelationalDatabase.h>
+
7#include <xrpld/app/tx/detail/NFTokenUtils.h>
+
8#include <xrpld/rpc/Context.h>
+
9#include <xrpld/rpc/DeliveredAmount.h>
+
10#include <xrpld/rpc/detail/RPCHelpers.h>
+
11
+
12#include <xrpl/ledger/View.h>
+
13#include <xrpl/protocol/AccountID.h>
+
14#include <xrpl/protocol/RPCErr.h>
+
15#include <xrpl/protocol/nftPageMask.h>
+
16#include <xrpl/resource/Fees.h>
+
17
+
18#include <boost/algorithm/string/case_conv.hpp>
+
19#include <boost/algorithm/string/predicate.hpp>
+
20
+
21namespace ripple {
+
22namespace RPC {
+
23
+
24namespace {
+
25
+
26bool
+
27isValidatedOld(LedgerMaster& ledgerMaster, bool standalone)
+
28{
+
29 if (standalone)
+
30 return false;
+
31
+
32 return ledgerMaster.getValidatedLedgerAge() > Tuning::maxValidatedLedgerAge;
+
33}
+
34
+
35template <class T>
+
36Status
+
37ledgerFromRequest(T& ledger, JsonContext& context)
+
38{
+
39 ledger.reset();
+
40
+
41 auto& params = context.params;
+
42
+
43 auto indexValue = params[jss::ledger_index];
+
44 auto hashValue = params[jss::ledger_hash];
+
45
+
46 // We need to support the legacy "ledger" field.
+
47 auto& legacyLedger = params[jss::ledger];
+
48 if (legacyLedger)
+
49 {
+
50 if (legacyLedger.asString().size() > 12)
+
51 hashValue = legacyLedger;
+
52 else
+
53 indexValue = legacyLedger;
+
54 }
+
55
+
56 if (!hashValue.isNull())
+
57 {
+
58 if (!hashValue.isString())
+
59 return {rpcINVALID_PARAMS, "ledgerHashNotString"};
+
60
+
61 uint256 ledgerHash;
+
62 if (!ledgerHash.parseHex(hashValue.asString()))
+
63 return {rpcINVALID_PARAMS, "ledgerHashMalformed"};
+
64 return getLedger(ledger, ledgerHash, context);
+
65 }
+
66
+
67 if (!indexValue.isConvertibleTo(Json::stringValue))
+
68 return {rpcINVALID_PARAMS, "ledgerIndexMalformed"};
+
69
+
70 auto const index = indexValue.asString();
+
71
+
72 if (index == "current" || index.empty())
+
73 return getLedger(ledger, LedgerShortcut::CURRENT, context);
+
74
+
75 if (index == "validated")
+
76 return getLedger(ledger, LedgerShortcut::VALIDATED, context);
+
77
+
78 if (index == "closed")
+
79 return getLedger(ledger, LedgerShortcut::CLOSED, context);
+
80
+
81 std::uint32_t val;
+
82 if (!beast::lexicalCastChecked(val, index))
+
83 return {rpcINVALID_PARAMS, "ledgerIndexMalformed"};
+
84
+
85 return getLedger(ledger, val, context);
+
86}
+
87} // namespace
+
88
+
89template <class T, class R>
+
90Status
+
+
91ledgerFromRequest(T& ledger, GRPCContext<R>& context)
+
92{
+
93 R& request = context.params;
+
94 return ledgerFromSpecifier(ledger, request.ledger(), context);
+
95}
+
+
96
+
97// explicit instantiation of above function
+
98template Status
+
99ledgerFromRequest<>(
+
100 std::shared_ptr<ReadView const>&,
+
101 GRPCContext<org::xrpl::rpc::v1::GetLedgerEntryRequest>&);
+
102
+
103// explicit instantiation of above function
+
104template Status
+
105ledgerFromRequest<>(
+
106 std::shared_ptr<ReadView const>&,
+
107 GRPCContext<org::xrpl::rpc::v1::GetLedgerDataRequest>&);
+
108
+
109// explicit instantiation of above function
+
110template Status
+
111ledgerFromRequest<>(
+
112 std::shared_ptr<ReadView const>&,
+
113 GRPCContext<org::xrpl::rpc::v1::GetLedgerRequest>&);
+
114
+
115template <class T>
+
116Status
+
+
117ledgerFromSpecifier(
+
118 T& ledger,
+
119 org::xrpl::rpc::v1::LedgerSpecifier const& specifier,
+
120 Context& context)
+
121{
+
122 ledger.reset();
+
123
+
124 using LedgerCase = org::xrpl::rpc::v1::LedgerSpecifier::LedgerCase;
+
125 LedgerCase ledgerCase = specifier.ledger_case();
+
126 switch (ledgerCase)
+
127 {
+
128 case LedgerCase::kHash: {
+
129 if (auto hash = uint256::fromVoidChecked(specifier.hash()))
+
130 {
+
131 return getLedger(ledger, *hash, context);
+
132 }
+
133 return {rpcINVALID_PARAMS, "ledgerHashMalformed"};
+
134 }
+
135 case LedgerCase::kSequence:
+
136 return getLedger(ledger, specifier.sequence(), context);
+
137 case LedgerCase::kShortcut:
+
138 [[fallthrough]];
+
139 case LedgerCase::LEDGER_NOT_SET: {
+
140 auto const shortcut = specifier.shortcut();
+
141 if (shortcut ==
+
142 org::xrpl::rpc::v1::LedgerSpecifier::SHORTCUT_VALIDATED)
+
143 {
+
144 return getLedger(ledger, LedgerShortcut::VALIDATED, context);
+
145 }
+
146 else
+
147 {
+
148 if (shortcut ==
+
149 org::xrpl::rpc::v1::LedgerSpecifier::SHORTCUT_CURRENT ||
+
150 shortcut ==
+
151 org::xrpl::rpc::v1::LedgerSpecifier::
+
152 SHORTCUT_UNSPECIFIED)
+
153 {
+
154 return getLedger(ledger, LedgerShortcut::CURRENT, context);
+
155 }
+
156 else if (
+
157 shortcut ==
+
158 org::xrpl::rpc::v1::LedgerSpecifier::SHORTCUT_CLOSED)
+
159 {
+
160 return getLedger(ledger, LedgerShortcut::CLOSED, context);
+
161 }
+
162 }
+
163 }
+
164 }
+
165
+
166 return Status::OK;
+
167}
+
+
168
+
169template <class T>
+
170Status
+
+
171getLedger(T& ledger, uint256 const& ledgerHash, Context& context)
+
172{
+
173 ledger = context.ledgerMaster.getLedgerByHash(ledgerHash);
+
174 if (ledger == nullptr)
+
175 return {rpcLGR_NOT_FOUND, "ledgerNotFound"};
+
176 return Status::OK;
+
177}
+
+
178
+
179template <class T>
+
180Status
+
+
181getLedger(T& ledger, uint32_t ledgerIndex, Context& context)
+
182{
+
183 ledger = context.ledgerMaster.getLedgerBySeq(ledgerIndex);
+
184 if (ledger == nullptr)
+
185 {
+
186 auto cur = context.ledgerMaster.getCurrentLedger();
+
187 if (cur->info().seq == ledgerIndex)
+
188 {
+
189 ledger = cur;
+
190 }
+
191 }
+
192
+
193 if (ledger == nullptr)
+
194 return {rpcLGR_NOT_FOUND, "ledgerNotFound"};
+
195
+
196 if (ledger->info().seq > context.ledgerMaster.getValidLedgerIndex() &&
+
197 isValidatedOld(context.ledgerMaster, context.app.config().standalone()))
+
198 {
+
199 ledger.reset();
+
200 if (context.apiVersion == 1)
+
201 return {rpcNO_NETWORK, "InsufficientNetworkMode"};
+
202 return {rpcNOT_SYNCED, "notSynced"};
+
203 }
+
204
+
205 return Status::OK;
+
206}
+
+
207
+
208template <class T>
+
209Status
+
+
210getLedger(T& ledger, LedgerShortcut shortcut, Context& context)
+
211{
+
212 if (isValidatedOld(context.ledgerMaster, context.app.config().standalone()))
+
213 {
+
214 if (context.apiVersion == 1)
+
215 return {rpcNO_NETWORK, "InsufficientNetworkMode"};
+
216 return {rpcNOT_SYNCED, "notSynced"};
+
217 }
+
218
+
219 if (shortcut == LedgerShortcut::VALIDATED)
+
220 {
+
221 ledger = context.ledgerMaster.getValidatedLedger();
+
222 if (ledger == nullptr)
+
223 {
+
224 if (context.apiVersion == 1)
+
225 return {rpcNO_NETWORK, "InsufficientNetworkMode"};
+
226 return {rpcNOT_SYNCED, "notSynced"};
+
227 }
+
228
+
229 XRPL_ASSERT(
+
230 !ledger->open(), "ripple::RPC::getLedger : validated is not open");
+
231 }
+
232 else
+
233 {
+
234 if (shortcut == LedgerShortcut::CURRENT)
+
235 {
+
236 ledger = context.ledgerMaster.getCurrentLedger();
+
237 XRPL_ASSERT(
+
238 ledger->open(), "ripple::RPC::getLedger : current is open");
+
239 }
+
240 else if (shortcut == LedgerShortcut::CLOSED)
+
241 {
+
242 ledger = context.ledgerMaster.getClosedLedger();
+
243 XRPL_ASSERT(
+
244 !ledger->open(), "ripple::RPC::getLedger : closed is not open");
+
245 }
+
246 else
+
247 {
+
248 return {rpcINVALID_PARAMS, "ledgerIndexMalformed"};
+
249 }
+
250
+
251 if (ledger == nullptr)
+
252 {
+
253 if (context.apiVersion == 1)
+
254 return {rpcNO_NETWORK, "InsufficientNetworkMode"};
+
255 return {rpcNOT_SYNCED, "notSynced"};
+
256 }
+
257
+
258 static auto const minSequenceGap = 10;
+
259
+
260 if (ledger->info().seq + minSequenceGap <
+
261 context.ledgerMaster.getValidLedgerIndex())
+
262 {
+
263 ledger.reset();
+
264 if (context.apiVersion == 1)
+
265 return {rpcNO_NETWORK, "InsufficientNetworkMode"};
+
266 return {rpcNOT_SYNCED, "notSynced"};
+
267 }
+
268 }
+
269 return Status::OK;
+
270}
+
+
271
+
272// Explicit instantiation of above three functions
+
273template Status
+
274getLedger<>(std::shared_ptr<ReadView const>&, uint32_t, Context&);
+
275
+
276template Status
+
277getLedger<>(
+
278 std::shared_ptr<ReadView const>&,
+
279 LedgerShortcut shortcut,
+
280 Context&);
+
281
+
282template Status
+
283getLedger<>(std::shared_ptr<ReadView const>&, uint256 const&, Context&);
+
284
+
285// The previous version of the lookupLedger command would accept the
+
286// "ledger_index" argument as a string and silently treat it as a request to
+
287// return the current ledger which, while not strictly wrong, could cause a lot
+
288// of confusion.
+
289//
+
290// The code now robustly validates the input and ensures that the only possible
+
291// values for the "ledger_index" parameter are the index of a ledger passed as
+
292// an integer or one of the strings "current", "closed" or "validated".
+
293// Additionally, the code ensures that the value passed in "ledger_hash" is a
+
294// string and a valid hash. Invalid values will return an appropriate error
+
295// code.
+
296//
+
297// In the absence of the "ledger_hash" or "ledger_index" parameters, the code
+
298// assumes that "ledger_index" has the value "current".
+
299//
+
300// Returns a Json::objectValue. If there was an error, it will be in that
+
301// return value. Otherwise, the object contains the field "validated" and
+
302// optionally the fields "ledger_hash", "ledger_index" and
+
303// "ledger_current_index", if they are defined.
+
304Status
+
+
305lookupLedger(
+
306 std::shared_ptr<ReadView const>& ledger,
+
307 JsonContext& context,
+
308 Json::Value& result)
+
309{
+
310 if (auto status = ledgerFromRequest(ledger, context))
+
311 return status;
+
312
+
313 auto& info = ledger->info();
+
314
+
315 if (!ledger->open())
+
316 {
+
317 result[jss::ledger_hash] = to_string(info.hash);
+
318 result[jss::ledger_index] = info.seq;
+
319 }
+
320 else
+
321 {
+
322 result[jss::ledger_current_index] = info.seq;
+
323 }
+
324
+
325 result[jss::validated] = context.ledgerMaster.isValidated(*ledger);
+
326 return Status::OK;
+
327}
+
+
328
+
329Json::Value
+
+
330lookupLedger(std::shared_ptr<ReadView const>& ledger, JsonContext& context)
+
331{
+
332 Json::Value result;
+
333 if (auto status = lookupLedger(ledger, context, result))
+
334 status.inject(result);
+
335
+
336 return result;
+
337}
+
+
338
+
339std::variant<std::shared_ptr<Ledger const>, Json::Value>
+
+
340getLedgerByContext(RPC::JsonContext& context)
+
341{
+
342 auto const hasHash = context.params.isMember(jss::ledger_hash);
+
343 auto const hasIndex = context.params.isMember(jss::ledger_index);
+
344 std::uint32_t ledgerIndex = 0;
+
345
+
346 auto& ledgerMaster = context.app.getLedgerMaster();
+
347 LedgerHash ledgerHash;
+
348
+
349 if ((hasHash && hasIndex) || !(hasHash || hasIndex))
+
350 {
+
351 return RPC::make_param_error(
+
352 "Exactly one of ledger_hash and ledger_index can be set.");
+
353 }
+
354
+
355 context.loadType = Resource::feeHeavyBurdenRPC;
+
356
+
357 if (hasHash)
+
358 {
+
359 auto const& jsonHash = context.params[jss::ledger_hash];
+
360 if (!jsonHash.isString() || !ledgerHash.parseHex(jsonHash.asString()))
+
361 return RPC::invalid_field_error(jss::ledger_hash);
+
362 }
+
363 else
+
364 {
+
365 auto const& jsonIndex = context.params[jss::ledger_index];
+
366 if (!jsonIndex.isInt())
+
367 return RPC::invalid_field_error(jss::ledger_index);
+
368
+
369 // We need a validated ledger to get the hash from the sequence
+
370 if (ledgerMaster.getValidatedLedgerAge() >
+
371 RPC::Tuning::maxValidatedLedgerAge)
+
372 {
+
373 if (context.apiVersion == 1)
+
374 return rpcError(rpcNO_CURRENT);
+
375 return rpcError(rpcNOT_SYNCED);
+
376 }
+
377
+
378 ledgerIndex = jsonIndex.asInt();
+
379 auto ledger = ledgerMaster.getValidatedLedger();
+
380
+
381 if (ledgerIndex >= ledger->info().seq)
+
382 return RPC::make_param_error("Ledger index too large");
+
383 if (ledgerIndex <= 0)
+
384 return RPC::make_param_error("Ledger index too small");
+
385
+
386 auto const j = context.app.journal("RPCHandler");
+
387 // Try to get the hash of the desired ledger from the validated
+
388 // ledger
+
389 auto neededHash = hashOfSeq(*ledger, ledgerIndex, j);
+
390 if (!neededHash)
+
391 {
+
392 // Find a ledger more likely to have the hash of the desired
+
393 // ledger
+
394 auto const refIndex = getCandidateLedger(ledgerIndex);
+
395 auto refHash = hashOfSeq(*ledger, refIndex, j);
+
396 XRPL_ASSERT(
+
397 refHash,
+
398 "ripple::RPC::getLedgerByContext : nonzero ledger hash");
+
399
+
400 ledger = ledgerMaster.getLedgerByHash(*refHash);
+
401 if (!ledger)
+
402 {
+
403 // We don't have the ledger we need to figure out which
+
404 // ledger they want. Try to get it.
+
405
+
406 if (auto il = context.app.getInboundLedgers().acquire(
+
407 *refHash, refIndex, InboundLedger::Reason::GENERIC))
+
408 {
+
409 Json::Value jvResult = RPC::make_error(
+
410 rpcLGR_NOT_FOUND,
+
411 "acquiring ledger containing requested index");
+
412 jvResult[jss::acquiring] =
+
413 getJson(LedgerFill(*il, &context));
+
414 return jvResult;
+
415 }
+
416
+
417 if (auto il = context.app.getInboundLedgers().find(*refHash))
+
418 {
+
419 Json::Value jvResult = RPC::make_error(
+
420 rpcLGR_NOT_FOUND,
+
421 "acquiring ledger containing requested index");
+
422 jvResult[jss::acquiring] = il->getJson(0);
+
423 return jvResult;
+
424 }
+
425
+
426 // Likely the app is shutting down
+
427 return Json::Value();
+
428 }
+
429
+
430 neededHash = hashOfSeq(*ledger, ledgerIndex, j);
+
431 }
+
432 XRPL_ASSERT(
+
433 neededHash,
+
434 "ripple::RPC::getLedgerByContext : nonzero needed hash");
+
435 ledgerHash = neededHash ? *neededHash : beast::zero; // kludge
+
436 }
+
437
+
438 // Try to get the desired ledger
+
439 // Verify all nodes even if we think we have it
+
440 auto ledger = context.app.getInboundLedgers().acquire(
+
441 ledgerHash, ledgerIndex, InboundLedger::Reason::GENERIC);
+
442
+
443 // In standalone mode, accept the ledger from the ledger cache
+
444 if (!ledger && context.app.config().standalone())
+
445 ledger = ledgerMaster.getLedgerByHash(ledgerHash);
+
446
+
447 if (ledger)
+
448 return ledger;
+
449
+
450 if (auto il = context.app.getInboundLedgers().find(ledgerHash))
+
451 return il->getJson(0);
+
452
+
453 return RPC::make_error(
+
454 rpcNOT_READY, "findCreate failed to return an inbound ledger");
+
455}
+
+
456
+
457} // namespace RPC
+
458} // namespace ripple
+
Json::Value
Represents a JSON value.
Definition json_value.h:131
+
Json::Value::isMember
bool isMember(char const *key) const
Return true if the object has a member named key.
Definition json_value.cpp:1030
+
ripple::Application::config
virtual Config & config()=0
+
ripple::Application::journal
virtual beast::Journal journal(std::string const &name)=0
+
ripple::Application::getInboundLedgers
virtual InboundLedgers & getInboundLedgers()=0
+
ripple::Application::getLedgerMaster
virtual LedgerMaster & getLedgerMaster()=0
+
ripple::Config::standalone
bool standalone() const
Definition Config.h:317
+ +
ripple::InboundLedgers::acquire
virtual std::shared_ptr< Ledger const > acquire(uint256 const &hash, std::uint32_t seq, InboundLedger::Reason)=0
+
ripple::InboundLedgers::find
virtual std::shared_ptr< InboundLedger > find(LedgerHash const &hash)=0
+
ripple::LedgerMaster::getValidatedLedger
std::shared_ptr< Ledger const > getValidatedLedger()
Definition LedgerMaster.cpp:1546
+
ripple::LedgerMaster::getCurrentLedger
std::shared_ptr< ReadView const > getCurrentLedger()
Definition LedgerMaster.cpp:1540
+
ripple::LedgerMaster::isValidated
bool isValidated(ReadView const &ledger)
Definition LedgerMaster.cpp:480
+
ripple::LedgerMaster::getClosedLedger
std::shared_ptr< Ledger const > getClosedLedger()
Definition LedgerMaster.h:60
+
ripple::LedgerMaster::getLedgerBySeq
std::shared_ptr< Ledger const > getLedgerBySeq(std::uint32_t index)
Definition LedgerMaster.cpp:1689
+
ripple::LedgerMaster::getLedgerByHash
std::shared_ptr< Ledger const > getLedgerByHash(uint256 const &hash)
Definition LedgerMaster.cpp:1725
+
ripple::LedgerMaster::getValidLedgerIndex
LedgerIndex getValidLedgerIndex()
Definition LedgerMaster.cpp:110
+
ripple::base_uint< 256 >
+
ripple::base_uint< 256 >::fromVoidChecked
static std::optional< base_uint > fromVoidChecked(T const &from)
Definition base_uint.h:307
+
ripple::base_uint::parseHex
constexpr bool parseHex(std::string_view sv)
Parse a hex string into a base_uint.
Definition base_uint.h:484
+ +
Json::stringValue
@ stringValue
UTF-8 string value.
Definition json_value.h:24
+
beast::lexicalCastChecked
bool lexicalCastChecked(Out &out, In in)
Intelligently convert from one type to another.
Definition LexicalCast.h:181
+
ripple::NodeStore::Status
Status
Return codes from Backend operations.
Definition nodestore/Types.h:25
+ +
ripple::RPC::ledgerFromRequest
Status ledgerFromRequest(T &ledger, GRPCContext< R > &context)
Definition RPCLedgerHelpers.cpp:91
+
ripple::RPC::make_error
Json::Value make_error(error_code_i code)
Returns a new json object that reflects the error code.
Definition ErrorCodes.cpp:172
+
ripple::RPC::getLedgerByContext
std::variant< std::shared_ptr< Ledger const >, Json::Value > getLedgerByContext(RPC::JsonContext &context)
Return a ledger based on ledger_hash or ledger_index, or an RPC error.
Definition RPCLedgerHelpers.cpp:340
+
ripple::RPC::invalid_field_error
Json::Value invalid_field_error(std::string const &name)
Definition ErrorCodes.h:306
+ +
ripple::RPC::make_param_error
Json::Value make_param_error(std::string const &message)
Returns a new json object that indicates invalid parameters.
Definition ErrorCodes.h:252
+
ripple::RPC::getLedger
Status getLedger(T &ledger, uint256 const &ledgerHash, Context &context)
Get ledger by hash If there is no error in the return value, the ledger pointer will have been filled...
Definition RPCLedgerHelpers.cpp:171
+
ripple::RPC::lookupLedger
Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
Definition RPCLedgerHelpers.cpp:305
+
ripple::RPC::ledgerFromSpecifier
Status ledgerFromSpecifier(T &ledger, org::xrpl::rpc::v1::LedgerSpecifier const &specifier, Context &context)
Definition RPCLedgerHelpers.cpp:117
+
ripple::Resource::feeHeavyBurdenRPC
Charge const feeHeavyBurdenRPC
+
ripple
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition algorithm.h:6
+
ripple::getCandidateLedger
LedgerIndex getCandidateLedger(LedgerIndex requested)
Find a ledger index from which we could easily get the requested ledger.
Definition View.h:410
+
ripple::rpcNO_NETWORK
@ rpcNO_NETWORK
Definition ErrorCodes.h:47
+
ripple::rpcNOT_READY
@ rpcNOT_READY
Definition ErrorCodes.h:41
+
ripple::rpcNO_CURRENT
@ rpcNO_CURRENT
Definition ErrorCodes.h:46
+
ripple::rpcINVALID_PARAMS
@ rpcINVALID_PARAMS
Definition ErrorCodes.h:65
+
ripple::rpcLGR_NOT_FOUND
@ rpcLGR_NOT_FOUND
Definition ErrorCodes.h:53
+
ripple::rpcNOT_SYNCED
@ rpcNOT_SYNCED
Definition ErrorCodes.h:48
+
ripple::uint256
base_uint< 256 > uint256
Definition base_uint.h:539
+
ripple::hashOfSeq
std::optional< uint256 > hashOfSeq(ReadView const &ledger, LedgerIndex seq, beast::Journal journal)
Return the hash of a ledger by sequence.
Definition View.cpp:942
+
ripple::rpcError
Json::Value rpcError(int iError)
Definition RPCErr.cpp:12
+
ripple::to_string
std::string to_string(base_uint< Bits, Tag > const &a)
Definition base_uint.h:611
+
ripple::getJson
Json::Value getJson(LedgerFill const &fill)
Return a new Json::Value representing the ledger with given options.
Definition LedgerToJson.cpp:338
+
ripple::HashPrefix::ledgerMaster
@ ledgerMaster
ledger master data for signing
+ + +
ripple::RPC::Context
The context of information needed to call an RPC.
Definition Context.h:20
+
ripple::RPC::Context::apiVersion
unsigned int apiVersion
Definition Context.h:30
+
ripple::RPC::Context::loadType
Resource::Charge & loadType
Definition Context.h:23
+
ripple::RPC::Context::app
Application & app
Definition Context.h:22
+
ripple::RPC::Context::ledgerMaster
LedgerMaster & ledgerMaster
Definition Context.h:25
+ + + + +
ripple::RPC::Status
Status represents the results of an operation that might fail.
Definition Status.h:21
+
ripple::RPC::Status::OK
static constexpr Code OK
Definition Status.h:27
+ +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/RPCLedgerHelpers_8h_source.html b/RPCLedgerHelpers_8h_source.html new file mode 100644 index 0000000000..12790cc9d5 --- /dev/null +++ b/RPCLedgerHelpers_8h_source.html @@ -0,0 +1,179 @@ + + + + + + + +rippled: RPCLedgerHelpers.h Source File + + + + + + + + + +
+
+ + + + + + +
+
rippled +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
RPCLedgerHelpers.h
+
+
+
1#ifndef XRPL_RPC_RPCLEDGERHELPERS_H_INCLUDED
+
2#define XRPL_RPC_RPCLEDGERHELPERS_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
+
35template <class T>
+
36Status
+
37getLedger(T& ledger, uint256 const& ledgerHash, Context& context);
+
38
+
43template <class T>
+
44Status
+
45getLedger(T& ledger, uint32_t ledgerIndex, Context& context);
+
46
+
47enum LedgerShortcut { CURRENT, CLOSED, VALIDATED };
+
52template <class T>
+
53Status
+
54getLedger(T& ledger, LedgerShortcut shortcut, Context& context);
+
55
+
62Json::Value
+
63lookupLedger(std::shared_ptr<ReadView const>&, JsonContext&);
+
64
+
70Status
+
71lookupLedger(
+
72 std::shared_ptr<ReadView const>&,
+
73 JsonContext&,
+
74 Json::Value& result);
+
75
+
76template <class T, class R>
+
77Status
+
78ledgerFromRequest(T& ledger, GRPCContext<R>& context);
+
79
+
80template <class T>
+
81Status
+
82ledgerFromSpecifier(
+
83 T& ledger,
+
84 org::xrpl::rpc::v1::LedgerSpecifier const& specifier,
+
85 Context& context);
+
86
+
89std::variant<std::shared_ptr<Ledger const>, Json::Value>
+
90getLedgerByContext(RPC::JsonContext& context);
+
91
+
92} // namespace RPC
+
93
+
94} // namespace ripple
+
95
+
96#endif
+
Json::Value
Represents a JSON value.
Definition json_value.h:131
+
Json
JSON (JavaScript Object Notation).
Definition json_errors.h:6
+
ripple::NodeStore::Status
Status
Return codes from Backend operations.
Definition nodestore/Types.h:25
+
ripple::RPC::ledgerFromRequest
Status ledgerFromRequest(T &ledger, GRPCContext< R > &context)
Definition RPCLedgerHelpers.cpp:91
+
ripple::RPC::getLedgerByContext
std::variant< std::shared_ptr< Ledger const >, Json::Value > getLedgerByContext(RPC::JsonContext &context)
Return a ledger based on ledger_hash or ledger_index, or an RPC error.
Definition RPCLedgerHelpers.cpp:340
+ + + + +
ripple::RPC::getLedger
Status getLedger(T &ledger, uint256 const &ledgerHash, Context &context)
Get ledger by hash If there is no error in the return value, the ledger pointer will have been filled...
Definition RPCLedgerHelpers.cpp:171
+
ripple::RPC::lookupLedger
Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
Definition RPCLedgerHelpers.cpp:305
+
ripple::RPC::ledgerFromSpecifier
Status ledgerFromSpecifier(T &ledger, org::xrpl::rpc::v1::LedgerSpecifier const &specifier, Context &context)
Definition RPCLedgerHelpers.cpp:117
+
ripple
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition algorithm.h:6
+
ripple::uint256
base_uint< 256 > uint256
Definition base_uint.h:539
+ + + + +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/RelationalDatabase_8h_source.html b/RelationalDatabase_8h_source.html index 382aeec69b..3032350d72 100644 --- a/RelationalDatabase_8h_source.html +++ b/RelationalDatabase_8h_source.html @@ -89,7 +89,7 @@ $(document).ready(function() { init_codefold(0); });
6#include <xrpld/app/misc/Transaction.h>
7#include <xrpld/core/Config.h>
8#include <xrpld/core/DatabaseCon.h>
-
9#include <xrpld/rpc/detail/RPCHelpers.h>
+
9#include <xrpld/rpc/detail/RPCLedgerHelpers.h>
10
11#include <xrpl/beast/utility/instrumentation.h>
12
@@ -284,7 +284,7 @@ $(document).ready(function() { init_codefold(0); });
std::numeric_limits::lowest
T lowest(T... args)
std::numeric_limits::max
T max(T... args)
- +
ripple
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition algorithm.h:6
ripple::uint256
base_uint< 256 > uint256
Definition base_uint.h:539
ripple::rangeCheckedCast
T rangeCheckedCast(C c)
Definition RelationalDatabase.h:211
diff --git a/RipplePathFind_8cpp_source.html b/RipplePathFind_8cpp_source.html index 315efc05a7..7f872dfd09 100644 --- a/RipplePathFind_8cpp_source.html +++ b/RipplePathFind_8cpp_source.html @@ -85,7 +85,7 @@ $(document).ready(function() { init_codefold(0); });
2#include <xrpld/app/paths/PathRequests.h>
3#include <xrpld/rpc/Context.h>
4#include <xrpld/rpc/detail/LegacyPathFind.h>
-
5#include <xrpld/rpc/detail/RPCHelpers.h>
+
5#include <xrpld/rpc/detail/RPCLedgerHelpers.h>
6
7#include <xrpl/protocol/RPCErr.h>
8#include <xrpl/resource/Fees.h>
@@ -256,7 +256,7 @@ $(document).ready(function() { init_codefold(0); }); -
ripple::RPC::lookupLedger
Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
Definition RPCHelpers.cpp:606
+
ripple::RPC::lookupLedger
Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
Definition RPCLedgerHelpers.cpp:305
ripple::Resource::feeHeavyBurdenRPC
Charge const feeHeavyBurdenRPC
ripple
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition algorithm.h:6
ripple::rpcNOT_SUPPORTED
@ rpcNOT_SUPPORTED
Definition ErrorCodes.h:113
diff --git a/SlotImp_8h_source.html b/SlotImp_8h_source.html index 7ae6b61b88..21917f1e2f 100644 --- a/SlotImp_8h_source.html +++ b/SlotImp_8h_source.html @@ -287,7 +287,7 @@ $(document).ready(function() { init_codefold(0); });
176 // DEPRECATED public data members
177
178 // Tells us if we checked the connection. Outbound connections
-
179 // are always considered checked since we successfuly connected.
+
179 // are always considered checked since we successfully connected.
180 bool checked;
181
182 // Set to indicate if the connection can receive incoming at the
diff --git a/SociDB__test_8cpp_source.html b/SociDB__test_8cpp_source.html index 720631b1f3..691a02359a 100644 --- a/SociDB__test_8cpp_source.html +++ b/SociDB__test_8cpp_source.html @@ -176,7 +176,7 @@ $(document).ready(function() { init_codefold(0); });
80 testSQLiteFileNames()
81 {
-
82 // confirm that files are given the correct exensions
+
82 // confirm that files are given the correct extensions
83 testcase("sqliteFileNames");
84 BasicConfig c;
85 setupSQLiteConfig(c, getDatabasePath());
diff --git a/Subscribe_8cpp_source.html b/Subscribe_8cpp_source.html index 782c46d8eb..fa5d2876f5 100644 --- a/Subscribe_8cpp_source.html +++ b/Subscribe_8cpp_source.html @@ -502,7 +502,7 @@ $(document).ready(function() { init_codefold(0); });
Json::objectValue
@ objectValue
object value (collection of name/value pairs).
Definition json_value.h:27
ripple::RPC::Tuning::bookOffers
static LimitRange constexpr bookOffers
Limits for the book_offers command.
Definition src/xrpld/rpc/detail/Tuning.h:33
ripple::RPC::make_param_error
Json::Value make_param_error(std::string const &message)
Returns a new json object that indicates invalid parameters.
Definition ErrorCodes.h:252
-
ripple::RPC::parseAccountIds
hash_set< AccountID > parseAccountIds(Json::Value const &jvArray)
Definition RPCHelpers.cpp:641
+
ripple::RPC::parseAccountIds
hash_set< AccountID > parseAccountIds(Json::Value const &jvArray)
Definition RPCHelpers.cpp:134
ripple::Resource::feeMediumBurdenRPC
Charge const feeMediumBurdenRPC
ripple
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition algorithm.h:6
ripple::noAccount
AccountID const & noAccount()
A placeholder for empty accounts.
Definition AccountID.cpp:166
diff --git a/TransactionEntry_8cpp_source.html b/TransactionEntry_8cpp_source.html index 9dfbc1290e..7b166ae840 100644 --- a/TransactionEntry_8cpp_source.html +++ b/TransactionEntry_8cpp_source.html @@ -84,7 +84,7 @@ $(document).ready(function() { init_codefold(0); });
1#include <xrpld/app/ledger/LedgerMaster.h>
2#include <xrpld/app/misc/DeliverMax.h>
3#include <xrpld/rpc/Context.h>
-
4#include <xrpld/rpc/detail/RPCHelpers.h>
+
4#include <xrpld/rpc/detail/RPCLedgerHelpers.h>
5
6#include <xrpl/ledger/ReadView.h>
7#include <xrpl/protocol/jss.h>
@@ -192,7 +192,7 @@ $(document).ready(function() { init_codefold(0); });
ripple::base_uint< 256 >
ripple::base_uint::parseHex
constexpr bool parseHex(std::string_view sv)
Parse a hex string into a base_uint.
Definition base_uint.h:484
Json::nullValue
@ nullValue
'null' value
Definition json_value.h:20
-
ripple::RPC::lookupLedger
Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
Definition RPCHelpers.cpp:606
+
ripple::RPC::lookupLedger
Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
Definition RPCLedgerHelpers.cpp:305
ripple::RPC::insertDeliverMax
void insertDeliverMax(Json::Value &tx_json, TxType txnType, unsigned int apiVersion)
Copy Amount field to DeliverMax field in transaction output JSON.
Definition DeliverMax.cpp:9
ripple
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition algorithm.h:6
ripple::doTransactionEntry
Json::Value doTransactionEntry(RPC::JsonContext &)
Definition TransactionEntry.cpp:19
diff --git a/TransactionSign_8cpp_source.html b/TransactionSign_8cpp_source.html index 1d14250ac5..c6ee82b42c 100644 --- a/TransactionSign_8cpp_source.html +++ b/TransactionSign_8cpp_source.html @@ -1734,7 +1734,7 @@ $(document).ready(function() { init_codefold(0); });
ripple::RPC::getAPIVersionNumber
unsigned int getAPIVersionNumber(Json::Value const &jv, bool betaEnabled)
Retrieve the api version number from the json value.
Definition ApiVersion.h:104
ripple::RPC::checkFee
Json::Value checkFee(Json::Value &request, Role const role, bool doAutoFill, Config const &config, LoadFeeTrack const &feeTrack, TxQ const &txQ, Application const &app)
Fill in the fee on behalf of the client.
Definition TransactionSign.cpp:910
ripple::RPC::missing_field_error
Json::Value missing_field_error(std::string const &name)
Definition ErrorCodes.h:264
-
ripple::RPC::keypairForSignature
std::optional< std::pair< PublicKey, SecretKey > > keypairForSignature(Json::Value const &params, Json::Value &error, unsigned int apiVersion)
Definition RPCHelpers.cpp:785
+
ripple::RPC::keypairForSignature
std::optional< std::pair< PublicKey, SecretKey > > keypairForSignature(Json::Value const &params, Json::Value &error, unsigned int apiVersion)
Definition RPCHelpers.cpp:278
ripple::keylet::account
Keylet account(AccountID const &id) noexcept
AccountID root.
Definition Indexes.cpp:165
ripple
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition algorithm.h:6
ripple::toBase58
std::string toBase58(AccountID const &v)
Convert AccountID to base58 checked string.
Definition AccountID.cpp:95
diff --git a/Unsubscribe_8cpp_source.html b/Unsubscribe_8cpp_source.html index ae13705525..907deb84c8 100644 --- a/Unsubscribe_8cpp_source.html +++ b/Unsubscribe_8cpp_source.html @@ -361,7 +361,7 @@ $(document).ready(function() { init_codefold(0); });
ripple::base_uint< 256 >
ripple::base_uint::parseHex
constexpr bool parseHex(std::string_view sv)
Parse a hex string into a base_uint.
Definition base_uint.h:484
Json::objectValue
@ objectValue
object value (collection of name/value pairs).
Definition json_value.h:27
-
ripple::RPC::parseAccountIds
hash_set< AccountID > parseAccountIds(Json::Value const &jvArray)
Definition RPCHelpers.cpp:641
+
ripple::RPC::parseAccountIds
hash_set< AccountID > parseAccountIds(Json::Value const &jvArray)
Definition RPCHelpers.cpp:134
ripple
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition algorithm.h:6
ripple::noAccount
AccountID const & noAccount()
A placeholder for empty accounts.
Definition AccountID.cpp:166
ripple::toBase58
std::string toBase58(AccountID const &v)
Convert AccountID to base58 checked string.
Definition AccountID.cpp:95
diff --git a/ValidatorList__test_8cpp_source.html b/ValidatorList__test_8cpp_source.html index 93701ef9d4..75fad36cdc 100644 --- a/ValidatorList__test_8cpp_source.html +++ b/ValidatorList__test_8cpp_source.html @@ -1853,7 +1853,7 @@ $(document).ready(function() { init_codefold(0); });
1740 // locals[0]: from 0 to maxKeys - 4
1741 // locals[1]: from 1 to maxKeys - 2
1742 // locals[2]: from 2 to maxKeys
-
1743 // interesection of at least 2: same as locals[1]
+
1743 // intersection of at least 2: same as locals[1]
1744 // intersection when 1 is dropped: from 2 to maxKeys - 4
1745 constexpr static int publishers = 3;
1746 std::array<
diff --git a/VaultInfo_8cpp_source.html b/VaultInfo_8cpp_source.html index 4fad2a63cd..8c7d45c88e 100644 --- a/VaultInfo_8cpp_source.html +++ b/VaultInfo_8cpp_source.html @@ -82,7 +82,7 @@ $(document).ready(function() { init_codefold(0); });
1#include <xrpld/rpc/Context.h>
-
2#include <xrpld/rpc/detail/RPCHelpers.h>
+
2#include <xrpld/rpc/detail/RPCLedgerHelpers.h>
3
4#include <xrpl/beast/utility/Zero.h>
5#include <xrpl/json/json_value.h>
@@ -188,7 +188,7 @@ $(document).ready(function() { init_codefold(0); });
ripple::base_uint::parseHex
constexpr bool parseHex(std::string_view sv)
Parse a hex string into a base_uint.
Definition base_uint.h:484
std::is_same_v
T is_same_v
ripple::RPC::inject_error
void inject_error(error_code_i code, JsonValue &json)
Add or update the json update to reflect the error code.
Definition ErrorCodes.h:214
-
ripple::RPC::lookupLedger
Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
Definition RPCHelpers.cpp:606
+
ripple::RPC::lookupLedger
Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
Definition RPCLedgerHelpers.cpp:305
ripple::keylet::mptIssuance
Keylet mptIssuance(std::uint32_t seq, AccountID const &issuer) noexcept
Definition Indexes.cpp:507
ripple::keylet::vault
Keylet vault(AccountID const &owner, std::uint32_t seq) noexcept
Definition Indexes.cpp:545
ripple
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition algorithm.h:6
diff --git a/WalletPropose_8cpp_source.html b/WalletPropose_8cpp_source.html index 6f67a2409a..3e1abce90e 100644 --- a/WalletPropose_8cpp_source.html +++ b/WalletPropose_8cpp_source.html @@ -256,9 +256,9 @@ $(document).ready(function() { init_codefold(0); });
std::floor
T floor(T... args)
Json::objectValue
@ objectValue
object value (collection of name/value pairs).
Definition json_value.h:27
-
ripple::RPC::getSeedFromRPC
std::optional< Seed > getSeedFromRPC(Json::Value const &params, Json::Value &error)
Definition RPCHelpers.cpp:726
+
ripple::RPC::getSeedFromRPC
std::optional< Seed > getSeedFromRPC(Json::Value const &params, Json::Value &error)
Definition RPCHelpers.cpp:219
ripple::RPC::expected_field_error
Json::Value expected_field_error(std::string const &name, std::string const &type)
Definition ErrorCodes.h:330
-
ripple::RPC::parseRippleLibSeed
std::optional< Seed > parseRippleLibSeed(Json::Value const &value)
Definition RPCHelpers.cpp:707
+
ripple::RPC::parseRippleLibSeed
std::optional< Seed > parseRippleLibSeed(Json::Value const &value)
Definition RPCHelpers.cpp:200
ripple
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition algorithm.h:6
ripple::keyTypeFromString
std::optional< KeyType > keyTypeFromString(std::string const &s)
Definition KeyType.h:15
ripple::toBase58
std::string toBase58(AccountID const &v)
Convert AccountID to base58 checked string.
Definition AccountID.cpp:95
diff --git a/apply__test_8cpp_source.html b/apply__test_8cpp_source.html index 61a812448a..b3de4cbd48 100644 --- a/apply__test_8cpp_source.html +++ b/apply__test_8cpp_source.html @@ -136,7 +136,7 @@ $(document).ready(function() { init_codefold(0); });
49 .first;
50
51 if (valid != Validity::Valid)
-
52 fail("Non-Fully canoncial signature was not permitted");
+
52 fail("Non-Fully canonical signature was not permitted");
53 }
54
55 {
@@ -150,7 +150,7 @@ $(document).ready(function() { init_codefold(0); });
63 fully_canonical.app().config())
64 .first;
65 if (valid == Validity::Valid)
-
66 fail("Non-Fully canoncial signature was permitted");
+
66 fail("Non-Fully canonical signature was permitted");
67 }
68
69 pass();
diff --git a/base__uint_8h_source.html b/base__uint_8h_source.html index e1756a239c..7cd27a0566 100644 --- a/base__uint_8h_source.html +++ b/base__uint_8h_source.html @@ -697,7 +697,7 @@ $(document).ready(function() { init_codefold(0); });
546 // This comparison might seem wrong on a casual inspection because it
547 // compares data internally stored as std::uint32_t byte-by-byte. But
548 // note that the underlying data is stored in big endian, even if the
-
549 // plaform is little endian. This makes the comparison correct.
+
549 // platform is little endian. This makes the comparison correct.
550 //
551 // FIXME: use std::lexicographical_compare_three_way once support is
552 // added to MacOS.
diff --git a/classbeast_1_1unit__test_1_1detail_1_1reporter.html b/classbeast_1_1unit__test_1_1detail_1_1reporter.html index c24c52c540..7ff98d0d80 100644 --- a/classbeast_1_1unit__test_1_1detail_1_1reporter.html +++ b/classbeast_1_1unit__test_1_1detail_1_1reporter.html @@ -687,7 +687,7 @@ template<class _ >

Set the argument string.

-

The argument string is available to suites and allows for customization of the test. Each suite defines its own syntax for the argumnet string. The same argument is passed to all suites.

+

The argument string is available to suites and allows for customization of the test. Each suite defines its own syntax for the argument string. The same argument is passed to all suites.

Definition at line 46 of file runner.h.

diff --git a/classbeast_1_1unit__test_1_1recorder.html b/classbeast_1_1unit__test_1_1recorder.html index fa826f7d85..f242383386 100644 --- a/classbeast_1_1unit__test_1_1recorder.html +++ b/classbeast_1_1unit__test_1_1recorder.html @@ -538,7 +538,7 @@ Private Attributes

Set the argument string.

-

The argument string is available to suites and allows for customization of the test. Each suite defines its own syntax for the argumnet string. The same argument is passed to all suites.

+

The argument string is available to suites and allows for customization of the test. Each suite defines its own syntax for the argument string. The same argument is passed to all suites.

Definition at line 46 of file runner.h.

diff --git a/classbeast_1_1unit__test_1_1runner.html b/classbeast_1_1unit__test_1_1runner.html index d641e682cb..bb71b8c912 100644 --- a/classbeast_1_1unit__test_1_1runner.html +++ b/classbeast_1_1unit__test_1_1runner.html @@ -337,7 +337,7 @@ Friends

Set the argument string.

-

The argument string is available to suites and allows for customization of the test. Each suite defines its own syntax for the argumnet string. The same argument is passed to all suites.

+

The argument string is available to suites and allows for customization of the test. Each suite defines its own syntax for the argument string. The same argument is passed to all suites.

Definition at line 46 of file runner.h.

diff --git a/classripple_1_1SlabAllocator.html b/classripple_1_1SlabAllocator.html index caaad2d893..9787a38048 100644 --- a/classripple_1_1SlabAllocator.html +++ b/classripple_1_1SlabAllocator.html @@ -196,7 +196,7 @@ template<typename Type >

Constructs a slab allocator able to allocate objects of a fixed size.

Parameters
- +
countthe number of items the slab allocator can allocate; note that a count of 0 is valid and means that the allocator is, effectively, disabled. This can be very useful in some contexts (e.g. when mimimal memory usage is needed) and allows for graceful failure.
countthe number of items the slab allocator can allocate; note that a count of 0 is valid and means that the allocator is, effectively, disabled. This can be very useful in some contexts (e.g. when minimal memory usage is needed) and allows for graceful failure.
diff --git a/classripple_1_1test_1_1multi__runner__child.html b/classripple_1_1test_1_1multi__runner__child.html index d43618a8b5..213a0ae0b7 100644 --- a/classripple_1_1test_1_1multi__runner__child.html +++ b/classripple_1_1test_1_1multi__runner__child.html @@ -760,7 +760,7 @@ template<class Pred >

Set the argument string.

-

The argument string is available to suites and allows for customization of the test. Each suite defines its own syntax for the argumnet string. The same argument is passed to all suites.

+

The argument string is available to suites and allows for customization of the test. Each suite defines its own syntax for the argument string. The same argument is passed to all suites.

Definition at line 46 of file runner.h.

diff --git a/cluster__test_8cpp_source.html b/cluster__test_8cpp_source.html index cbc4d18915..ab646ec99b 100644 --- a/cluster__test_8cpp_source.html +++ b/cluster__test_8cpp_source.html @@ -322,7 +322,7 @@ $(document).ready(function() { init_codefold(0); });
227 BEAST_EXPECT(!c->load(s4));
228
229 // Check if we properly terminate when we encounter
-
230 // a malformed or unparseable entry:
+
230 // a malformed or unparsable entry:
231 auto const node1 = randomNode();
232 auto const node2 = randomNode();
233
diff --git a/comparators_8h_source.html b/comparators_8h_source.html index ae5f124321..e4ba797fcf 100644 --- a/comparators_8h_source.html +++ b/comparators_8h_source.html @@ -92,7 +92,7 @@ $(document).ready(function() { init_codefold(0); });
9
10/*
11 * MSVC 2019 version 16.9.0 added [[nodiscard]] to the std comparison
-
12 * operator() functions. boost::bimap checks that the comparitor is a
+
12 * operator() functions. boost::bimap checks that the comparator is a
13 * BinaryFunction, in part by calling the function and ignoring the value.
14 * These two things don't play well together. These wrapper classes simply
15 * strip [[nodiscard]] from operator() for use in boost::bimap.
diff --git a/dir_f2000200ababdfebbc57680f92fa09d7.html b/dir_f2000200ababdfebbc57680f92fa09d7.html index 68aaacd8e4..27b76a337a 100644 --- a/dir_f2000200ababdfebbc57680f92fa09d7.html +++ b/dir_f2000200ababdfebbc57680f92fa09d7.html @@ -112,6 +112,10 @@ Files    RPCHelpers.h   + RPCLedgerHelpers.cpp +  + RPCLedgerHelpers.h +   RPCSub.cpp    ServerHandler.cpp diff --git a/envconfig_8h_source.html b/envconfig_8h_source.html index 701296977a..0c7c4ae121 100644 --- a/envconfig_8h_source.html +++ b/envconfig_8h_source.html @@ -89,7 +89,7 @@ $(document).ready(function() { init_codefold(0); });
6namespace ripple {
7namespace test {
8
-
9// frequently used macros defined here for convinience.
+
9// frequently used macros defined here for convenience.
10#define PORT_WS "port_ws"
11#define PORT_RPC "port_rpc"
12#define PORT_PEER "port_peer"
diff --git a/namespacemembers_f.html b/namespacemembers_f.html index 5ee4231667..38b51c14d8 100644 --- a/namespacemembers_f.html +++ b/namespacemembers_f.html @@ -151,8 +151,9 @@ $(function() {
  • fullBelowExpiration : ripple
  • fullBelowTargetSize : ripple
  • FunctionType : ripple
    • +
  • fund() : ripple::test::jtx
  • Fund : ripple::test::jtx
    • -
  • fund() : ripple::test::jtx, ripple::test::jtx::paychan
    • +
  • fund() : ripple::test::jtx::paychan
    • diff --git a/namespacemembers_func_g.html b/namespacemembers_func_g.html index 573ce7efd8..8da76f2a8d 100644 --- a/namespacemembers_func_g.html +++ b/namespacemembers_func_g.html @@ -92,7 +92,7 @@ $(function() {
  • get_random() : antithesis
  • getAccount() : ripple
  • getAccountLines() : ripple::test::jtx
    • -
  • getAccountObjects() : ripple::RPC
    • +
  • getAccountObjects() : ripple
  • getAccountOffers() : ripple::test::jtx
  • getAccountTxs() : ripple::detail
  • getAccountTxsB() : ripple::detail
    • diff --git a/namespacemembers_g.html b/namespacemembers_g.html index 4648965ddd..402b82fa1b 100644 --- a/namespacemembers_g.html +++ b/namespacemembers_g.html @@ -93,7 +93,7 @@ $(function() {
  • get_random() : antithesis
  • getAccount() : ripple
  • getAccountLines() : ripple::test::jtx
    • -
  • getAccountObjects() : ripple::RPC
    • +
  • getAccountObjects() : ripple
  • getAccountOffers() : ripple::test::jtx
  • getAccountTxs() : ripple::detail
  • getAccountTxsB() : ripple::detail
    • diff --git a/namespacemembers_i.html b/namespacemembers_i.html index 329f1a35a1..e3aacc0261 100644 --- a/namespacemembers_i.html +++ b/namespacemembers_i.html @@ -137,7 +137,7 @@ $(function() {
  • is_loopback() : beast::IP
  • is_lws() : beast::rfc2616::detail
  • is_multicast() : beast::IP
    • -
  • is_private() : beast::IP
    • +
  • is_private() : beast::IP
  • is_public() : beast::IP
  • is_unspecified() : beast::IP
  • is_white() : beast::rfc2616::detail
    • diff --git a/namespacemembers_t.html b/namespacemembers_t.html index 70581f41fa..ceb6d47359 100644 --- a/namespacemembers_t.html +++ b/namespacemembers_t.html @@ -490,8 +490,8 @@ $(function() {
  • trust() : ripple::test::jtx::amm, ripple::test::jtx
  • trustCreate() : ripple
  • trustDelete() : ripple
    • -
  • TrustFlag : ripple::test
  • trustFlag() : ripple::test
    • +
  • TrustFlag : ripple::test
  • TrustSet : ripple
  • ttCONTRACT : ripple
  • ttHOOK_SET : ripple
    • diff --git a/namespaceripple.html b/namespaceripple.html index f45ef388bd..5e235dc0f2 100644 --- a/namespaceripple.html +++ b/namespaceripple.html @@ -5261,6 +5261,8 @@ requires (T::ConsequencesFactory == Json::Value doAccountNFTs (RPC::JsonContext &context)  General RPC command that can retrieve objects in the account root.
      +bool getAccountObjects (ReadView const &ledger, AccountID const &account, std::optional< std::vector< LedgerEntryType > > const &typeFilter, uint256 dirIndex, uint256 entryIndex, std::uint32_t const limit, Json::Value &jvResult) +  Json::Value doAccountObjects (RPC::JsonContext &context)   void appendOfferJson (std::shared_ptr< SLE const > const &offer, Json::Value &offers) @@ -47194,7 +47196,7 @@ template<class T >
    -

    Definition at line 117 of file LedgerData.cpp.

    +

    Definition at line 118 of file LedgerData.cpp.

    @@ -47244,7 +47246,7 @@ template<class T >
    -

    Definition at line 16 of file AccountChannels.cpp.

    +

    Definition at line 17 of file AccountChannels.cpp.

    @@ -47264,7 +47266,7 @@ template<class T >
    -

    Definition at line 49 of file AccountChannels.cpp.

    +

    Definition at line 50 of file AccountChannels.cpp.

    @@ -47304,7 +47306,7 @@ template<class T >
    -

    Definition at line 31 of file AccountInfo.cpp.

    +

    Definition at line 32 of file AccountInfo.cpp.

    @@ -47334,7 +47336,7 @@ template<class T >
    -

    Definition at line 15 of file AccountLines.cpp.

    +

    Definition at line 16 of file AccountLines.cpp.

    @@ -47354,7 +47356,7 @@ template<class T >
    -

    Definition at line 62 of file AccountLines.cpp.

    +

    Definition at line 63 of file AccountLines.cpp.

    @@ -47377,7 +47379,67 @@ template<class T >

    General RPC command that can retrieve objects in the account root.

    { account: <account> ledger_hash: <string> // optional ledger_index: <string | unsigned integer> // optional type: <string> // optional, defaults to all account objects types limit: <integer> // optional marker: <opaque> // optional, resume previous query }

    -

    Definition at line 31 of file AccountObjects.cpp.

    +

    Definition at line 32 of file AccountObjects.cpp.

    + +
    +
    + +

    ◆ getAccountObjects()

    + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    bool ripple::getAccountObjects (ReadView const & ledger,
    AccountID const & account,
    std::optional< std::vector< LedgerEntryType > > const & typeFilter,
    uint256 dirIndex,
    uint256 entryIndex,
    std::uint32_t const limit,
    Json::Value & jvResult 
    )
    +
    + +

    Definition at line 163 of file AccountObjects.cpp.

    @@ -47397,7 +47459,7 @@ template<class T >
    -

    Definition at line 162 of file AccountObjects.cpp.

    +

    Definition at line 355 of file AccountObjects.cpp.

    @@ -47427,7 +47489,7 @@ template<class T >
    -

    Definition at line 16 of file AccountOffers.cpp.

    +

    Definition at line 17 of file AccountOffers.cpp.

    @@ -47447,7 +47509,7 @@ template<class T >
    -

    Definition at line 38 of file AccountOffers.cpp.

    +

    Definition at line 39 of file AccountOffers.cpp.

    @@ -47623,7 +47685,7 @@ template<class T >
    -

    Definition at line 16 of file AMMInfo.cpp.

    +

    Definition at line 17 of file AMMInfo.cpp.

    @@ -47653,7 +47715,7 @@ template<class T >
    -

    Definition at line 32 of file AMMInfo.cpp.

    +

    Definition at line 33 of file AMMInfo.cpp.

    @@ -47673,7 +47735,7 @@ template<class T >
    -

    Definition at line 46 of file AMMInfo.cpp.

    +

    Definition at line 47 of file AMMInfo.cpp.

    @@ -47693,7 +47755,7 @@ template<class T >
    -

    Definition at line 57 of file AMMInfo.cpp.

    +

    Definition at line 58 of file AMMInfo.cpp.

    @@ -47733,7 +47795,7 @@ template<class T >
    -

    Definition at line 18 of file BookOffers.cpp.

    +

    Definition at line 19 of file BookOffers.cpp.

    @@ -47753,7 +47815,7 @@ template<class T >
    -

    Definition at line 203 of file BookOffers.cpp.

    +

    Definition at line 204 of file BookOffers.cpp.

    @@ -48280,7 +48342,7 @@ template<class T >
    -

    Definition at line 27 of file LedgerData.cpp.

    +

    Definition at line 28 of file LedgerData.cpp.

    @@ -48400,7 +48462,7 @@ template<class T >
    -

    Definition at line 146 of file NFTOffers.cpp.

    +

    Definition at line 147 of file NFTOffers.cpp.

    @@ -48420,7 +48482,7 @@ template<class T >
    -

    Definition at line 132 of file NFTOffers.cpp.

    +

    Definition at line 133 of file NFTOffers.cpp.

    @@ -48440,7 +48502,7 @@ template<class T >
    -

    Definition at line 43 of file NoRippleCheck.cpp.

    +

    Definition at line 44 of file NoRippleCheck.cpp.

    @@ -50334,7 +50396,7 @@ template<class T >
    -

    Definition at line 16 of file NFTOffers.cpp.

    +

    Definition at line 17 of file NFTOffers.cpp.

    @@ -50378,7 +50440,7 @@ template<class T >
    -

    Definition at line 44 of file NFTOffers.cpp.

    +

    Definition at line 45 of file NFTOffers.cpp.

    @@ -50434,7 +50496,7 @@ template<class T >
    -

    Definition at line 17 of file NoRippleCheck.cpp.

    +

    Definition at line 18 of file NoRippleCheck.cpp.

    diff --git a/namespaceripple_1_1RPC.html b/namespaceripple_1_1RPC.html index 71cd2cff81..c958bdbebd 100644 --- a/namespaceripple_1_1RPC.html +++ b/namespaceripple_1_1RPC.html @@ -240,9 +240,27 @@ Functions bool isRelatedToAccount (ReadView const &ledger, std::shared_ptr< SLE const > const &sle, AccountID const &accountID)  Tests if a SLE is owned by accountID.
      -bool getAccountObjects (ReadView const &ledger, AccountID const &account, std::optional< std::vector< LedgerEntryType > > const &typeFilter, uint256 dirIndex, uint256 entryIndex, std::uint32_t const limit, Json::Value &jvResult) - Gathers all objects for an account in a ledger.
    -  +hash_set< AccountID > parseAccountIds (Json::Value const &jvArray) +  +void injectSLE (Json::Value &jv, SLE const &sle) + Inject JSON describing ledger entry.
    +  +std::optional< Json::Value > readLimitField (unsigned int &limit, Tuning::LimitRange const &, JsonContext const &) + Retrieve the limit value from a JsonContext, or set a default - then restrict the limit by max and min if not an ADMIN request.
    +  +std::optional< Seed > parseRippleLibSeed (Json::Value const &value) +  +std::optional< Seed > getSeedFromRPC (Json::Value const &params, Json::Value &error) +  +std::optional< std::pair< PublicKey, SecretKey > > keypairForSignature (Json::Value const &params, Json::Value &error, unsigned int apiVersion) +  +std::pair< RPC::Status, LedgerEntryType > chooseLedgerEntryType (Json::Value const &params) +  +bool isAccountObjectsValidType (LedgerEntryType const &type) + Check if the type is a valid filtering type for account_objects method.
    +  +bool isHexTxID (std::string const &txid) +  template<class T , class R > Status ledgerFromRequest (T &ledger, GRPCContext< R > &context)   @@ -279,30 +297,9 @@ Functions Json::Value lookupLedger (std::shared_ptr< ReadView const > &, JsonContext &)  Look up a ledger from a request and fill a Json::Result with either an error, or data representing a ledger.
      -hash_set< AccountID > parseAccountIds (Json::Value const &jvArray) -  -void injectSLE (Json::Value &jv, SLE const &sle) - Inject JSON describing ledger entry.
    -  -std::optional< Json::Value > readLimitField (unsigned int &limit, Tuning::LimitRange const &, JsonContext const &) - Retrieve the limit value from a JsonContext, or set a default - then restrict the limit by max and min if not an ADMIN request.
    -  -std::optional< Seed > parseRippleLibSeed (Json::Value const &value) -  -std::optional< Seed > getSeedFromRPC (Json::Value const &params, Json::Value &error) -  -std::optional< std::pair< PublicKey, SecretKey > > keypairForSignature (Json::Value const &params, Json::Value &error, unsigned int apiVersion) -  -std::pair< RPC::Status, LedgerEntryType > chooseLedgerEntryType (Json::Value const &params) -  -bool isAccountObjectsValidType (LedgerEntryType const &type) - Check if the type is a valid filtering type for account_objects method.
    -  std::variant< std::shared_ptr< Ledger const >, Json::Value > getLedgerByContext (RPC::JsonContext &context)  Return a ledger based on ledger_hash or ledger_index, or an RPC error.
      -bool isHexTxID (std::string const &txid) -  static XRPAmount getTxFee (Application const &app, Config const &config, Json::Value tx)   Json::Value getCurrentNetworkFee (Role const role, Config const &config, LoadFeeTrack const &feeTrack, TxQ const &txQ, Application const &app, Json::Value const &tx, int mult, int div) @@ -511,7 +508,7 @@ Variables VALIDATED  -

    Definition at line 111 of file RPCHelpers.h.

    +

    Definition at line 47 of file RPCLedgerHelpers.h.

    @@ -2383,53 +2380,43 @@ template<class T > - -

    ◆ getAccountObjects()

    + +

    ◆ parseAccountIds()

    - + - - - - - + + - - +
    bool ripple::RPC::getAccountObjects hash_set< AccountID > ripple::RPC::parseAccountIds (ReadView const & ledger,
    Json::Value const & jvArray) AccountID const & account,
    +
    + +

    Definition at line 134 of file RPCHelpers.cpp.

    + +
    +
    + +

    ◆ injectSLE()

    + +
    +
    + - - - - - - - - - - - - - - - - - - - - - - - - - - + + - + + + + + + + @@ -2439,21 +2426,197 @@ template<class T >
    std::optional< std::vector< LedgerEntryType > > const & typeFilter,
    uint256 dirIndex,
    uint256 entryIndex,
    std::uint32_t const limit,
    void ripple::RPC::injectSLE ( Json::Value & jvResult jv,
    SLE const & sle 
    -

    Gathers all objects for an account in a ledger.

    -
    Parameters
    - - - - - - - - -
    ledgerLedger to search account objects.
    accountAccountID to find objects for.
    typeFilterGathers objects of these types. empty gathers all types.
    dirIndexBegin gathering account objects from this directory.
    entryIndexBegin gathering objects from this directory node.
    limitMaximum number of objects to find.
    jvResultA JSON result that holds the request objects.
    -
    -
    +

    Inject JSON describing ledger entry.

    +

    Effects: Adds the JSON description of sle to jv.

    +

    If sle holds an account root, also adds the urlgravatar field JSON if sfEmailHash is present.

    -

    Definition at line 134 of file RPCHelpers.cpp.

    +

    Definition at line 150 of file RPCHelpers.cpp.

    + +
    +
    + +

    ◆ readLimitField()

    + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + +
    std::optional< Json::Value > ripple::RPC::readLimitField (unsigned int & limit,
    Tuning::LimitRange const & ,
    JsonContext const &  
    )
    +
    + +

    Retrieve the limit value from a JsonContext, or set a default - then restrict the limit by max and min if not an ADMIN request.

    +

    If there is an error, return it as JSON.

    + +

    Definition at line 175 of file RPCHelpers.cpp.

    + +
    +
    + +

    ◆ parseRippleLibSeed()

    + +
    +
    + + + + + + + + +
    std::optional< Seed > ripple::RPC::parseRippleLibSeed (Json::Value const & value)
    +
    + +

    Definition at line 200 of file RPCHelpers.cpp.

    + +
    +
    + +

    ◆ getSeedFromRPC()

    + +
    +
    + + + + + + + + + + + + + + + + + + +
    std::optional< Seed > ripple::RPC::getSeedFromRPC (Json::Value const & params,
    Json::Value & error 
    )
    +
    + +

    Definition at line 219 of file RPCHelpers.cpp.

    + +
    +
    + +

    ◆ keypairForSignature()

    + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + +
    std::optional< std::pair< PublicKey, SecretKey > > ripple::RPC::keypairForSignature (Json::Value const & params,
    Json::Value & error,
    unsigned int apiVersion 
    )
    +
    + +

    Definition at line 278 of file RPCHelpers.cpp.

    + +
    +
    + +

    ◆ chooseLedgerEntryType()

    + +
    +
    + + + + + + + + +
    std::pair< RPC::Status, LedgerEntryType > ripple::RPC::chooseLedgerEntryType (Json::Value const & params)
    +
    + +

    Definition at line 414 of file RPCHelpers.cpp.

    + +
    +
    + +

    ◆ isAccountObjectsValidType()

    + +
    +
    + + + + + + + + +
    bool ripple::RPC::isAccountObjectsValidType (LedgerEntryType const & type)
    +
    + +

    Check if the type is a valid filtering type for account_objects method.

    +

    Since Amendments, DirectoryNode, FeeSettings, LedgerHashes can not be owned by an account, this function will return false in these situations.

    + +

    Definition at line 469 of file RPCHelpers.cpp.

    + +
    +
    + +

    ◆ isHexTxID()

    + +
    +
    + + + + + + + + +
    bool ripple::RPC::isHexTxID (std::string const & txid)
    +
    @@ -2485,7 +2648,7 @@ template<class T , class R >
    -

    Definition at line 392 of file RPCHelpers.cpp.

    +

    Definition at line 91 of file RPCLedgerHelpers.cpp.

    @@ -2607,7 +2770,7 @@ template<class T >
    -

    Definition at line 418 of file RPCHelpers.cpp.

    +

    Definition at line 117 of file RPCLedgerHelpers.cpp.

    @@ -2647,7 +2810,7 @@ template<class T >

    Get ledger by hash If there is no error in the return value, the ledger pointer will have been filled.

    -

    Definition at line 472 of file RPCHelpers.cpp.

    +

    Definition at line 171 of file RPCLedgerHelpers.cpp.

    @@ -2687,7 +2850,7 @@ template<class T >

    Get ledger by sequence If there is no error in the return value, the ledger pointer will have been filled.

    -

    Definition at line 482 of file RPCHelpers.cpp.

    +

    Definition at line 181 of file RPCLedgerHelpers.cpp.

    @@ -2728,7 +2891,7 @@ template<class T >

    Get ledger specified in shortcut.

    If there is no error in the return value, the ledger pointer will have been filled

    -

    Definition at line 511 of file RPCHelpers.cpp.

    +

    Definition at line 210 of file RPCLedgerHelpers.cpp.

    @@ -2869,7 +3032,7 @@ template<class T >

    Look up a ledger from a request and fill a Json::Result with the data representing a ledger.

    If the returned Status is OK, the ledger pointer will have been filled.

    -

    Definition at line 606 of file RPCHelpers.cpp.

    +

    Definition at line 305 of file RPCLedgerHelpers.cpp.

    @@ -2902,229 +3065,7 @@ template<class T >

    Look up a ledger from a request and fill a Json::Result with either an error, or data representing a ledger.

    If there is no error in the return value, then the ledger pointer will have been filled.

    -

    Definition at line 631 of file RPCHelpers.cpp.

    - - - - -

    ◆ parseAccountIds()

    - -
    -
    - - - - - - - - -
    hash_set< AccountID > ripple::RPC::parseAccountIds (Json::Value const & jvArray)
    -
    - -

    Definition at line 641 of file RPCHelpers.cpp.

    - -
    -
    - -

    ◆ injectSLE()

    - -
    -
    - - - - - - - - - - - - - - - - - - -
    void ripple::RPC::injectSLE (Json::Value & jv,
    SLE const & sle 
    )
    -
    - -

    Inject JSON describing ledger entry.

    -

    Effects: Adds the JSON description of sle to jv.

    -

    If sle holds an account root, also adds the urlgravatar field JSON if sfEmailHash is present.

    - -

    Definition at line 657 of file RPCHelpers.cpp.

    - -
    -
    - -

    ◆ readLimitField()

    - -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - -
    std::optional< Json::Value > ripple::RPC::readLimitField (unsigned int & limit,
    Tuning::LimitRange const & ,
    JsonContext const &  
    )
    -
    - -

    Retrieve the limit value from a JsonContext, or set a default - then restrict the limit by max and min if not an ADMIN request.

    -

    If there is an error, return it as JSON.

    - -

    Definition at line 682 of file RPCHelpers.cpp.

    - -
    -
    - -

    ◆ parseRippleLibSeed()

    - -
    -
    - - - - - - - - -
    std::optional< Seed > ripple::RPC::parseRippleLibSeed (Json::Value const & value)
    -
    - -

    Definition at line 707 of file RPCHelpers.cpp.

    - -
    -
    - -

    ◆ getSeedFromRPC()

    - -
    -
    - - - - - - - - - - - - - - - - - - -
    std::optional< Seed > ripple::RPC::getSeedFromRPC (Json::Value const & params,
    Json::Value & error 
    )
    -
    - -

    Definition at line 726 of file RPCHelpers.cpp.

    - -
    -
    - -

    ◆ keypairForSignature()

    - -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - -
    std::optional< std::pair< PublicKey, SecretKey > > ripple::RPC::keypairForSignature (Json::Value const & params,
    Json::Value & error,
    unsigned int apiVersion 
    )
    -
    - -

    Definition at line 785 of file RPCHelpers.cpp.

    - -
    -
    - -

    ◆ chooseLedgerEntryType()

    - -
    -
    - - - - - - - - -
    std::pair< RPC::Status, LedgerEntryType > ripple::RPC::chooseLedgerEntryType (Json::Value const & params)
    -
    - -

    Definition at line 921 of file RPCHelpers.cpp.

    - -
    -
    - -

    ◆ isAccountObjectsValidType()

    - -
    -
    - - - - - - - - -
    bool ripple::RPC::isAccountObjectsValidType (LedgerEntryType const & type)
    -
    - -

    Check if the type is a valid filtering type for account_objects method.

    -

    Since Amendments, DirectoryNode, FeeSettings, LedgerHashes can not be owned by an account, this function will return false in these situations.

    - -

    Definition at line 976 of file RPCHelpers.cpp.

    +

    Definition at line 330 of file RPCLedgerHelpers.cpp.

    @@ -3146,25 +3087,7 @@ template<class T >

    Return a ledger based on ledger_hash or ledger_index, or an RPC error.

    -

    Definition at line 992 of file RPCHelpers.cpp.

    - - - - -

    ◆ isHexTxID()

    - -
    -
    - - - - - - - - -
    bool ripple::RPC::isHexTxID (std::string const & txid)
    -
    +

    Definition at line 340 of file RPCLedgerHelpers.cpp.

    diff --git a/search/all_10.js b/search/all_10.js index 60ac61cb80..5304865847 100644 --- a/search/all_10.js +++ b/search/all_10.js @@ -320,7 +320,7 @@ var searchData= ['ipaddressconversion_317',['ipaddressconversion',['../structbeast_1_1IPAddressConversion.html#aeeb741eceefb870c1c7ff31b894f1011',1,'beast::IPAddressConversion::IPAddressConversion()'],['../structbeast_1_1IPAddressConversion.html',1,'beast::IPAddressConversion']]], ['ipaddresses_318',['IPAddresses',['../namespaceripple_1_1PeerFinder.html#aa976f893782a0e9ae34878b7d7045c05',1,'ripple::PeerFinder']]], ['ipallowed_319',['ipAllowed',['../namespaceripple.html#ae526cb7431d0104912811e64227383f8',1,'ripple']]], - ['ipe_320',['ipe',['../namespaceripple_1_1test_1_1jtx.html#a992303bb9a650824e18de77a2355ac23',1,'ripple::test::jtx::IPE()'],['../namespaceripple_1_1test.html#acb8d1b93cfea8a1115a2ced455a83e82',1,'ripple::test::ipe()']]], + ['ipe_320',['ipe',['../namespaceripple_1_1test.html#acb8d1b93cfea8a1115a2ced455a83e82',1,'ripple::test::ipe()'],['../namespaceripple_1_1test_1_1jtx.html#a992303bb9a650824e18de77a2355ac23',1,'ripple::test::jtx::IPE()']]], ['ipendpoint_5ftest_321',['IPEndpoint_test',['../classbeast_1_1IP_1_1IPEndpoint__test.html',1,'beast::IP']]], ['iplimit_322',['iplimit',['../structripple_1_1PeerFinder_1_1Config.html#a46decaaf39a6782668b563d2d774ddb5',1,'ripple::PeerFinder::Config::ipLimit'],['../structripple_1_1Overlay_1_1Setup.html#a80250951d1e867a2cdc1cb3f4ed6d8a1',1,'ripple::Overlay::Setup::ipLimit']]], ['iplimitexceeded_323',['ipLimitExceeded',['../namespaceripple_1_1PeerFinder.html#ae15e107cb3b0b67dbf43bd4a0a229c15a290e854afb37272f6ff33bda722dacb7',1,'ripple::PeerFinder']]], diff --git a/search/all_13.js b/search/all_13.js index 5a39e3ccb1..c03966cd94 100644 --- a/search/all_13.js +++ b/search/all_13.js @@ -145,7 +145,7 @@ var searchData= ['ledgergenesistimeresolution_142',['ledgerGenesisTimeResolution',['../namespaceripple.html#a82e58c7a4ba5450436885574fb2fd4f5',1,'ripple']]], ['ledgergranularity_143',['ledgerGRANULARITY',['../structripple_1_1ConsensusParms.html#a0f51900eb407dde2619c639882d564e7',1,'ripple::ConsensusParms']]], ['ledgerhandler_144',['ledgerhandler',['../classripple_1_1RPC_1_1LedgerHandler.html',1,'ripple::RPC::LedgerHandler'],['../classripple_1_1RPC_1_1LedgerHandler.html#afa39c881edcf53399964ec32b3312b1a',1,'ripple::RPC::LedgerHandler::LedgerHandler()']]], - ['ledgerhash_145',['ledgerhash',['../classripple_1_1RelationalDatabase.html#ae6ed6a653c43698a1480c0230b1e99aa',1,'ripple::RelationalDatabase::LedgerHash'],['../structripple_1_1LedgerHashPair.html#a4b52e6ae64b9feac6fa5f8f8cbf1f9ce',1,'ripple::LedgerHashPair::ledgerHash'],['../structripple_1_1TxResult.html#a973f423b31549213ee1613c9ae25dc82',1,'ripple::TxResult::ledgerHash'],['../namespaceripple_1_1test.html#a0bd41ec0e7d28cae7397e33711e22ff5',1,'ripple::test::ledgerHash()'],['../namespaceripple.html#af5a72d3e0d9b6913c13f688390b90796',1,'ripple::LedgerHash']]], + ['ledgerhash_145',['ledgerhash',['../classripple_1_1RelationalDatabase.html#ae6ed6a653c43698a1480c0230b1e99aa',1,'ripple::RelationalDatabase::LedgerHash'],['../structripple_1_1LedgerHashPair.html#a4b52e6ae64b9feac6fa5f8f8cbf1f9ce',1,'ripple::LedgerHashPair::ledgerHash'],['../structripple_1_1TxResult.html#a973f423b31549213ee1613c9ae25dc82',1,'ripple::TxResult::ledgerHash'],['../namespaceripple.html#af5a72d3e0d9b6913c13f688390b90796',1,'ripple::LedgerHash'],['../namespaceripple_1_1test.html#a0bd41ec0e7d28cae7397e33711e22ff5',1,'ripple::test::ledgerHash()']]], ['ledgerhashpair_146',['LedgerHashPair',['../structripple_1_1LedgerHashPair.html',1,'ripple']]], ['ledgerheader_147',['ledgerheader',['../structripple_1_1LedgerHeader.html',1,'ripple::LedgerHeader'],['../structripple_1_1LedgerHeader.html#a03771f954fb5b32e330aec50ae5a87de',1,'ripple::LedgerHeader::LedgerHeader()']]], ['ledgerheader_5ftest_148',['LedgerHeader_test',['../classripple_1_1LedgerHeader__test.html',1,'ripple']]], diff --git a/search/all_17.js b/search/all_17.js index 62ab4c0d3d..3ec76b9faf 100644 --- a/search/all_17.js +++ b/search/all_17.js @@ -269,7 +269,7 @@ var searchData= ['payment_266',['payment',['../classripple_1_1Payment.html#a4ed9102d4015a6b67ea2129171fcd159',1,'ripple::Payment::Payment()'],['../classripple_1_1Payment.html',1,'ripple::Payment']]], ['payment_20tt_20transaction_20json_20schema_267',['Modification to <tt>Payment</tt> transaction JSON schema',['../md__2____w_2rippled_2rippled_2API-CHANGELOG.html#autotoc_md4',1,'']]], ['payment_5fauto_5fpath_5ffind_268',['payment_auto_path_find',['../classripple_1_1test_1_1Path__test.html#a3024cf59d94cc5e123c603c6d467e1e5',1,'ripple::test::Path_test']]], - ['paymentchannelclaim_269',['paymentchannelclaim',['../namespaceripple.html#ad5143ceada01141772ae4aab984f94bdae9474a9e64b014ac43be92e69750cfc2',1,'ripple::paymentChannelClaim'],['../namespaceripple.html#adf19dc78a0185e45380be5dbe2415bbb',1,'ripple::PaymentChannelClaim']]], + ['paymentchannelclaim_269',['paymentchannelclaim',['../namespaceripple.html#adf19dc78a0185e45380be5dbe2415bbb',1,'ripple::PaymentChannelClaim'],['../namespaceripple.html#ad5143ceada01141772ae4aab984f94bdae9474a9e64b014ac43be92e69750cfc2',1,'ripple::paymentChannelClaim']]], ['paymentchannelcreate_270',['PaymentChannelCreate',['../namespaceripple.html#aa7a665b0e4d145246c459ffe6d8a6c03',1,'ripple']]], ['paymentchannelfund_271',['PaymentChannelFund',['../namespaceripple.html#a1b8ee7f363a248581f484dbf7bf7fa97',1,'ripple']]], ['paymentsandbox_272',['paymentsandbox',['../classripple_1_1PaymentSandbox.html#adb0094cac0964f9fed3e050364897648',1,'ripple::PaymentSandbox::PaymentSandbox(PaymentSandbox *base)'],['../classripple_1_1PaymentSandbox.html#ae15058fe338f8aa06837f54c21a918d0',1,'ripple::PaymentSandbox::PaymentSandbox(PaymentSandbox const *base)'],['../classripple_1_1PaymentSandbox.html#ab1053f94b2865ac786fac9f780f4cb02',1,'ripple::PaymentSandbox::PaymentSandbox()=delete'],['../classripple_1_1PaymentSandbox.html#ae02b1332fe55c307074866a9c3b15546',1,'ripple::PaymentSandbox::PaymentSandbox(PaymentSandbox const &)=delete'],['../classripple_1_1PaymentSandbox.html#aec1550eb021dc24fc76fdfa320f7c040',1,'ripple::PaymentSandbox::PaymentSandbox(PaymentSandbox &&)=default'],['../classripple_1_1PaymentSandbox.html#ab7631f4e5085e026d8c8fd65aa9b1533',1,'ripple::PaymentSandbox::PaymentSandbox(ReadView const *base, ApplyFlags flags)'],['../classripple_1_1PaymentSandbox.html',1,'ripple::PaymentSandbox'],['../classripple_1_1PaymentSandbox.html#a6859b772e9f03d8f1bb690de83055e22',1,'ripple::PaymentSandbox::PaymentSandbox()']]], diff --git a/search/all_1b.js b/search/all_1b.js index c28853b092..b520fcb56b 100644 --- a/search/all_1b.js +++ b/search/all_1b.js @@ -2053,7 +2053,7 @@ var searchData= ['trustedvalidations_2050',['trustedValidations',['../classripple_1_1AmendmentSet.html#a6d6b63ea4b09a0b012667c79aff07528',1,'ripple::AmendmentSet']]], ['trustedvalidations_5f_2051',['trustedValidations_',['../classripple_1_1AmendmentSet.html#a08f7a2888e1f8767713d045a114975c9',1,'ripple::AmendmentSet']]], ['trustedvotes_2052',['trustedvotes',['../classripple_1_1TrustedVotes.html',1,'ripple::TrustedVotes'],['../classripple_1_1TrustedVotes.html#abe5928a3f6fa4cf32bc180a88978e4bf',1,'ripple::TrustedVotes::TrustedVotes(TrustedVotes const &rhs)=delete'],['../classripple_1_1TrustedVotes.html#a3d752f8a8137c54441bd754db241b286',1,'ripple::TrustedVotes::TrustedVotes()=default']]], - ['trustflag_2053',['trustflag',['../namespaceripple_1_1test.html#acf39cc44acdd6b5089f2076897fa3911',1,'ripple::test::TrustFlag'],['../namespaceripple_1_1test.html#a6879dc19e056b84550387698c4c38ec4',1,'ripple::test::trustFlag(TrustFlag f, bool useHigh)']]], + ['trustflag_2053',['trustflag',['../namespaceripple_1_1test.html#a6879dc19e056b84550387698c4c38ec4',1,'ripple::test::trustFlag(TrustFlag f, bool useHigh)'],['../namespaceripple_1_1test.html#acf39cc44acdd6b5089f2076897fa3911',1,'ripple::test::TrustFlag']]], ['trustgraph_2054',['trustgraph',['../classripple_1_1test_1_1csf_1_1TrustGraph.html',1,'ripple::test::csf::TrustGraph< Peer >'],['../classripple_1_1test_1_1csf_1_1TrustGraph.html#ad71fd7d9762e7c9b25ef2f27514afd9f',1,'ripple::test::csf::TrustGraph::TrustGraph()'],['../structripple_1_1test_1_1csf_1_1Peer.html#a570755672f7b6ec1c2bb96570882c166',1,'ripple::test::csf::Peer::trustGraph'],['../classripple_1_1test_1_1csf_1_1Sim.html#a8bc47ca290010d8a2637da1cd274a605',1,'ripple::test::csf::Sim::trustGraph']]], ['trustgraph_3c_20ripple_3a_3atest_3a_3acsf_3a_3apeer_20_2a_20_3e_2055',['TrustGraph< ripple::test::csf::Peer * >',['../classripple_1_1test_1_1csf_1_1TrustGraph.html',1,'ripple::test::csf']]], ['trustlinebase_2056',['trustlinebase',['../classripple_1_1RPCTrustLine.html#a74bdbbfaa6b36d1c4444faaa507012e9',1,'ripple::RPCTrustLine::TrustLineBase(TrustLineBase &&)=default'],['../classripple_1_1RPCTrustLine.html#ae0423b9670b43791ebddc47fc329256f',1,'ripple::RPCTrustLine::TrustLineBase(TrustLineBase const &)=default'],['../classripple_1_1RPCTrustLine.html#a710bb727f7f0b4d0872fcca8eaed8768',1,'ripple::RPCTrustLine::TrustLineBase(std::shared_ptr< SLE const > const &sle, AccountID const &viewAccount)'],['../classripple_1_1PathFindTrustLine.html#a74bdbbfaa6b36d1c4444faaa507012e9',1,'ripple::PathFindTrustLine::TrustLineBase(TrustLineBase &&)=default'],['../classripple_1_1PathFindTrustLine.html#ae0423b9670b43791ebddc47fc329256f',1,'ripple::PathFindTrustLine::TrustLineBase(TrustLineBase const &)=default'],['../classripple_1_1TrustLineBase.html#a74bdbbfaa6b36d1c4444faaa507012e9',1,'ripple::TrustLineBase::TrustLineBase()'],['../classripple_1_1PathFindTrustLine.html#a710bb727f7f0b4d0872fcca8eaed8768',1,'ripple::PathFindTrustLine::TrustLineBase()'],['../classripple_1_1TrustLineBase.html',1,'ripple::TrustLineBase'],['../classripple_1_1TrustLineBase.html#ae0423b9670b43791ebddc47fc329256f',1,'ripple::TrustLineBase::TrustLineBase(TrustLineBase const &)=default'],['../classripple_1_1TrustLineBase.html#a710bb727f7f0b4d0872fcca8eaed8768',1,'ripple::TrustLineBase::TrustLineBase(std::shared_ptr< SLE const > const &sle, AccountID const &viewAccount)']]], diff --git a/search/all_1c.js b/search/all_1c.js index 3c60a1d1b2..ecf350b852 100644 --- a/search/all_1c.js +++ b/search/all_1c.js @@ -60,7 +60,7 @@ var searchData= ['underlying_5ftype_5ft_57',['underlying_type_t',['http://en.cppreference.com/w/cpp/types/underlying_type.html',1,'std']]], ['undodelay_58',['undodelay',['../structripple_1_1test_1_1Consensus__test_1_1UndoDelay.html#ad77d5ecdff941435a78cd8d970434363',1,'ripple::test::Consensus_test::UndoDelay::UndoDelay()'],['../structripple_1_1test_1_1Consensus__test_1_1UndoDelay.html',1,'ripple::test::Consensus_test::UndoDelay']]], ['unexcept_59',['unexcept',['../classbeast_1_1unit__test_1_1suite.html#ab110ab2b1585caaa855150af0e3c7a74',1,'beast::unit_test::suite::unexcept(F &&f, String const &reason)'],['../classbeast_1_1unit__test_1_1suite.html#ad28942f03a54b2da8204b46850d9cc03',1,'beast::unit_test::suite::unexcept(F &&f)']]], - ['unexpected_60',['unexpected',['../classripple_1_1Unexpected.html#af2f4eee2862f4eab830c32717c524527',1,'ripple::Unexpected::Unexpected()'],['../classbeast_1_1unit__test_1_1suite.html#a865757d2d9992fb2c91c51e137166e9d',1,'beast::unit_test::suite::unexpected(Condition shouldBeFalse, String const &reason)'],['../classbeast_1_1unit__test_1_1suite.html#a789edeb2afc9951e32b18362cb98f656',1,'beast::unit_test::suite::unexpected(Condition shouldBeFalse)'],['http://en.cppreference.com/w/cpp/error/unexpected.html',1,'std::unexpected()'],['../namespaceripple.html#ad6887fe0534dd3b0df2da54ff8994e2f',1,'ripple::Unexpected()'],['../classripple_1_1Unexpected.html#a8139a951450ea521bb2321a4f2417dce',1,'ripple::Unexpected::Unexpected(E const &e)'],['../classripple_1_1Unexpected.html#ae84f51e4038d4ba8c436d2aa90a33ae8',1,'ripple::Unexpected::Unexpected()=delete'],['../classripple_1_1Unexpected.html',1,'ripple::Unexpected< E >']]], + ['unexpected_60',['unexpected',['../classripple_1_1Unexpected.html#af2f4eee2862f4eab830c32717c524527',1,'ripple::Unexpected::Unexpected()'],['../classbeast_1_1unit__test_1_1suite.html#a865757d2d9992fb2c91c51e137166e9d',1,'beast::unit_test::suite::unexpected(Condition shouldBeFalse, String const &reason)'],['../classbeast_1_1unit__test_1_1suite.html#a789edeb2afc9951e32b18362cb98f656',1,'beast::unit_test::suite::unexpected(Condition shouldBeFalse)'],['../namespaceripple.html#ad6887fe0534dd3b0df2da54ff8994e2f',1,'ripple::Unexpected()'],['http://en.cppreference.com/w/cpp/error/unexpected.html',1,'std::unexpected()'],['../classripple_1_1Unexpected.html#a8139a951450ea521bb2321a4f2417dce',1,'ripple::Unexpected::Unexpected(E const &e)'],['../classripple_1_1Unexpected.html#ae84f51e4038d4ba8c436d2aa90a33ae8',1,'ripple::Unexpected::Unexpected()=delete'],['../classripple_1_1Unexpected.html',1,'ripple::Unexpected< E >']]], ['unexpected_5fhandler_61',['unexpected_handler',['http://en.cppreference.com/w/cpp/error/unexpected_handler.html',1,'std']]], ['unexpected_5ftag_62',['unexpected_tag',['../namespaceripple_1_1cryptoconditions.html#ae0bee5541ce10d52809660ad2d100a23a680460a7b6e0775b40c1af6d93f0af0a',1,'ripple::cryptoconditions']]], ['unfundedofferremovelimit_63',['unfundedOfferRemoveLimit',['../namespaceripple.html#a2ec27d00ce38a9962f60eaacbc0f0bf1',1,'ripple']]], diff --git a/search/all_1d.js b/search/all_1d.js index 08b526154a..1117be6b57 100644 --- a/search/all_1d.js +++ b/search/all_1d.js @@ -10,7 +10,7 @@ var searchData= ['valcookie_5f_7',['valCookie_',['../classripple_1_1RCLConsensus_1_1Adaptor.html#ae5dae1ff6ce46d6fa64c3d919182c99d',1,'ripple::RCLConsensus::Adaptor']]], ['valence_8',['valence',['../classripple_1_1PeerFinder_1_1Bootcache_1_1Entry.html#a0647b5e8158e4ee5c2c94795e1fd98aa',1,'ripple::PeerFinder::Bootcache::Entry::valence() const'],['../classripple_1_1PeerFinder_1_1Bootcache_1_1Entry.html#a581be978321271123284c7284fd771c3',1,'ripple::PeerFinder::Bootcache::Entry::valence()'],['../structripple_1_1PeerFinder_1_1Store_1_1Entry.html#a655fa5ae18ff218993a606634f07f3e3',1,'ripple::PeerFinder::Store::Entry::valence']]], ['valfilecontents_9',['valFileContents',['../namespaceripple_1_1detail.html#a1c5d9fb1006ebe79534ff7eb895abdbb',1,'ripple::detail']]], - ['valid_10',['valid',['../classripple_1_1test_1_1ElementComboIter.html#a2a29df8240c82cde9df104f298477759',1,'ripple::test::ElementComboIter::valid()'],['../structripple_1_1detail_1_1MultiApiJson.html#a92ff5d0e802f7a50bf23df59c13467bf',1,'ripple::detail::MultiApiJson::valid()'],['http://en.cppreference.com/w/cpp/thread/shared_future/valid.html',1,'std::shared_future::valid()'],['http://en.cppreference.com/w/cpp/thread/packaged_task/valid.html',1,'std::packaged_task::valid()'],['http://en.cppreference.com/w/cpp/thread/future/valid.html',1,'std::future::valid()'],['../structripple_1_1detail_1_1DatabasePairValid.html#a7c79b804e14484620d9f2c18633f5365',1,'ripple::detail::DatabasePairValid::valid'],['../namespaceripple_1_1credentials.html#ab0cd6a3f76fa9f09c5f1c2d6fffc11e0',1,'ripple::credentials::valid()'],['../namespaceripple.html#abcad59b0151763334cc398263373bcdda3ac705f2acd51a4613f9188c05c91d0d',1,'ripple::Valid']]], + ['valid_10',['valid',['../classripple_1_1test_1_1ElementComboIter.html#a2a29df8240c82cde9df104f298477759',1,'ripple::test::ElementComboIter::valid()'],['../structripple_1_1detail_1_1MultiApiJson.html#a92ff5d0e802f7a50bf23df59c13467bf',1,'ripple::detail::MultiApiJson::valid()'],['http://en.cppreference.com/w/cpp/thread/shared_future/valid.html',1,'std::shared_future::valid()'],['http://en.cppreference.com/w/cpp/thread/packaged_task/valid.html',1,'std::packaged_task::valid()'],['http://en.cppreference.com/w/cpp/thread/future/valid.html',1,'std::future::valid()'],['../structripple_1_1detail_1_1DatabasePairValid.html#a7c79b804e14484620d9f2c18633f5365',1,'ripple::detail::DatabasePairValid::valid'],['../namespaceripple.html#abcad59b0151763334cc398263373bcdda3ac705f2acd51a4613f9188c05c91d0d',1,'ripple::Valid'],['../namespaceripple_1_1credentials.html#ab0cd6a3f76fa9f09c5f1c2d6fffc11e0',1,'ripple::credentials::valid()']]], ['valid_5f_11',['valid_',['../classripple_1_1STValidation.html#a2b834566e12309f92d12e7f11771ad82',1,'ripple::STValidation']]], ['validamm_12',['validamm',['../classripple_1_1ValidAMM.html#a4ff96005ce67d1c76f446609e315e6ea',1,'ripple::ValidAMM::ValidAMM()'],['../classripple_1_1ValidAMM.html',1,'ripple::ValidAMM']]], ['validamounts_13',['validamounts',['../structripple_1_1Attestations_1_1AttestationClaim.html#a20c7be9549c66d4053b4cb5aaa77b772',1,'ripple::Attestations::AttestationClaim::validAmounts()'],['../structripple_1_1Attestations_1_1AttestationCreateAccount.html#a31e20b33b7f491a7f449086a26b44c95',1,'ripple::Attestations::AttestationCreateAccount::validAmounts()']]], diff --git a/search/all_d.js b/search/all_d.js index f46ffee079..fb2a8d8b54 100644 --- a/search/all_d.js +++ b/search/all_d.js @@ -390,7 +390,7 @@ var searchData= ['frac_5fdigits_387',['frac_digits',['http://en.cppreference.com/w/cpp/locale/moneypunct/frac_digits.html',1,'std::moneypunct_byname::frac_digits()'],['http://en.cppreference.com/w/cpp/locale/moneypunct/frac_digits.html',1,'std::moneypunct::frac_digits()']]], ['framework_388',['Consensus Simulation Framework',['../md_test_2csf_2README.html',1,'']]], ['fread_389',['fread',['http://en.cppreference.com/w/cpp/io/c/fread.html',1,'std']]], - ['free_390',['free',['http://en.cppreference.com/w/cpp/filesystem/space_info.html',1,'std::filesystem::space_info::free'],['http://en.cppreference.com/w/cpp/experimental/fs/space_info.html',1,'std::experimental::filesystem::space_info::free'],['http://en.cppreference.com/w/cpp/memory/c/free.html',1,'std::free()'],['../namespaceripple.html#a5d9fe757c37a7602a883d30b14e1bf3ca88c189a42c87aa49d667fc8ab76bc323',1,'ripple::FREE']]], + ['free_390',['free',['http://en.cppreference.com/w/cpp/filesystem/space_info.html',1,'std::filesystem::space_info::free'],['http://en.cppreference.com/w/cpp/experimental/fs/space_info.html',1,'std::experimental::filesystem::space_info::free'],['../namespaceripple.html#a5d9fe757c37a7602a883d30b14e1bf3ca88c189a42c87aa49d667fc8ab76bc323',1,'ripple::FREE'],['http://en.cppreference.com/w/cpp/memory/c/free.html',1,'std::free()']]], ['free_5ffd_5fthreshold_391',['FREE_FD_THRESHOLD',['../classripple_1_1Door.html#a5b1655cde11f01613b6316e7379cb53e',1,'ripple::Door']]], ['freeze_392',['freeze',['../namespaceripple_1_1test.html#acf39cc44acdd6b5089f2076897fa3911aeb479605271a1f0ffff9d87f2cab0b75',1,'ripple::test::freeze'],['http://en.cppreference.com/w/cpp/io/ostrstream/freeze.html',1,'std::ostrstream::freeze()'],['http://en.cppreference.com/w/cpp/io/strstream/freeze.html',1,'std::strstream::freeze()'],['http://en.cppreference.com/w/cpp/io/strstreambuf/freeze.html',1,'std::strstreambuf::freeze()']]], ['freeze_5ftest_393',['Freeze_test',['../classripple_1_1Freeze__test.html',1,'ripple']]], @@ -480,7 +480,7 @@ var searchData= ['function_5fname_477',['function_name',['http://en.cppreference.com/w/cpp/utility/source_location/function_name.html',1,'std::source_location::function_name()'],['http://en.cppreference.com/w/cpp/experimental/source_location/function_name.html',1,'std::experimental::source_location::function_name()']]], ['functional_478',['functional',['http://en.cppreference.com/w/cpp/header/functional.html',1,'']]], ['functiontype_479',['FunctionType',['../namespaceripple.html#ac7430b8a581c7d838130308cd016633a',1,'ripple']]], - ['fund_480',['fund',['../classripple_1_1test_1_1jtx_1_1Env.html#a9264df26c2f14a094de53a21055cdb1c',1,'ripple::test::jtx::Env::fund()'],['../namespaceripple_1_1test_1_1jtx.html#aff98aceb75526246bab03273ec360fb6',1,'ripple::test::jtx::Fund'],['../namespaceripple_1_1test_1_1jtx.html#a7465bcfa8bde2f58f93cee57934f7df8',1,'ripple::test::jtx::fund(jtx::Env &env, jtx::Account const &gw, std::vector< jtx::Account > const &accounts, std::vector< STAmount > const &amts, Fund how)'],['../namespaceripple_1_1test_1_1jtx.html#a97d903cc3d66d2e1a292d1cb3121644f',1,'ripple::test::jtx::fund(jtx::Env &env, jtx::Account const &gw, std::vector< jtx::Account > const &accounts, STAmount const &xrp, std::vector< STAmount > const &amts={}, Fund how=Fund::All)'],['../namespaceripple_1_1test_1_1jtx.html#a5699279c9df70c69fd8c99caec2761c1',1,'ripple::test::jtx::fund(jtx::Env &env, std::vector< jtx::Account > const &accounts, STAmount const &xrp, std::vector< STAmount > const &amts={}, Fund how=Fund::All)'],['../namespaceripple_1_1test_1_1jtx_1_1paychan.html#a1240fe13bcc6f33d957653b61e31122e',1,'ripple::test::jtx::paychan::fund()'],['../structripple_1_1test_1_1jtx_1_1MPTInit.html#aaeab5f952e81f45cc8f9842cc67c2b58',1,'ripple::test::jtx::MPTInit::fund'],['../structripple_1_1test_1_1jtx_1_1MPTCreate.html#aab96e394a05042b3d83739e6843d9dcd',1,'ripple::test::jtx::MPTCreate::fund'],['../structripple_1_1test_1_1SEnv.html#af615fc2c58f90c04d02a76f789559f73',1,'ripple::test::SEnv::fund()'],['../classripple_1_1test_1_1jtx_1_1Env.html#ae2349266cb09d1f1c3de06606ebdf9e2',1,'ripple::test::jtx::Env::fund(bool setDefaultRipple, STAmount const &amount, Account const &account)']]], + ['fund_480',['fund',['../classripple_1_1test_1_1jtx_1_1Env.html#a9264df26c2f14a094de53a21055cdb1c',1,'ripple::test::jtx::Env::fund()'],['../namespaceripple_1_1test_1_1jtx.html#a7465bcfa8bde2f58f93cee57934f7df8',1,'ripple::test::jtx::fund(jtx::Env &env, jtx::Account const &gw, std::vector< jtx::Account > const &accounts, std::vector< STAmount > const &amts, Fund how)'],['../namespaceripple_1_1test_1_1jtx.html#a97d903cc3d66d2e1a292d1cb3121644f',1,'ripple::test::jtx::fund(jtx::Env &env, jtx::Account const &gw, std::vector< jtx::Account > const &accounts, STAmount const &xrp, std::vector< STAmount > const &amts={}, Fund how=Fund::All)'],['../namespaceripple_1_1test_1_1jtx.html#a5699279c9df70c69fd8c99caec2761c1',1,'ripple::test::jtx::fund(jtx::Env &env, std::vector< jtx::Account > const &accounts, STAmount const &xrp, std::vector< STAmount > const &amts={}, Fund how=Fund::All)'],['../namespaceripple_1_1test_1_1jtx_1_1paychan.html#a1240fe13bcc6f33d957653b61e31122e',1,'ripple::test::jtx::paychan::fund()'],['../namespaceripple_1_1test_1_1jtx.html#aff98aceb75526246bab03273ec360fb6',1,'ripple::test::jtx::Fund'],['../structripple_1_1test_1_1jtx_1_1MPTInit.html#aaeab5f952e81f45cc8f9842cc67c2b58',1,'ripple::test::jtx::MPTInit::fund'],['../structripple_1_1test_1_1jtx_1_1MPTCreate.html#aab96e394a05042b3d83739e6843d9dcd',1,'ripple::test::jtx::MPTCreate::fund'],['../structripple_1_1test_1_1SEnv.html#af615fc2c58f90c04d02a76f789559f73',1,'ripple::test::SEnv::fund()'],['../classripple_1_1test_1_1jtx_1_1Env.html#ae2349266cb09d1f1c3de06606ebdf9e2',1,'ripple::test::jtx::Env::fund(bool setDefaultRipple, STAmount const &amount, Account const &account)']]], ['fund_5farg_481',['fund_arg',['../classripple_1_1test_1_1jtx_1_1Env.html#a01d32419e46d88ebc1a6325ca56e2902',1,'ripple::test::jtx::Env::fund_arg(STAmount const &amount, std::array< Account, N > const &list)'],['../classripple_1_1test_1_1jtx_1_1Env.html#afa7324d98ed5b298e853f7c170c06ea6',1,'ripple::test::jtx::Env::fund_arg(STAmount const &amount, Account const &account)']]], ['future_482',['future',['http://en.cppreference.com/w/cpp/experimental/future/future.html',1,'std::experimental::future::future()'],['http://en.cppreference.com/w/cpp/header/future.html',1,'(Global Namespace)'],['http://en.cppreference.com/w/cpp/thread/future/future.html',1,'std::future::future()'],['http://en.cppreference.com/w/cpp/thread/future.html',1,'std::future'],['http://en.cppreference.com/w/cpp/experimental/future.html',1,'std::experimental::future']]], ['future_5fcategory_483',['future_category',['http://en.cppreference.com/w/cpp/thread/future_category.html',1,'std']]], diff --git a/search/all_e.js b/search/all_e.js index 1770ececd2..4e8d8ed18a 100644 --- a/search/all_e.js +++ b/search/all_e.js @@ -109,7 +109,7 @@ var searchData= ['getaccountid_106',['getaccountid',['../classripple_1_1STObject.html#a0d2d874d34a1c3ed432cdb9fb1386b35',1,'ripple::STObject::getAccountID()'],['../classripple_1_1STPathElement.html#a34ec4c731897c178cebb4727f1445d8f',1,'ripple::STPathElement::getAccountID()'],['../classripple_1_1TrustLineBase.html#a88cd02cdc2ca7a31a332ff246bac3cfe',1,'ripple::TrustLineBase::getAccountID() const']]], ['getaccountidpeer_107',['getAccountIDPeer',['../classripple_1_1TrustLineBase.html#acbbabccf2e7a126365796c627977cfa7',1,'ripple::TrustLineBase']]], ['getaccountlines_108',['getaccountlines',['../namespaceripple_1_1test_1_1jtx.html#a64156c78e17d95b40ecd47efbd86975e',1,'ripple::test::jtx::getAccountLines(Env &env, AccountID const &acctId)'],['../namespaceripple_1_1test_1_1jtx.html#aaaa207462036797a6d54438e6d23242e',1,'ripple::test::jtx::getAccountLines(Env &env, Account const &acct)'],['../namespaceripple_1_1test_1_1jtx.html#a5ee40310c9627195bbc0825624de0a07',1,'ripple::test::jtx::getAccountLines(Env &env, AccountID const &acctId, IOU... ious)']]], - ['getaccountobjects_109',['getAccountObjects',['../namespaceripple_1_1RPC.html#a8357793802bdb5dc41c19160d17943c1',1,'ripple::RPC']]], + ['getaccountobjects_109',['getAccountObjects',['../namespaceripple.html#a8e341df5ee04eb3eafd7b1a16879da9c',1,'ripple']]], ['getaccountoffers_110',['getaccountoffers',['../namespaceripple_1_1test_1_1jtx.html#aff96e24753f0f457eb0ca0fbf763401c',1,'ripple::test::jtx::getAccountOffers(Env &env, AccountID const &acct, bool current)'],['../namespaceripple_1_1test_1_1jtx.html#a81f0b9b140d0f7a1b2e4ac16ca1321d0',1,'ripple::test::jtx::getAccountOffers(Env &env, Account const &acct, bool current=false)']]], ['getaccounttransactioncount_111',['getaccounttransactioncount',['../classripple_1_1SQLiteDatabaseImp.html#a6828f44ae053fc1ef628028202dc8fac',1,'ripple::SQLiteDatabaseImp::getAccountTransactionCount()'],['../classripple_1_1SQLiteDatabase.html#acb2f609a8add65fb702e840ae74c7422',1,'ripple::SQLiteDatabase::getAccountTransactionCount()']]], ['getaccounttransactionsminledgerseq_112',['getaccounttransactionsminledgerseq',['../classripple_1_1SQLiteDatabaseImp.html#a526e18b895cb05e3b11afcf873f753da',1,'ripple::SQLiteDatabaseImp::getAccountTransactionsMinLedgerSeq()'],['../classripple_1_1SQLiteDatabase.html#a5b2e1df48da2d5d853a8ed23655f5ed2',1,'ripple::SQLiteDatabase::getAccountTransactionsMinLedgerSeq()']]], diff --git a/search/functions_15.js b/search/functions_15.js index b38ed9e02d..e99a452ea8 100644 --- a/search/functions_15.js +++ b/search/functions_15.js @@ -23,7 +23,7 @@ var searchData= ['underflow_5ferror_20',['underflow_error',['http://en.cppreference.com/w/cpp/error/underflow_error.html',1,'std::underflow_error']]], ['undodelay_21',['UndoDelay',['../structripple_1_1test_1_1Consensus__test_1_1UndoDelay.html#ad77d5ecdff941435a78cd8d970434363',1,'ripple::test::Consensus_test::UndoDelay']]], ['unexcept_22',['unexcept',['../classbeast_1_1unit__test_1_1suite.html#ab110ab2b1585caaa855150af0e3c7a74',1,'beast::unit_test::suite::unexcept(F &&f, String const &reason)'],['../classbeast_1_1unit__test_1_1suite.html#ad28942f03a54b2da8204b46850d9cc03',1,'beast::unit_test::suite::unexcept(F &&f)']]], - ['unexpected_23',['unexpected',['../namespaceripple.html#ad6887fe0534dd3b0df2da54ff8994e2f',1,'ripple::Unexpected()'],['http://en.cppreference.com/w/cpp/error/unexpected.html',1,'std::unexpected()'],['../classbeast_1_1unit__test_1_1suite.html#a789edeb2afc9951e32b18362cb98f656',1,'beast::unit_test::suite::unexpected(Condition shouldBeFalse)'],['../classbeast_1_1unit__test_1_1suite.html#a865757d2d9992fb2c91c51e137166e9d',1,'beast::unit_test::suite::unexpected(Condition shouldBeFalse, String const &reason)'],['../classripple_1_1Unexpected.html#af2f4eee2862f4eab830c32717c524527',1,'ripple::Unexpected::Unexpected(E &&e)'],['../classripple_1_1Unexpected.html#a8139a951450ea521bb2321a4f2417dce',1,'ripple::Unexpected::Unexpected(E const &e)'],['../classripple_1_1Unexpected.html#ae84f51e4038d4ba8c436d2aa90a33ae8',1,'ripple::Unexpected::Unexpected()=delete']]], + ['unexpected_23',['unexpected',['http://en.cppreference.com/w/cpp/error/unexpected.html',1,'std::unexpected()'],['../namespaceripple.html#ad6887fe0534dd3b0df2da54ff8994e2f',1,'ripple::Unexpected()'],['../classbeast_1_1unit__test_1_1suite.html#a789edeb2afc9951e32b18362cb98f656',1,'beast::unit_test::suite::unexpected(Condition shouldBeFalse)'],['../classbeast_1_1unit__test_1_1suite.html#a865757d2d9992fb2c91c51e137166e9d',1,'beast::unit_test::suite::unexpected(Condition shouldBeFalse, String const &reason)'],['../classripple_1_1Unexpected.html#af2f4eee2862f4eab830c32717c524527',1,'ripple::Unexpected::Unexpected(E &&e)'],['../classripple_1_1Unexpected.html#a8139a951450ea521bb2321a4f2417dce',1,'ripple::Unexpected::Unexpected(E const &e)'],['../classripple_1_1Unexpected.html#ae84f51e4038d4ba8c436d2aa90a33ae8',1,'ripple::Unexpected::Unexpected()=delete']]], ['unget_24',['unget',['http://en.cppreference.com/w/cpp/io/basic_istream/unget.html',1,'std::wiostream::unget()'],['http://en.cppreference.com/w/cpp/io/basic_istream/unget.html',1,'std::wistream::unget()'],['http://en.cppreference.com/w/cpp/io/basic_istream/unget.html',1,'std::wistringstream::unget()'],['http://en.cppreference.com/w/cpp/io/basic_istream/unget.html',1,'std::wstringstream::unget()'],['http://en.cppreference.com/w/cpp/io/basic_istream/unget.html',1,'std::wifstream::unget()'],['http://en.cppreference.com/w/cpp/io/basic_istream/unget.html',1,'std::basic_ifstream::unget()'],['http://en.cppreference.com/w/cpp/io/basic_istream/unget.html',1,'std::istringstream::unget()'],['http://en.cppreference.com/w/cpp/io/basic_istream/unget.html',1,'std::istream::unget()'],['http://en.cppreference.com/w/cpp/io/basic_istream/unget.html',1,'std::iostream::unget()'],['http://en.cppreference.com/w/cpp/io/basic_istream/unget.html',1,'std::ifstream::unget()'],['http://en.cppreference.com/w/cpp/io/basic_istream/unget.html',1,'std::fstream::unget()'],['http://en.cppreference.com/w/cpp/io/basic_istream/unget.html',1,'std::basic_stringstream::unget()'],['http://en.cppreference.com/w/cpp/io/basic_istream/unget.html',1,'std::istrstream::unget()'],['http://en.cppreference.com/w/cpp/io/basic_istream/unget.html',1,'std::basic_istringstream::unget()'],['http://en.cppreference.com/w/cpp/io/basic_istream/unget.html',1,'std::basic_istream::unget()'],['http://en.cppreference.com/w/cpp/io/basic_istream/unget.html',1,'std::basic_iostream::unget()'],['http://en.cppreference.com/w/cpp/io/basic_istream/unget.html',1,'std::basic_fstream::unget()'],['http://en.cppreference.com/w/cpp/io/basic_istream/unget.html',1,'std::stringstream::unget()'],['http://en.cppreference.com/w/cpp/io/basic_istream/unget.html',1,'std::strstream::unget()'],['http://en.cppreference.com/w/cpp/io/basic_istream/unget.html',1,'std::wfstream::unget()']]], ['ungetc_25',['ungetc',['http://en.cppreference.com/w/cpp/io/c/ungetc.html',1,'std']]], ['ungetwc_26',['ungetwc',['http://en.cppreference.com/w/cpp/io/c/ungetwc.html',1,'std']]], diff --git a/search/functions_7.js b/search/functions_7.js index 8e84c34197..7556988bd8 100644 --- a/search/functions_7.js +++ b/search/functions_7.js @@ -83,7 +83,7 @@ var searchData= ['getaccountid_80',['getaccountid',['../classripple_1_1STObject.html#a0d2d874d34a1c3ed432cdb9fb1386b35',1,'ripple::STObject::getAccountID()'],['../classripple_1_1STPathElement.html#a34ec4c731897c178cebb4727f1445d8f',1,'ripple::STPathElement::getAccountID()'],['../classripple_1_1TrustLineBase.html#a88cd02cdc2ca7a31a332ff246bac3cfe',1,'ripple::TrustLineBase::getAccountID() const']]], ['getaccountidpeer_81',['getAccountIDPeer',['../classripple_1_1TrustLineBase.html#acbbabccf2e7a126365796c627977cfa7',1,'ripple::TrustLineBase']]], ['getaccountlines_82',['getaccountlines',['../namespaceripple_1_1test_1_1jtx.html#aaaa207462036797a6d54438e6d23242e',1,'ripple::test::jtx::getAccountLines(Env &env, Account const &acct)'],['../namespaceripple_1_1test_1_1jtx.html#a64156c78e17d95b40ecd47efbd86975e',1,'ripple::test::jtx::getAccountLines(Env &env, AccountID const &acctId)'],['../namespaceripple_1_1test_1_1jtx.html#a5ee40310c9627195bbc0825624de0a07',1,'ripple::test::jtx::getAccountLines(Env &env, AccountID const &acctId, IOU... ious)']]], - ['getaccountobjects_83',['getAccountObjects',['../namespaceripple_1_1RPC.html#a8357793802bdb5dc41c19160d17943c1',1,'ripple::RPC']]], + ['getaccountobjects_83',['getAccountObjects',['../namespaceripple.html#a8e341df5ee04eb3eafd7b1a16879da9c',1,'ripple']]], ['getaccountoffers_84',['getaccountoffers',['../namespaceripple_1_1test_1_1jtx.html#a81f0b9b140d0f7a1b2e4ac16ca1321d0',1,'ripple::test::jtx::getAccountOffers(Env &env, Account const &acct, bool current=false)'],['../namespaceripple_1_1test_1_1jtx.html#aff96e24753f0f457eb0ca0fbf763401c',1,'ripple::test::jtx::getAccountOffers(Env &env, AccountID const &acct, bool current)']]], ['getaccounttransactioncount_85',['getaccounttransactioncount',['../classripple_1_1SQLiteDatabaseImp.html#a6828f44ae053fc1ef628028202dc8fac',1,'ripple::SQLiteDatabaseImp::getAccountTransactionCount()'],['../classripple_1_1SQLiteDatabase.html#acb2f609a8add65fb702e840ae74c7422',1,'ripple::SQLiteDatabase::getAccountTransactionCount()']]], ['getaccounttransactionsminledgerseq_86',['getaccounttransactionsminledgerseq',['../classripple_1_1SQLiteDatabaseImp.html#a526e18b895cb05e3b11afcf873f753da',1,'ripple::SQLiteDatabaseImp::getAccountTransactionsMinLedgerSeq()'],['../classripple_1_1SQLiteDatabase.html#a5b2e1df48da2d5d853a8ed23655f5ed2',1,'ripple::SQLiteDatabase::getAccountTransactionsMinLedgerSeq()']]], diff --git a/search/functions_9.js b/search/functions_9.js index 6bf47d7127..b2ac9fb363 100644 --- a/search/functions_9.js +++ b/search/functions_9.js @@ -154,7 +154,7 @@ var searchData= ['iouamount_151',['iouamount',['../classripple_1_1IOUAmount.html#a9ad31953488b4fc880a9700da03e2a71',1,'ripple::IOUAmount::IOUAmount()=default'],['../classripple_1_1IOUAmount.html#af346ea69bfcc118ea700e618f32dffc3',1,'ripple::IOUAmount::IOUAmount(Number const &other)'],['../classripple_1_1IOUAmount.html#a65f7a8b13a5e1fd4ebe199d57e2c6393',1,'ripple::IOUAmount::IOUAmount(beast::Zero)'],['../classripple_1_1IOUAmount.html#a95467fc67fc518d10ae94764a967e8bd',1,'ripple::IOUAmount::IOUAmount(std::int64_t mantissa, int exponent)']]], ['ipaddressconversion_152',['IPAddressConversion',['../structbeast_1_1IPAddressConversion.html#aeeb741eceefb870c1c7ff31b894f1011',1,'beast::IPAddressConversion']]], ['ipallowed_153',['ipAllowed',['../namespaceripple.html#ae526cb7431d0104912811e64227383f8',1,'ripple']]], - ['ipe_154',['ipe',['../namespaceripple_1_1test.html#acb8d1b93cfea8a1115a2ced455a83e82',1,'ripple::test::ipe()'],['../namespaceripple_1_1test_1_1jtx.html#a992303bb9a650824e18de77a2355ac23',1,'ripple::test::jtx::IPE()']]], + ['ipe_154',['ipe',['../namespaceripple_1_1test_1_1jtx.html#a992303bb9a650824e18de77a2355ac23',1,'ripple::test::jtx::IPE()'],['../namespaceripple_1_1test.html#acb8d1b93cfea8a1115a2ced455a83e82',1,'ripple::test::ipe()']]], ['is_155',['is',['http://en.cppreference.com/w/cpp/locale/ctype/is.html',1,'std::ctype::is()'],['http://en.cppreference.com/w/cpp/locale/ctype/is.html',1,'std::ctype_byname::is()']]], ['is_5fabsolute_156',['is_absolute',['http://en.cppreference.com/w/cpp/experimental/fs/path/is_absrel.html',1,'std::experimental::filesystem::path::is_absolute()'],['http://en.cppreference.com/w/cpp/filesystem/path/is_absrel.html',1,'std::filesystem::path::is_absolute()']]], ['is_5faged_5fcontainer_157',['is_aged_container',['../structbeast_1_1is__aged__container.html#a1dbf1de88c052c23ef435cc965f1c6da',1,'beast::is_aged_container::is_aged_container()'],['../structbeast_1_1is__aged__container_3_01beast_1_1detail_1_1aged__ordered__container_3_01IsMulti_0338a9b22fe6c4be0d8f95d218bdfb0e7.html#a767d3040286475dd3879f0bfa7feae76',1,'beast::is_aged_container< beast::detail::aged_ordered_container< IsMulti, IsMap, Key, T, Clock, Compare, Allocator > >::is_aged_container()'],['../structbeast_1_1is__aged__container_3_01beast_1_1detail_1_1aged__unordered__container_3_01IsMultia80d60acae45fc077226391e490a323d.html#a2209be63bb676e9732e2e5e33c58fb3e',1,'beast::is_aged_container< beast::detail::aged_unordered_container< IsMulti, IsMap, Key, T, Clock, Hash, KeyEqual, Allocator > >::is_aged_container()']]], diff --git a/src_2test_2jtx_2amount_8h_source.html b/src_2test_2jtx_2amount_8h_source.html index 66ffb678ee..a621dd32cb 100644 --- a/src_2test_2jtx_2amount_8h_source.html +++ b/src_2test_2jtx_2amount_8h_source.html @@ -803,7 +803,7 @@ $(document).ready(function() { init_codefold(0); });
    ripple::test::jtx::XRP_t::operator~
    friend BookSpec operator~(XRP_t const &)
    Definition src/test/jtx/amount.h:286
    ripple::test::jtx::XRP_t::operator()
    None operator()(none_t) const
    Returns None-of-XRP.
    Definition src/test/jtx/amount.h:280
    ripple::test::jtx::XRP_t::operator()
    PrettyAmount operator()(double v) const
    Definition src/test/jtx/amount.h:261
    -
    ripple::test::jtx::XRP_t::operator()
    PrettyAmount operator()(T v) const
    Returns an amount of XRP as PrettyAmount, which is trivially convertable to STAmount.
    Definition src/test/jtx/amount.h:253
    +
    ripple::test::jtx::XRP_t::operator()
    PrettyAmount operator()(T v) const
    Returns an amount of XRP as PrettyAmount, which is trivially convertible to STAmount.
    Definition src/test/jtx/amount.h:253
    ripple::test::jtx::any_t
    Definition src/test/jtx/amount.h:510
    ripple::test::jtx::any_t::operator()
    AnyAmount operator()(STAmount const &sta) const
    Definition src/test/jtx/amount.h:546
    ripple::test::jtx::epsilon_t
    Definition src/test/jtx/amount.h:327
    diff --git a/structripple_1_1test_1_1jtx_1_1XRP__t.html b/structripple_1_1test_1_1jtx_1_1XRP__t.html index 932de9cbe1..7a2b9a4f98 100644 --- a/structripple_1_1test_1_1jtx_1_1XRP__t.html +++ b/structripple_1_1test_1_1jtx_1_1XRP__t.html @@ -94,7 +94,7 @@ Public Member Functions
    template<class T , class = std::enable_if_t<std::is_integral_v<T>>> PrettyAmount operator() (T v) const - Returns an amount of XRP as PrettyAmount, which is trivially convertable to STAmount.
    + Returns an amount of XRP as PrettyAmount, which is trivially convertible to STAmount.
      PrettyAmount operator() (double v) const   @@ -148,7 +148,7 @@ template<class T , class = std::enable_if_t<std::is_integral_v<T>&g
    -

    Returns an amount of XRP as PrettyAmount, which is trivially convertable to STAmount.

    +

    Returns an amount of XRP as PrettyAmount, which is trivially convertible to STAmount.

    Parameters
    diff --git a/xrpld_2rpc_2handlers_2LedgerHeader_8cpp_source.html b/xrpld_2rpc_2handlers_2LedgerHeader_8cpp_source.html index e5cd107ba2..801d7b28cf 100644 --- a/xrpld_2rpc_2handlers_2LedgerHeader_8cpp_source.html +++ b/xrpld_2rpc_2handlers_2LedgerHeader_8cpp_source.html @@ -82,7 +82,7 @@ $(document).ready(function() { init_codefold(0); });
    1#include <xrpld/app/ledger/LedgerToJson.h>
    -
    2#include <xrpld/rpc/detail/RPCHelpers.h>
    +
    2#include <xrpld/rpc/detail/RPCLedgerHelpers.h>
    3
    4#include <xrpl/basics/strHex.h>
    5#include <xrpl/ledger/ReadView.h>
    @@ -120,7 +120,7 @@ $(document).ready(function() { init_codefold(0); });
    Json::Value
    Represents a JSON value.
    Definition json_value.h:131
    ripple::Serializer::peekData
    Blob const & peekData() const
    Definition Serializer.h:183
    -
    ripple::RPC::lookupLedger
    Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
    Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
    Definition RPCHelpers.cpp:606
    +
    ripple::RPC::lookupLedger
    Status lookupLedger(std::shared_ptr< ReadView const > &ledger, JsonContext &context, Json::Value &result)
    Look up a ledger from a request and fill a Json::Result with the data representing a ledger.
    Definition RPCLedgerHelpers.cpp:305
    ripple
    Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
    Definition algorithm.h:6
    ripple::addJson
    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.
    Definition LedgerToJson.cpp:328
    ripple::strHex
    std::string strHex(FwdIt begin, FwdIt end)
    Definition strHex.h:11
    vThe number of XRP (not drops)