Interface OfferCreate

All Superinterfaces:
Transaction
All Known Implementing Classes:
ImmutableOfferCreate

@Immutable public interface OfferCreate extends Transaction
An OfferCreate transaction is effectively a limit order. It defines an intent to exchange currencies, and creates an offer object if not completely fulfilled when placed. Offers can be partially fulfilled.
See Also:
  • "https://xrpl.org/offercreate.html"
  • Method Details

    • builder

      static ImmutableOfferCreate.Builder builder()
      Construct a builder for this class.
      Returns:
      An ImmutableOfferCreate.Builder.
    • flags

      @Default default OfferCreateFlags flags()
      Set of OfferCreateFlagss for this OfferCreate.
      Returns:
      The OfferCreateFlags for this transaction.
    • offerSequence

      Optional<com.google.common.primitives.UnsignedInteger> offerSequence()
      An offer to delete first, specified in the same way as an Offer Cancel.
      Returns:
      An Optional of type UnsignedInteger representing the offer sequence.
    • takerPays

      CurrencyAmount takerPays()
      The amount and type of currency being requested by the offer creator.
      Returns:
      A CurrencyAmount representing the amount being requested.
    • takerGets

      CurrencyAmount takerGets()
      The amount and type of currency being provided by the offer creator.
      Returns:
      A CurrencyAmount representing the amount being offered.
    • expiration

      Optional<com.google.common.primitives.UnsignedInteger> expiration()
      Time after which the Check is no longer valid, in seconds since the Ripple Epoch.
      Returns:
      An Optional of type UnsignedInteger representing the expiration time.
    • domainId

      Optional<Hash256> domainId()
      The permissioned domain that the offer must be a part of.
      Returns:
      A Hash256 representing DomainID.
    • check

      @Check default void check()
      Validates tfHybrid flag cannot be set if the offer doesn't have a DomainID.