Merge pull request XRPLF#1704 from XRPLF/amm_api_updates

amm_info updates
jonathanlei · Jan 28, 2023 · 9a675d3 · 9a675d3
2 parents cdb9939 + f335de0
commit 9a675d3
Show file tree

Hide file tree

Showing 10 changed files with 303 additions and 159 deletions.
diff --git a/assets/js/apitool-methods-ws.js b/assets/js/apitool-methods-ws.js
@@ -197,6 +197,26 @@ Request('ledger_entry - AccountRoot', {
   }
 })
 
+Request('ledger_entry - AMM', {
+  description: "Returns a single Automated Market Maker object in its raw ledger format.",
+  link: "ledger_entry.html#get-amm-object",
+  status: "not_enabled",
+  body: {
+    "id": "example_get_amm",
+    "command": "ledger_entry",
+    "amm": {
+      "asset": {
+        "currency": "XRP"
+      },
+      "asset2": {
+        "currency" : "TST",
+        "issuer" : "rP9jPyP5kyvFRb6ZiRghAGw5u8SGAmU4bd"
+      }
+    },
+    "ledger_index": "validated"
+  }
+})
+
 Request('ledger_entry - DirectoryNode', {
   description: "Returns a directory object in its raw ledger format.",
   link: "ledger_entry.html#get-directorynode-object",

diff --git a/content/_snippets/lowercase-types.md b/content/_snippets/lowercase-types.md
@@ -0,0 +1 @@
+The valid types are: `account`, `amendments`, `amm` :not_enabled:,  `check`, `deposit_preauth`, `directory`, `escrow`, `fee`, `hashes`, `nft_offer`, `offer`, `payment_channel`, `signer_list`, `state` (trust line), and `ticket`.
diff --git a/content/_snippets/rippled-api-links.md b/content/_snippets/rippled-api-links.md
@@ -118,6 +118,7 @@
   "account_objects",
   "account_offers",
   "account_tx",
+  "amm_info",
   "book_offers",
   "can_delete",
   "channel_authorize",

diff --git a/...ences/http-websocket-apis/public-api-methods/account-methods/account_objects.md b/...ences/http-websocket-apis/public-api-methods/account-methods/account_objects.md
@@ -71,15 +71,15 @@ rippled account_objects r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 validated
 
 The request includes the following parameters:
 
-| `Field`                  | Type             | Description                    |
-|:-------------------------|:-----------------|:-------------------------------|
-| `account`                | String           | A unique identifier for the account, most commonly the account's address. |
-| `type`                   | String           | _(Optional)_ If included, filter results to include only this type of ledger object. The valid types are: `check`, `deposit_preauth`, `escrow`, `offer`, `payment_channel`, `signer_list`, `ticket`,  `state` (trust line), and `nft_offer`. <!-- Author's note: Omitted types that can't be owned by an account --> |
-| `deletion_blockers_only` | Boolean          | _(Optional)_ If `true`, the response only includes objects that would block this account from [being deleted](accounts.html#deletion-of-accounts). The default is `false`. [New in: rippled 1.4.0][] |
-| `ledger_hash`            | String           | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]) |
-| `ledger_index`           | String or Number | _(Optional)_ The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) |
-| `limit`                  | Number           | _(Optional)_ The maximum number of objects to include in the results. Must be within the inclusive range `10` to `400` on non-admin connections. The default is `200`. |
-| `marker`                 | [Marker][]       | _(Optional)_ Value from a previous paginated response. Resume retrieving data where that response left off. |
+| `Field`                  | Type             | Required? | Description |
+|:-------------------------|:-----------------|:----------|-------------|
+| `account`                | String           | Yes       | A unique identifier for the account, most commonly the account's [Address][]. |
+| `deletion_blockers_only` | Boolean          | No        | If `true`, the response only includes objects that would block this account from [being deleted](accounts.html#deletion-of-accounts). The default is `false`. [New in: rippled 1.4.0][] |
+| `ledger_hash`            | [Hash][]         | No        | A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]) |
+| `ledger_index`           | [Ledger Index][] | No        | The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) |
+| `limit`                  | Number           | No        | The maximum number of objects to include in the results. Must be within the inclusive range `10` to `400` on non-admin connections. The default is `200`. |
+| `marker`                 | [Marker][]       | No        | Value from a previous paginated response. Resume retrieving data where that response left off. |
+| `type`                   | String           | No        | Filter results by a ledger entry type. The valid types are: `check`, `deposit_preauth`, `escrow`, `nft_offer`, `offer`, `payment_channel`, `signer_list`, `state` (trust line), and `ticket`. <!-- Author's note: Omitted types that can't be owned by an account --> |
 
 ## Response Format
 

diff --git a/content/references/http-websocket-apis/public-api-methods/ledger-methods/ledger.md b/content/references/http-websocket-apis/public-api-methods/ledger-methods/ledger.md
@@ -63,17 +63,19 @@ rippled ledger validated
 
 The request can contain the following parameters:
 
