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

// 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 PaymentChannelClaimBuilder;

/**
 * @brief Transaction: PaymentChannelClaim
 *
 * Type: ttPAYCHAN_CLAIM (15)
 * Delegable: Delegation::Delegable
 * Amendment: uint256{}
 * Privileges: NoPriv
 *
 * Immutable wrapper around STTx providing type-safe field access.
 * Use PaymentChannelClaimBuilder to construct new transactions.
 */
class PaymentChannelClaim : public TransactionBase
{
public:
    static constexpr xrpl::TxType txType = ttPAYCHAN_CLAIM;

    /**
     * @brief Construct a PaymentChannelClaim transaction wrapper from an existing STTx object.
     * @throws std::runtime_error if the transaction type doesn't match.
     */
    explicit PaymentChannelClaim(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 PaymentChannelClaim");
        }
    }

    // Transaction-specific field getters

    /**
     * @brief Get sfChannel (SoeRequired)
     * @return The field value.
     */
    [[nodiscard]]
    SF_UINT256::type::value_type
    getChannel() const
    {
        return this->tx_->at(sfChannel);
    }

    /**
     * @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 sfBalance (SoeOptional)
     * @return The field value, or std::nullopt if not present.
     */
    [[nodiscard]]
    protocol_autogen::Optional<SF_AMOUNT::type::value_type>
    getBalance() const
    {
        if (hasBalance())
        {
            return this->tx_->at(sfBalance);
        }
        return std::nullopt;
    }

    /**
     * @brief Check if sfBalance is present.
     * @return True if the field is present, false otherwise.
     */
    [[nodiscard]]
    bool
    hasBalance() const
    {
        return this->tx_->isFieldPresent(sfBalance);
    }

    /**
     * @brief Get sfSignature (SoeOptional)
     * @return The field value, or std::nullopt if not present.
     */
    [[nodiscard]]
    protocol_autogen::Optional<SF_VL::type::value_type>
    getSignature() const
    {
        if (hasSignature())
        {
            return this->tx_->at(sfSignature);
        }
        return std::nullopt;
    }

    /**
     * @brief Check if sfSignature is present.
     * @return True if the field is present, false otherwise.
     */
    [[nodiscard]]
    bool
    hasSignature() const
    {
        return this->tx_->isFieldPresent(sfSignature);
    }

    /**
     * @brief Get sfPublicKey (SoeOptional)
     * @return The field value, or std::nullopt if not present.
     */
    [[nodiscard]]
    protocol_autogen::Optional<SF_VL::type::value_type>
    getPublicKey() const
    {
        if (hasPublicKey())
        {
            return this->tx_->at(sfPublicKey);
        }
        return std::nullopt;
    }

    /**
     * @brief Check if sfPublicKey is present.
     * @return True if the field is present, false otherwise.
     */
    [[nodiscard]]
    bool
    hasPublicKey() const
    {
        return this->tx_->isFieldPresent(sfPublicKey);
    }

    /**
     * @brief Get sfCredentialIDs (SoeOptional)
     * @return The field value, or std::nullopt if not present.
     */
    [[nodiscard]]
    protocol_autogen::Optional<SF_VECTOR256::type::value_type>
    getCredentialIDs() const
    {
        if (hasCredentialIDs())
        {
            return this->tx_->at(sfCredentialIDs);
        }
        return std::nullopt;
    }

    /**
     * @brief Check if sfCredentialIDs is present.
     * @return True if the field is present, false otherwise.
     */
    [[nodiscard]]
    bool
    hasCredentialIDs() const
    {
        return this->tx_->isFieldPresent(sfCredentialIDs);
    }
};

/**
 * @brief Builder for PaymentChannelClaim 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 PaymentChannelClaimBuilder : public TransactionBuilderBase<PaymentChannelClaimBuilder>
{
public:
    /**
     * @brief Construct a new PaymentChannelClaimBuilder with required fields.
     * @param account The account initiating the transaction.
     * @param channel The sfChannel field value.
     * @param sequence Optional sequence number for the transaction.
     * @param fee Optional fee for the transaction.
     */
    PaymentChannelClaimBuilder(SF_ACCOUNT::type::value_type account,
                     std::decay_t<typename SF_UINT256::type::value_type> const& channel,                    std::optional<SF_UINT32::type::value_type> sequence = std::nullopt,
                    std::optional<SF_AMOUNT::type::value_type> fee = std::nullopt
)
        : TransactionBuilderBase<PaymentChannelClaimBuilder>(ttPAYCHAN_CLAIM, account, sequence, fee)
    {
        setChannel(channel);
    }

    /**
     * @brief Construct a PaymentChannelClaimBuilder from an existing STTx object.
     * @param tx The existing transaction to copy from.
     * @throws std::runtime_error if the transaction type doesn't match.
     */
    PaymentChannelClaimBuilder(std::shared_ptr<STTx const> tx)
    {
        if (tx->getTxnType() != ttPAYCHAN_CLAIM)
        {
            throw std::runtime_error("Invalid transaction type for PaymentChannelClaimBuilder");
        }
        object_ = *tx;
    }

    /** @brief Transaction-specific field setters */

    /**
     * @brief Set sfChannel (SoeRequired)
     * @return Reference to this builder for method chaining.
     */
    PaymentChannelClaimBuilder&
    setChannel(std::decay_t<typename SF_UINT256::type::value_type> const& value)
    {
        object_[sfChannel] = value;
        return *this;
    }

    /**
     * @brief Set sfAmount (SoeOptional)
     * @return Reference to this builder for method chaining.
     */
    PaymentChannelClaimBuilder&
    setAmount(std::decay_t<typename SF_AMOUNT::type::value_type> const& value)
    {
        object_[sfAmount] = value;
        return *this;
    }

    /**
     * @brief Set sfBalance (SoeOptional)
     * @return Reference to this builder for method chaining.
     */
    PaymentChannelClaimBuilder&
    setBalance(std::decay_t<typename SF_AMOUNT::type::value_type> const& value)
    {
        object_[sfBalance] = value;
        return *this;
    }

    /**
     * @brief Set sfSignature (SoeOptional)
     * @return Reference to this builder for method chaining.
     */
    PaymentChannelClaimBuilder&
    setSignature(std::decay_t<typename SF_VL::type::value_type> const& value)
    {
        object_[sfSignature] = value;
        return *this;
    }

    /**
     * @brief Set sfPublicKey (SoeOptional)
     * @return Reference to this builder for method chaining.
     */
    PaymentChannelClaimBuilder&
    setPublicKey(std::decay_t<typename SF_VL::type::value_type> const& value)
    {
        object_[sfPublicKey] = value;
        return *this;
    }

    /**
     * @brief Set sfCredentialIDs (SoeOptional)
     * @return Reference to this builder for method chaining.
     */
    PaymentChannelClaimBuilder&
    setCredentialIDs(std::decay_t<typename SF_VECTOR256::type::value_type> const& value)
    {
        object_[sfCredentialIDs] = value;
        return *this;
    }

    /**
     * @brief Build and return the PaymentChannelClaim wrapper.
     * @param publicKey The public key for signing.
     * @param secretKey The secret key for signing.
     * @return The constructed transaction wrapper.
     */
    PaymentChannelClaim
    build(PublicKey const& publicKey, SecretKey const& secretKey)
    {
        sign(publicKey, secretKey);
        return PaymentChannelClaim{std::make_shared<STTx>(std::move(object_))};
    }
};

}  // namespace xrpl::transactions