Package org.xrpl.xrpl4j.model.ledger

Interface OfferObject

All Superinterfaces:
LedgerObject
All Known Implementing Classes:
ImmutableOfferObject
@Immutable public interface OfferObject extends LedgerObject
The Offer object type describes an offer to exchange currencies, more traditionally known as an order.
See Also:
  • "https://xrpl.org/offer.html"

  • Method Details

    • builder

      static ImmutableOfferObject.Builder builder()
      Construct a builder for this class.
      Returns:
      An ImmutableOfferObject.Builder.

    • ledgerEntryType

      @Derived default LedgerObject.LedgerEntryType ledgerEntryType()
      The value 0x006F, mapped to the string "Offer", indicates that this object is a OfferObject object.
      Returns:
      Always LedgerObject.LedgerEntryType.OFFER.

    • account

      Address account()
      The sender of the OfferObject. Cashing the OfferObject debits this address's balance.
      Returns:
      The Address of the offer sender.

    • flags

      OfferFlags flags()
      A bit-map of boolean flags.
      Returns:
      A OfferFlags.

    • sequence

      com.google.common.primitives.UnsignedInteger sequence()
      The sequence number of the OfferCreate transaction that created this offer.
      Returns:
      An UnsignedInteger representing the sequence number.

    • takerPays

      CurrencyAmount takerPays()
      The remaining amount and type of currency requested by the offer creator.
      Returns:
      A CurrencyAmount.

    • takerGets

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

    • bookDirectory

      Hash256 bookDirectory()
      The ID of the Offer Directory that links to this offer.
      Returns:
      A Hash256 containing the ID.

    • bookNode

      String bookNode()
      A hint indicating which page of the offer directory links to this object, in case the directory consists of multiple pages.
      Returns:
      A String containing the hint.

    • ownerNode

      String ownerNode()
      A hint indicating which page of the sender's owner directory links to this object, in case the directory consists of multiple pages. Note: The object does not contain a direct link to the owner directory containing it, since that value can be derived from the Account.
      Returns:
      A String containing the hint.

    • previousTransactionId

      Hash256 previousTransactionId()
      The identifying hash of the transaction that most recently modified this object.
      Returns:
      A Hash256 containing the previous transaction hash.

    • previousTransactionLedgerSequence

      com.google.common.primitives.UnsignedInteger previousTransactionLedgerSequence()
      The index of the ledger that contains the transaction that most recently modified this object.
      Returns:
      An UnsignedInteger representing the previous transaction ledger sequence.

    • expiration

      Optional<com.google.common.primitives.UnsignedInteger> expiration()
      Indicates the time after which this offer is considered expired, in seconds since the Ripple Epoch.
      Returns:
      An Optional of type UnsignedInteger representing the expiration of this offer.

    • domainId

      Optional<Hash256> domainId()
      The permissioned domain that the offer is part of.
      Returns:
      A Hash256 representing DomainID.

    • additionalBooks

      List<BookWrapper> additionalBooks()
      An additional list of order book directories that this offer belongs to. Currently, this field only applicable to hybrid offers.
      Returns:
      A list of BookWrapper representing order book directories.

    • index

      Hash256 index()
      The unique ID of the OfferObject.
      Returns:
      A Hash256 containing the ID.