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