mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-04 20:05:50 +00:00
update docs for pr 5271
This commit is contained in:
@@ -65,9 +65,9 @@ The following amendments are open for voting with this release:
|
||||
- Improved UNL security by enabling validators to set a minimum number of UNL publishers to agree on validators. ([#5112](https://github.com/XRPLF/rippled/pull/5112)) **TODO: doc UNL config**
|
||||
- Added a new `simulate` API method to execute dry runs of transactions and see the simulated metadata. ([#5069](https://github.com/XRPLF/rippled/pull/5069), [#5265](https://github.com/XRPLF/rippled/pull/5265)) **TODO: doc new API method**
|
||||
- Updated the XRPL Foundation UNL keys. ([#5289](https://github.com/XRPLF/rippled/pull/5289))
|
||||
- Added support to filter ledger entry types by their canonical names in the `ledger`, `ledger_data`, and `account_objects` API methods. ([#5271](https://github.com/XRPLF/rippled/pull/5271)) **TODO: doc updates for API methods**
|
||||
- Added support to filter ledger entry types by their canonical names in the `ledger`, `ledger_data`, and `account_objects` API methods. ([#5271](https://github.com/XRPLF/rippled/pull/5271))
|
||||
- Added detailed logging for each validation and proposal received from the network. ([#5291](https://github.com/XRPLF/rippled/pull/5291))
|
||||
- Improved git commit hash lookups when checking the version of a `rippled` debug build. Also added git commit hash info when using the `server_info` API method on an admin connection. ([#5225](https://github.com/XRPLF/rippled/pull/5225)) **TODO: update server_info docs**
|
||||
- Improved git commit hash lookups when checking the version of a `rippled` debug build. Also added git commit hash info when using the `server_info` API method on an admin connection. ([#5225](https://github.com/XRPLF/rippled/pull/5225))
|
||||
|
||||
|
||||
### Bug fixes
|
||||
|
||||
@@ -84,7 +84,23 @@ The request includes the following parameters:
|
||||
| `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: `bridge`, `check`, `deposit_preauth`, `escrow`, `nft_offer`, `nft_page`, `offer`, `payment_channel`, `signer_list`, `state` (trust line), and `ticket`. <!-- Author's note: Omitted types that can't be owned by an account --> |
|
||||
| `type` | String | No | Filter results to a specific type of ledger entry. This field accepts canonical ledger entry names (case insensitive) or short names. |
|
||||
|
||||
Valid `type` field values are:
|
||||
<!-- Author's note: Omitted types that can't be owned by an account -->
|
||||
| Canonical Name | Short Name |
|
||||
| ---------------- | ----------------- |
|
||||
| `Bridge` | `bridge` |
|
||||
| `Check` | `check` |
|
||||
| `DepositPreauth` | `deposit_preauth` |
|
||||
| `Escrow` | `escrow` |
|
||||
| `NFTokenOffer` | `nft_offer` |
|
||||
| `NFTokenPage` | `nft_page` |
|
||||
| `Offer` | `offer` |
|
||||
| `PayChannel` | `payment_channel` |
|
||||
| `RippleState` | `state` |
|
||||
| `SignerList` | `signer_list` |
|
||||
| `Ticket` | `ticket` |
|
||||
|
||||
{% admonition type="info" name="Note" %}The commandline interface to the `account_objects` command doesn't accept the `type` field. Use the [json method][] to send the JSON-RPC format request on the commandline instead.{% /admonition %}
|
||||
|
||||
|
||||
@@ -59,10 +59,33 @@ A request can include the following fields:
|
||||
| `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). Positive values outside this range are replaced with the closest valid option. 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. The valid types are: `account`, `amendments`, `amm`, `check`, `deposit_preauth`, `directory`, `escrow`, `fee`, `hashes`, `nft_offer`, `offer`, `payment_channel`, `signer_list`, `state` (trust line), and `ticket`. |
|
||||
| `type` | String | No | Filter results to a specific type of ledger entry. This field accepts canonical ledger entry names (case insensitive) or short names. |
|
||||
|
||||
Valid `type` field values are:
|
||||
|
||||
| Canonical Name | Short Name |
|
||||
| ----------------- | ----------------- |
|
||||
| `AccountRoot` | `account` |
|
||||
| `Amendments` | `amendments` |
|
||||
| `AMM` | `amm` |
|
||||
| `Check` | `check` |
|
||||
| `DepositPreauth` | `deposit_preauth` |
|
||||
| `DirectoryNode` | `directory` |
|
||||
| `Escrow` | `escrow` |
|
||||
| `FeeSettings` | `fee` |
|
||||
| `LedgerHashes` | `hashes` |
|
||||
| `MPToken` | `mptoken` |
|
||||
| `MPTokenIssuance` | `mpt_issuance` |
|
||||
| `NFTokenOffer ` | `nft_offer` |
|
||||
| `Offer` | `offer` |
|
||||
| `PayChannel` | `payment_channel` |
|
||||
| `RippleState` | `state` |
|
||||
| `SignerList` | `signer_list` |
|
||||
| `Ticket` | `ticket` |
|
||||
|
||||
The `ledger` field is deprecated and may be removed without further notice.
|
||||
|
||||
|
||||
## Response Format
|
||||
|
||||
An example of a successful response:
|
||||
|
||||
Reference in New Issue
Block a user