Class ImmutableAmmBid
- All Implemented Interfaces:
AmmBid,Transaction
AmmBid.
Use the builder to create immutable instances:
ImmutableAmmBid.builder().
-
Nested Class Summary
Nested Classes -
Field Summary
Fields inherited from interface org.xrpl.xrpl4j.model.transactions.Transaction
typeMap -
Method Summary
Modifier and TypeMethodDescriptionaccount()The uniqueAddressof the account that initiated this transaction.Hash value identifying another transaction.asset()The definition for one of the assets in the AMM's pool.asset2()The definition for the other asset in the AMM's pool.com.google.common.collect.ImmutableList<AuthAccountWrapper> A list of up to 4 additional accounts that you allow to trade at the discounted fee.bidMax()Pay at most this amount for the slot.bidMin()Pay at least this amount for the slot.static ImmutableAmmBid.Builderbuilder()Creates a builder forImmutableAmmBid.static ImmutableAmmBidCreates an immutable copy of aAmmBidvalue.delegate()The delegate account that is sending the transaction on behalf of theaccount().booleanThis instance is equal to all instances ofImmutableAmmBidthat have equal attribute values.fee()TheStringrepresentation of an integer amount of XRP, in drops, to be destroyed as a cost for distributing this Payment transaction to the network.flags()Set ofTransactionFlagss for thisAmmBid, which only allows thetfFullyCanonicalSigflag, which is deprecated.inthashCode()Computes a hash code from attributes:account,transactionType,fee,sequence,ticketSequence,accountTransactionId,lastLedgerSequence,memos,signers,sourceTag,signingPublicKey,transactionSignature,networkId,delegate,unknownFields,flags,asset,asset2,bidMin,bidMax,authAccounts.Optional<com.google.common.primitives.UnsignedInteger> Highest ledger index this transaction can appear in.com.google.common.collect.ImmutableList<MemoWrapper> memos()Additional arbitrary information used to identify thisTransaction.com.google.common.primitives.UnsignedIntegersequence()The sequence number of the account submitting theTransaction.com.google.common.collect.ImmutableList<SignerWrapper> signers()Array ofSignerWrappers that represent a multi-signature which authorizes thisTransaction.ThePublicKeythat corresponds to the private key used to sign this transaction.Optional<com.google.common.primitives.UnsignedInteger> ArbitraryUnsignedIntegerused to identify the reason for thisTransaction, or a sender on whose behalf thisTransactionis made.Optional<com.google.common.primitives.UnsignedInteger> The sequence number of theTicketObjectto use in place of asequence()number.toString()Prints the immutable valueAmmBidwith attribute values.The signature that verifies this transaction as originating from the account it says it is from.The type of transaction.final ImmutableAmmBidwithAccount(Address value) Copy the current immutable object by setting a value for theaccountattribute.final ImmutableAmmBidwithAccountTransactionId(Optional<? extends Hash256> optional) Copy the current immutable object by setting an optional value for theaccountTransactionIdattribute.final ImmutableAmmBidwithAccountTransactionId(Hash256 value) Copy the current immutable object by setting a present value for the optionalaccountTransactionIdattribute.final ImmutableAmmBidCopy the current immutable object by setting a value for theassetattribute.final ImmutableAmmBidwithAsset2(Issue value) Copy the current immutable object by setting a value for theasset2attribute.final ImmutableAmmBidwithAuthAccounts(Iterable<? extends AuthAccountWrapper> elements) Copy the current immutable object with elements that replace the content ofauthAccounts.final ImmutableAmmBidwithAuthAccounts(AuthAccountWrapper... elements) Copy the current immutable object with elements that replace the content ofauthAccounts.final ImmutableAmmBidwithBidMax(Optional<? extends CurrencyAmount> optional) Copy the current immutable object by setting an optional value for thebidMaxattribute.final ImmutableAmmBidwithBidMax(CurrencyAmount value) Copy the current immutable object by setting a present value for the optionalbidMaxattribute.final ImmutableAmmBidwithBidMin(Optional<? extends CurrencyAmount> optional) Copy the current immutable object by setting an optional value for thebidMinattribute.final ImmutableAmmBidwithBidMin(CurrencyAmount value) Copy the current immutable object by setting a present value for the optionalbidMinattribute.final ImmutableAmmBidwithDelegate(Optional<? extends Address> optional) Copy the current immutable object by setting an optional value for thedelegateattribute.final ImmutableAmmBidwithDelegate(Address value) Copy the current immutable object by setting a present value for the optionaldelegateattribute.final ImmutableAmmBidwithFee(XrpCurrencyAmount value) Copy the current immutable object by setting a value for thefeeattribute.final ImmutableAmmBidwithFlags(TransactionFlags value) Copy the current immutable object by setting a value for theflagsattribute.final ImmutableAmmBidwithLastLedgerSequence(com.google.common.primitives.UnsignedInteger value) Copy the current immutable object by setting a present value for the optionallastLedgerSequenceattribute.final ImmutableAmmBidwithLastLedgerSequence(Optional<? extends com.google.common.primitives.UnsignedInteger> optional) Copy the current immutable object by setting an optional value for thelastLedgerSequenceattribute.final ImmutableAmmBidwithMemos(Iterable<? extends MemoWrapper> elements) Copy the current immutable object with elements that replace the content ofmemos.final ImmutableAmmBidwithMemos(MemoWrapper... elements) Copy the current immutable object with elements that replace the content ofmemos.final ImmutableAmmBidwithNetworkId(Optional<? extends NetworkId> optional) Copy the current immutable object by setting an optional value for thenetworkIdattribute.final ImmutableAmmBidwithNetworkId(NetworkId value) Copy the current immutable object by setting a present value for the optionalnetworkIdattribute.final ImmutableAmmBidwithSequence(com.google.common.primitives.UnsignedInteger value) Copy the current immutable object by setting a value for thesequenceattribute.final ImmutableAmmBidwithSigners(Iterable<? extends SignerWrapper> elements) Copy the current immutable object with elements that replace the content ofsigners.final ImmutableAmmBidwithSigners(SignerWrapper... elements) Copy the current immutable object with elements that replace the content ofsigners.final ImmutableAmmBidwithSigningPublicKey(PublicKey value) Copy the current immutable object by setting a value for thesigningPublicKeyattribute.final ImmutableAmmBidwithSourceTag(com.google.common.primitives.UnsignedInteger value) Copy the current immutable object by setting a present value for the optionalsourceTagattribute.final ImmutableAmmBidwithSourceTag(Optional<? extends com.google.common.primitives.UnsignedInteger> optional) Copy the current immutable object by setting an optional value for thesourceTagattribute.final ImmutableAmmBidwithTicketSequence(com.google.common.primitives.UnsignedInteger value) Copy the current immutable object by setting a present value for the optionalticketSequenceattribute.final ImmutableAmmBidwithTicketSequence(Optional<? extends com.google.common.primitives.UnsignedInteger> optional) Copy the current immutable object by setting an optional value for theticketSequenceattribute.final ImmutableAmmBidwithTransactionSignature(Optional<? extends Signature> optional) Copy the current immutable object by setting an optional value for thetransactionSignatureattribute.final ImmutableAmmBidCopy the current immutable object by setting a present value for the optionaltransactionSignatureattribute.final ImmutableAmmBidCopy the current immutable object by setting a value for thetransactionTypeattribute.final ImmutableAmmBidwithUnknownFields(Map<String, ? extends Object> entries) Copy the current immutable object by replacing theunknownFieldsmap with the specified map.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.xrpl.xrpl4j.model.transactions.Transaction
transactionFlags, validateDelegateNotSameAsAccount
-
Method Details
-
account
The uniqueAddressof the account that initiated this transaction.- Specified by:
accountin interfaceTransaction- Returns:
- The
Addressof the account submitting this transaction.
-
transactionType
The type of transaction.- Specified by:
transactionTypein interfaceTransaction- Returns:
- A
TransactionType.
-
fee
TheStringrepresentation of an integer amount of XRP, in drops, to be destroyed as a cost for distributing this Payment transaction to the network.This field is auto-fillable
- Specified by:
feein interfaceTransaction- Returns:
- An
XrpCurrencyAmountrepresenting the transaction cost. - See Also:
-
sequence
public com.google.common.primitives.UnsignedInteger sequence()The sequence number of the account submitting theTransaction. ATransactionis only valid if the Sequence number is exactly 1 greater than the previous transaction from the same account.This field is auto-fillable
- Specified by:
sequencein interfaceTransaction- Returns:
- An
UnsignedIntegerrepresenting the sequence of the transaction. - See Also:
-
ticketSequence
The sequence number of theTicketObjectto use in place of asequence()number. If this is provided,sequence()must be 0. Cannot be used withaccountTransactionId().- Specified by:
ticketSequencein interfaceTransaction- Returns:
- An
UnsignedIntegerrepresenting the ticket sequence of the transaction.
-
accountTransactionId
Hash value identifying another transaction. If provided, thisTransactionis only valid if the sending account's previously-sent transaction matches the provided hash.- Specified by:
accountTransactionIdin interfaceTransaction- Returns:
- An
Optionalof typeHash256containing the account transaction ID.
-
lastLedgerSequence
Highest ledger index this transaction can appear in. Specifying this field places a strict upper limit on how long the transaction can wait to be validated or rejected.- Specified by:
lastLedgerSequencein interfaceTransaction- Returns:
- An
Optionalof typeUnsignedIntegerrepresenting the last ledger sequence.
-
memos
Additional arbitrary information used to identify thisTransaction.- Specified by:
memosin interfaceTransaction- Returns:
- A
ListofMemoWrappers.
-
signers
Array ofSignerWrappers that represent a multi-signature which authorizes thisTransaction.- Specified by:
signersin interfaceTransaction- Returns:
- A
ListofSignerWrappers.
-
sourceTag
ArbitraryUnsignedIntegerused to identify the reason for thisTransaction, or a sender on whose behalf thisTransactionis made.- Specified by:
sourceTagin interfaceTransaction- Returns:
- An
OptionalUnsignedIntegerrepresenting the source account's tag.
-
signingPublicKey
ThePublicKeythat corresponds to the private key used to sign this transaction. If an empty string, iePublicKey.MULTI_SIGN_PUBLIC_KEY, indicates a multi-signature is present in theTransaction.signers()field instead.- Specified by:
signingPublicKeyin interfaceTransaction- Returns:
- A
PublicKeycontaining the public key of the account submitting the transaction, orPublicKey.MULTI_SIGN_PUBLIC_KEYif the transaction is multi-signed.
-
transactionSignature
The signature that verifies this transaction as originating from the account it says it is from.This field is automatically added when signing this
Transaction.- Specified by:
transactionSignaturein interfaceTransaction- Returns:
- An
OptionalStringcontaining the transaction signature.
-
networkId
- Specified by:
networkIdin interfaceTransaction- Returns:
- The value of the
networkIdattribute
-
delegate
The delegate account that is sending the transaction on behalf of theaccount().The way the
Delegatefield works is somewhat akin toRegularKey. Theaccount()field is the delegating account, theDelegatefield is the delegate, and thesigningPublicKey()andtransactionSignature()are based on the delegate's keys.If a
Delegatehas multisign enabled, they can also use that multisign setup on their delegated transactions.The delegate will pay the fees on the transaction, to prevent a delegate from draining an account's XRP via fees. Only the
account()'s sequence number is incremented, not theDelegate's.This field is part of the Permission Delegation feature (XLS-75).
- Specified by:
delegatein interfaceTransaction- Returns:
- An
OptionalAddressof the delegate account. - See Also:
-
unknownFields
- Specified by:
unknownFieldsin interfaceTransaction- Returns:
- The value of the
unknownFieldsattribute
-
flags
Set ofTransactionFlagss for thisAmmBid, which only allows thetfFullyCanonicalSigflag, 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.
- Specified by:
flagsin interfaceAmmBid- Returns:
- Always
TransactionFlags.EMPTY.
-
asset
The definition for one of the assets in the AMM's pool. -
asset2
The definition for the other asset in the AMM's pool. -
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 specifyXrpCurrencyAmounts with atecerror code, which means these malformed transactions can be included in validated ledgers. Therefore, this field is typed as aCurrencyAmountso that malformed transactions can be correctly deserialized. See #529- Specified by:
bidMinin interfaceAmmBid- 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 specifyXrpCurrencyAmounts with atecerror code, which means these malformed transactions can be included in validated ledgers. Therefore, this field is typed as aCurrencyAmountso that malformed transactions can be correctly deserialized. See #529- Specified by:
bidMaxin interfaceAmmBid- Returns:
- An optionally present
CurrencyAmount.
-
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- Specified by:
authAccountsin interfaceAmmBid- Returns:
- A
List
-
withAccount
Copy the current immutable object by setting a value for theaccountattribute. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for account- Returns:
- A modified copy of the
thisobject
-
withTransactionType
Copy the current immutable object by setting a value for thetransactionTypeattribute. A value equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for transactionType- Returns:
- A modified copy of the
thisobject
-
withFee
Copy the current immutable object by setting a value for thefeeattribute. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for fee- Returns:
- A modified copy of the
thisobject
-
withSequence
Copy the current immutable object by setting a value for thesequenceattribute. An equals check used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for sequence- Returns:
- A modified copy of the
thisobject
-
withTicketSequence
Copy the current immutable object by setting a present value for the optionalticketSequenceattribute.- Parameters:
value- The value for ticketSequence- Returns:
- A modified copy of
thisobject
-
withTicketSequence
public final ImmutableAmmBid withTicketSequence(Optional<? extends com.google.common.primitives.UnsignedInteger> optional) Copy the current immutable object by setting an optional value for theticketSequenceattribute. An equality check is used on inner nullable value to prevent copying of the same value by returningthis.- Parameters:
optional- A value for ticketSequence- Returns:
- A modified copy of
thisobject
-
withAccountTransactionId
Copy the current immutable object by setting a present value for the optionalaccountTransactionIdattribute.- Parameters:
value- The value for accountTransactionId- Returns:
- A modified copy of
thisobject
-
withAccountTransactionId
Copy the current immutable object by setting an optional value for theaccountTransactionIdattribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returningthis.- Parameters:
optional- A value for accountTransactionId- Returns:
- A modified copy of
thisobject
-
withLastLedgerSequence
public final ImmutableAmmBid withLastLedgerSequence(com.google.common.primitives.UnsignedInteger value) Copy the current immutable object by setting a present value for the optionallastLedgerSequenceattribute.- Parameters:
value- The value for lastLedgerSequence- Returns:
- A modified copy of
thisobject
-
withLastLedgerSequence
public final ImmutableAmmBid withLastLedgerSequence(Optional<? extends com.google.common.primitives.UnsignedInteger> optional) Copy the current immutable object by setting an optional value for thelastLedgerSequenceattribute. An equality check is used on inner nullable value to prevent copying of the same value by returningthis.- Parameters:
optional- A value for lastLedgerSequence- Returns:
- A modified copy of
thisobject
-
withMemos
Copy the current immutable object with elements that replace the content ofmemos.- Parameters:
elements- The elements to set- Returns:
- A modified copy of
thisobject
-
withMemos
Copy the current immutable object with elements that replace the content ofmemos. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
elements- An iterable of memos elements to set- Returns:
- A modified copy of
thisobject
-
withSigners
Copy the current immutable object with elements that replace the content ofsigners.- Parameters:
elements- The elements to set- Returns:
- A modified copy of
thisobject
-
withSigners
Copy the current immutable object with elements that replace the content ofsigners. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
elements- An iterable of signers elements to set- Returns:
- A modified copy of
thisobject
-
withSourceTag
Copy the current immutable object by setting a present value for the optionalsourceTagattribute.- Parameters:
value- The value for sourceTag- Returns:
- A modified copy of
thisobject
-
withSourceTag
public final ImmutableAmmBid withSourceTag(Optional<? extends com.google.common.primitives.UnsignedInteger> optional) Copy the current immutable object by setting an optional value for thesourceTagattribute. An equality check is used on inner nullable value to prevent copying of the same value by returningthis.- Parameters:
optional- A value for sourceTag- Returns:
- A modified copy of
thisobject
-
withSigningPublicKey
Copy the current immutable object by setting a value for thesigningPublicKeyattribute. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for signingPublicKey- Returns:
- A modified copy of the
thisobject
-
withTransactionSignature
Copy the current immutable object by setting a present value for the optionaltransactionSignatureattribute.- Parameters:
value- The value for transactionSignature- Returns:
- A modified copy of
thisobject
-
withTransactionSignature
Copy the current immutable object by setting an optional value for thetransactionSignatureattribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returningthis.- Parameters:
optional- A value for transactionSignature- Returns:
- A modified copy of
thisobject
-
withNetworkId
Copy the current immutable object by setting a present value for the optionalnetworkIdattribute.- Parameters:
value- The value for networkId- Returns:
- A modified copy of
thisobject
-
withNetworkId
Copy the current immutable object by setting an optional value for thenetworkIdattribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returningthis.- Parameters:
optional- A value for networkId- Returns:
- A modified copy of
thisobject
-
withDelegate
Copy the current immutable object by setting a present value for the optionaldelegateattribute.- Parameters:
value- The value for delegate- Returns:
- A modified copy of
thisobject
-
withDelegate
Copy the current immutable object by setting an optional value for thedelegateattribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returningthis.- Parameters:
optional- A value for delegate- Returns:
- A modified copy of
thisobject
-
withUnknownFields
Copy the current immutable object by replacing theunknownFieldsmap with the specified map. Nulls are not permitted as keys or values. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
entries- The entries to be added to the unknownFields map- Returns:
- A modified copy of
thisobject
-
withFlags
Copy the current immutable object by setting a value for theflagsattribute. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for flags- Returns:
- A modified copy of the
thisobject
-
withAsset
Copy the current immutable object by setting a value for theassetattribute. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for asset- Returns:
- A modified copy of the
thisobject
-
withAsset2
Copy the current immutable object by setting a value for theasset2attribute. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for asset2- Returns:
- A modified copy of the
thisobject
-
withBidMin
Copy the current immutable object by setting a present value for the optionalbidMinattribute.- Parameters:
value- The value for bidMin- Returns:
- A modified copy of
thisobject
-
withBidMin
Copy the current immutable object by setting an optional value for thebidMinattribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returningthis.- Parameters:
optional- A value for bidMin- Returns:
- A modified copy of
thisobject
-
withBidMax
Copy the current immutable object by setting a present value for the optionalbidMaxattribute.- Parameters:
value- The value for bidMax- Returns:
- A modified copy of
thisobject
-
withBidMax
Copy the current immutable object by setting an optional value for thebidMaxattribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returningthis.- Parameters:
optional- A value for bidMax- Returns:
- A modified copy of
thisobject
-
withAuthAccounts
Copy the current immutable object with elements that replace the content ofauthAccounts.- Parameters:
elements- The elements to set- Returns:
- A modified copy of
thisobject
-
withAuthAccounts
Copy the current immutable object with elements that replace the content ofauthAccounts. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
elements- An iterable of authAccounts elements to set- Returns:
- A modified copy of
thisobject
-
equals
This instance is equal to all instances ofImmutableAmmBidthat have equal attribute values. -
hashCode
public int hashCode()Computes a hash code from attributes:account,transactionType,fee,sequence,ticketSequence,accountTransactionId,lastLedgerSequence,memos,signers,sourceTag,signingPublicKey,transactionSignature,networkId,delegate,unknownFields,flags,asset,asset2,bidMin,bidMax,authAccounts. -
toString
Prints the immutable valueAmmBidwith attribute values. -
copyOf
Creates an immutable copy of aAmmBidvalue. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.- Parameters:
instance- The instance to copy- Returns:
- A copied immutable AmmBid instance
-
builder
Creates a builder forImmutableAmmBid.ImmutableAmmBid.builder() .account(org.xrpl.xrpl4j.model.transactions.Address) // requiredaccount.transactionType(org.xrpl.xrpl4j.model.transactions.TransactionType) // optionaltransactionType.fee(org.xrpl.xrpl4j.model.transactions.XrpCurrencyAmount) // requiredfee.sequence(com.google.common.primitives.UnsignedInteger) // optionalsequence.ticketSequence(com.google.common.primitives.UnsignedInteger) // optionalticketSequence.accountTransactionId(Hash256) // optionalaccountTransactionId.lastLedgerSequence(com.google.common.primitives.UnsignedInteger) // optionallastLedgerSequence.addMemos|addAllMemos(org.xrpl.xrpl4j.model.transactions.MemoWrapper) //memoselements .addSigners|addAllSigners(org.xrpl.xrpl4j.model.transactions.SignerWrapper) //signerselements .sourceTag(com.google.common.primitives.UnsignedInteger) // optionalsourceTag.signingPublicKey(org.xrpl.xrpl4j.crypto.keys.PublicKey) // optionalsigningPublicKey.transactionSignature(org.xrpl.xrpl4j.crypto.signing.Signature) // optionaltransactionSignature.networkId(NetworkId) // optionalnetworkId.delegate(Address) // optionaldelegate.putUnknownFields|putAllUnknownFields(String => Object) //unknownFieldsmappings .flags(org.xrpl.xrpl4j.model.flags.TransactionFlags) // optionalflags.asset(org.xrpl.xrpl4j.model.ledger.Issue) // requiredasset.asset2(org.xrpl.xrpl4j.model.ledger.Issue) // requiredasset2.bidMin(org.xrpl.xrpl4j.model.transactions.CurrencyAmount) // optionalbidMin.bidMax(org.xrpl.xrpl4j.model.transactions.CurrencyAmount) // optionalbidMax.addAuthAccounts|addAllAuthAccounts(org.xrpl.xrpl4j.model.ledger.AuthAccountWrapper) //authAccountselements .build();- Returns:
- A new ImmutableAmmBid builder
-