AMMDeposit class
Deposit funds into an Automated Market Maker (AMM) instance and receive the AMM's liquidity provider tokens (LP Tokens) in exchange.
You can deposit one or both of the assets in the AMM's pool. If successful, this transaction creates a trust line to the AMM Account (limit 0) to hold the LP Tokens.
- Inheritance
-
- Object
- XRPLBase
- XRPTransaction
- AMMDeposit
Constructors
-
AMMDeposit.new({required String account, required XRPCurrencies asset, required XRPCurrencies asset2, CurrencyAmount? amount, CurrencyAmount? amount2, CurrencyAmount? ePrice, IssuedCurrencyAmount? lpTokenOut, 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 []}) -
AMMDeposit.fromJson(Map<
String, dynamic> json)
Properties
- account → String
-
finalinherited
- accountTxId → String?
-
finalinherited
- amount → CurrencyAmount?
-
amount The amount of one asset to deposit to the AMM.
If present, this must match the type of one of the assets (tokens or XRP)
in the AMM's pool.
final
- amount2 → CurrencyAmount?
-
amount2 The amount of another asset to add to the AMM.
If present, this must match the type of the other asset in the AMM's pool
and cannot be the same asset as Amount.
final
- 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
- ePrice → CurrencyAmount?
-
ePrice The maximum effective price, in the deposit asset, to pay
for each LP Token received.
final
- fee ↔ BigInt?
-
getter/setter pairinherited
- flags → dynamic
-
finalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- lastLedgerSequence ↔ int?
-
getter/setter pairinherited
- lpTokenOut → IssuedCurrencyAmount?
-
lpTokenOut How many of the AMM's LP Tokens to buy.
final
-
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