mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-28 07:35:50 +00:00
Fix some lingering TODOs
This commit is contained in:
mDuo13
@@ -5,7 +5,7 @@ Instructs the server to download a specific [shard of historical ledger data](hi
|
||||
|
||||
_The `download_shard` method is an [admin method](admin-rippled-methods.html) that cannot be run by unprivileged users._
|
||||
|
||||
The external source must provide the shard as an [lz4-compressed](https://lz4.github.io/lz4/) [tar archive](https://en.wikipedia.org/wiki/Tar_(computing)) served via HTTPS. The contents of the archive must match the database type used for your shard store (NuDB or RocksDB).
|
||||
The external source must provide the shard as an [lz4-compressed](https://lz4.github.io/lz4/) [tar archive](https://en.wikipedia.org/wiki/Tar_(computing)) served via HTTPS. The archive must contain the shard directory and data files in NuDB format.
|
||||
|
||||
Downloading and importing shards using this method is usually faster than acquiring the shards individually from the peer-to-peer network. You can also use this method to choose a specific range or set of shards to provide from your server.
|
||||
|
||||
@@ -103,7 +103,7 @@ The response follows the [standard format][], with a successful result containin
|
||||
|:----------|:-------|:--------------------------------------------------------|
|
||||
| `message` | String | A message describing the actions taken in response to this request. |
|
||||
|
||||
**Tip:** To see which shards your server has available, you can look at the subfolders in your configured location for the shard store (the `path` parameter of `[shard_db]` in your `rippled.cfg`). The folders are named to match the numbers of the shards; up to one of those folders may contain a `control.txt` file indicating that the shard is incomplete. <!-- TODO: Update to recommend the `crawl_shards` command if/when that command becomes available. -->
|
||||
**Tip:** To see which shards your server has available, use the [crawl_shards method][]. Alternatively, you can look at the subfolders in your configured location for the shard store (the `path` parameter of `[shard_db]` in your `rippled.cfg`). The folders are named to match the numbers of the shards; up to one of those folders may contain a `control.txt` file indicating that the shard is incomplete.
|
||||
|
||||
### Possible Errors
|
||||
|
||||
@@ -112,8 +112,6 @@ The response follows the [standard format][], with a successful result containin
|
||||
- `tooBusy` - The server is already downloading the shard, either from the peer-to-peer network or as the result of a previous `download_shard` request.
|
||||
- `invalidParams` - One or more required fields were omitted from the request, or a provided field was specified as the wrong data type.
|
||||
|
||||
<!--{# @mduo13's note: Was unable to reproduce the following feature:
|
||||
**Tip:** If you make the request with the WebSocket API, the server can notify you over the same WebSocket connection if the download fails or an error occurs while extracting the archive. TODO: Get an example of what this message looks like. #}-->
|
||||
|
||||
|
||||
<!--{# common link defs #}-->
|
||||
|
||||
@@ -3,8 +3,6 @@
|
||||
|
||||
The `account_objects` command returns the raw [ledger format][] for all objects owned by an account. For a higher-level view of an account's trust lines and balances, see the [account_lines method][] instead.
|
||||
|
||||
[ledger format]: ledger-data-formats.html
|
||||
|
||||
The types of objects that may appear in the `account_objects` response for an account include:
|
||||
|
||||
- [Offer objects](offer.html) for orders that are currently live, unfunded, or expired but not yet removed. (See [Lifecycle of an Offer](offers.html#lifecycle-of-an-offer) for more information.)
|
||||
@@ -619,5 +617,7 @@ The response follows the [standard format][], with a successful result containin
|
||||
* `lgrNotFound` - The ledger specified by the `ledger_hash` or `ledger_index` does not exist, or it does exist but the server does not have it.
|
||||
|
||||
|
||||
{% include '_snippets/rippled_versions.md' %}
|
||||
<!--{# common link defs #}-->
|
||||
{% include '_snippets/rippled-api-links.md' %}
|
||||
{% include '_snippets/tx-type-links.md' %}
|
||||
{% include '_snippets/rippled_versions.md' %}
|
||||
|
||||
@@ -196,8 +196,6 @@ If the request specified `"owner_funds": true` and expanded transactions, the re
|
||||
* `noPermission` - If you specified `full` or `accounts` as true, but are not connected to the server as an admin (usually, admin requires connecting on a local port).
|
||||
|
||||
|
||||
<!-- TODO: we should add this fee levels link to rippled-api-links.md. server_state.md is also including this as a one-off.-->
|
||||
[fee levels]: transaction-cost.html#fee-levels
|
||||
<!--{# common link defs #}-->
|
||||
{% include '_snippets/rippled-api-links.md' %}
|
||||
{% include '_snippets/tx-type-links.md' %}
|
||||
|
||||
@@ -165,7 +165,8 @@ The response follows the [standard format][], with a successful result containin
|
||||
* `unknownOption` - The fields provided in the request did not match any of the expected request formats.
|
||||
|
||||
|
||||
<!-- TODO: we should add this ledger format link to rippled-api-links.md. account_objects.md is also including this as a one-off.-->
|
||||
[ledger format]: ledger-data-formats.html
|
||||
{% include '_snippets/rippled_versions.md' %}
|
||||
|
||||
<!--{# common link defs #}-->
|
||||
{% include '_snippets/rippled-api-links.md' %}
|
||||
{% include '_snippets/tx-type-links.md' %}
|
||||
{% include '_snippets/rippled_versions.md' %}
|
||||
|
||||
@@ -158,7 +158,7 @@ The response follows the [standard format][], with a successful result containin
|
||||
* Any of the [universal error types][].
|
||||
|
||||
|
||||
<!-- TODO: fee levels link to rippled-api-links.md - it is being used one off in a couple of files -->
|
||||
[fee levels]: transaction-cost.html#fee-levels
|
||||
{% include '_snippets/rippled_versions.md' %}
|
||||
<!--{# common link defs #}-->
|
||||
{% include '_snippets/rippled-api-links.md' %}
|
||||
{% include '_snippets/tx-type-links.md' %}
|
||||
{% include '_snippets/rippled_versions.md' %}
|
||||
|
||||
@@ -320,12 +320,12 @@ The `info` object may have some arrangement of the following fields:
|
||||
|
||||
**Note:** If the `closed_ledger` field is present and has a small `seq` value (less than 8 digits), that indicates `rippled` does not currently have a copy of the validated ledger from the peer-to-peer network. This could mean your server is still syncing. Typically, it takes about 5 minutes to sync with the network, depending on your connection speed and hardware specs.
|
||||
|
||||
[transaction cost]: transaction-cost.html
|
||||
|
||||
## Possible Errors
|
||||
|
||||
* Any of the [universal error types][].
|
||||
|
||||
|
||||
{% include '_snippets/rippled_versions.md' %}
|
||||
<!--{# common link defs #}-->
|
||||
{% include '_snippets/rippled-api-links.md' %}
|
||||
{% include '_snippets/tx-type-links.md' %}
|
||||
{% include '_snippets/rippled_versions.md' %}
|
||||
|
||||
@@ -290,9 +290,8 @@ The `state` object may have some arrangement of the following fields:
|
||||
|
||||
* Any of the [universal error types][].
|
||||
|
||||
<!-- TODO: add fee levels and transaction cost to rippled-api-links.md. multiple files are including them one-off, as below -->
|
||||
[fee levels]: transaction-cost.html#fee-levels
|
||||
[transaction cost]: transaction-cost.html
|
||||
{% include '_snippets/rippled_versions.md' %}
|
||||
|
||||
<!--{# common link defs #}-->
|
||||
{% include '_snippets/rippled-api-links.md' %}
|
||||
{% include '_snippets/tx-type-links.md' %}
|
||||
{% include '_snippets/rippled_versions.md' %}
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# DepositPreauth
|
||||
[[Source]<br>](https://github.com/ripple/rippled/blob/master/src/ripple/app/tx/impl/DepositPreauth.cpp "Source") <!--{# TODO: change from develop to master when 1.1.0 is released #}-->
|
||||
[[Source]<br>](https://github.com/ripple/rippled/blob/master/src/ripple/app/tx/impl/DepositPreauth.cpp "Source")
|
||||
|
||||
_Requires the [DepositPreauth amendment][]._
|
||||
|
||||
|
||||
Reference in New Issue
Block a user