Files
clio/tests/unit/rpc/handlers/NFTsByIssuerTest.cpp
2026-05-13 12:09:06 +01:00

671 lines
23 KiB
C++

#include "data/Types.hpp"
#include "rpc/Errors.hpp"
#include "rpc/common/AnyHandler.hpp"
#include "rpc/common/Types.hpp"
#include "rpc/handlers/NFTsByIssuer.hpp"
#include "util/HandlerBaseTestFixture.hpp"
#include "util/TestObject.hpp"
#include <boost/asio/spawn.hpp>
#include <boost/json/parse.hpp>
#include <fmt/format.h>
#include <gmock/gmock.h>
#include <gtest/gtest.h>
#include <xrpl/basics/base_uint.h>
#include <xrpl/protocol/Indexes.h>
#include <xrpl/protocol/LedgerHeader.h>
#include <functional>
#include <optional>
#include <string>
#include <vector>
using namespace rpc;
using namespace data;
namespace json = boost::json;
using namespace testing;
namespace {
constexpr auto kAccount = "r4X6JLsBfhNK4UnquNkCxhVHKPkvbQff67";
constexpr auto kLedgerHash = "4BC50C9B0D8515D3EAAE1E74B29A95804346C491EE1A95BF25E4AAB854A6A652";
constexpr auto kNftID1 =
"00080000EC28C2910FD1C454A51598AAB91C8876286B2E7F0000099B00000000"; // taxon 0
constexpr auto kNftID2 =
"00080000EC28C2910FD1C454A51598AAB91C8876286B2E7F16E5DA9C00000001"; // taxon 0
constexpr auto kNftID3 =
"00080000EC28C2910FD1C454A51598AAB91C8876286B2E7F5B974D9E00000004"; // taxon 1
std::string const kNfT1Out =
R"JSON({
"nft_id": "00080000EC28C2910FD1C454A51598AAB91C8876286B2E7F0000099B00000000",
"ledger_index": 29,
"owner": "r4X6JLsBfhNK4UnquNkCxhVHKPkvbQff67",
"is_burned": false,
"uri": "757269",
"flags": 8,
"transfer_fee": 0,
"issuer": "r4X6JLsBfhNK4UnquNkCxhVHKPkvbQff67",
"nft_taxon": 0,
"nft_serial": 0
})JSON";
std::string const kNfT2Out =
R"JSON({
"nft_id": "00080000EC28C2910FD1C454A51598AAB91C8876286B2E7F16E5DA9C00000001",
"ledger_index": 29,
"owner": "r4X6JLsBfhNK4UnquNkCxhVHKPkvbQff67",
"is_burned": false,
"uri": "757269",
"flags": 8,
"transfer_fee": 0,
"issuer": "r4X6JLsBfhNK4UnquNkCxhVHKPkvbQff67",
"nft_taxon": 0,
"nft_serial": 1
})JSON";
std::string const kNfT3Out =
R"JSON({
"nft_id": "00080000EC28C2910FD1C454A51598AAB91C8876286B2E7F5B974D9E00000004",
"ledger_index": 29,
"owner": "r4X6JLsBfhNK4UnquNkCxhVHKPkvbQff67",
"is_burned": false,
"uri": "757269",
"flags": 8,
"transfer_fee": 0,
"issuer": "r4X6JLsBfhNK4UnquNkCxhVHKPkvbQff67",
"nft_taxon": 1,
"nft_serial": 4
})JSON";
} // namespace
struct RPCNFTsByIssuerHandlerTest : HandlerBaseTest {
RPCNFTsByIssuerHandlerTest()
{
backend_->setRange(10, 30);
}
};
TEST_F(RPCNFTsByIssuerHandlerTest, NonHexLedgerHash)
{
runSpawn([this](boost::asio::yield_context yield) {
auto const handler = AnyHandler{NFTsByIssuerHandler{backend_}};
auto const input = json::parse(
fmt::format(
R"JSON({{
"issuer": "{}",
"ledger_hash": "xxx"
}})JSON",
kAccount
)
);
auto const output = handler.process(input, Context{.yield = std::ref(yield)});
ASSERT_FALSE(output);
auto const err = rpc::makeError(output.result.error());
EXPECT_EQ(err.at("error").as_string(), "invalidParams");
EXPECT_EQ(err.at("error_message").as_string(), "ledger_hashMalformed");
});
}
TEST_F(RPCNFTsByIssuerHandlerTest, NonStringLedgerHash)
{
runSpawn([this](boost::asio::yield_context yield) {
auto const handler = AnyHandler{NFTsByIssuerHandler{backend_}};
auto const input = json::parse(
fmt::format(
R"JSON({{
"issuer": "{}",
"ledger_hash": 123
}})JSON",
kAccount
)
);
auto const output = handler.process(input, Context{.yield = std::ref(yield)});
ASSERT_FALSE(output);
auto const err = rpc::makeError(output.result.error());
EXPECT_EQ(err.at("error").as_string(), "invalidParams");
EXPECT_EQ(err.at("error_message").as_string(), "ledger_hashNotString");
});
}
TEST_F(RPCNFTsByIssuerHandlerTest, InvalidLedgerIndexString)
{
runSpawn([this](boost::asio::yield_context yield) {
auto const handler = AnyHandler{NFTsByIssuerHandler{backend_}};
auto const input = json::parse(
fmt::format(
R"JSON({{
"issuer": "{}",
"ledger_index": "notvalidated"
}})JSON",
kAccount
)
);
auto const output = handler.process(input, Context{.yield = std::ref(yield)});
ASSERT_FALSE(output);
auto const err = rpc::makeError(output.result.error());
EXPECT_EQ(err.at("error").as_string(), "invalidParams");
EXPECT_EQ(err.at("error_message").as_string(), "ledgerIndexMalformed");
});
}
// error case: issuer invalid format, length is incorrect
TEST_F(RPCNFTsByIssuerHandlerTest, NFTIssuerInvalidFormat)
{
runSpawn([this](boost::asio::yield_context yield) {
auto const handler = AnyHandler{NFTsByIssuerHandler{backend_}};
auto const input = json::parse(R"JSON({
"issuer": "xxx"
})JSON");
auto const output = handler.process(input, Context{.yield = std::ref(yield)});
ASSERT_FALSE(output);
auto const err = rpc::makeError(output.result.error());
EXPECT_EQ(err.at("error").as_string(), "actMalformed");
EXPECT_EQ(err.at("error_message").as_string(), "issuerMalformed");
});
}
// error case: issuer missing
TEST_F(RPCNFTsByIssuerHandlerTest, NFTIssuerMissing)
{
runSpawn([this](boost::asio::yield_context yield) {
auto const handler = AnyHandler{NFTsByIssuerHandler{backend_}};
auto const input = json::parse(R"JSON({})JSON");
auto const output = handler.process(input, Context{.yield = std::ref(yield)});
ASSERT_FALSE(output);
auto const err = rpc::makeError(output.result.error());
EXPECT_EQ(err.at("error").as_string(), "invalidParams");
EXPECT_EQ(err.at("error_message").as_string(), "Required field 'issuer' missing");
});
}
// error case: issuer invalid format
TEST_F(RPCNFTsByIssuerHandlerTest, NFTIssuerNotString)
{
runSpawn([this](boost::asio::yield_context yield) {
auto const handler = AnyHandler{NFTsByIssuerHandler{backend_}};
auto const input = json::parse(R"JSON({
"issuer": 12
})JSON");
auto const output = handler.process(input, Context{.yield = std::ref(yield)});
ASSERT_FALSE(output);
auto const err = rpc::makeError(output.result.error());
EXPECT_EQ(err.at("error").as_string(), "invalidParams");
EXPECT_EQ(err.at("error_message").as_string(), "issuerNotString");
});
}
// error case ledger non exist via hash
TEST_F(RPCNFTsByIssuerHandlerTest, NonExistLedgerViaLedgerHash)
{
// mock fetchLedgerByHash return empty
EXPECT_CALL(*backend_, fetchLedgerByHash).Times(1);
ON_CALL(*backend_, fetchLedgerByHash(ripple::uint256{kLedgerHash}, _))
.WillByDefault(Return(std::optional<ripple::LedgerHeader>{}));
auto const input = json::parse(
fmt::format(
R"JSON({{
"issuer": "{}",
"ledger_hash": "{}"
}})JSON",
kAccount,
kLedgerHash
)
);
runSpawn([&, this](boost::asio::yield_context yield) {
auto const handler = AnyHandler{NFTsByIssuerHandler{backend_}};
auto const output = handler.process(input, Context{.yield = std::ref(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");
});
}
// error case ledger non exist via index
TEST_F(RPCNFTsByIssuerHandlerTest, NonExistLedgerViaLedgerStringIndex)
{
// mock fetchLedgerBySequence return empty
EXPECT_CALL(*backend_, fetchLedgerBySequence)
.WillOnce(Return(std::optional<ripple::LedgerHeader>{}));
auto const input = json::parse(
fmt::format(
R"JSON({{
"issuer": "{}",
"ledger_index": "4"
}})JSON",
kAccount
)
);
runSpawn([&, this](boost::asio::yield_context yield) {
auto const handler = AnyHandler{NFTsByIssuerHandler{backend_}};
auto const output = handler.process(input, Context{.yield = std::ref(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(RPCNFTsByIssuerHandlerTest, NonExistLedgerViaLedgerIntIndex)
{
// mock fetchLedgerBySequence return empty
EXPECT_CALL(*backend_, fetchLedgerBySequence)
.WillOnce(Return(std::optional<ripple::LedgerHeader>{}));
auto const input = json::parse(
fmt::format(
R"JSON({{
"issuer": "{}",
"ledger_index": 4
}})JSON",
kAccount
)
);
runSpawn([&, this](boost::asio::yield_context yield) {
auto const handler = AnyHandler{NFTsByIssuerHandler{backend_}};
auto const output = handler.process(input, Context{.yield = std::ref(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");
});
}
// error case ledger > max seq via hash
// idk why this case will happen in reality
TEST_F(RPCNFTsByIssuerHandlerTest, NonExistLedgerViaLedgerHash2)
{
// mock fetchLedgerByHash return ledger but seq is 31 > 30
auto ledgerHeader = createLedgerHeader(kLedgerHash, 31);
ON_CALL(*backend_, fetchLedgerByHash(ripple::uint256{kLedgerHash}, _))
.WillByDefault(Return(ledgerHeader));
EXPECT_CALL(*backend_, fetchLedgerByHash).Times(1);
auto const input = json::parse(
fmt::format(
R"JSON({{
"issuer": "{}",
"ledger_hash": "{}"
}})JSON",
kAccount,
kLedgerHash
)
);
runSpawn([&, this](boost::asio::yield_context yield) {
auto const handler = AnyHandler{NFTsByIssuerHandler{backend_}};
auto const output = handler.process(input, Context{.yield = std::ref(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");
});
}
// error case ledger > max seq via index
TEST_F(RPCNFTsByIssuerHandlerTest, NonExistLedgerViaLedgerIndex2)
{
// no need to check from db,call fetchLedgerBySequence 0 time
// differ from previous logic
EXPECT_CALL(*backend_, fetchLedgerBySequence).Times(0);
auto const input = json::parse(
fmt::format(
R"JSON({{
"issuer": "{}",
"ledger_index": "31"
}})JSON",
kAccount
)
);
runSpawn([&, this](boost::asio::yield_context yield) {
auto const handler = AnyHandler{NFTsByIssuerHandler{backend_}};
auto const output = handler.process(input, Context{.yield = std::ref(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");
});
}
// normal case when issuer does not exist or has no NFTs
TEST_F(RPCNFTsByIssuerHandlerTest, AccountNotFound)
{
auto ledgerHeader = createLedgerHeader(kLedgerHash, 30);
ON_CALL(*backend_, fetchLedgerByHash(ripple::uint256{kLedgerHash}, _))
.WillByDefault(Return(ledgerHeader));
EXPECT_CALL(*backend_, fetchLedgerByHash).Times(1);
ON_CALL(*backend_, doFetchLedgerObject).WillByDefault(Return(std::optional<Blob>{}));
EXPECT_CALL(*backend_, doFetchLedgerObject).Times(1);
auto const input = json::parse(
fmt::format(
R"JSON({{
"issuer": "{}",
"ledger_hash": "{}"
}})JSON",
kAccount,
kLedgerHash
)
);
runSpawn([&, this](boost::asio::yield_context yield) {
auto handler = AnyHandler{NFTsByIssuerHandler{this->backend_}};
auto const output = handler.process(input, Context{.yield = 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(), "Account not found.");
});
}
// normal case when issuer has a single nft
TEST_F(RPCNFTsByIssuerHandlerTest, DefaultParameters)
{
auto const currentOutput = fmt::format(
R"JSON({{
"issuer": "{}",
"limit": 50,
"ledger_index": 30,
"nfts": [{}],
"validated": true
}})JSON",
kAccount,
kNfT1Out
);
auto ledgerHeader = createLedgerHeader(kLedgerHash, 30);
EXPECT_CALL(*backend_, fetchLedgerBySequence).WillOnce(Return(ledgerHeader));
auto const accountKk = ripple::keylet::account(getAccountIdWithString(kAccount)).key;
ON_CALL(*backend_, doFetchLedgerObject(accountKk, 30, _))
.WillByDefault(Return(Blob{'f', 'a', 'k', 'e'}));
std::vector<NFT> const nfts = {createNft(kNftID1, kAccount, 29)};
auto const account = getAccountIdWithString(kAccount);
ON_CALL(*backend_, fetchNFTsByIssuer)
.WillByDefault(Return(NFTsAndCursor{.nfts = nfts, .cursor = {}}));
EXPECT_CALL(
*backend_, fetchNFTsByIssuer(account, Eq(std::nullopt), Const(30), _, Eq(std::nullopt), _)
)
.Times(1);
auto const input = json::parse(
fmt::format(
R"JSON({{
"issuer": "{}"
}})JSON",
kAccount
)
);
runSpawn([&, this](auto& yield) {
auto handler = AnyHandler{NFTsByIssuerHandler{this->backend_}};
auto const output = handler.process(input, Context{yield});
ASSERT_TRUE(output);
EXPECT_EQ(json::parse(currentOutput), *output.result);
});
}
TEST_F(RPCNFTsByIssuerHandlerTest, SpecificLedgerIndex)
{
auto const specificLedger = 20;
auto const currentOutput = fmt::format(
R"JSON({{
"issuer": "{}",
"limit": 50,
"ledger_index": {},
"nfts": [{{
"nft_id": "00080000EC28C2910FD1C454A51598AAB91C8876286B2E7F0000099B00000000",
"ledger_index": 20,
"owner": "r4X6JLsBfhNK4UnquNkCxhVHKPkvbQff67",
"is_burned": false,
"uri": "757269",
"flags": 8,
"transfer_fee": 0,
"issuer": "r4X6JLsBfhNK4UnquNkCxhVHKPkvbQff67",
"nft_taxon": 0,
"nft_serial": 0
}}],
"validated": true
}})JSON",
kAccount,
specificLedger
);
auto ledgerHeader = createLedgerHeader(kLedgerHash, specificLedger);
ON_CALL(*backend_, fetchLedgerBySequence(specificLedger, _))
.WillByDefault(Return(ledgerHeader));
EXPECT_CALL(*backend_, fetchLedgerBySequence).Times(1);
auto const accountKk = ripple::keylet::account(getAccountIdWithString(kAccount)).key;
ON_CALL(*backend_, doFetchLedgerObject(accountKk, specificLedger, _))
.WillByDefault(Return(Blob{'f', 'a', 'k', 'e'}));
std::vector<NFT> const nfts = {createNft(kNftID1, kAccount, specificLedger)};
auto const account = getAccountIdWithString(kAccount);
ON_CALL(*backend_, fetchNFTsByIssuer)
.WillByDefault(Return(NFTsAndCursor{.nfts = nfts, .cursor = {}}));
EXPECT_CALL(
*backend_,
fetchNFTsByIssuer(account, Eq(std::nullopt), Const(specificLedger), _, Eq(std::nullopt), _)
)
.Times(1);
auto const input = json::parse(
fmt::format(
R"JSON({{
"issuer": "{}",
"ledger_index": {}
}})JSON",
kAccount,
specificLedger
)
);
runSpawn([&, this](auto& yield) {
auto handler = AnyHandler{NFTsByIssuerHandler{this->backend_}};
auto const output = handler.process(input, Context{yield});
ASSERT_TRUE(output);
EXPECT_EQ(json::parse(currentOutput), *output.result);
});
}
TEST_F(RPCNFTsByIssuerHandlerTest, TaxonParameter)
{
auto const currentOutput = fmt::format(
R"JSON({{
"issuer": "{}",
"limit": 50,
"ledger_index": 30,
"nfts": [{}],
"validated": true,
"nft_taxon": 0
}})JSON",
kAccount,
kNfT1Out
);
auto ledgerHeader = createLedgerHeader(kLedgerHash, 30);
EXPECT_CALL(*backend_, fetchLedgerBySequence).WillOnce(Return(ledgerHeader));
auto const accountKk = ripple::keylet::account(getAccountIdWithString(kAccount)).key;
ON_CALL(*backend_, doFetchLedgerObject(accountKk, 30, _))
.WillByDefault(Return(Blob{'f', 'a', 'k', 'e'}));
std::vector<NFT> const nfts = {createNft(kNftID1, kAccount, 29)};
auto const account = getAccountIdWithString(kAccount);
ON_CALL(*backend_, fetchNFTsByIssuer)
.WillByDefault(Return(NFTsAndCursor{.nfts = nfts, .cursor = {}}));
EXPECT_CALL(
*backend_, fetchNFTsByIssuer(account, Optional(0), Const(30), _, Eq(std::nullopt), _)
)
.Times(1);
auto const input = json::parse(
fmt::format(
R"JSON({{
"issuer": "{}",
"nft_taxon": 0
}})JSON",
kAccount
)
);
runSpawn([&, this](auto& yield) {
auto handler = AnyHandler{NFTsByIssuerHandler{this->backend_}};
auto const output = handler.process(input, Context{yield});
ASSERT_TRUE(output);
EXPECT_EQ(json::parse(currentOutput), *output.result);
});
}
TEST_F(RPCNFTsByIssuerHandlerTest, MarkerParameter)
{
auto const currentOutput = fmt::format(
R"JSON({{
"issuer": "{}",
"limit": 50,
"ledger_index": 30,
"nfts": [{}],
"validated": true,
"marker": "00080000EC28C2910FD1C454A51598AAB91C8876286B2E7F5B974D9E00000004"
}})JSON",
kAccount,
kNfT3Out
);
auto ledgerHeader = createLedgerHeader(kLedgerHash, 30);
EXPECT_CALL(*backend_, fetchLedgerBySequence).WillOnce(Return(ledgerHeader));
auto const accountKk = ripple::keylet::account(getAccountIdWithString(kAccount)).key;
ON_CALL(*backend_, doFetchLedgerObject(accountKk, 30, _))
.WillByDefault(Return(Blob{'f', 'a', 'k', 'e'}));
std::vector<NFT> const nfts = {createNft(kNftID3, kAccount, 29)};
auto const account = getAccountIdWithString(kAccount);
ON_CALL(*backend_, fetchNFTsByIssuer)
.WillByDefault(Return(NFTsAndCursor{.nfts = nfts, .cursor = ripple::uint256{kNftID3}}));
EXPECT_CALL(
*backend_, fetchNFTsByIssuer(account, _, Const(30), _, Eq(ripple::uint256{kNftID1}), _)
)
.Times(1);
auto const input = json::parse(
fmt::format(
R"JSON({{
"issuer": "{}",
"marker": "{}"
}})JSON",
kAccount,
kNftID1
)
);
runSpawn([&, this](auto& yield) {
auto handler = AnyHandler{NFTsByIssuerHandler{this->backend_}};
auto const output = handler.process(input, Context{yield});
ASSERT_TRUE(output);
EXPECT_EQ(json::parse(currentOutput), *output.result);
});
}
TEST_F(RPCNFTsByIssuerHandlerTest, MultipleNFTs)
{
auto const currentOutput = fmt::format(
R"JSON({{
"issuer": "{}",
"limit": 50,
"ledger_index": 30,
"nfts": [{}, {}, {}],
"validated": true
}})JSON",
kAccount,
kNfT1Out,
kNfT2Out,
kNfT3Out
);
auto ledgerHeader = createLedgerHeader(kLedgerHash, 30);
EXPECT_CALL(*backend_, fetchLedgerBySequence).WillOnce(Return(ledgerHeader));
auto const accountKk = ripple::keylet::account(getAccountIdWithString(kAccount)).key;
ON_CALL(*backend_, doFetchLedgerObject(accountKk, 30, _))
.WillByDefault(Return(Blob{'f', 'a', 'k', 'e'}));
std::vector<NFT> const nfts = {
createNft(kNftID1, kAccount, 29),
createNft(kNftID2, kAccount, 29),
createNft(kNftID3, kAccount, 29)
};
auto const account = getAccountIdWithString(kAccount);
ON_CALL(*backend_, fetchNFTsByIssuer)
.WillByDefault(Return(NFTsAndCursor{.nfts = nfts, .cursor = {}}));
EXPECT_CALL(
*backend_, fetchNFTsByIssuer(account, Eq(std::nullopt), Const(30), _, Eq(std::nullopt), _)
)
.Times(1);
auto const input = json::parse(
fmt::format(
R"JSON({{
"issuer": "{}"
}})JSON",
kAccount
)
);
runSpawn([&, this](auto& yield) {
auto handler = AnyHandler{NFTsByIssuerHandler{this->backend_}};
auto const output = handler.process(input, Context{yield});
ASSERT_TRUE(output);
EXPECT_EQ(json::parse(currentOutput), *output.result);
});
}
TEST_F(RPCNFTsByIssuerHandlerTest, LimitMoreThanMax)
{
auto const currentOutput = fmt::format(
R"JSON({{
"issuer": "{}",
"limit": 100,
"ledger_index": 30,
"nfts": [{}],
"validated": true
}})JSON",
kAccount,
kNfT1Out
);
auto ledgerHeader = createLedgerHeader(kLedgerHash, 30);
EXPECT_CALL(*backend_, fetchLedgerBySequence).WillOnce(Return(ledgerHeader));
auto const accountKk = ripple::keylet::account(getAccountIdWithString(kAccount)).key;
ON_CALL(*backend_, doFetchLedgerObject(accountKk, 30, _))
.WillByDefault(Return(Blob{'f', 'a', 'k', 'e'}));
std::vector<NFT> const nfts = {createNft(kNftID1, kAccount, 29)};
auto const account = getAccountIdWithString(kAccount);
ON_CALL(*backend_, fetchNFTsByIssuer)
.WillByDefault(Return(NFTsAndCursor{.nfts = nfts, .cursor = {}}));
EXPECT_CALL(
*backend_,
fetchNFTsByIssuer(
account,
Eq(std::nullopt),
Const(30),
NFTsByIssuerHandler::kLimitMax,
Eq(std::nullopt),
_
)
)
.Times(1);
auto const input = json::parse(
fmt::format(
R"JSON({{
"issuer": "{}",
"limit": {}
}})JSON",
kAccount,
NFTsByIssuerHandler::kLimitMax + 1
)
);
runSpawn([&, this](auto& yield) {
auto handler = AnyHandler{NFTsByIssuerHandler{this->backend_}};
auto const output = handler.process(input, Context{yield});
ASSERT_TRUE(output);
EXPECT_EQ(json::parse(currentOutput), *output.result);
});
}