Interface AmmClawback
- All Superinterfaces:
Transaction
- All Known Implementing Classes:
ImmutableAmmClawback
An
AmmClawback transaction claws back tokens from a holder that has funds in an AMM pool.-
Field Summary
Fields inherited from interface org.xrpl.xrpl4j.model.transactions.Transaction
typeMap -
Method Summary
Modifier and TypeMethodDescriptionamount()Optional field that specifies the maximum amount to clawback from the AMM pool.asset()The asset in the AMM pool that the issuer is looking to claw back.asset2()Other asset in the AMM pool that the issuer is looking to claw back.static ImmutableAmmClawback.Builderbuilder()Construct a builder for this class.default AmmClawbackFlagsflags()Transaction Flags forAmmClawback, with the only option being tfClawTwoAssets.holder()The address of the holder that has funds deposited in the AMM pool.Methods inherited from interface org.xrpl.xrpl4j.model.transactions.Transaction
account, accountTransactionId, delegate, fee, lastLedgerSequence, memos, networkId, sequence, signers, signingPublicKey, sourceTag, ticketSequence, transactionFlags, transactionSignature, transactionType, unknownFields, validateDelegateNotSameAsAccount
-
Method Details
-
builder
Construct a builder for this class.- Returns:
- An
ImmutableAmmClawback.Builder.
-
holder
Address holder()The address of the holder that has funds deposited in the AMM pool.- Returns:
- An
Address.
-
asset
Issue asset()The asset in the AMM pool that the issuer is looking to claw back.- Returns:
- An
Issue.
-
asset2
Issue asset2()Other asset in the AMM pool that the issuer is looking to claw back.- Returns:
- An
Issue.
-
amount
Optional<CurrencyAmount> amount()Optional field that specifies the maximum amount to clawback from the AMM pool.- Returns:
- An
CurrencyAmount.
-
flags
Transaction Flags forAmmClawback, with the only option being tfClawTwoAssets.- Returns:
AmmClawbackFlags.UNSETif field was not set, otherwise returns with the set flag.
-