Interface SetFee

All Superinterfaces:
Transaction
All Known Implementing Classes:
ImmutableSetFee

@Immutable public interface SetFee extends Transaction
A SetFee pseudo-transaction marks a change in transaction cost or reserve requirements as a result of Fee Voting.
See Also:
  • "https://xrpl.org/setfee.html"
  • Method Details

    • builder

      static ImmutableSetFee.Builder builder()
      Construct a builder for this class.
      Returns:
      An ImmutableSetFee.Builder.
    • baseFee

      @Derived default String 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 SetFee transaction from ledgers prior to the XRPFees amendment, this field will still be set based on baseFeeDrops().

      Returns:
      A hex String baseFee 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 BaseFee value from any SetFee transactions 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. SetFee transactions deserialized from ledgers prior to the XRPFees amendment will always have this field, but transactions deserialized from ledgers post XRPFees activation will never have this field.
      Returns:
      An UnsignedInteger cost 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 SetFee transaction from ledgers prior to the XRPFees amendment, this field will still be set based on reserveBaseDrops()}.

      Returns:
      An UnsignedInteger base reserve value in FeeDrops.
    • reserveBaseDrops

      XrpCurrencyAmount reserveBaseDrops()
      The base reserve, as an XrpCurrencyAmount.

      This field will also be populated with the ReserveBase value from any SetFee transactions 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 SetFee transaction from ledgers prior to the XRPFees amendment, this field will still be set based on reserveIncrementDrops().

      Returns:
      An UnsignedInteger incremental reserve in FeeDrops.
    • reserveIncrementDrops

      XrpCurrencyAmount reserveIncrementDrops()
      The incremental reserve, as an XrpCurrencyAmount.

      This field will also be populated with the ReserveIncrement value from any SetFee transactions 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 LedgerIndex to indicates where the tx appears.