ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-11-21 04:05:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

amm_info: clarify amount/amount2 may be swapped due to canonical asset order

Browse Source
This commit is contained in:
mDuo13
2023-01-24 18:38:05 -08:00
parent 52f8ed4726
commit 418a321b27
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
content/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/amm_info.md
View File

@@ -206,8 +206,8 @@ The `amm` field is an object describing the current status of an Automated Marke
| Field | Type | Description |
|-----------------|---------------------|-------------|
| `amm_account` | String | The [Address][] of the AMM Account. |
| `amount` | [Currency Amount][] | The total amount of one asset in the AMM's pool. |
| `amount2` | [Currency Amount][] | The total amount of the other asset in the AMM's pool. |
| `amount` | [Currency Amount][] | The total amount of one asset in the AMM's pool. (Note: This could be `asset` _or_ `asset2` from the request.) |
| `amount2` | [Currency Amount][] | The total amount of the other asset in the AMM's pool. (Note: This could be `asset` _or_ `asset2` from the request.) |
| `asset_frozen` | Boolean | _(Omitted for XRP)_ If `true`, the `amount` currency is currently [frozen](freezes.html). |
| `asset2_frozen` | Boolean | _(Omitted for XRP)_ If `true`, the `amount2` currency is currently [frozen](freezes.html). |
| `auction_slot` | Object | _(May be omitted)_ An [Auction Slot Object](#auction-slot-object) describing the current auction slot holder, if there is one. |