AMMBid class

Bid on an Automated Market Maker's (AMM's) auction slot. If you win, you can trade against the AMM at a discounted fee until you are outbid or 24 hours have passed. If you are outbid before 24 hours have passed, you are refunded part of the cost of your bid based on how much time remains. You bid using the AMM's LP Tokens; the amount of a winning bid is returned to the AMM, decreasing the outstanding balance of LP Tokens.

Inheritance

Constructors

AMMBid.new({required XRPCurrencies asset, required XRPCurrencies asset2, CurrencyAmount? bidMax, CurrencyAmount? bidMin, required String account, List<AuthAccount>? authAccounts, List<XRPLMemo>? memos = const [], String signingPubKey = "", int? ticketSequance, BigInt? fee, int? lastLedgerSequence, int? sequence, List<XRPLSigners>? signers, dynamic flags, int? sourceTag, List<String> multiSigSigners = const []})
AMMBid.fromJson(Map<String, dynamic> json)

Properties

account String
finalinherited
accountTxId String?
finalinherited
asset XRPCurrencies
asset The definition for one of the assets in the AMM's pool.
final
asset2 XRPCurrencies
asset2 The definition for the other asset in the AMM's pool
final
authAccounts List<AuthAccount>?
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.
final
bidMax 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.
final
bidMin CurrencyAmount?
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.
final
fee BigInt?
getter/setter pairinherited
flags → dynamic
finalinherited
hashCode int
The hash code for this object.
no setterinherited
lastLedgerSequence int?
getter/setter pairinherited
memos List<XRPLMemo>?
getter/setter pairinherited
multiSigSigners List<String>
getter/setter pairinherited
networkId int?
getter/setter pairinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
sequence int?
getter/setter pairinherited
signers List<XRPLSigners>?
getter/setter pairinherited
signingPubKey String
getter/setter pairinherited
sourceTag int?
finalinherited
ticketSequance int?
finalinherited
transactionType XRPLTransactionType
finalinherited
txnSignature String?
getter/setter pairinherited
validate String?
no setteroverride

Methods

getHash() String
inherited
isSigned() bool
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
setFee(BigInt? newFee) → void
inherited
setLastLedgerSequence(int? newSequance) → void
inherited
setMultiSigSignature(List<XRPLSigners> sigs) → void
inherited
setNetworkId(int? network) → void
inherited
setSequence(int? newSequance) → void
inherited
setSignature(String? sig) → void
inherited
toBlob({bool forSigning = true}) String
inherited
toJson() Map<String, dynamic>
Converts the object to a JSON representation.
override
toMultisigBlob(String address) String
inherited
toString() String
A string representation of this object.
inherited
toXrpl() Map<String, dynamic>
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited