Package org.xrpl.xrpl4j.model.ledger
Interface AuctionSlot
- All Known Implementing Classes:
ImmutableAuctionSlot
@Immutable
@Beta
public interface AuctionSlot
Represents an AuctionSlot object in an
AmmObject, containing details of the current owner of the auction
slot.
This class will be marked Beta until the AMM amendment is enabled on mainnet. Its API is subject to
change.
-
Method Summary
Modifier and TypeMethodDescriptionaccount()The current owner of this auction slot.A list of at most 4 additional accounts that are authorized to trade at the discounted fee for this AMM instance.Extracts all the addresses found in theAuthAccounts found inauthAccounts().static ImmutableAuctionSlot.Builderbuilder()Construct aAuctionSlotbuilder.The trading fee to be charged to the auction owner.com.google.common.primitives.UnsignedIntegerThe time when this slot expires, in seconds since the Ripple Epoch.price()The amount the auction owner paid to win this slot, in LP Tokens.
-
Method Details
-
builder
Construct aAuctionSlotbuilder.- Returns:
- An
ImmutableAuctionSlot.Builder.
-
account
Address account()The current owner of this auction slot.- Returns:
- An
Address.
-
authAccounts
List<AuthAccountWrapper> authAccounts()A list of at most 4 additional accounts that are authorized to trade at the discounted fee for this AMM instance.- Returns:
- A
ListofAuthAccountWrappers.
-
authAccountsAddresses
Extracts all the addresses found in theAuthAccounts found inauthAccounts(). -
discountedFee
TradingFee discountedFee()The trading fee to be charged to the auction owner. By default this is 0, meaning that the auction owner can trade at no fee instead of the standard fee for this AMM.- Returns:
- A
TradingFee.
-
price
IssuedCurrencyAmount price()The amount the auction owner paid to win this slot, in LP Tokens.- Returns:
- An
IssuedCurrencyAmount.
-
expiration
com.google.common.primitives.UnsignedInteger expiration()The time when this slot expires, in seconds since the Ripple Epoch.- Returns:
- An
UnsignedInteger
-