mirror of
https://github.com/XRPLF/clio.git
synced 2026-06-07 10:46:51 +00:00
273 lines
8.4 KiB
C++
273 lines
8.4 KiB
C++
//------------------------------------------------------------------------------
|
|
/*
|
|
This file is part of clio: https://github.com/XRPLF/clio
|
|
Copyright (c) 2022, 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.
|
|
*/
|
|
//==============================================================================
|
|
|
|
/** @file */
|
|
#pragma once
|
|
|
|
#include "util/Assert.hpp"
|
|
|
|
#include <boost/container/flat_set.hpp>
|
|
#include <xrpl/basics/Blob.h>
|
|
#include <xrpl/basics/Log.h>
|
|
#include <xrpl/basics/StringUtilities.h>
|
|
#include <xrpl/basics/base_uint.h>
|
|
#include <xrpl/protocol/AccountID.h>
|
|
#include <xrpl/protocol/SField.h>
|
|
#include <xrpl/protocol/STAccount.h>
|
|
#include <xrpl/protocol/STLedgerEntry.h>
|
|
#include <xrpl/protocol/Serializer.h>
|
|
#include <xrpl/protocol/TxMeta.h>
|
|
|
|
#include <cstddef>
|
|
#include <cstdint>
|
|
#include <optional>
|
|
#include <string>
|
|
|
|
/**
|
|
* @brief Struct used to keep track of what to write to account_transactions/account_tx tables.
|
|
*/
|
|
struct AccountTransactionsData {
|
|
boost::container::flat_set<xrpl::AccountID> accounts;
|
|
std::uint32_t ledgerSequence{};
|
|
std::uint32_t transactionIndex{};
|
|
xrpl::uint256 txHash;
|
|
|
|
/**
|
|
* @brief Construct a new AccountTransactionsData object
|
|
*
|
|
* @param meta The transaction metadata
|
|
* @param txHash The transaction hash
|
|
*/
|
|
AccountTransactionsData(xrpl::TxMeta const& meta, xrpl::uint256 const& txHash)
|
|
: accounts(meta.getAffectedAccounts())
|
|
, ledgerSequence(meta.getLgrSeq())
|
|
, transactionIndex(meta.getIndex())
|
|
, txHash(txHash)
|
|
{
|
|
}
|
|
|
|
AccountTransactionsData() = default;
|
|
};
|
|
|
|
/**
|
|
* @brief Represents a link from a tx to an NFT that was targeted/modified/created by it.
|
|
*
|
|
* Gets written to nf_token_transactions table and the like.
|
|
*/
|
|
struct NFTTransactionsData {
|
|
xrpl::uint256 tokenID;
|
|
std::uint32_t ledgerSequence;
|
|
std::uint32_t transactionIndex;
|
|
xrpl::uint256 txHash;
|
|
|
|
/**
|
|
* @brief Construct a new NFTTransactionsData object
|
|
*
|
|
* @param tokenID The token ID
|
|
* @param meta The transaction metadata
|
|
* @param txHash The transaction hash
|
|
*/
|
|
NFTTransactionsData(xrpl::uint256 const& tokenID, xrpl::TxMeta const& meta, xrpl::uint256 const& txHash)
|
|
: tokenID(tokenID), ledgerSequence(meta.getLgrSeq()), transactionIndex(meta.getIndex()), txHash(txHash)
|
|
{
|
|
}
|
|
};
|
|
|
|
/**
|
|
* @brief Represents an NFT state at a particular ledger.
|
|
*
|
|
* Gets written to nf_tokens table and the like.
|
|
*
|
|
* The transaction index is only stored because we want to store only the final state of an NFT per ledger.
|
|
* Since we pull this from transactions we keep track of which tx index created this so we can de-duplicate, as it is
|
|
* possible for one ledger to have multiple txs that change the state of the same NFT.
|
|
*
|
|
* We only set the uri if this is a mint tx, or if we are loading initial state from NFTokenPage objects.
|
|
*/
|
|
struct NFTsData {
|
|
xrpl::uint256 tokenID;
|
|
std::uint32_t ledgerSequence;
|
|
std::optional<std::uint32_t> transactionIndex;
|
|
xrpl::AccountID owner;
|
|
std::optional<xrpl::Blob> uri;
|
|
bool isBurned = false;
|
|
bool onlyUriChanged = false; // Whether only the URI was changed
|
|
|
|
/**
|
|
* @brief Construct a new NFTsData object
|
|
*
|
|
* @note This constructor is used when parsing an NFTokenMint tx
|
|
* Unfortunately because of the extreme edge case of being able to re-mint an NFT with the same ID, we must
|
|
* explicitly record a null URI. For this reason, we _always_ write this field as a result of this tx.
|
|
*
|
|
* @param tokenID The token ID
|
|
* @param owner The owner
|
|
* @param uri The URI
|
|
* @param meta The transaction metadata
|
|
*/
|
|
NFTsData(
|
|
xrpl::uint256 const& tokenID,
|
|
xrpl::AccountID const& owner,
|
|
xrpl::Blob const& uri,
|
|
xrpl::TxMeta const& meta
|
|
)
|
|
: tokenID(tokenID), ledgerSequence(meta.getLgrSeq()), transactionIndex(meta.getIndex()), owner(owner), uri(uri)
|
|
{
|
|
}
|
|
|
|
/**
|
|
* @brief Construct a new NFTsData object
|
|
*
|
|
* @note This constructor is used when parsing an NFTokenBurn or NFTokenAcceptOffer tx
|
|
*
|
|
* @param tokenID The token ID
|
|
* @param owner The owner
|
|
* @param meta The transaction metadata
|
|
* @param isBurned Whether the NFT is burned
|
|
*/
|
|
NFTsData(xrpl::uint256 const& tokenID, xrpl::AccountID const& owner, xrpl::TxMeta const& meta, bool isBurned)
|
|
: tokenID(tokenID)
|
|
, ledgerSequence(meta.getLgrSeq())
|
|
, transactionIndex(meta.getIndex())
|
|
, owner(owner)
|
|
, isBurned(isBurned)
|
|
{
|
|
}
|
|
|
|
/**
|
|
* @brief Construct a new NFTsData object
|
|
*
|
|
* @note This constructor is used when parsing an NFTokenPage directly from ledger state.
|
|
* Unfortunately because of the extreme edge case of being able to re-mint an NFT with the same ID, we must
|
|
* explicitly record a null URI. For this reason, we _always_ write this field as a result of this tx.
|
|
*
|
|
* @param tokenID The token ID
|
|
* @param ledgerSequence The ledger sequence
|
|
* @param owner The owner
|
|
* @param uri The URI
|
|
*/
|
|
NFTsData(
|
|
xrpl::uint256 const& tokenID,
|
|
std::uint32_t const ledgerSequence,
|
|
xrpl::AccountID const& owner,
|
|
xrpl::Blob const& uri
|
|
)
|
|
: tokenID(tokenID), ledgerSequence(ledgerSequence), owner(owner), uri(uri)
|
|
{
|
|
}
|
|
|
|
/**
|
|
* @brief Construct a new NFTsData object with only the URI changed
|
|
*
|
|
* @param tokenID The token ID
|
|
* @param meta The transaction metadata
|
|
* @param uri The new URI
|
|
*
|
|
*/
|
|
NFTsData(xrpl::uint256 const& tokenID, xrpl::TxMeta const& meta, xrpl::Blob const& uri)
|
|
: tokenID(tokenID)
|
|
, ledgerSequence(meta.getLgrSeq())
|
|
, transactionIndex(meta.getIndex())
|
|
, uri(uri)
|
|
, onlyUriChanged(true)
|
|
{
|
|
}
|
|
};
|
|
|
|
/**
|
|
* @brief Represents an MPT and holder pair
|
|
*/
|
|
struct MPTHolderData {
|
|
xrpl::uint192 mptID;
|
|
xrpl::AccountID holder;
|
|
};
|
|
|
|
/**
|
|
* @brief Check whether the supplied object is a dir node.
|
|
*
|
|
* @param object The object to check
|
|
* @return true if the object is a dir node; false otherwise
|
|
*/
|
|
template <typename T>
|
|
inline bool
|
|
isDirNode(T const& object)
|
|
{
|
|
static constexpr auto kMIN_SIZE_REQUIRED = 3;
|
|
if (std::size(object) < kMIN_SIZE_REQUIRED)
|
|
return false;
|
|
|
|
static constexpr short kDIR_NODE_SPACE_KEY = 0x0064;
|
|
short const spaceKey = (object.data()[1] << 8) | object.data()[2];
|
|
return spaceKey == kDIR_NODE_SPACE_KEY;
|
|
}
|
|
|
|
/**
|
|
* @brief Check whether the supplied object is a book dir.
|
|
*
|
|
* @param key The key into the object
|
|
* @param object The object to check
|
|
* @return true if the object is a book dir; false otherwise
|
|
*/
|
|
template <typename T, typename R>
|
|
inline bool
|
|
isBookDir(T const& key, R const& object)
|
|
{
|
|
if (!isDirNode(object))
|
|
return false;
|
|
|
|
xrpl::STLedgerEntry const sle{xrpl::SerialIter{object.data(), object.size()}, key};
|
|
return !sle[~xrpl::sfOwner].has_value();
|
|
}
|
|
|
|
/**
|
|
* @brief Get the book base.
|
|
*
|
|
* @param key The key to get the book base out of
|
|
* @return Book base as xrpl::uint256
|
|
*/
|
|
template <typename T>
|
|
inline xrpl::uint256
|
|
getBookBase(T const& key)
|
|
{
|
|
static constexpr size_t kEY_SIZE = 24;
|
|
|
|
ASSERT(key.size() == xrpl::uint256::size(), "Invalid key size {}", key.size());
|
|
|
|
xrpl::uint256 ret;
|
|
for (size_t i = 0; i < kEY_SIZE; ++i)
|
|
ret.data()[i] = key.data()[i];
|
|
|
|
return ret;
|
|
}
|
|
|
|
/**
|
|
* @brief Stringify a xrpl::uint256.
|
|
*
|
|
* @param input The input value
|
|
* @return The input value as a string
|
|
*/
|
|
inline std::string
|
|
uint256ToString(xrpl::uint256 const& input)
|
|
{
|
|
return {reinterpret_cast<char const*>(input.data()), xrpl::uint256::size()};
|
|
}
|
|
|
|
/** @brief The ripple epoch start timestamp. Midnight on 1st January 2000. */
|
|
static constexpr std::uint32_t kRIPPLE_EPOCH_START = 946684800;
|