Compare commits

..

10 Commits

Author SHA1 Message Date
Ed Hennis
f4d297b54c Merge branch 'develop' into ximinez/fix-batchinnersigs 2025-12-05 21:12:51 -05:00
Ed Hennis
d76c69e78d Merge remote-tracking branch 'XRPLF/develop' into ximinez/fix-batchinnersigs
* XRPLF/develop:
  Implement Lending Protocol (unsupported) (5270)
2025-12-02 17:36:18 -05:00
Ed Hennis
06b4e84654 Merge branch 'develop' into ximinez/fix-batchinnersigs 2025-12-01 14:40:23 -05:00
Ed Hennis
80579dca62 Merge branch 'develop' into ximinez/fix-batchinnersigs 2025-11-28 15:46:27 -05:00
Ed Hennis
37c3133a91 Merge branch 'develop' into ximinez/fix-batchinnersigs 2025-11-27 01:48:40 -05:00
Ed Hennis
5c31b55357 Merge branch 'develop' into ximinez/fix-batchinnersigs 2025-11-26 00:24:58 -05:00
Ed Hennis
cc26829d32 Merge branch 'develop' into ximinez/fix-batchinnersigs 2025-11-25 14:54:48 -05:00
Ed Hennis
ebb05195cf Merge branch 'develop' into ximinez/fix-batchinnersigs 2025-11-24 21:48:54 -05:00
Ed Hennis
bd7a9051db Merge branch 'develop' into ximinez/fix-batchinnersigs 2025-11-24 21:30:04 -05:00
Ed Hennis
f4d55c8b77 fix: Inner batch transactions never have a valid signatures
- Introduces amendment `fixBatchInnerSigs`
2025-11-21 16:11:05 -05:00
7 changed files with 80 additions and 564 deletions

View File

@@ -16,6 +16,7 @@
// Add new amendments to the top of this list. // Add new amendments to the top of this list.
// Keep it sorted in reverse chronological order. // Keep it sorted in reverse chronological order.
XRPL_FIX (BatchInnerSigs, Supported::yes, VoteBehavior::DefaultNo)
XRPL_FEATURE(LendingProtocol, Supported::no, VoteBehavior::DefaultNo) XRPL_FEATURE(LendingProtocol, Supported::no, VoteBehavior::DefaultNo)
XRPL_FEATURE(PermissionDelegationV1_1, Supported::no, VoteBehavior::DefaultNo) XRPL_FEATURE(PermissionDelegationV1_1, Supported::no, VoteBehavior::DefaultNo)
XRPL_FIX (DirectoryLimit, Supported::yes, VoteBehavior::DefaultNo) XRPL_FIX (DirectoryLimit, Supported::yes, VoteBehavior::DefaultNo)

View File

@@ -2295,9 +2295,12 @@ class Batch_test : public beast::unit_test::suite
Serializer s; Serializer s;
parsed.object->add(s); parsed.object->add(s);
auto const jrr = env.rpc("submit", strHex(s.slice()))[jss::result]; auto const jrr = env.rpc("submit", strHex(s.slice()))[jss::result];
BEAST_EXPECT( BEAST_EXPECTS(
jrr[jss::status] == "success" && jrr[jss::status] == "error" &&
jrr[jss::engine_result] == "temINVALID_FLAG"); jrr[jss::error] == "invalidTransaction" &&
jrr[jss::error_exception] ==
"fails local checks: Empty SigningPubKey.",
to_string(jrr));
env.close(); env.close();
} }
@@ -4353,6 +4356,7 @@ public:
using namespace test::jtx; using namespace test::jtx;
auto const sa = testable_amendments(); auto const sa = testable_amendments();
testWithFeats(sa); testWithFeats(sa);
testWithFeats(sa - fixBatchInnerSigs);
} }
}; };

View File

