Interface AmmBid

All Superinterfaces:
Transaction
All Known Implementing Classes:
ImmutableAmmBid

@Immutable @Beta public interface AmmBid extends Transaction
Object mapping for the AMMBid transaction.

This class will be marked Beta until the AMM amendment is enabled on mainnet. Its API is subject to change.

  • Method Details

    • builder

      static ImmutableAmmBid.Builder builder()
      Construct a AmmBid builder.
      Returns:
      An ImmutableAmmBid.Builder.
    • flags

      @Default default TransactionFlags flags()
      Set of TransactionFlagss for this AmmBid, which only allows the tfFullyCanonicalSig flag, which is deprecated.

      The value of the flags cannot be set manually, but exists for JSON serialization/deserialization only and for proper signature computation in rippled.

      Returns:
      Always TransactionFlags.EMPTY.
    • asset

      Issue asset()
      The definition for one of the assets in the AMM's pool.
      Returns:
      An Issue.
    • asset2

      Issue asset2()
      The definition for the other asset in the AMM's pool.
      Returns:
      An Issue.
    • bidMin

      Pay at least this amount for the slot. Setting this value higher makes it harder for others to outbid you. If omitted, pay the minimum necessary to win the bid.

      In a well-formed transaction, this field is always an IssuedCurrencyAmount. However, the XRPL will fail AMM transactions that specify XrpCurrencyAmounts with a tec error code, which means these malformed transactions can be included in validated ledgers. Therefore, this field is typed as a CurrencyAmount so that malformed transactions can be correctly deserialized. See #529

      Returns:
      An optionally present CurrencyAmount.
    • bidMax

      Pay at most this amount for the slot. If the cost to win the bid is higher than this amount, the transaction fails. If omitted, pay as much as necessary to win the bid.

      In a well-formed transaction, this field is always an IssuedCurrencyAmount. However, the XRPL will fail AMM transactions that specify XrpCurrencyAmounts with a tec error code, which means these malformed transactions can be included in validated ledgers. Therefore, this field is typed as a CurrencyAmount so that malformed transactions can be correctly deserialized. See #529

      Returns:
      An optionally present CurrencyAmount.
    • authAccounts

      List<AuthAccountWrapper> authAccounts()
      A list of up to 4 additional accounts that you allow to trade at the discounted fee. This cannot include the address of the transaction sender
      Returns:
      A List