// This file is auto-generated. Do not edit. #pragma once #include #include #include #include #include #include #include #include namespace xrpl::transactions { class CheckCashBuilder; /** * @brief Transaction: CheckCash * * Type: ttCHECK_CASH (17) * Delegable: Delegation::delegable * Amendment: uint256{} * Privileges: mayCreateMPT * * Immutable wrapper around STTx providing type-safe field access. * Use CheckCashBuilder to construct new transactions. */ class CheckCash : public TransactionBase { public: static constexpr xrpl::TxType txType = ttCHECK_CASH; /** * @brief Construct a CheckCash transaction wrapper from an existing STTx object. * @throws std::runtime_error if the transaction type doesn't match. */ explicit CheckCash(std::shared_ptr tx) : TransactionBase(std::move(tx)) { // Verify transaction type if (tx_->getTxnType() != txType) { throw std::runtime_error("Invalid transaction type for CheckCash"); } } // Transaction-specific field getters /** * @brief Get sfCheckID (soeREQUIRED) * @return The field value. */ [[nodiscard]] SF_UINT256::type::value_type getCheckID() const { return this->tx_->at(sfCheckID); } /** * @brief Get sfAmount (soeOPTIONAL) * @note This field supports MPT (Multi-Purpose Token) amounts. * @return The field value, or std::nullopt if not present. */ [[nodiscard]] protocol_autogen::Optional 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 sfDeliverMin (soeOPTIONAL) * @note This field supports MPT (Multi-Purpose Token) amounts. * @return The field value, or std::nullopt if not present. */ [[nodiscard]] protocol_autogen::Optional getDeliverMin() const { if (hasDeliverMin()) { return this->tx_->at(sfDeliverMin); } return std::nullopt; } /** * @brief Check if sfDeliverMin is present. * @return True if the field is present, false otherwise. */ [[nodiscard]] bool hasDeliverMin() const { return this->tx_->isFieldPresent(sfDeliverMin); } }; /** * @brief Builder for CheckCash 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 CheckCashBuilder : public TransactionBuilderBase { public: /** * @brief Construct a new CheckCashBuilder with required fields. * @param account The account initiating the transaction. * @param checkID The sfCheckID field value. * @param sequence Optional sequence number for the transaction. * @param fee Optional fee for the transaction. */ CheckCashBuilder(SF_ACCOUNT::type::value_type account, std::decay_t const& checkID, std::optional sequence = std::nullopt, std::optional fee = std::nullopt ) : TransactionBuilderBase(ttCHECK_CASH, account, sequence, fee) { setCheckID(checkID); } /** * @brief Construct a CheckCashBuilder from an existing STTx object. * @param tx The existing transaction to copy from. * @throws std::runtime_error if the transaction type doesn't match. */ CheckCashBuilder(std::shared_ptr tx) { if (tx->getTxnType() != ttCHECK_CASH) { throw std::runtime_error("Invalid transaction type for CheckCashBuilder"); } object_ = *tx; } /** @brief Transaction-specific field setters */ /** * @brief Set sfCheckID (soeREQUIRED) * @return Reference to this builder for method chaining. */ CheckCashBuilder& setCheckID(std::decay_t const& value) { object_[sfCheckID] = value; return *this; } /** * @brief Set sfAmount (soeOPTIONAL) * @note This field supports MPT (Multi-Purpose Token) amounts. * @return Reference to this builder for method chaining. */ CheckCashBuilder& setAmount(std::decay_t const& value) { object_[sfAmount] = value; return *this; } /** * @brief Set sfDeliverMin (soeOPTIONAL) * @note This field supports MPT (Multi-Purpose Token) amounts. * @return Reference to this builder for method chaining. */ CheckCashBuilder& setDeliverMin(std::decay_t const& value) { object_[sfDeliverMin] = value; return *this; } /** * @brief Build and return the CheckCash wrapper. * @param publicKey The public key for signing. * @param secretKey The secret key for signing. * @return The constructed transaction wrapper. */ CheckCash build(PublicKey const& publicKey, SecretKey const& secretKey) { sign(publicKey, secretKey); return CheckCash{std::make_shared(std::move(object_))}; } }; } // namespace xrpl::transactions