@@ -5,8 +5,6 @@
#include <test/jtx/multisign.h> #include <test/jtx/multisign.h>
#include <test/jtx/xchain_bridge.h> #include <test/jtx/xchain_bridge.h>
#include <xrpld/app/tx/apply.h>
#include <xrpl/beast/unit_test.h> #include <xrpl/beast/unit_test.h>
#include <xrpl/json/json_value.h> #include <xrpl/json/json_value.h>
#include <xrpl/protocol/AccountID.h> #include <xrpl/protocol/AccountID.h>
@@ -2010,370 +2008,6 @@ class LedgerEntry_test : public beast::unit_test::suite
} }
} }
/// Test the ledger entry types that don't take parameters
void
testLedgerEntryFixed()
{
using namespace test::jtx;
Account const alice{"alice"};
Account const bob{"bob"};
Env env{*this, envconfig([](auto cfg) {
cfg->START_UP = Config::FRESH;
return cfg;
})};
env.close();
/** Verifies that the RPC result has the expected data
*
* @param good: Indicates that the request should have succeeded
* and returned a ledger object of `expectedType` type.
* @param jv: The RPC result Json value
* @param expectedType: The type that the ledger object should
* have if "good".
* @param expectedError: Optional. The expected error if not
* good. Defaults to "entryNotFound".
*/
auto checkResult =
[&](bool good,
Json::Value const& jv,
Json::StaticString const& expectedType,
std::optional<std::string> const& expectedError = {}) {
if (good)
{
BEAST_EXPECTS(
jv.isObject() && jv.isMember(jss::result) &&
!jv[jss::result].isMember(jss::error) &&
jv[jss::result].isMember(jss::node) &&
jv[jss::result][jss::node].isMember(
sfLedgerEntryType.jsonName) &&
jv[jss::result][jss::node]
[sfLedgerEntryType.jsonName] == expectedType,
to_string(jv));
}
else
{
BEAST_EXPECTS(
jv.isObject() && jv.isMember(jss::result) &&
jv[jss::result].isMember(jss::error) &&
!jv[jss::result].isMember(jss::node) &&
jv[jss::result][jss::error] ==
expectedError.value_or("entryNotFound"),
to_string(jv));
}
};
/** Runs a series of tests for a given fixed-position ledger
* entry.
*
* @param field: The Json request field to use.
* @param expectedType: The type that the ledger object should
* have if "good".
* @param expectedKey: The keylet of the fixed object.
* @param good: Indicates whether the object is expected to
* exist.
*/
auto test = [&](Json::StaticString const& field,
Json::StaticString const& expectedType,
Keylet const& expectedKey,
bool good) {
testcase << "ledger_entry " << expectedType.c_str()
<< (good ? "" : " not") << " found";
auto const hexKey = strHex(expectedKey.key);
// Test bad values
// "field":null
Json::Value params;
params[jss::ledger_index] = jss::validated;
params[field] = Json::nullValue;
auto jv = env.rpc("json", "ledger_entry", to_string(params));
checkResult(false, jv, expectedType, "malformedRequest");
BEAST_EXPECT(!jv[jss::result].isMember(jss::index));
// "field":"string"
params.clear();
params[jss::ledger_index] = jss::validated;
params[field] = "arbitrary string";
jv = env.rpc("json", "ledger_entry", to_string(params));
checkResult(false, jv, expectedType, "malformedRequest");
BEAST_EXPECT(!jv[jss::result].isMember(jss::index));
// "field":false
params.clear();
params[jss::ledger_index] = jss::validated;
params[field] = false;
jv = env.rpc("json", "ledger_entry", to_string(params));
checkResult(false, jv, expectedType, "invalidParams");
BEAST_EXPECT(!jv[jss::result].isMember(jss::index));
{
// "field":[incorrect index hash]
auto const badKey = strHex(expectedKey.key + uint256{1});
params.clear();
params[jss::ledger_index] = jss::validated;
params[field] = badKey;
jv = env.rpc("json", "ledger_entry", to_string(params));
checkResult(false, jv, expectedType, "entryNotFound");
BEAST_EXPECTS(
jv[jss::result][jss::index] == badKey, to_string(jv));
}
// "index":"field" using API 2
params.clear();
params[jss::ledger_index] = jss::validated;
params[jss::index] = field;
params[jss::api_version] = 2;
jv = env.rpc("json", "ledger_entry", to_string(params));
checkResult(false, jv, expectedType, "malformedRequest");
BEAST_EXPECT(!jv[jss::result].isMember(jss::index));
// Test good values
// Use the "field":true notation
params.clear();
params[jss::ledger_index] = jss::validated;
params[field] = true;
jv = env.rpc("json", "ledger_entry", to_string(params));
// Index will always be returned for valid parameters.
std::string const pdIdx = jv[jss::result][jss::index].asString();
BEAST_EXPECTS(hexKey == pdIdx, to_string(jv));
checkResult(good, jv, expectedType);
// "field":"[index hash]"
params.clear();
params[jss::ledger_index] = jss::validated;
params[field] = hexKey;
jv = env.rpc("json", "ledger_entry", to_string(params));
checkResult(good, jv, expectedType);
BEAST_EXPECT(jv[jss::result][jss::index].asString() == hexKey);
// Use the "index":"field" notation with API 3
params.clear();
params[jss::ledger_index] = jss::validated;
params[jss::index] = field;
params[jss::api_version] = 3;
jv = env.rpc("json", "ledger_entry", to_string(params));
// Index is correct either way
BEAST_EXPECT(jv[jss::result][jss::index].asString() == hexKey);
checkResult(good, jv, expectedType);
// Use the "index":"[index hash]" notation
params.clear();
params[jss::ledger_index] = jss::validated;
params[jss::index] = pdIdx;
jv = env.rpc("json", "ledger_entry", to_string(params));
// Index is correct either way
BEAST_EXPECT(jv[jss::result][jss::index].asString() == hexKey);
checkResult(good, jv, expectedType);
};
test(jss::amendments, jss::Amendments, keylet::amendments(), true);
test(jss::fee, jss::FeeSettings, keylet::fees(), true);
// There won't be an nunl
test(jss::nunl, jss::NegativeUNL, keylet::negativeUNL(), false);
// Can only get the short skip list this way
test(jss::hashes, jss::LedgerHashes, keylet::skip(), true);
}
void
testLedgerEntryHashes()
{
using namespace test::jtx;
Account const alice{"alice"};
Account const bob{"bob"};
Env env{*this, envconfig([](auto cfg) {
cfg->START_UP = Config::FRESH;
return cfg;
})};
env.close();
/** Verifies that the RPC result has the expected data
*
* @param good: Indicates that the request should have succeeded
* and returned a ledger object of `expectedType` type.
* @param jv: The RPC result Json value
* @param expectedCount: The number of Hashes expected in the
* object if "good".
* @param expectedError: Optional. The expected error if not
* good. Defaults to "entryNotFound".
*/
auto checkResult =
[&](bool good,
Json::Value const& jv,
int expectedCount,
std::optional<std::string> const& expectedError = {}) {
if (good)
{
BEAST_EXPECTS(
jv.isObject() && jv.isMember(jss::result) &&
!jv[jss::result].isMember(jss::error) &&
jv[jss::result].isMember(jss::node) &&
jv[jss::result][jss::node].isMember(
sfLedgerEntryType.jsonName) &&
jv[jss::result][jss::node]
[sfLedgerEntryType.jsonName] == jss::LedgerHashes,
to_string(jv));
BEAST_EXPECTS(
jv[jss::result].isMember(jss::node) &&
jv[jss::result][jss::node].isMember("Hashes") &&
jv[jss::result][jss::node]["Hashes"].size() ==
expectedCount,
to_string(jv[jss::result][jss::node]["Hashes"].size()));
}
else
{
BEAST_EXPECTS(
jv.isObject() && jv.isMember(jss::result) &&
jv[jss::result].isMember(jss::error) &&
!jv[jss::result].isMember(jss::node) &&
jv[jss::result][jss::error] ==
expectedError.value_or("entryNotFound"),
to_string(jv));
}
};
/** Runs a series of tests for a given ledger index.
*
* @param ledger: The ledger index value of the "hashes" request
* parameter. May not necessarily be a number.
* @param expectedKey: The expected keylet of the object.
* @param good: Indicates whether the object is expected to
* exist.
* @param expectedCount: The number of Hashes expected in the
* object if "good".
*/
auto test = [&](Json::Value ledger,
Keylet const& expectedKey,
bool good,
int expectedCount = 0) {
testcase << "ledger_entry LedgerHashes: seq: "
<< env.current()->info().seq
<< " \"hashes\":" << to_string(ledger)
<< (good ? "" : " not") << " found";
auto const hexKey = strHex(expectedKey.key);
// Test bad values
// "hashes":null
Json::Value params;
params[jss::ledger_index] = jss::validated;
params[jss::hashes] = Json::nullValue;
auto jv = env.rpc("json", "ledger_entry", to_string(params));
checkResult(false, jv, 0, "malformedRequest");
BEAST_EXPECT(!jv[jss::result].isMember(jss::index));
// "hashes":"non-uint string"
params.clear();
params[jss::ledger_index] = jss::validated;
params[jss::hashes] = "arbitrary string";
jv = env.rpc("json", "ledger_entry", to_string(params));
checkResult(false, jv, 0, "malformedRequest");
BEAST_EXPECT(!jv[jss::result].isMember(jss::index));
// "hashes":"uint string" is invalid, too
params.clear();
params[jss::ledger_index] = jss::validated;
params[jss::hashes] = "10";
jv = env.rpc("json", "ledger_entry", to_string(params));
checkResult(false, jv, 0, "malformedRequest");
BEAST_EXPECT(!jv[jss::result].isMember(jss::index));
// "hashes":false
params.clear();
params[jss::ledger_index] = jss::validated;
params[jss::hashes] = false;
jv = env.rpc("json", "ledger_entry", to_string(params));
checkResult(false, jv, 0, "invalidParams");
BEAST_EXPECT(!jv[jss::result].isMember(jss::index));
// "hashes":-1
params.clear();
params[jss::ledger_index] = jss::validated;
params[jss::hashes] = -1;
jv = env.rpc("json", "ledger_entry", to_string(params));
checkResult(false, jv, 0, "internal");
BEAST_EXPECT(!jv[jss::result].isMember(jss::index));
// "hashes":[incorrect index hash]
{
auto const badKey = strHex(expectedKey.key + uint256{1});
params.clear();
params[jss::ledger_index] = jss::validated;
params[jss::hashes] = badKey;
jv = env.rpc("json", "ledger_entry", to_string(params));
checkResult(false, jv, 0, "entryNotFound");
BEAST_EXPECT(jv[jss::result][jss::index] == badKey);
}
// Test good values
// Use the "hashes":ledger notation
params.clear();
params[jss::ledger_index] = jss::validated;
params[jss::hashes] = ledger;
jv = env.rpc("json", "ledger_entry", to_string(params));
checkResult(good, jv, expectedCount);
// Index will always be returned for valid parameters.
std::string const pdIdx = jv[jss::result][jss::index].asString();
BEAST_EXPECTS(hexKey == pdIdx, strHex(pdIdx));
// "hashes":"[index hash]"
params.clear();
params[jss::ledger_index] = jss::validated;
params[jss::hashes] = hexKey;
jv = env.rpc("json", "ledger_entry", to_string(params));
checkResult(good, jv, expectedCount);
// Index is correct either way
BEAST_EXPECTS(
hexKey == jv[jss::result][jss::index].asString(),
strHex(jv[jss::result][jss::index].asString()));
// Use the "index":"[index hash]" notation
params.clear();
params[jss::ledger_index] = jss::validated;
params[jss::index] = hexKey;
jv = env.rpc("json", "ledger_entry", to_string(params));
checkResult(good, jv, expectedCount);
// Index is correct either way
BEAST_EXPECTS(
hexKey == jv[jss::result][jss::index].asString(),
strHex(jv[jss::result][jss::index].asString()));
};
// short skip list
test(true, keylet::skip(), true, 2);
// long skip list at index 0
test(1, keylet::skip(1), false);
// long skip list at index 1
test(1 << 17, keylet::skip(1 << 17), false);
// Close more ledgers, but stop short of the flag ledger
for (auto i = env.current()->seq(); i <= 250; ++i)
env.close();
// short skip list
test(true, keylet::skip(), true, 249);
// long skip list at index 0
test(1, keylet::skip(1), false);
// long skip list at index 1
test(1 << 17, keylet::skip(1 << 17), false);
// Close a flag ledger so the first "long" skip list is created
for (auto i = env.current()->seq(); i <= 260; ++i)
env.close();
// short skip list
test(true, keylet::skip(), true, 256);
// long skip list at index 0
test(1, keylet::skip(1), true, 1);
// long skip list at index 1
test(1 << 17, keylet::skip(1 << 17), false);
}
void void
testLedgerEntryCLI() testLedgerEntryCLI()
{ {
@@ -2423,8 +2057,6 @@ public:
testOracleLedgerEntry(); testOracleLedgerEntry();
testLedgerEntryMPT(); testLedgerEntryMPT();
testLedgerEntryPermissionedDomain(); testLedgerEntryPermissionedDomain();
testLedgerEntryFixed();
testLedgerEntryHashes();
testLedgerEntryCLI(); testLedgerEntryCLI();
} }
}; };