-| `Field`        | Type                       | Description                    |
-|:---------------|:---------------------------|:-------------------------------|
-| `ledger_hash`  | String                     | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]). |
-| `ledger_index` | String or Unsigned Integer | _(Optional)_ The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) |
-| `full`         | Boolean                    | _(Optional)_ **Admin required** If `true`, return full information on the entire ledger. Ignored if you did not specify a ledger version. The default is `false`. (Equivalent to enabling `transactions`, `accounts`, and `expand`.) The [Clio server](the-clio-server.html) does not support this field. **Caution:** On Mainnet, this can be gigabytes worth of data, so the request is likely to time out. |
-| `accounts`     | Boolean                    | _(Optional)_ **Admin required.** If `true`, return information on accounts in the ledger. Ignored if you did not specify a ledger version. The default is `false`. **Caution:** On Mainnet, this can be gigabytes worth of data, so the request is likely to time out. |
-| `transactions` | Boolean                    | _(Optional)_ If `true`, return information on transactions in the specified ledger version. The default is `false`. Ignored if you did not specify a ledger version. |
-| `expand`       | Boolean                    | _(Optional)_ Provide full JSON-formatted information for transaction/account information instead of only hashes. The default is `false`. Ignored unless you request transactions, accounts, or both. |
-| `owner_funds`  | Boolean                    | _(Optional)_ If `true`, include `owner_funds` field in the metadata of OfferCreate transactions in the response. The default is `false`. Ignored unless transactions are included and `expand` is true. |
-| `binary`       | Boolean                    | _(Optional)_ If `true`, and `transactions` and `expand` are both also `true`, return transaction information in binary format (hexadecimal string) instead of JSON format. [New in: rippled 0.28.0][] |
-| `queue`        | Boolean                    | _(Optional)_ If `true`, and the command is requesting the `current` ledger, includes an array of [queued transactions](transaction-cost.html#queued-transactions) in the results.
+| `Field`        | Type             | Required? | Description |
+|:---------------|:-----------------|:----------|-------------|
+| `ledger_hash`  | [Hash][]         | No        | A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]). |
+| `ledger_index` | [Ledger Index][] | No        | The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) |
+| `full`         | Boolean          | No        | **Admin only** If `true`, return full information on the entire ledger. Ignored if you did not specify a ledger version. The default is `false`. (Equivalent to enabling `transactions`, `accounts`, and `expand`.) The [Clio server](the-clio-server.html) does not support this field. **Caution:** On Mainnet, this can be gigabytes worth of data, so the request is likely to time out. |
+| `accounts`     | Boolean          | No        | **Admin only.** If `true`, return the ledger's entire state data. Ignored if you did not specify a ledger version. The default is `false`. **Caution:** On Mainnet, this can be gigabytes worth of data, so the request is likely to time out. Use [ledger_data][ledger_data method] instead to fetch state data across multiple paginated requests. |
+| `transactions` | Boolean          | No        | If `true`, return information on transactions in the specified ledger version. The default is `false`. Ignored if you did not specify a ledger version. |
+| `expand`       | Boolean          | No        | Provide full JSON-formatted information for transaction/account information instead of only hashes. The default is `false`. Ignored unless you request transactions, accounts, or both. |
+| `owner_funds`  | Boolean          | No        | If `true`, include `owner_funds` field in the metadata of OfferCreate transactions in the response. The default is `false`. Ignored unless transactions are included and `expand` is true. |
+| `binary`       | Boolean          | No        | If `true`, and `transactions` and `expand` are both also `true`, return transaction information in binary format (hexadecimal string) instead of JSON format. [New in: rippled 0.28.0][] |
+| `queue`        | Boolean          | No        | If `true`, and the command is requesting the `current` ledger, includes an array of [queued transactions](transaction-cost.html#queued-transactions) in the results. |
+| `type`         | String           | No        | Filter by a ledger entry type. {% include '_snippets/lowercase-types.md' %} Ignored unless you request `accounts` (state data). |
+
 
 The `ledger` field is deprecated and may be removed without further notice.
 

diff --git a/...references/http-websocket-apis/public-api-methods/ledger-methods/ledger_data.md b/...references/http-websocket-apis/public-api-methods/ledger-methods/ledger_data.md
@@ -50,13 +50,14 @@ An example of the request format:
 
 A request can include the following fields:
 
-| `Field`        | Type                      | Required? | Description    |
-|:---------------|:--------------------------|:----------|----------------|
-| `ledger_hash`  | String - [Hash][]         | No        | A 20-byte hex string identifying the ledger version to use. |
-| `ledger_index` | Number - [Ledger Index][] | No        | The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) |
-| `binary`       | Boolean                   | No        | If `true`, return ledger entries as hexadecimal strings instead of JSON. The default is `false`. |
-| `limit`        | Integer                   | No        | Limit the number of ledger entries to retrieve. The server may return fewer than this number of entries. Cannot be more than 2048 (when requesting binary) or 256 (when requesting JSON). The default is the maximum. |
-| `marker`       | [Marker][]                | No        | Value from a previous paginated response. Resume retrieving data where that response left off. |
+| `Field`        | Type             | Required? | Description    |
+|:---------------|:-----------------|:----------|----------------|
+| `ledger_hash`  | [Hash][]         | No        | A 20-byte hex string identifying the ledger version to use. |
+| `ledger_index` | [Ledger Index][] | No        | The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) |
+| `binary`       | Boolean          | No        | If `true`, return ledger entries as hexadecimal strings instead of JSON. The default is `false`. |
+| `limit`        | Number           | No        | Limit the number of ledger entries to retrieve. The server may return fewer than this number of entries. Cannot be more than 2048 (when requesting binary) or 256 (when requesting JSON). The default is the maximum. |
+| `marker`       | [Marker][]       | No        | Value from a previous paginated response. Resume retrieving data where that response left off. |
+| `type`         | String           | No        | Filter results to a specific type of ledger entry. {% include '_snippets/lowercase-types.md' %} |
 
 The `ledger` field is deprecated and may be removed without further notice.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		The valid types are: `account`, `amendments`, `amm` :not_enabled:, `check`, `deposit_preauth`, `directory`, `escrow`, `fee`, `hashes`, `nft_offer`, `offer`, `payment_channel`, `signer_list`, `state` (trust line), and `ticket`.