Show / Hide Table of Contents

Class DexAmmPool

An AMM pool as the payment engine reads it.

Inheritance
object
DexAmmPool
Namespace: Xrpl.Amounts
Assembly: Xrpl.dll
Syntax
public sealed class DexAmmPool

Properties

| Edit this page View Source

Account

The AMM's account.

Declaration
public string Account { get; init; }
Property Value
Type Description
string
| Edit this page View Source

Asset2Frozen

Whether the second asset is frozen for the AMM.

Declaration
public bool Asset2Frozen { get; init; }
Property Value
Type Description
bool
| Edit this page View Source

AssetFrozen

Whether the first asset is frozen for the AMM, which leaves the pool out of the book.

Declaration
public bool AssetFrozen { get; init; }
Property Value
Type Description
bool
| Edit this page View Source

Balance

The pool's balance of its first asset.

Declaration
public XrplAmount Balance { get; init; }
Property Value
Type Description
XrplAmount
| Edit this page View Source

Balance2

The pool's balance of its second asset.

Declaration
public XrplAmount Balance2 { get; init; }
Property Value
Type Description
XrplAmount
| Edit this page View Source

DiscountedFee

The auction slot's discounted fee, in 1/100,000.

Declaration
public ushort DiscountedFee { get; init; }
Property Value
Type Description
ushort
| Edit this page View Source

SlotAccount

The auction slot's holder; null when the slot is empty.

Declaration
public string SlotAccount { get; init; }
Property Value
Type Description
string
| Edit this page View Source

SlotAuthAccounts

The accounts the slot holder authorized to trade at its fee.

Declaration
public IReadOnlyList<string> SlotAuthAccounts { get; init; }
Property Value
Type Description
IReadOnlyList<string>
| Edit this page View Source

SlotExpiration

When the slot expires, in seconds since the Ripple epoch; null when there is no slot.

Declaration
public uint? SlotExpiration { get; init; }
Property Value
Type Description
uint?
| Edit this page View Source

TradingFee

The pool's trading fee, in 1/100,000.

Declaration
public ushort TradingFee { get; init; }
Property Value
Type Description
ushort

Methods

| Edit this page View Source

FeeFor(string, uint)

getTradingFee: the discounted fee while the slot has not expired, for its holder and the accounts it authorized; the trading fee otherwise.

Declaration
public ushort FeeFor(string account, uint parentCloseTime)
Parameters
Type Name Description
string account
uint parentCloseTime
Returns
Type Description
ushort
  • Edit this page
  • View Source
In this article
Back to top Generated by DocFX