View File

@@ -1681,7 +1681,7 @@ NetworkOPsImp::apply(std::unique_lock<std::mutex>& batchLock)
// only be set if the Batch feature is enabled. If Batch is // only be set if the Batch feature is enabled. If Batch is
// not enabled, the flag is always invalid, so don't relay // not enabled, the flag is always invalid, so don't relay
// it regardless. // it regardless.
!sttx.isFlag(tfInnerBatchTxn)) !(sttx.isFlag(tfInnerBatchTxn)))
{ {
protocol::TMTransaction tx; protocol::TMTransaction tx;
Serializer s; Serializer s;

View File

@@ -671,7 +671,10 @@ Transactor::checkSign(
auto const pkSigner = sigObject.getFieldVL(sfSigningPubKey); auto const pkSigner = sigObject.getFieldVL(sfSigningPubKey);
// Ignore signature check on batch inner transactions // Ignore signature check on batch inner transactions
if (parentBatchId && view.rules().enabled(featureBatch)) bool const useCtx = view.rules().enabled(fixBatchInnerSigs);
if ((useCtx ? parentBatchId.has_value()
: sigObject.isFlag(tfInnerBatchTxn)) &&
view.rules().enabled(featureBatch))
{ {
// Defensive Check: These values are also checked in Batch::preflight // Defensive Check: These values are also checked in Batch::preflight
if (sigObject.isFieldPresent(sfTxnSignature) || !pkSigner.empty() || if (sigObject.isFieldPresent(sfTxnSignature) || !pkSigner.empty() ||

View File

@@ -41,15 +41,22 @@ checkValidity(
Validity::SigBad, Validity::SigBad,
"Malformed: Invalid inner batch transaction."}; "Malformed: Invalid inner batch transaction."};
std::string reason; // This block should probably have never been included in the
if (!passesLocalChecks(tx, reason)) // original `Batch` implementation. An inner transaction never
// has a valid signature.
bool const neverValid = rules.enabled(fixBatchInnerSigs);
if (!neverValid)
{ {
router.setFlags(id, SF_LOCALBAD); std::string reason;
return {Validity::SigGoodOnly, reason}; if (!passesLocalChecks(tx, reason))
} {
router.setFlags(id, SF_LOCALBAD);
return {Validity::SigGoodOnly, reason};
}
router.setFlags(id, SF_SIGGOOD); router.setFlags(id, SF_SIGGOOD);
return {Validity::Valid, ""}; return {Validity::Valid, ""};
}
} }
if (any(flags & SF_SIGBAD)) if (any(flags & SF_SIGBAD))

View File

@@ -18,32 +18,6 @@
namespace ripple { namespace ripple {
using FunctionType = std::function<Expected<uint256, Json::Value>(
Json::Value const&,
Json::StaticString const,
unsigned apiVersion)>;
static Expected<uint256, Json::Value>
parseFixed(
Keylet const& keylet,
Json::Value const& params,
Json::StaticString const& fieldName,
unsigned apiVersion);
// Helper function to return FunctionType for objects that have a fixed
// location. That is, they don't take parameters to compute the index.
// e.g. amendments, fees, negative UNL, etc.
static FunctionType
fixed(Keylet const& keylet)
{
return [&keylet](
Json::Value const& params,
Json::StaticString const fieldName,
unsigned apiVersion) -> Expected<uint256, Json::Value> {
return parseFixed(keylet, params, fieldName, apiVersion);
};
}
static Expected<uint256, Json::Value> static Expected<uint256, Json::Value>
parseObjectID( parseObjectID(
Json::Value const& params, Json::Value const& params,
@@ -59,33 +33,13 @@ parseObjectID(
} }
static Expected<uint256, Json::Value> static Expected<uint256, Json::Value>
parseIndex( parseIndex(Json::Value const& params, Json::StaticString const fieldName)
Json::Value const& params,
Json::StaticString const fieldName,
unsigned apiVersion)
{ {
if (apiVersion > 2u && params.isString())
{
std::string const index = params.asString();
if (index == jss::amendments.c_str())
return keylet::amendments().key;
if (index == jss::fee.c_str())
return keylet::fees().key;
if (index == jss::nunl)
return keylet::negativeUNL().key;
if (index == jss::hashes)
// Note this only finds the "short" skip list. Use "hashes":index to
// get the long list.
return keylet::skip().key;
}
return parseObjectID(params, fieldName, "hex string"); return parseObjectID(params, fieldName, "hex string");
} }
static Expected<uint256, Json::Value> static Expected<uint256, Json::Value>
parseAccountRoot( parseAccountRoot(Json::Value const& params, Json::StaticString const fieldName)
Json::Value const& params,
Json::StaticString const fieldName,
unsigned apiVersion)
{ {
if (auto const account = LedgerEntryHelpers::parse<AccountID>(params)) if (auto const account = LedgerEntryHelpers::parse<AccountID>(params))
{ {
@@ -96,13 +50,14 @@ parseAccountRoot(
"malformedAddress", fieldName, "AccountID"); "malformedAddress", fieldName, "AccountID");
} }
auto const parseAmendments = fixed(keylet::amendments()); static Expected<uint256, Json::Value>
parseAmendments(Json::Value const& params, Json::StaticString const fieldName)
{
return parseObjectID(params, fieldName, "hex string");
}
static Expected<uint256, Json::Value> static Expected<uint256, Json::Value>
parseAMM( parseAMM(Json::Value const& params, Json::StaticString const fieldName)
Json::Value const& params,
Json::StaticString const fieldName,
unsigned apiVersion)
{ {
if (!params.isObject()) if (!params.isObject())
{ {
@@ -129,10 +84,7 @@ parseAMM(
} }
static Expected<uint256, Json::Value> static Expected<uint256, Json::Value>
parseBridge( parseBridge(Json::Value const& params, Json::StaticString const fieldName)
Json::Value const& params,
Json::StaticString const fieldName,
unsigned apiVersion)
{ {
if (!params.isMember(jss::bridge)) if (!params.isMember(jss::bridge))
{ {
@@ -163,19 +115,13 @@ parseBridge(
} }
static Expected<uint256, Json::Value> static Expected<uint256, Json::Value>
parseCheck( parseCheck(Json::Value const& params, Json::StaticString const fieldName)
Json::Value const& params,
Json::StaticString const fieldName,
unsigned apiVersion)
{ {
return parseObjectID(params, fieldName, "hex string"); return parseObjectID(params, fieldName, "hex string");
} }
static Expected<uint256, Json::Value> static Expected<uint256, Json::Value>
parseCredential( parseCredential(Json::Value const& cred, Json::StaticString const fieldName)
Json::Value const& cred,
Json::StaticString const fieldName,
unsigned apiVersion)
{ {
if (!cred.isObject()) if (!cred.isObject())
{ {
@@ -206,10 +152,7 @@ parseCredential(
} }
static Expected<uint256, Json::Value> static Expected<uint256, Json::Value>
parseDelegate( parseDelegate(Json::Value const& params, Json::StaticString const fieldName)
Json::Value const& params,
Json::StaticString const fieldName,
unsigned apiVersion)
{ {
if (!params.isObject()) if (!params.isObject())
{ {
@@ -300,10 +243,7 @@ parseAuthorizeCredentials(Json::Value const& jv)
} }
static Expected<uint256, Json::Value> static Expected<uint256, Json::Value>
parseDepositPreauth( parseDepositPreauth(Json::Value const& dp, Json::StaticString const fieldName)
Json::Value const& dp,
Json::StaticString const fieldName,
unsigned apiVersion)
{ {
if (!dp.isObject()) if (!dp.isObject())
{ {
@@ -356,10 +296,7 @@ parseDepositPreauth(
} }
static Expected<uint256, Json::Value> static Expected<uint256, Json::Value>
parseDID( parseDID(Json::Value const& params, Json::StaticString const fieldName)
Json::Value const& params,
Json::StaticString const fieldName,
unsigned apiVersion)
{ {
auto const account = LedgerEntryHelpers::parse<AccountID>(params); auto const account = LedgerEntryHelpers::parse<AccountID>(params);
if (!account) if (!account)
@@ -374,8 +311,7 @@ parseDID(
static Expected<uint256, Json::Value> static Expected<uint256, Json::Value>
parseDirectoryNode( parseDirectoryNode(
Json::Value const& params, Json::Value const& params,
Json::StaticString const fieldName, Json::StaticString const fieldName)
unsigned apiVersion)
{ {
if (!params.isObject()) if (!params.isObject())
{ {
@@ -428,10 +364,7 @@ parseDirectoryNode(
} }
static Expected<uint256, Json::Value> static Expected<uint256, Json::Value>
parseEscrow( parseEscrow(Json::Value const& params, Json::StaticString const fieldName)
Json::Value const& params,
Json::StaticString const fieldName,
unsigned apiVersion)
{ {
if (!params.isObject()) if (!params.isObject())
{ {
@@ -450,53 +383,20 @@ parseEscrow(
return keylet::escrow(*id, *seq).key; return keylet::escrow(*id, *seq).key;
} }
auto const parseFeeSettings = fixed(keylet::fees());
static Expected<uint256, Json::Value> static Expected<uint256, Json::Value>
parseFixed( parseFeeSettings(Json::Value const& params, Json::StaticString const fieldName)
Keylet const& keylet,
Json::Value const& params,
Json::StaticString const& fieldName,
unsigned apiVersion)
{ {
if (!params.isBool()) return parseObjectID(params, fieldName, "hex string");
{
return parseObjectID(params, fieldName, "hex string");
}
if (!params.asBool())
{
return LedgerEntryHelpers::invalidFieldError(
"invalidParams", fieldName, "true");
}
return keylet.key;
} }
static Expected<uint256, Json::Value> static Expected<uint256, Json::Value>
parseLedgerHashes( parseLedgerHashes(Json::Value const& params, Json::StaticString const fieldName)
Json::Value const& params,
Json::StaticString const fieldName,
unsigned apiVersion)
{ {
if (params.isUInt() || params.isInt()) return parseObjectID(params, fieldName, "hex string");
{
// If the index doesn't parse as a UInt, throw
auto const index = params.asUInt();
// Return the "long" skip list for the given ledger index.
auto const keylet = keylet::skip(index);
return keylet.key;
}
// Return the key in `params` or the "short" skip list, which contains
// hashes since the last flag ledger.
return parseFixed(keylet::skip(), params, fieldName, apiVersion);
} }
static Expected<uint256, Json::Value> static Expected<uint256, Json::Value>
parseLoanBroker( parseLoanBroker(Json::Value const& params, Json::StaticString const fieldName)
Json::Value const& params,
Json::StaticString const fieldName,
unsigned apiVersion)
{ {
if (!params.isObject()) if (!params.isObject())
{ {
@@ -516,10 +416,7 @@ parseLoanBroker(
} }
static Expected<uint256, Json::Value> static Expected<uint256, Json::Value>
parseLoan( parseLoan(Json::Value const& params, Json::StaticString const fieldName)
Json::Value const& params,
Json::StaticString const fieldName,
unsigned apiVersion)
{ {
if (!params.isObject()) if (!params.isObject())
{ {
@@ -539,10 +436,7 @@ parseLoan(
} }
static Expected<uint256, Json::Value> static Expected<uint256, Json::Value>
parseMPToken( parseMPToken(Json::Value const& params, Json::StaticString const fieldName)
Json::Value const& params,
Json::StaticString const fieldName,
unsigned apiVersion)
{ {
if (!params.isObject()) if (!params.isObject())
{ {
@@ -565,8 +459,7 @@ parseMPToken(
static Expected<uint256, Json::Value> static Expected<uint256, Json::Value>
parseMPTokenIssuance( parseMPTokenIssuance(
Json::Value const& params, Json::Value const& params,
Json::StaticString const fieldName, Json::StaticString const fieldName)
unsigned apiVersion)
{ {
auto const mptIssuanceID = LedgerEntryHelpers::parse<uint192>(params); auto const mptIssuanceID = LedgerEntryHelpers::parse<uint192>(params);
if (!mptIssuanceID) if (!mptIssuanceID)
@@ -577,30 +470,25 @@ parseMPTokenIssuance(
} }
static Expected<uint256, Json::Value> static Expected<uint256, Json::Value>
parseNFTokenOffer( parseNFTokenOffer(Json::Value const& params, Json::StaticString const fieldName)
Json::Value const& params,
Json::StaticString const fieldName,
unsigned apiVersion)
{ {
return parseObjectID(params, fieldName, "hex string"); return parseObjectID(params, fieldName, "hex string");
} }
static Expected<uint256, Json::Value> static Expected<uint256, Json::Value>
parseNFTokenPage( parseNFTokenPage(Json::Value const& params, Json::StaticString const fieldName)
Json::Value const& params,
Json::StaticString const fieldName,
unsigned apiVersion)
{ {
return parseObjectID(params, fieldName, "hex string"); return parseObjectID(params, fieldName, "hex string");
} }
auto const parseNegativeUNL = fixed(keylet::negativeUNL()); static Expected<uint256, Json::Value>
parseNegativeUNL(Json::Value const& params, Json::StaticString const fieldName)
{
return parseObjectID(params, fieldName, "hex string");
}
static Expected<uint256, Json::Value> static Expected<uint256, Json::Value>
parseOffer( parseOffer(Json::Value const& params, Json::StaticString const fieldName)
Json::Value const& params,
Json::StaticString const fieldName,
unsigned apiVersion)
{ {
if (!params.isObject()) if (!params.isObject())
{ {
@@ -621,10 +509,7 @@ parseOffer(
} }
static Expected<uint256, Json::Value> static Expected<uint256, Json::Value>
parseOracle( parseOracle(Json::Value const& params, Json::StaticString const fieldName)
Json::Value const& params,
Json::StaticString const fieldName,
unsigned apiVersion)
{ {
if (!params.isObject()) if (!params.isObject())
{ {
@@ -645,10 +530,7 @@ parseOracle(
} }
static Expected<uint256, Json::Value> static Expected<uint256, Json::Value>
parsePayChannel( parsePayChannel(Json::Value const& params, Json::StaticString const fieldName)
Json::Value const& params,
Json::StaticString const fieldName,
unsigned apiVersion)
{ {
return parseObjectID(params, fieldName, "hex string"); return parseObjectID(params, fieldName, "hex string");
} }
@@ -656,8 +538,7 @@ parsePayChannel(
static Expected<uint256, Json::Value> static Expected<uint256, Json::Value>
parsePermissionedDomain( parsePermissionedDomain(
Json::Value const& pd, Json::Value const& pd,
Json::StaticString const fieldName, Json::StaticString const fieldName)
unsigned apiVersion)
{ {
if (pd.isString()) if (pd.isString())
{ {
@@ -686,8 +567,7 @@ parsePermissionedDomain(
static Expected<uint256, Json::Value> static Expected<uint256, Json::Value>
parseRippleState( parseRippleState(
Json::Value const& jvRippleState, Json::Value const& jvRippleState,
Json::StaticString const fieldName, Json::StaticString const fieldName)
unsigned apiVersion)
{ {
Currency uCurrency; Currency uCurrency;
@@ -737,19 +617,13 @@ parseRippleState(
} }
static Expected<uint256, Json::Value> static Expected<uint256, Json::Value>
parseSignerList( parseSignerList(Json::Value const& params, Json::StaticString const fieldName)
Json::Value const& params,
Json::StaticString const fieldName,
unsigned apiVersion)
{ {
return parseObjectID(params, fieldName, "hex string"); return parseObjectID(params, fieldName, "hex string");
} }
static Expected<uint256, Json::Value> static Expected<uint256, Json::Value>
parseTicket( parseTicket(Json::Value const& params, Json::StaticString const fieldName)
Json::Value const& params,
Json::StaticString const fieldName,
unsigned apiVersion)
{ {
if (!params.isObject()) if (!params.isObject())
{ {
@@ -770,10 +644,7 @@ parseTicket(
} }
static Expected<uint256, Json::Value> static Expected<uint256, Json::Value>
parseVault( parseVault(Json::Value const& params, Json::StaticString const fieldName)
Json::Value const& params,
Json::StaticString const fieldName,
unsigned apiVersion)
{ {
if (!params.isObject()) if (!params.isObject())
{ {
@@ -796,8 +667,7 @@ parseVault(
static Expected<uint256, Json::Value> static Expected<uint256, Json::Value>
parseXChainOwnedClaimID( parseXChainOwnedClaimID(
Json::Value const& claim_id, Json::Value const& claim_id,
Json::StaticString const fieldName, Json::StaticString const fieldName)
unsigned apiVersion)
{ {
if (!claim_id.isObject()) if (!claim_id.isObject())
{ {
@@ -822,8 +692,7 @@ parseXChainOwnedClaimID(
static Expected<uint256, Json::Value> static Expected<uint256, Json::Value>
parseXChainOwnedCreateAccountClaimID( parseXChainOwnedCreateAccountClaimID(
Json::Value const& claim_id, Json::Value const& claim_id,
Json::StaticString const fieldName, Json::StaticString const fieldName)
unsigned apiVersion)
{ {
if (!claim_id.isObject()) if (!claim_id.isObject())
{ {
@@ -847,6 +716,10 @@ parseXChainOwnedCreateAccountClaimID(
return keylet.key; return keylet.key;
} }
using FunctionType = Expected<uint256, Json::Value> (*)(
Json::Value const&,
Json::StaticString const);
struct LedgerEntry struct LedgerEntry
{ {
Json::StaticString fieldName; Json::StaticString fieldName;
@@ -879,7 +752,7 @@ doLedgerEntry(RPC::JsonContext& context)
{jss::ripple_state, parseRippleState, ltRIPPLE_STATE}, {jss::ripple_state, parseRippleState, ltRIPPLE_STATE},
}); });
auto const hasMoreThanOneMember = [&]() { auto hasMoreThanOneMember = [&]() {
int count = 0; int count = 0;
for (auto const& ledgerEntry : ledgerEntryParsers) for (auto const& ledgerEntry : ledgerEntryParsers)
@@ -923,8 +796,8 @@ doLedgerEntry(RPC::JsonContext& context)
Json::Value const& params = ledgerEntry.fieldName == jss::bridge Json::Value const& params = ledgerEntry.fieldName == jss::bridge
? context.params ? context.params
: context.params[ledgerEntry.fieldName]; : context.params[ledgerEntry.fieldName];
auto const result = ledgerEntry.parseFunction( auto const result =
params, ledgerEntry.fieldName, context.apiVersion); ledgerEntry.parseFunction(params, ledgerEntry.fieldName);
if (!result) if (!result)
return result.error(); return result.error();
@@ -955,13 +828,9 @@ doLedgerEntry(RPC::JsonContext& context)
throw; throw;
} }
// Return the computed index regardless of whether the node exists.
jvResult[jss::index] = to_string(uNodeIndex);
if (uNodeIndex.isZero()) if (uNodeIndex.isZero())
{ {
RPC::inject_error(rpcENTRY_NOT_FOUND, jvResult); return RPC::make_error(rpcENTRY_NOT_FOUND);
return jvResult;
} }
auto const sleNode = lpLedger->read(keylet::unchecked(uNodeIndex)); auto const sleNode = lpLedger->read(keylet::unchecked(uNodeIndex));
@@ -973,14 +842,12 @@ doLedgerEntry(RPC::JsonContext& context)
if (!sleNode) if (!sleNode)
{ {
// Not found. // Not found.
RPC::inject_error(rpcENTRY_NOT_FOUND, jvResult); return RPC::make_error(rpcENTRY_NOT_FOUND);
return jvResult;
} }
if ((expectedType != ltANY) && (expectedType != sleNode->getType())) if ((expectedType != ltANY) && (expectedType != sleNode->getType()))
{ {
RPC::inject_error(rpcUNEXPECTED_LEDGER_TYPE, jvResult); return RPC::make_error(rpcUNEXPECTED_LEDGER_TYPE);
return jvResult;
} }
if (bNodeBinary) if (bNodeBinary)
@@ -990,10 +857,12 @@ doLedgerEntry(RPC::JsonContext& context)
sleNode->add(s); sleNode->add(s);
jvResult[jss::node_binary] = strHex(s.peekData()); jvResult[jss::node_binary] = strHex(s.peekData());
jvResult[jss::index] = to_string(uNodeIndex);
} }
else else
{ {
jvResult[jss::node] = sleNode->getJson(JsonOptions::none); jvResult[jss::node] = sleNode->getJson(JsonOptions::none);
jvResult[jss::index] = to_string(uNodeIndex);
} }
return jvResult; return jvResult;