Interface NfTokenCreateOffer

All Superinterfaces:
Transaction
All Known Implementing Classes:
ImmutableNfTokenCreateOffer

@Immutable public interface NfTokenCreateOffer extends Transaction
The NfTokenCreateOffer transaction creates either a new Sell offer for an NfToken owned by the account executing the transaction or a new Buy offer for NfToken owned by another account.
  • Method Details

    • builder

      Construct a builder for this class.
      Returns:
      An ImmutableNfTokenCreateOffer.Builder.
    • account

      Address account()
      Indicates the AccountID of the account that initiated the transaction.
      Specified by:
      account in interface Transaction
      Returns:
      The Address of the account that created the Offer.
    • nfTokenId

      NfTokenId nfTokenId()
      Identifies the TokenID of the NfToken object that the offer references.
      Returns:
      Offer is created for the token with TokenID.
    • amount

      CurrencyAmount amount()
      Indicates the amount expected or offered for the Token.

      The amount must be non-zero, except where this is an offer is an offer to sell and the asset is XRP; then it is legal to specify an amount of zero, which means that the current owner of the token is giving it away, gratis, either to anyone at all, or to the account identified by the Destination field.

      Returns:
      Expected Amount of type CurrencyAmount for the token.
    • owner

      Optional<Address> owner()
      Indicates the AccountID of the account that owns the corresponding NfToken.

      If the offer is to buy a token, this field must be present and it must be different than Account (since an offer to buy a token one already holds is meaningless). If the offer is to sell a token, this field must not be present, as the owner is, implicitly, the same as Account (since an offer to sell a token one doesn't already hold is meaningless).

      Returns:
      An Optional field Owner of type Address.
    • expiration

      Optional<com.google.common.primitives.UnsignedLong> expiration()
      Indicates the time after which the offer will no longer be valid. The value is the number of seconds since the Ripple Epoch.
      Returns:
      An Optional field Owner of type UnsignedLong.
    • destination

      Optional<Address> destination()
      If present, indicates that this offer may only be accepted by the specified account. Attempts by other accounts to accept this offer MUST fail.
      Returns:
      An Optional field Destination of type Address.
    • flags

      @Default default NfTokenCreateOfferFlags flags()
      Returns:
      The NfTokenCreateOfferFlags for this transaction.