Files
rippled/include/xrpl/protocol_autogen/transactions/NFTokenMint.h

352 lines
9.2 KiB
C++

// This file is auto-generated. Do not edit.
#pragma once
#include <xrpl/protocol/STTx.h>
#include <xrpl/protocol/STParsedJSON.h>
#include <xrpl/protocol/jss.h>
#include <xrpl/protocol_autogen/TransactionBase.h>
#include <xrpl/protocol_autogen/TransactionBuilderBase.h>
#include <xrpl/json/json_value.h>
#include <stdexcept>
#include <optional>
namespace xrpl::transactions {
class NFTokenMintBuilder;
/**
* @brief Transaction: NFTokenMint
*
* Type: ttNFTOKEN_MINT (25)
* Delegable: Delegation::Delegable
* Amendment: uint256{}
* Privileges: ChangeNftCounts
*
* Immutable wrapper around STTx providing type-safe field access.
* Use NFTokenMintBuilder to construct new transactions.
*/
class NFTokenMint : public TransactionBase
{
public:
static constexpr xrpl::TxType txType = ttNFTOKEN_MINT;
/**
* @brief Construct a NFTokenMint transaction wrapper from an existing STTx object.
* @throws std::runtime_error if the transaction type doesn't match.
*/
explicit NFTokenMint(std::shared_ptr<STTx const> tx)
: TransactionBase(std::move(tx))
{
// Verify transaction type
if (tx_->getTxnType() != txType)
{
throw std::runtime_error("Invalid transaction type for NFTokenMint");
}
}
// Transaction-specific field getters
/**
* @brief Get sfNFTokenTaxon (SoeRequired)
* @return The field value.
*/
[[nodiscard]]
SF_UINT32::type::value_type
getNFTokenTaxon() const
{
return this->tx_->at(sfNFTokenTaxon);
}
/**
* @brief Get sfTransferFee (SoeOptional)
* @return The field value, or std::nullopt if not present.
*/
[[nodiscard]]
protocol_autogen::Optional<SF_UINT16::type::value_type>
getTransferFee() const
{
if (hasTransferFee())
{
return this->tx_->at(sfTransferFee);
}
return std::nullopt;
}
/**
* @brief Check if sfTransferFee is present.
* @return True if the field is present, false otherwise.
*/
[[nodiscard]]
bool
hasTransferFee() const
{
return this->tx_->isFieldPresent(sfTransferFee);
}
/**
* @brief Get sfIssuer (SoeOptional)
* @return The field value, or std::nullopt if not present.
*/
[[nodiscard]]
protocol_autogen::Optional<SF_ACCOUNT::type::value_type>
getIssuer() const
{
if (hasIssuer())
{
return this->tx_->at(sfIssuer);
}
return std::nullopt;
}
/**
* @brief Check if sfIssuer is present.
* @return True if the field is present, false otherwise.
*/
[[nodiscard]]
bool
hasIssuer() const
{
return this->tx_->isFieldPresent(sfIssuer);
}
/**
* @brief Get sfURI (SoeOptional)
* @return The field value, or std::nullopt if not present.
*/
[[nodiscard]]
protocol_autogen::Optional<SF_VL::type::value_type>
getURI() const
{
if (hasURI())
{
return this->tx_->at(sfURI);
}
return std::nullopt;
}
/**
* @brief Check if sfURI is present.
* @return True if the field is present, false otherwise.
*/
[[nodiscard]]
bool
hasURI() const
{
return this->tx_->isFieldPresent(sfURI);
}
/**
* @brief Get sfAmount (SoeOptional)
* @return The field value, or std::nullopt if not present.
*/
[[nodiscard]]
protocol_autogen::Optional<SF_AMOUNT::type::value_type>
getAmount() const
{
if (hasAmount())
{
return this->tx_->at(sfAmount);
}
return std::nullopt;
}
/**
* @brief Check if sfAmount is present.
* @return True if the field is present, false otherwise.
*/
[[nodiscard]]
bool
hasAmount() const
{
return this->tx_->isFieldPresent(sfAmount);
}
/**
* @brief Get sfDestination (SoeOptional)
* @return The field value, or std::nullopt if not present.
*/
[[nodiscard]]
protocol_autogen::Optional<SF_ACCOUNT::type::value_type>
getDestination() const
{
if (hasDestination())
{
return this->tx_->at(sfDestination);
}
return std::nullopt;
}
/**
* @brief Check if sfDestination is present.
* @return True if the field is present, false otherwise.
*/
[[nodiscard]]
bool
hasDestination() const
{
return this->tx_->isFieldPresent(sfDestination);
}
/**
* @brief Get sfExpiration (SoeOptional)
* @return The field value, or std::nullopt if not present.
*/
[[nodiscard]]
protocol_autogen::Optional<SF_UINT32::type::value_type>
getExpiration() const
{
if (hasExpiration())
{
return this->tx_->at(sfExpiration);
}
return std::nullopt;
}
/**
* @brief Check if sfExpiration is present.
* @return True if the field is present, false otherwise.
*/
[[nodiscard]]
bool
hasExpiration() const
{
return this->tx_->isFieldPresent(sfExpiration);
}
};
/**
* @brief Builder for NFTokenMint transactions.
*
* Provides a fluent interface for constructing transactions with method chaining.
* Uses STObject internally for flexible transaction construction.
* Inherits common field setters from TransactionBuilderBase.
*/
class NFTokenMintBuilder : public TransactionBuilderBase<NFTokenMintBuilder>
{
public:
/**
* @brief Construct a new NFTokenMintBuilder with required fields.
* @param account The account initiating the transaction.
* @param nFTokenTaxon The sfNFTokenTaxon field value.
* @param sequence Optional sequence number for the transaction.
* @param fee Optional fee for the transaction.
*/
NFTokenMintBuilder(SF_ACCOUNT::type::value_type account,
std::decay_t<typename SF_UINT32::type::value_type> const& nFTokenTaxon, std::optional<SF_UINT32::type::value_type> sequence = std::nullopt,
std::optional<SF_AMOUNT::type::value_type> fee = std::nullopt
)
: TransactionBuilderBase<NFTokenMintBuilder>(ttNFTOKEN_MINT, account, sequence, fee)
{
setNFTokenTaxon(nFTokenTaxon);
}
/**
* @brief Construct a NFTokenMintBuilder from an existing STTx object.
* @param tx The existing transaction to copy from.
* @throws std::runtime_error if the transaction type doesn't match.
*/
NFTokenMintBuilder(std::shared_ptr<STTx const> tx)
{
if (tx->getTxnType() != ttNFTOKEN_MINT)
{
throw std::runtime_error("Invalid transaction type for NFTokenMintBuilder");
}
object_ = *tx;
}
/** @brief Transaction-specific field setters */
/**
* @brief Set sfNFTokenTaxon (SoeRequired)
* @return Reference to this builder for method chaining.
*/
NFTokenMintBuilder&
setNFTokenTaxon(std::decay_t<typename SF_UINT32::type::value_type> const& value)
{
object_[sfNFTokenTaxon] = value;
return *this;
}
/**
* @brief Set sfTransferFee (SoeOptional)
* @return Reference to this builder for method chaining.
*/
NFTokenMintBuilder&
setTransferFee(std::decay_t<typename SF_UINT16::type::value_type> const& value)
{
object_[sfTransferFee] = value;
return *this;
}
/**
* @brief Set sfIssuer (SoeOptional)
* @return Reference to this builder for method chaining.
*/
NFTokenMintBuilder&
setIssuer(std::decay_t<typename SF_ACCOUNT::type::value_type> const& value)
{
object_[sfIssuer] = value;
return *this;
}
/**
* @brief Set sfURI (SoeOptional)
* @return Reference to this builder for method chaining.
*/
NFTokenMintBuilder&
setURI(std::decay_t<typename SF_VL::type::value_type> const& value)
{
object_[sfURI] = value;
return *this;
}
/**
* @brief Set sfAmount (SoeOptional)
* @return Reference to this builder for method chaining.
*/
NFTokenMintBuilder&
setAmount(std::decay_t<typename SF_AMOUNT::type::value_type> const& value)
{
object_[sfAmount] = value;
return *this;
}
/**
* @brief Set sfDestination (SoeOptional)
* @return Reference to this builder for method chaining.
*/
NFTokenMintBuilder&
setDestination(std::decay_t<typename SF_ACCOUNT::type::value_type> const& value)
{
object_[sfDestination] = value;
return *this;
}
/**
* @brief Set sfExpiration (SoeOptional)
* @return Reference to this builder for method chaining.
*/
NFTokenMintBuilder&
setExpiration(std::decay_t<typename SF_UINT32::type::value_type> const& value)
{
object_[sfExpiration] = value;
return *this;
}
/**
* @brief Build and return the NFTokenMint wrapper.
* @param publicKey The public key for signing.
* @param secretKey The secret key for signing.
* @return The constructed transaction wrapper.
*/
NFTokenMint
build(PublicKey const& publicKey, SecretKey const& secretKey)
{
sign(publicKey, secretKey);
return NFTokenMint{std::make_shared<STTx>(std::move(object_))};
}
};
} // namespace xrpl::transactions