//------------------------------------------------------------------------------ /* This file is part of clio: https://github.com/XRPLF/clio Copyright (c) 2023, the clio developers. Permission to use, copy, modify, and 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 "data/Types.hpp" #include "rpc/Errors.hpp" #include "rpc/common/AnyHandler.hpp" #include "rpc/common/Types.hpp" #include "rpc/handlers/GatewayBalances.hpp" #include "util/HandlerBaseTestFixture.hpp" #include "util/NameGenerator.hpp" #include "util/TestObject.hpp" #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include using namespace rpc; namespace json = boost::json; using namespace testing; namespace { constexpr auto ACCOUNT = "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn"; constexpr auto ACCOUNT2 = "rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun"; constexpr auto ACCOUNT3 = "raHGBERMka3KZsfpTQUAtumxmvpqhFLyrk"; constexpr auto ISSUER = "rK9DrarGKnVEo2nYp5MfVRXRYf5yRX3mwD"; constexpr auto LEDGERHASH = "4BC50C9B0D8515D3EAAE1E74B29A95804346C491EE1A95BF25E4AAB854A6A652"; constexpr auto INDEX1 = "1B8590C01B0006EDFA9ED60296DD052DC5E90F99659B25014D08E1BC983515BC"; constexpr auto INDEX2 = "E6DBAFC99223B42257915A63DFC6B0C032D4070F9A574B255AD97466726FC321"; constexpr auto TXNID = "E3FE6EA3D48F0C2B639448020EA4F03D4F4F8FFDB243A852A0F59177921B4879"; struct ParameterTestBundle { std::string testName; std::string testJson; std::string expectedError; std::string expectedErrorMessage; std::uint32_t apiVersion = 1u; }; } // namespace struct RPCGatewayBalancesHandlerTest : HandlerBaseTest { RPCGatewayBalancesHandlerTest() { backend->setRange(10, 300); } }; struct ParameterTest : public RPCGatewayBalancesHandlerTest, public WithParamInterface {}; TEST_P(ParameterTest, CheckError) { auto bundle = GetParam(); auto const handler = AnyHandler{GatewayBalancesHandler{backend}}; runSpawn([&](auto yield) { auto const output = handler.process(json::parse(bundle.testJson), Context{.yield = yield, .apiVersion = bundle.apiVersion}); ASSERT_FALSE(output); auto const err = rpc::makeError(output.result.error()); EXPECT_EQ(err.at("error").as_string(), bundle.expectedError); EXPECT_EQ(err.at("error_message").as_string(), bundle.expectedErrorMessage); }); } auto generateParameterTestBundles() { return std::vector{ ParameterTestBundle{ "AccountNotString", R"({ "account": 1213 })", "invalidParams", "accountNotString" }, ParameterTestBundle{ "AccountMissing", R"({ })", "invalidParams", "Required field 'account' missing" }, ParameterTestBundle{ "AccountInvalid", R"({ "account": "1213" })", "actMalformed", "accountMalformed" }, ParameterTestBundle{ "LedgerIndexInvalid", fmt::format( R"({{ "account": "{}", "ledger_index": "meh" }})", ACCOUNT ), "invalidParams", "ledgerIndexMalformed" }, ParameterTestBundle{ "LedgerHashInvalid", fmt::format( R"({{ "account": "{}", "ledger_hash": "meh" }})", ACCOUNT ), "invalidParams", "ledger_hashMalformed" }, ParameterTestBundle{ "LedgerHashNotString", fmt::format( R"({{ "account": "{}", "ledger_hash": 12 }})", ACCOUNT ), "invalidParams", "ledger_hashNotString" }, ParameterTestBundle{ .testName = "WalletsNotStringOrArrayV1", .testJson = fmt::format( R"({{ "account": "{}", "hotwallet": 12 }})", ACCOUNT ), .expectedError = "invalidHotWallet", .expectedErrorMessage = "hotwalletNotStringOrArray" }, ParameterTestBundle{ .testName = "WalletsNotStringAccountV1", .testJson = fmt::format( R"({{ "account": "{}", "hotwallet": [12] }})", ACCOUNT ), .expectedError = "invalidHotWallet", .expectedErrorMessage = "hotwalletMalformed" }, ParameterTestBundle{ .testName = "WalletsInvalidAccountV1", .testJson = fmt::format( R"({{ "account": "{}", "hotwallet": ["12"] }})", ACCOUNT ), .expectedError = "invalidHotWallet", .expectedErrorMessage = "hotwalletMalformed" }, ParameterTestBundle{ .testName = "WalletInvalidAccountV1", .testJson = fmt::format( R"({{ "account": "{}", "hotwallet": "12" }})", ACCOUNT ), .expectedError = "invalidHotWallet", .expectedErrorMessage = "hotwalletMalformed" }, ParameterTestBundle{ .testName = "WalletsNotStringOrArrayV2", .testJson = fmt::format( R"({{ "account": "{}", "hotwallet": 12 }})", ACCOUNT ), .expectedError = "invalidParams", .expectedErrorMessage = "hotwalletNotStringOrArray", .apiVersion = 2u }, ParameterTestBundle{ .testName = "WalletsNotStringAccountV2", .testJson = fmt::format( R"({{ "account": "{}", "hotwallet": [12] }})", ACCOUNT ), .expectedError = "invalidParams", .expectedErrorMessage = "hotwalletMalformed", .apiVersion = 2u }, ParameterTestBundle{ .testName = "WalletsInvalidAccountV2", .testJson = fmt::format( R"({{ "account": "{}", "hotwallet": ["12"] }})", ACCOUNT ), .expectedError = "invalidParams", .expectedErrorMessage = "hotwalletMalformed", .apiVersion = 2u }, ParameterTestBundle{ .testName = "WalletInvalidAccountV2", .testJson = fmt::format( R"({{ "account": "{}", "hotwallet": "12" }})", ACCOUNT ), .expectedError = "invalidParams", .expectedErrorMessage = "hotwalletMalformed", .apiVersion = 2u }, }; } INSTANTIATE_TEST_SUITE_P( RPCGatewayBalancesHandler, ParameterTest, testing::ValuesIn(generateParameterTestBundles()), tests::util::NameGenerator ); TEST_F(RPCGatewayBalancesHandlerTest, LedgerNotFoundViaStringIndex) { auto const seq = 123; EXPECT_CALL(*backend, fetchLedgerBySequence).Times(1); // return empty ledgerHeader ON_CALL(*backend, fetchLedgerBySequence(seq, _)).WillByDefault(Return(std::optional{})); auto const handler = AnyHandler{GatewayBalancesHandler{backend}}; runSpawn([&](auto yield) { auto const output = handler.process( json::parse(fmt::format( R"({{ "account": "{}", "ledger_index": "{}" }})", ACCOUNT, seq )), Context{yield} ); ASSERT_FALSE(output); auto const err = rpc::makeError(output.result.error()); EXPECT_EQ(err.at("error").as_string(), "lgrNotFound"); EXPECT_EQ(err.at("error_message").as_string(), "ledgerNotFound"); }); } TEST_F(RPCGatewayBalancesHandlerTest, LedgerNotFoundViaIntIndex) { auto const seq = 123; EXPECT_CALL(*backend, fetchLedgerBySequence).Times(1); // return empty ledgerHeader ON_CALL(*backend, fetchLedgerBySequence(seq, _)).WillByDefault(Return(std::optional{})); auto const handler = AnyHandler{GatewayBalancesHandler{backend}}; runSpawn([&](auto yield) { auto const output = handler.process( json::parse(fmt::format( R"({{ "account": "{}", "ledger_index": {} }})", ACCOUNT, seq )), Context{yield} ); ASSERT_FALSE(output); auto const err = rpc::makeError(output.result.error()); EXPECT_EQ(err.at("error").as_string(), "lgrNotFound"); EXPECT_EQ(err.at("error_message").as_string(), "ledgerNotFound"); }); } TEST_F(RPCGatewayBalancesHandlerTest, LedgerNotFoundViaHash) { EXPECT_CALL(*backend, fetchLedgerByHash).Times(1); // return empty ledgerHeader ON_CALL(*backend, fetchLedgerByHash(ripple::uint256{LEDGERHASH}, _)) .WillByDefault(Return(std::optional{})); auto const handler = AnyHandler{GatewayBalancesHandler{backend}}; runSpawn([&](auto yield) { auto const output = handler.process( json::parse(fmt::format( R"({{ "account": "{}", "ledger_hash": "{}" }})", ACCOUNT, LEDGERHASH )), Context{yield} ); ASSERT_FALSE(output); auto const err = rpc::makeError(output.result.error()); EXPECT_EQ(err.at("error").as_string(), "lgrNotFound"); EXPECT_EQ(err.at("error_message").as_string(), "ledgerNotFound"); }); } TEST_F(RPCGatewayBalancesHandlerTest, AccountNotFound) { auto const seq = 300; EXPECT_CALL(*backend, fetchLedgerBySequence).Times(1); // return valid ledgerHeader auto const ledgerHeader = CreateLedgerHeader(LEDGERHASH, seq); ON_CALL(*backend, fetchLedgerBySequence(seq, _)).WillByDefault(Return(ledgerHeader)); // return empty account auto const accountKk = ripple::keylet::account(GetAccountIDWithString(ACCOUNT)).key; ON_CALL(*backend, doFetchLedgerObject(accountKk, seq, _)).WillByDefault(Return(std::optional{})); EXPECT_CALL(*backend, doFetchLedgerObject).Times(1); auto const handler = AnyHandler{GatewayBalancesHandler{backend}}; runSpawn([&](auto yield) { auto const output = handler.process( json::parse(fmt::format( R"({{ "account": "{}" }})", ACCOUNT )), Context{yield} ); ASSERT_FALSE(output); auto const err = rpc::makeError(output.result.error()); EXPECT_EQ(err.at("error").as_string(), "actNotFound"); EXPECT_EQ(err.at("error_message").as_string(), "accountNotFound"); }); } struct NormalTestBundle { std::string testName; ripple::STObject mockedDir; std::vector mockedObjects; std::string expectedJson; std::string hotwallet; }; struct NormalPathTest : public RPCGatewayBalancesHandlerTest, public WithParamInterface {}; TEST_P(NormalPathTest, CheckOutput) { auto const& bundle = GetParam(); auto const seq = 300; EXPECT_CALL(*backend, fetchLedgerBySequence).Times(1); // return valid ledgerHeader auto const ledgerHeader = CreateLedgerHeader(LEDGERHASH, seq); ON_CALL(*backend, fetchLedgerBySequence(seq, _)).WillByDefault(Return(ledgerHeader)); // return valid account auto const accountKk = ripple::keylet::account(GetAccountIDWithString(ACCOUNT)).key; ON_CALL(*backend, doFetchLedgerObject(accountKk, seq, _)).WillByDefault(Return(Blob{'f', 'a', 'k', 'e'})); // return valid owner dir auto const ownerDir = CreateOwnerDirLedgerObject({ripple::uint256{INDEX2}}, INDEX1); auto const ownerDirKk = ripple::keylet::ownerDir(GetAccountIDWithString(ACCOUNT)).key; ON_CALL(*backend, doFetchLedgerObject(ownerDirKk, seq, _)) .WillByDefault(Return(bundle.mockedDir.getSerializer().peekData())); EXPECT_CALL(*backend, doFetchLedgerObject).Times(2); std::vector bbs; std::transform( bundle.mockedObjects.begin(), bundle.mockedObjects.end(), std::back_inserter(bbs), [](auto const& obj) { return obj.getSerializer().peekData(); } ); ON_CALL(*backend, doFetchLedgerObjects).WillByDefault(Return(bbs)); EXPECT_CALL(*backend, doFetchLedgerObjects).Times(1); auto const handler = AnyHandler{GatewayBalancesHandler{backend}}; runSpawn([&](auto yield) { auto const output = handler.process( json::parse(fmt::format( R"({{ "account": "{}", {} }})", ACCOUNT, bundle.hotwallet )), Context{yield} ); ASSERT_TRUE(output); EXPECT_EQ(output.result.value(), json::parse(bundle.expectedJson)); }); } auto generateNormalPathTestBundles() { auto frozenState = CreateRippleStateLedgerObject("JPY", ISSUER, -50, ACCOUNT, 10, ACCOUNT3, 20, TXNID, 123); frozenState.setFieldU32(ripple::sfFlags, ripple::lsfLowFreeze); auto overflowState = CreateRippleStateLedgerObject("JPY", ISSUER, 50, ACCOUNT, 10, ACCOUNT3, 20, TXNID, 123); int64_t const min64 = -9922966390934554; overflowState.setFieldAmount(ripple::sfBalance, ripple::STAmount(GetIssue("JPY", ISSUER), min64, 80)); return std::vector{ NormalTestBundle{ "AllBranches", CreateOwnerDirLedgerObject( {ripple::uint256{INDEX2}, ripple::uint256{INDEX2}, ripple::uint256{INDEX2}, ripple::uint256{INDEX2}, ripple::uint256{INDEX2}, ripple::uint256{INDEX2}}, INDEX1 ), std::vector{// hotwallet CreateRippleStateLedgerObject("USD", ISSUER, -10, ACCOUNT, 100, ACCOUNT2, 200, TXNID, 123), // hotwallet CreateRippleStateLedgerObject("CNY", ISSUER, -20, ACCOUNT, 100, ACCOUNT2, 200, TXNID, 123), // positive balance -> asset CreateRippleStateLedgerObject("EUR", ISSUER, 30, ACCOUNT, 100, ACCOUNT3, 200, TXNID, 123), // positive balance -> asset CreateRippleStateLedgerObject("JPY", ISSUER, 40, ACCOUNT, 100, ACCOUNT3, 200, TXNID, 123), // obligation CreateRippleStateLedgerObject("JPY", ISSUER, -50, ACCOUNT, 10, ACCOUNT3, 20, TXNID, 123), frozenState }, fmt::format( R"({{ "obligations":{{ "JPY":"50" }}, "balances":{{ "{}":[ {{ "currency":"USD", "value":"10" }}, {{ "currency":"CNY", "value":"20" }} ] }}, "frozen_balances":{{ "{}":[ {{ "currency":"JPY", "value":"50" }} ] }}, "assets":{{ "{}":[ {{ "currency":"EUR", "value":"30" }}, {{ "currency":"JPY", "value":"40" }} ] }}, "account":"{}", "ledger_index":300, "ledger_hash":"4BC50C9B0D8515D3EAAE1E74B29A95804346C491EE1A95BF25E4AAB854A6A652" }})", ACCOUNT2, ACCOUNT3, ACCOUNT3, ACCOUNT ), fmt::format(R"("hotwallet": "{}")", ACCOUNT2) }, NormalTestBundle{ "NoHotwallet", CreateOwnerDirLedgerObject({ripple::uint256{INDEX2}}, INDEX1), std::vector{CreateRippleStateLedgerObject("JPY", ISSUER, -50, ACCOUNT, 10, ACCOUNT3, 20, TXNID, 123)}, fmt::format( R"({{ "obligations":{{ "JPY":"50" }}, "account":"{}", "ledger_index":300, "ledger_hash":"4BC50C9B0D8515D3EAAE1E74B29A95804346C491EE1A95BF25E4AAB854A6A652" }})", ACCOUNT ), R"("ledger_index" : "validated")" }, NormalTestBundle{ "ObligationOverflow", CreateOwnerDirLedgerObject({ripple::uint256{INDEX2}, ripple::uint256{INDEX2}}, INDEX1), std::vector{overflowState, overflowState}, fmt::format( R"({{ "obligations":{{ "JPY":"9999999999999999e80" }}, "account":"{}", "ledger_index":300, "ledger_hash":"4BC50C9B0D8515D3EAAE1E74B29A95804346C491EE1A95BF25E4AAB854A6A652" }})", ACCOUNT ), R"("ledger_index" : "validated")" }, NormalTestBundle{ "HighID", CreateOwnerDirLedgerObject( {ripple::uint256{INDEX2}, ripple::uint256{INDEX2}, ripple::uint256{INDEX2}, ripple::uint256{INDEX2}}, INDEX1 ), std::vector{// hotwallet CreateRippleStateLedgerObject("USD", ISSUER, 10, ACCOUNT2, 100, ACCOUNT, 200, TXNID, 123), // hotwallet CreateRippleStateLedgerObject("CNY", ISSUER, 20, ACCOUNT2, 100, ACCOUNT, 200, TXNID, 123), CreateRippleStateLedgerObject("EUR", ISSUER, 30, ACCOUNT3, 100, ACCOUNT, 200, TXNID, 123), CreateRippleStateLedgerObject("JPY", ISSUER, -50, ACCOUNT3, 10, ACCOUNT, 20, TXNID, 123) }, fmt::format( R"({{ "obligations":{{ "EUR":"30" }}, "balances":{{ "{}":[ {{ "currency":"USD", "value":"10" }}, {{ "currency":"CNY", "value":"20" }} ] }}, "assets":{{ "{}":[ {{ "currency":"JPY", "value":"50" }} ] }}, "account":"{}", "ledger_index":300, "ledger_hash":"4BC50C9B0D8515D3EAAE1E74B29A95804346C491EE1A95BF25E4AAB854A6A652" }})", ACCOUNT2, ACCOUNT3, ACCOUNT ), fmt::format(R"("hotwallet": "{}")", ACCOUNT2) }, NormalTestBundle{ "HotWalletArray", CreateOwnerDirLedgerObject( {ripple::uint256{INDEX2}, ripple::uint256{INDEX2}, ripple::uint256{INDEX2}}, INDEX1 ), std::vector{ CreateRippleStateLedgerObject("USD", ISSUER, -10, ACCOUNT, 100, ACCOUNT2, 200, TXNID, 123), CreateRippleStateLedgerObject("CNY", ISSUER, -20, ACCOUNT, 100, ACCOUNT2, 200, TXNID, 123), CreateRippleStateLedgerObject("EUR", ISSUER, -30, ACCOUNT, 100, ACCOUNT3, 200, TXNID, 123) }, fmt::format( R"({{ "balances":{{ "{}":[ {{ "currency":"EUR", "value":"30" }} ], "{}":[ {{ "currency":"USD", "value":"10" }}, {{ "currency":"CNY", "value":"20" }} ] }}, "account":"{}", "ledger_index":300, "ledger_hash":"4BC50C9B0D8515D3EAAE1E74B29A95804346C491EE1A95BF25E4AAB854A6A652" }})", ACCOUNT3, ACCOUNT2, ACCOUNT ), fmt::format(R"("hotwallet": ["{}", "{}"])", ACCOUNT2, ACCOUNT3) }, }; } INSTANTIATE_TEST_SUITE_P( RPCGatewayBalancesHandler, NormalPathTest, testing::ValuesIn(generateNormalPathTestBundles()), tests::util::NameGenerator );