Files
rippled/include/xrpl/protocol_autogen/transactions/XChainModifyBridge.h
2026-03-03 15:57:27 +00:00

179 lines
4.9 KiB
C++

#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 XChainModifyBridgeBuilder;
/**
* Transaction: XChainModifyBridge
* Type: ttXCHAIN_MODIFY_BRIDGE (47)
* Delegable: Delegation::delegable
* Amendment: featureXChainBridge
* Privileges: noPriv
*
* Immutable wrapper around STTx providing type-safe field access.
* Use XChainModifyBridgeBuilder to construct new transactions.
*/
class XChainModifyBridge : public TransactionBase
{
public:
static constexpr xrpl::TxType txType = ttXCHAIN_MODIFY_BRIDGE;
/**
* Construct a XChainModifyBridge transaction wrapper from an existing STTx object.
* @throws std::runtime_error if the transaction type doesn't match.
*/
explicit XChainModifyBridge(STTx const& tx)
: TransactionBase(tx)
{
// Verify transaction type
if (tx.getTxnType() != txType)
{
throw std::runtime_error("Invalid transaction type for XChainModifyBridge");
}
}
// Transaction-specific field getters
/**
* Get sfXChainBridge (soeREQUIRED)
*/
[[nodiscard]]
SF_XCHAIN_BRIDGE::type::value_type
getXChainBridge() const
{
return this->tx_.at(sfXChainBridge);
}
/**
* Get sfSignatureReward (soeOPTIONAL)
*/
[[nodiscard]]
protocol_autogen::Optional<SF_AMOUNT::type::value_type>
getSignatureReward() const
{
if (hasSignatureReward())
{
return this->tx_.at(sfSignatureReward);
}
return std::nullopt;
}
[[nodiscard]]
bool
hasSignatureReward() const
{
return this->tx_.isFieldPresent(sfSignatureReward);
}
/**
* Get sfMinAccountCreateAmount (soeOPTIONAL)
*/
[[nodiscard]]
protocol_autogen::Optional<SF_AMOUNT::type::value_type>
getMinAccountCreateAmount() const
{
if (hasMinAccountCreateAmount())
{
return this->tx_.at(sfMinAccountCreateAmount);
}
return std::nullopt;
}
[[nodiscard]]
bool
hasMinAccountCreateAmount() const
{
return this->tx_.isFieldPresent(sfMinAccountCreateAmount);
}
};
/**
* Builder for XChainModifyBridge 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 XChainModifyBridgeBuilder : public TransactionBuilderBase<XChainModifyBridgeBuilder>
{
public:
XChainModifyBridgeBuilder(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_XCHAIN_BRIDGE::type::value_type> const& xChainBridge)
: TransactionBuilderBase<XChainModifyBridgeBuilder>(account, sequence, fee, signingPubKey, ttXCHAIN_MODIFY_BRIDGE)
{
setXChainBridge(xChainBridge);
}
XChainModifyBridgeBuilder(STTx const& tx)
{
if (tx.getTxnType() != ttXCHAIN_MODIFY_BRIDGE)
{
throw std::runtime_error("Invalid transaction type for XChainModifyBridgeBuilder");
}
object_ = tx;
}
// Transaction-specific field setters
/**
* Set sfXChainBridge (soeREQUIRED)
* @return Reference to this builder for method chaining.
*/
XChainModifyBridgeBuilder&
setXChainBridge(std::decay_t<typename SF_XCHAIN_BRIDGE::type::value_type> const& value)
{
object_[sfXChainBridge] = value;
return *this;
}
/**
* Set sfSignatureReward (soeOPTIONAL)
* @return Reference to this builder for method chaining.
*/
XChainModifyBridgeBuilder&
setSignatureReward(std::decay_t<typename SF_AMOUNT::type::value_type> const& value)
{
object_[sfSignatureReward] = value;
return *this;
}
/**
* Set sfMinAccountCreateAmount (soeOPTIONAL)
* @return Reference to this builder for method chaining.
*/
XChainModifyBridgeBuilder&
setMinAccountCreateAmount(std::decay_t<typename SF_AMOUNT::type::value_type> const& value)
{
object_[sfMinAccountCreateAmount] = value;
return *this;
}
/**
* Build and return the completed XChainModifyBridge wrapper.
* @return The constructed transaction wrapper.
* @throws std::runtime_error if the JSON cannot be parsed into a valid transaction.
*/
XChainModifyBridge
build()
{
return XChainModifyBridge(STTx(std::move(object_)));
}
};
} // namespace xrpl::transactions