Record Class FundingRate

java.lang.Object
java.lang.Record
com.wualabs.qtsurfer.engine.core.FundingRate
public record FundingRate(Instrument instrument, BigDecimal rate1h, BigDecimal rate8h, long effectiveMinutes, long timestamp) extends Record
Engine-owned, exchange-agnostic funding rate (perpetual-swap funding). Canonical precision model mirroring the fields the engine consumes: the 1h-normalized rate, the base (8h) rate, minutes until the next funding event, and the observation timestamp.

Pure domain record with no XChange dependency. Conversion to/from XChange DTOs lives in the exchange-adapter boundary (XChangeConvert in qtsurfer-engine-exchange). Rates may be null when the source does not report them.

  • Constructor Details

    • FundingRate

      public FundingRate(Instrument instrument, BigDecimal rate1h, BigDecimal rate8h, long effectiveMinutes, long timestamp)
      Creates an instance of a FundingRate record class.
      Parameters:
      instrument - the value for the instrument record component
      rate1h - the value for the rate1h record component
      rate8h - the value for the rate8h record component
      effectiveMinutes - the value for the effectiveMinutes record component
      timestamp - the value for the timestamp record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • instrument

      public Instrument instrument()
      Returns the value of the instrument record component.
      Returns:
      the value of the instrument record component

    • rate1h

      public BigDecimal rate1h()
      Returns the value of the rate1h record component.
      Returns:
      the value of the rate1h record component

    • rate8h

      public BigDecimal rate8h()
      Returns the value of the rate8h record component.
      Returns:
      the value of the rate8h record component

    • effectiveMinutes

      public long effectiveMinutes()
      Returns the value of the effectiveMinutes record component.
      Returns:
      the value of the effectiveMinutes record component

    • timestamp

      public long timestamp()
      Returns the value of the timestamp record component.
      Returns:
      the value of the timestamp record component