mirror of
https://github.com/XRPLF/rippled.git
synced 2025-12-06 17:27:55 +00:00
b6391fe011
Update book_changes RPC to reduce latency, add "validated" field, and accept shortcut strings (current, closed, validated) for ledger_index. `"validated": true` indicates that the transaction has been included in a validated ledger so the result of the transaction is immutable. Fix #5033 Fix #5034 Fix #5035 Fix #5036 --------- Co-authored-by: Bronek Kozicki <brok@incorrekt.com>
101 lines
4.0 KiB
C++
101 lines
4.0 KiB
C++
//------------------------------------------------------------------------------
|
|
/*
|
|
This file is part of rippled: https://github.com/ripple/rippled
|
|
Copyright (c) 2024 Ripple Labs Inc.
|
|
|
|
Permission to use, copy, modify, and/or distribute this software for any
|
|
purpose with or without fee is hereby granted, provided that the above
|
|
copyright notice and this permission notice appear in all copies.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
*/
|
|
//==============================================================================
|
|
|
|
#include <test/jtx.h>
|
|
|
|
namespace ripple {
|
|
namespace test {
|
|
|
|
class BookChanges_test : public beast::unit_test::suite
|
|
{
|
|
public:
|
|
void
|
|
testConventionalLedgerInputStrings()
|
|
{
|
|
testcase("Specify well-known strings as ledger input");
|
|
jtx::Env env(*this);
|
|
Json::Value params, resp;
|
|
|
|
// As per convention in XRPL, ledgers can be specified with strings
|
|
// "closed", "validated" or "current"
|
|
params["ledger"] = "validated";
|
|
resp = env.rpc("json", "book_changes", to_string(params));
|
|
BEAST_EXPECT(!resp[jss::result].isMember(jss::error));
|
|
BEAST_EXPECT(resp[jss::result][jss::status] == "success");
|
|
BEAST_EXPECT(resp[jss::result][jss::validated] == true);
|
|
|
|
params["ledger"] = "current";
|
|
resp = env.rpc("json", "book_changes", to_string(params));
|
|
BEAST_EXPECT(!resp[jss::result].isMember(jss::error));
|
|
BEAST_EXPECT(resp[jss::result][jss::status] == "success");
|
|
BEAST_EXPECT(resp[jss::result][jss::validated] == false);
|
|
|
|
params["ledger"] = "closed";
|
|
resp = env.rpc("json", "book_changes", to_string(params));
|
|
BEAST_EXPECT(!resp[jss::result].isMember(jss::error));
|
|
BEAST_EXPECT(resp[jss::result][jss::status] == "success");
|
|
|
|
// In the unit-test framework, requesting for "closed" ledgers appears
|
|
// to yield "validated" ledgers. This is not new behavior. It is also
|
|
// observed in the unit tests for the LedgerHeader class.
|
|
BEAST_EXPECT(resp[jss::result][jss::validated] == true);
|
|
|
|
// non-conventional ledger input should throw an error
|
|
params["ledger"] = "non_conventional_ledger_input";
|
|
resp = env.rpc("json", "book_changes", to_string(params));
|
|
BEAST_EXPECT(resp[jss::result].isMember(jss::error));
|
|
BEAST_EXPECT(resp[jss::result][jss::status] != "success");
|
|
}
|
|
|
|
void
|
|
testLedgerInputDefaultBehavior()
|
|
{
|
|
testcase(
|
|
"If ledger_hash or ledger_index is not specified, the behavior "
|
|
"must default to the `current` ledger");
|
|
jtx::Env env(*this);
|
|
|
|
// As per convention in XRPL, ledgers can be specified with strings
|
|
// "closed", "validated" or "current"
|
|
Json::Value const resp =
|
|
env.rpc("json", "book_changes", to_string(Json::Value{}));
|
|
BEAST_EXPECT(!resp[jss::result].isMember(jss::error));
|
|
BEAST_EXPECT(resp[jss::result][jss::status] == "success");
|
|
|
|
// I dislike asserting the below statement, because its dependent on the
|
|
// unit-test framework BEAST_EXPECT(resp[jss::result][jss::ledger_index]
|
|
// == 3);
|
|
}
|
|
|
|
void
|
|
run() override
|
|
{
|
|
testConventionalLedgerInputStrings();
|
|
testLedgerInputDefaultBehavior();
|
|
|
|
// Note: Other aspects of the book_changes rpc are fertile grounds for
|
|
// unit-testing purposes. It can be included in future work
|
|
}
|
|
};
|
|
|
|
BEAST_DEFINE_TESTSUITE(BookChanges, app, ripple);
|
|
|
|
} // namespace test
|
|
} // namespace ripple
|