rippled/include/xrpl/protocol_autogen/transactions/OracleSet.h

#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>

# cspell:words equalto

namespace xrpl::transactions {

// Forward declaration
class OracleSetBuilder;

/**
 * Transaction: OracleSet
 * Type: ttORACLE_SET (51)
 * Delegable: Delegation::delegable
 * Amendment: featurePriceOracle
 * Privileges: noPriv
 *
 * Immutable wrapper around STTx providing type-safe field access.
 * Use OracleSetBuilder to construct new transactions.
 */
class OracleSet : public TransactionBase
{
public:
    static constexpr xrpl::TxType txType = ttORACLE_SET;

    /**
     * Construct a OracleSet transaction wrapper from an existing STTx object.
     * @throws std::runtime_error if the transaction type doesn't match.
     */
    explicit OracleSet(STTx const& tx)
        : TransactionBase(tx)
    {
        // Verify transaction type
        if (tx.getTxnType() != txType)
        {
            throw std::runtime_error("Invalid transaction type for OracleSet");
        }
    }

    // Transaction-specific field getters

    /**
     * Get sfOracleDocumentID (soeREQUIRED)
     */
    [[nodiscard]]
    SF_UINT32::type::value_type
    getOracleDocumentID() const
    {
        return this->tx_.at(sfOracleDocumentID);
    }

    /**
     * Get sfProvider (soeOPTIONAL)
     */
    [[nodiscard]]
    protocol_autogen::Optional<SF_VL::type::value_type>
    getProvider() const
    {
        if (hasProvider())
        {
            return this->tx_.at(sfProvider);
        }
        return std::nullopt;
    }

    [[nodiscard]]
    bool
    hasProvider() const
    {
        return this->tx_.isFieldPresent(sfProvider);
    }

    /**
     * Get sfURI (soeOPTIONAL)
     */
    [[nodiscard]]
    protocol_autogen::Optional<SF_VL::type::value_type>
    getURI() const
    {
        if (hasURI())
        {
            return this->tx_.at(sfURI);
        }
        return std::nullopt;
    }

    [[nodiscard]]
    bool
    hasURI() const
    {
        return this->tx_.isFieldPresent(sfURI);
    }

    /**
     * Get sfAssetClass (soeOPTIONAL)
     */
    [[nodiscard]]
    protocol_autogen::Optional<SF_VL::type::value_type>
    getAssetClass() const
    {
        if (hasAssetClass())
        {
            return this->tx_.at(sfAssetClass);
        }
        return std::nullopt;
    }

    [[nodiscard]]
    bool
    hasAssetClass() const
    {
        return this->tx_.isFieldPresent(sfAssetClass);
    }

    /**
     * Get sfLastUpdateTime (soeREQUIRED)
     */
    [[nodiscard]]
    SF_UINT32::type::value_type
    getLastUpdateTime() const
    {
        return this->tx_.at(sfLastUpdateTime);
    }
    /**
     * Get sfPriceDataSeries (soeREQUIRED)
     * Note: This is an untyped field
     */
    [[nodiscard]]
    STArray const&
    getPriceDataSeries() const
    {
        return this->tx_.getFieldArray(sfPriceDataSeries);
    }
};

/**
 * Builder for OracleSet 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 OracleSetBuilder : public TransactionBuilderBase<OracleSetBuilder>
{
public:
    OracleSetBuilder(SF_ACCOUNT::type::value_type account,
                     SF_UINT32::type::value_type sequence,
                     SF_AMOUNT::type::value_type fee,
                     SF_VL::type::value_type signingPubKey,
                     std::decay_t<typename SF_UINT32::type::value_type> const& oracleDocumentID,
                     std::decay_t<typename SF_UINT32::type::value_type> const& lastUpdateTime,
                     STArray const& priceDataSeries)
        : TransactionBuilderBase<OracleSetBuilder>(account, sequence, fee, signingPubKey, ttORACLE_SET)
    {
        setOracleDocumentID(oracleDocumentID);
        setLastUpdateTime(lastUpdateTime);
        setPriceDataSeries(priceDataSeries);
    }

    OracleSetBuilder(STTx const& tx)
    {
        if (tx.getTxnType() != ttORACLE_SET)
        {
            throw std::runtime_error("Invalid transaction type for OracleSetBuilder");
        }
        object_ = tx;
    }

    // Transaction-specific field setters

    /**
     * Set sfOracleDocumentID (soeREQUIRED)
     * @return Reference to this builder for method chaining.
     */
    OracleSetBuilder&
    setOracleDocumentID(std::decay_t<typename SF_UINT32::type::value_type> const& value)
    {
        object_[sfOracleDocumentID] = value;
        return *this;
    }

    /**
     * Set sfProvider (soeOPTIONAL)
     * @return Reference to this builder for method chaining.
     */
    OracleSetBuilder&
    setProvider(std::decay_t<typename SF_VL::type::value_type> const& value)
    {
        object_[sfProvider] = value;
        return *this;
    }

    /**
     * Set sfURI (soeOPTIONAL)
     * @return Reference to this builder for method chaining.
     */
    OracleSetBuilder&
    setURI(std::decay_t<typename SF_VL::type::value_type> const& value)
    {
        object_[sfURI] = value;
        return *this;
    }

    /**
     * Set sfAssetClass (soeOPTIONAL)
     * @return Reference to this builder for method chaining.
     */
    OracleSetBuilder&
    setAssetClass(std::decay_t<typename SF_VL::type::value_type> const& value)
    {
        object_[sfAssetClass] = value;
        return *this;
    }

    /**
     * Set sfLastUpdateTime (soeREQUIRED)
     * @return Reference to this builder for method chaining.
     */
    OracleSetBuilder&
    setLastUpdateTime(std::decay_t<typename SF_UINT32::type::value_type> const& value)
    {
        object_[sfLastUpdateTime] = value;
        return *this;
    }

    /**
     * Set sfPriceDataSeries (soeREQUIRED)
     * @return Reference to this builder for method chaining.
     */
    OracleSetBuilder&
    setPriceDataSeries(STArray const& value)
    {
        object_.setFieldArray(sfPriceDataSeries, value);
        return *this;
    }

    /**
     * Build and return the completed OracleSet wrapper.
     * @return The constructed transaction wrapper.
     * @throws std::runtime_error if the JSON cannot be parsed into a valid transaction.
     */
    OracleSet
    build()
    {
        return OracleSet(STTx(std::move(object_)));
    }
};

}  // namespace xrpl::transactions