ARCHIVE/clio
1
0
Fork 0
mirror of https://github.com/XRPLF/clio.git synced 2025-12-06 17:27:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Implement nextgen nft_info handler (#558)

Browse Source 
Fixing #557
This commit is contained in:
Alex Kremer
2023-03-27 11:50:13 +01:00
committed by GitHub
parent 1bb67217e5
commit 95da706fed
7 changed files with 710 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
src/rpc/handlers/NFTInfo.cpp
View File

@@ -54,8 +54,7 @@ doNFTInfo(Context const& context)
response[JS(uri)] = ripple::strHex(dbResponse->uri);
response[JS(flags)] = ripple::nft::getFlags(dbResponse->tokenID);
response["transfer_rate"] =
ripple::nft::getTransferFee(dbResponse->tokenID);
response["transfer_fee"] = ripple::nft::getTransferFee(dbResponse->tokenID);
response[JS(issuer)] =
ripple::toBase58(ripple::nft::getIssuer(dbResponse->tokenID));
response["nft_taxon"] =

129
src/rpc/ngHandlers/NFTInfo.cpp Normal file
View File

@@ -0,0 +1,129 @@
//------------------------------------------------------------------------------
/*
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 <rpc/RPCHelpers.h>
#include <rpc/ngHandlers/NFTInfo.h>
#include <ripple/app/tx/impl/details/NFTokenUtils.h>
#include <ripple/protocol/Indexes.h>
using namespace ripple;
using namespace ::RPC;
namespace RPCng {
NFTInfoHandler::Result
NFTInfoHandler::process(
NFTInfoHandler::Input input,
boost::asio::yield_context& yield) const
{
auto const tokenID = ripple::uint256{input.nftID.c_str()};
auto const range = sharedPtrBackend_->fetchLedgerRange();
auto const lgrInfoOrStatus = getLedgerInfoFromHashOrSeq(
*sharedPtrBackend_,
yield,
input.ledgerHash,
input.ledgerIndex,
range->maxSequence);
if (auto const status = std::get_if<Status>(&lgrInfoOrStatus))
return Error{*status};
auto const lgrInfo = std::get<LedgerInfo>(lgrInfoOrStatus);
auto const maybeNft =
sharedPtrBackend_->fetchNFT(tokenID, lgrInfo.seq, yield);
if (not maybeNft.has_value())
return Error{
Status{RippledError::rpcOBJECT_NOT_FOUND, "NFT not found"}};
auto const& nft = *maybeNft;
auto output = NFTInfoHandler::Output{};
output.nftID = strHex(nft.tokenID);
output.ledgerIndex = nft.ledgerSequence;
output.owner = toBase58(nft.owner);
output.isBurned = nft.isBurned;
output.flags = nft::getFlags(nft.tokenID);
output.transferFee = nft::getTransferFee(nft.tokenID);
output.issuer = toBase58(nft::getIssuer(nft.tokenID));
output.taxon = nft::toUInt32(nft::getTaxon(nft.tokenID));
output.serial = nft::getSerial(nft.tokenID);
if (not nft.isBurned)
output.uri = strHex(nft.uri);
return output;
}
void
tag_invoke(
boost::json::value_from_tag,
boost::json::value& jv,
NFTInfoHandler::Output const& output)
{
// TODO: use JStrings when they become available
auto object = boost::json::object{
{JS(nft_id), output.nftID},
{JS(ledger_index), output.ledgerIndex},
{JS(owner), output.owner},
{"is_burned", output.isBurned},
{JS(flags), output.flags},
{"transfer_fee", output.transferFee},
{JS(issuer), output.issuer},
{"nft_taxon", output.taxon},
{JS(nft_serial), output.serial},
{JS(validated), output.validated},
};
if (output.uri)
object[JS(uri)] = *(output.uri);
jv = std::move(object);
}
NFTInfoHandler::Input
tag_invoke(
boost::json::value_to_tag<NFTInfoHandler::Input>,
boost::json::value const& jv)
{
auto const& jsonObject = jv.as_object();
NFTInfoHandler::Input input;
input.nftID = jsonObject.at(JS(nft_id)).as_string().c_str();
if (jsonObject.contains(JS(ledger_hash)))
{
input.ledgerHash = jsonObject.at(JS(ledger_hash)).as_string().c_str();
}
if (jsonObject.contains(JS(ledger_index)))
{
if (!jsonObject.at(JS(ledger_index)).is_string())
{
input.ledgerIndex = jsonObject.at(JS(ledger_index)).as_int64();
}
else if (jsonObject.at(JS(ledger_index)).as_string() != "validated")
{
input.ledgerIndex =
std::stoi(jsonObject.at(JS(ledger_index)).as_string().c_str());
}
}
return input;
}
} // namespace RPCng

97
src/rpc/ngHandlers/NFTInfo.h Normal file
View File

@@ -0,0 +1,97 @@
//------------------------------------------------------------------------------
/*
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.
*/
//==============================================================================
#pragma once
#include <backend/BackendInterface.h>
#include <rpc/RPCHelpers.h>
#include <rpc/common/Types.h>
#include <rpc/common/Validators.h>
#include <boost/asio/spawn.hpp>
namespace RPCng {
class NFTInfoHandler
{
std::shared_ptr<BackendInterface> sharedPtrBackend_;
public:
struct Output
{
std::string nftID;
uint32_t ledgerIndex;
std::string owner;
bool isBurned;
uint32_t flags;
uint32_t transferFee;
std::string issuer;
uint32_t taxon;
uint32_t
serial; // TODO: documented as 'nft_sequence' atm.
// https://github.com/XRPLF/xrpl-dev-portal/issues/1841
std::optional<std::string>
uri; // TODO: documented can be null vs. empty string
// https://github.com/XRPLF/xrpl-dev-portal/issues/1841
// validated should be sent via framework
bool validated = true;
};
struct Input
{
std::string nftID;
std::optional<std::string> ledgerHash;
std::optional<uint32_t> ledgerIndex;
};
using Result = RPCng::HandlerReturnType<Output>;
NFTInfoHandler(std::shared_ptr<BackendInterface> const& sharedPtrBackend)
: sharedPtrBackend_(sharedPtrBackend)
{
}
RpcSpecConstRef
spec() const
{
static auto const rpcSpec = RpcSpec{
{JS(nft_id),
validation::Required{},
validation::Uint256HexStringValidator},
{JS(ledger_hash), validation::Uint256HexStringValidator},
{JS(ledger_index), validation::LedgerIndexValidator},
};
return rpcSpec;
}
Result
process(Input input, boost::asio::yield_context& yield) const;
};
void
tag_invoke(
boost::json::value_from_tag,
boost::json::value& jv,
NFTInfoHandler::Output const& output);
NFTInfoHandler::Input
tag_invoke(
boost::json::value_to_tag<NFTInfoHandler::Input>,
boost::json::value const& jv);
} // namespace RPCng