mirror of
https://github.com/XRPLF/rippled.git
synced 2026-04-08 21:12:32 +00:00
Signed-off-by: JCW <a1q123456@users.noreply.github.com> Co-authored-by: Bart <bthomee@users.noreply.github.com>
228 lines
6.5 KiB
C++
228 lines
6.5 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 CredentialCreateBuilder;
|
|
|
|
/**
|
|
* @brief Transaction: CredentialCreate
|
|
*
|
|
* Type: ttCREDENTIAL_CREATE (58)
|
|
* Delegable: Delegation::delegable
|
|
* Amendment: featureCredentials
|
|
* Privileges: noPriv
|
|
*
|
|
* Immutable wrapper around STTx providing type-safe field access.
|
|
* Use CredentialCreateBuilder to construct new transactions.
|
|
*/
|
|
class CredentialCreate : public TransactionBase
|
|
{
|
|
public:
|
|
static constexpr xrpl::TxType txType = ttCREDENTIAL_CREATE;
|
|
|
|
/**
|
|
* @brief Construct a CredentialCreate transaction wrapper from an existing STTx object.
|
|
* @throws std::runtime_error if the transaction type doesn't match.
|
|
*/
|
|
explicit CredentialCreate(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 CredentialCreate");
|
|
}
|
|
}
|
|
|
|
// Transaction-specific field getters
|
|
|
|
/**
|
|
* @brief Get sfSubject (soeREQUIRED)
|
|
* @return The field value.
|
|
*/
|
|
[[nodiscard]]
|
|
SF_ACCOUNT::type::value_type
|
|
getSubject() const
|
|
{
|
|
return this->tx_->at(sfSubject);
|
|
}
|
|
|
|
/**
|
|
* @brief Get sfCredentialType (soeREQUIRED)
|
|
* @return The field value.
|
|
*/
|
|
[[nodiscard]]
|
|
SF_VL::type::value_type
|
|
getCredentialType() const
|
|
{
|
|
return this->tx_->at(sfCredentialType);
|
|
}
|
|
|
|
/**
|
|
* @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 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 Builder for CredentialCreate transactions.
|
|
*
|
|
* Provides a fluent interface for constructing transactions with method chaining.
|
|
* Uses Json::Value internally for flexible transaction construction.
|
|
* Inherits common field setters from TransactionBuilderBase.
|
|
*/
|
|
class CredentialCreateBuilder : public TransactionBuilderBase<CredentialCreateBuilder>
|
|
{
|
|
public:
|
|
/**
|
|
* @brief Construct a new CredentialCreateBuilder with required fields.
|
|
* @param account The account initiating the transaction.
|
|
* @param subject The sfSubject field value.
|
|
* @param credentialType The sfCredentialType field value.
|
|
* @param sequence Optional sequence number for the transaction.
|
|
* @param fee Optional fee for the transaction.
|
|
*/
|
|
CredentialCreateBuilder(SF_ACCOUNT::type::value_type account,
|
|
std::decay_t<typename SF_ACCOUNT::type::value_type> const& subject, std::decay_t<typename SF_VL::type::value_type> const& credentialType, std::optional<SF_UINT32::type::value_type> sequence = std::nullopt,
|
|
std::optional<SF_AMOUNT::type::value_type> fee = std::nullopt
|
|
)
|
|
: TransactionBuilderBase<CredentialCreateBuilder>(ttCREDENTIAL_CREATE, account, sequence, fee)
|
|
{
|
|
setSubject(subject);
|
|
setCredentialType(credentialType);
|
|
}
|
|
|
|
/**
|
|
* @brief Construct a CredentialCreateBuilder from an existing STTx object.
|
|
* @param tx The existing transaction to copy from.
|
|
* @throws std::runtime_error if the transaction type doesn't match.
|
|
*/
|
|
CredentialCreateBuilder(std::shared_ptr<STTx const> tx)
|
|
{
|
|
if (tx->getTxnType() != ttCREDENTIAL_CREATE)
|
|
{
|
|
throw std::runtime_error("Invalid transaction type for CredentialCreateBuilder");
|
|
}
|
|
object_ = *tx;
|
|
}
|
|
|
|
/** @brief Transaction-specific field setters */
|
|
|
|
/**
|
|
* @brief Set sfSubject (soeREQUIRED)
|
|
* @return Reference to this builder for method chaining.
|
|
*/
|
|
CredentialCreateBuilder&
|
|
setSubject(std::decay_t<typename SF_ACCOUNT::type::value_type> const& value)
|
|
{
|
|
object_[sfSubject] = value;
|
|
return *this;
|
|
}
|
|
|
|
/**
|
|
* @brief Set sfCredentialType (soeREQUIRED)
|
|
* @return Reference to this builder for method chaining.
|
|
*/
|
|
CredentialCreateBuilder&
|
|
setCredentialType(std::decay_t<typename SF_VL::type::value_type> const& value)
|
|
{
|
|
object_[sfCredentialType] = value;
|
|
return *this;
|
|
}
|
|
|
|
/**
|
|
* @brief Set sfExpiration (soeOPTIONAL)
|
|
* @return Reference to this builder for method chaining.
|
|
*/
|
|
CredentialCreateBuilder&
|
|
setExpiration(std::decay_t<typename SF_UINT32::type::value_type> const& value)
|
|
{
|
|
object_[sfExpiration] = value;
|
|
return *this;
|
|
}
|
|
|
|
/**
|
|
* @brief Set sfURI (soeOPTIONAL)
|
|
* @return Reference to this builder for method chaining.
|
|
*/
|
|
CredentialCreateBuilder&
|
|
setURI(std::decay_t<typename SF_VL::type::value_type> const& value)
|
|
{
|
|
object_[sfURI] = value;
|
|
return *this;
|
|
}
|
|
|
|
/**
|
|
* @brief Build and return the CredentialCreate wrapper.
|
|
* @param publicKey The public key for signing.
|
|
* @param secretKey The secret key for signing.
|
|
* @return The constructed transaction wrapper.
|
|
*/
|
|
CredentialCreate
|
|
build(PublicKey const& publicKey, SecretKey const& secretKey)
|
|
{
|
|
sign(publicKey, secretKey);
|
|
return CredentialCreate{std::make_shared<STTx>(std::move(object_))};
|
|
}
|
|
};
|
|
|
|
} // namespace xrpl::transactions
|