Package org.xrpl.xrpl4j.model.flags
Class AmmDepositFlags
java.lang.Object
org.xrpl.xrpl4j.model.flags.Flags
org.xrpl.xrpl4j.model.flags.TransactionFlags
org.xrpl.xrpl4j.model.flags.AmmDepositFlags
A set of
TransactionFlags that can be set on AmmDeposit transactions. Exactly one flag must be set on
each AmmDeposit transaction, so this class does not allow for combination of multiple flags.
While most other TransactionFlags support empty flags or 0, AmmDeposit transactions must have a Flags field to denote the deposit mode. Therefore, AmmDepositFlags does not support empty or unset flags.
This class will be marked Beta until the AMM amendment is enabled on mainnet. Its API is subject to
change.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.xrpl.xrpl4j.model.flags.TransactionFlags
TransactionFlags.Builder -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final AmmDepositFlagsConstantAmmDepositFlagsfor thetfInnerBatchTxnflag.static final AmmDepositFlagsConstantAmmDepositFlagsfor thetfLimitLPTokenflag.static final AmmDepositFlagsConstantAmmDepositFlagsfor thetfLPTokenflag.static final AmmDepositFlagsConstantAmmDepositFlagsfor thetfOneAssetLPTokenflag.static final AmmDepositFlagsConstantAmmDepositFlagsfor thetfSingleAssetflag.static final AmmDepositFlagsConstantAmmDepositFlagsfor thetfTwoAssetflag.static final AmmDepositFlagsConstantAmmDepositFlagsfor thetfTwoAssetIfEmptyflag.Fields inherited from class org.xrpl.xrpl4j.model.flags.TransactionFlags
EMPTY, FULLY_CANONICAL_SIG, UNSET -
Method Summary
Modifier and TypeMethodDescriptionbooleanWhether thetfInnerBatchTxnflag is set.booleanWhether thetfLimitLPTokenflag is set.booleanWhether thetfLPTokenflag is set.booleanWhether thetfOneAssetLPTokenflag is set.booleanWhether thetfSingleAssetflag is set.booleanWhether thetfTwoAssetflag is set.booleanWhether thetfTwoAssetIfEmptyflag is set.Methods inherited from class org.xrpl.xrpl4j.model.flags.TransactionFlags
of, tfFullyCanonicalSig
-
Field Details
-
LP_TOKEN
ConstantAmmDepositFlagsfor thetfLPTokenflag. -
SINGLE_ASSET
ConstantAmmDepositFlagsfor thetfSingleAssetflag. -
TWO_ASSET
ConstantAmmDepositFlagsfor thetfTwoAssetflag. -
ONE_ASSET_LP_TOKEN
ConstantAmmDepositFlagsfor thetfOneAssetLPTokenflag. -
LIMIT_LP_TOKEN
ConstantAmmDepositFlagsfor thetfLimitLPTokenflag. -
TWO_ASSET_IF_EMPTY
ConstantAmmDepositFlagsfor thetfTwoAssetIfEmptyflag. -
INNER_BATCH_TXN
ConstantAmmDepositFlagsfor thetfInnerBatchTxnflag.
-
-
Method Details
-
tfLpToken
public boolean tfLpToken()Whether thetfLPTokenflag is set.- Returns:
trueiftfLPTokenis set, otherwisefalse.
-
tfSingleAsset
public boolean tfSingleAsset()Whether thetfSingleAssetflag is set.- Returns:
trueiftfSingleAssetis set, otherwisefalse.
-
tfTwoAsset
public boolean tfTwoAsset()Whether thetfTwoAssetflag is set.- Returns:
trueiftfTwoAssetis set, otherwisefalse.
-
tfOneAssetLpToken
public boolean tfOneAssetLpToken()Whether thetfOneAssetLPTokenflag is set.- Returns:
trueiftfOneAssetLPTokenis set, otherwisefalse.
-
tfLimitLpToken
public boolean tfLimitLpToken()Whether thetfLimitLPTokenflag is set.- Returns:
trueiftfLimitLPTokenis set, otherwisefalse.
-
tfTwoAssetIfEmpty
public boolean tfTwoAssetIfEmpty()Whether thetfTwoAssetIfEmptyflag is set.- Returns:
trueiftfTwoAssetIfEmptyis set, otherwisefalse.
-
tfInnerBatchTxn
public boolean tfInnerBatchTxn()Whether thetfInnerBatchTxnflag is set.- Overrides:
tfInnerBatchTxnin classTransactionFlags- Returns:
trueiftfInnerBatchTxnis set, otherwisefalse.- See Also:
-