Interface SetFee
- All Superinterfaces:
Transaction
- All Known Implementing Classes:
ImmutableSetFee
SetFee pseudo-transaction marks a change in transaction cost or reserve requirements as a result of Fee
Voting.- See Also:
-
Field Summary
Fields inherited from interface org.xrpl.xrpl4j.model.transactions.Transaction
typeMap -
Method Summary
Modifier and TypeMethodDescriptiondefault StringbaseFee()The charge, in drops of XRP, for the reference transaction, as hex.The charge, in drops of XRP, for the reference transaction (This is the transaction cost before scaling for load).static ImmutableSetFee.Builderbuilder()Construct a builder for this class.The index of the ledger version where this pseudo-transaction appears.Optional<com.google.common.primitives.UnsignedInteger> The cost, in fee units, of the reference transaction.default com.google.common.primitives.UnsignedIntegerThe base reserve, in drops.The base reserve, as anXrpCurrencyAmount.default com.google.common.primitives.UnsignedIntegerThe incremental reserve, in drops.The incremental reserve, as anXrpCurrencyAmount.Methods inherited from interface org.xrpl.xrpl4j.model.transactions.Transaction
account, accountTransactionId, delegate, fee, lastLedgerSequence, memos, networkId, sequence, signers, signingPublicKey, sourceTag, ticketSequence, transactionFlags, transactionSignature, transactionType, unknownFields, validateDelegateNotSameAsAccount
-
Method Details
-
builder
Construct a builder for this class.- Returns:
- An
ImmutableSetFee.Builder.
-
baseFee
The charge, in drops of XRP, for the reference transaction, as hex. (This is the transaction cost before scaling for load.)This method only exists for historical purposes. When deserialized from a
SetFeetransaction from ledgers prior to theXRPFeesamendment, this field will still be set based onbaseFeeDrops().- Returns:
- A hex
StringbaseFee value.
-
baseFeeDrops
XrpCurrencyAmount baseFeeDrops()The charge, in drops of XRP, for the reference transaction (This is the transaction cost before scaling for load).This field will also be populated with the
BaseFeevalue from anySetFeetransactions that occurred before the XRPFees amendment took effect.- Returns:
- An
XrpCurrencyAmount.
-
referenceFeeUnits
Optional<com.google.common.primitives.UnsignedInteger> referenceFeeUnits()The cost, in fee units, of the reference transaction.SetFeetransactions deserialized from ledgers prior to theXRPFeesamendment will always have this field, but transactions deserialized from ledgers postXRPFeesactivation will never have this field.- Returns:
- An
UnsignedIntegercost of ref transaction.
-
reserveBase
@Derived default com.google.common.primitives.UnsignedInteger reserveBase()The base reserve, in drops.This method only exists for historical purposes. When deserialized from a
SetFeetransaction from ledgers prior to theXRPFeesamendment, this field will still be set based onreserveBaseDrops()}.- Returns:
- An
UnsignedIntegerbase reserve value inFeeDrops.
-
reserveBaseDrops
XrpCurrencyAmount reserveBaseDrops()The base reserve, as anXrpCurrencyAmount.This field will also be populated with the
ReserveBasevalue from anySetFeetransactions that occurred before the XRPFees amendment took effect.- Returns:
- An
XrpCurrencyAmount.
-
reserveIncrement
@Derived default com.google.common.primitives.UnsignedInteger reserveIncrement()The incremental reserve, in drops.This method only exists for historical purposes. When deserialized from a
SetFeetransaction from ledgers prior to theXRPFeesamendment, this field will still be set based onreserveIncrementDrops().- Returns:
- An
UnsignedIntegerincremental reserve inFeeDrops.
-
reserveIncrementDrops
XrpCurrencyAmount reserveIncrementDrops()The incremental reserve, as anXrpCurrencyAmount.This field will also be populated with the
ReserveIncrementvalue from anySetFeetransactions that occurred before the XRPFees amendment took effect.- Returns:
- An
XrpCurrencyAmount.
-
ledgerSequence
Optional<LedgerIndex> ledgerSequence()The index of the ledger version where this pseudo-transaction appears. This distinguishes the pseudo-transaction from other occurrences of the same change. Omitted for some historical SetFee pseudo-transactions hence making it optional.- Returns:
- A
LedgerIndexto indicates where the tx appears.
-