crawl_shards: start drafting method ref

2025-11-20 19:55:54 +00:00 · 2019-01-24 13:37:45 -08:00
parent 30d051b8a7
commit 8e64cd4219
1 changed files with 134 additions and 0 deletions
--- a/content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/crawl_shards.md
+++ b/content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/crawl_shards.md
@@ -0,0 +1,134 @@
+# crawl_shards
+[[Source]<br>](https://github.com/ripple/rippled/blob/master/src/ripple/rpc/handlers/CrawlShards.cpp "Source")
+
+Requests information from peer servers about which [shards of historical ledger data](history-sharding.html) they have available. [New in: rippled 1.2.0][]
+
+_The `crawl_shards` method is an [admin method](admin-rippled-methods.html) that cannot be run by unprivileged users._
+
+### Request Format
+
+An example of the request format:
+
+<!-- MULTICODE_BLOCK_START -->
+
+*WebSocket*
+
+```json
+{
+  "command": "crawl_shards",
+  "pubkey": true,
+  "limit": 2
+}
+```
+
+*JSON-RPC*
+
+```json
+{
+  "method": "crawl_shards",
+  "params": [
+    {
+      "pubkey": true,
+      "limit": 2
+    }
+  ]
+}
+```
+
+<!-- MULTICODE_BLOCK_END -->
+
+
+The request includes the following fields:
+
+| `Field`  | Type    | Description                                             |
+|:---------|:--------|:--------------------------------------------------------|
+| `pubkey` | Boolean | _(Optional)_ If `true`, the response includes the node public keys (for peer-to-peer communications) of servers that were crawled. The default is `false`. |
+| `limit`  | Number  | _(Optional)_ How many hops deep to search. The default is 0, which searches direct peers only. With a limit of `1`, searches peers' peers also. (The number of peers searched potentially grows exponentially as `limit` increases.) The maximum value is `3`. |
+
+
+### Response Format
+
+An example of a successful response:
+
+<!-- MULTICODE_BLOCK_START -->
+
+*WebSocket*
+
+```json
+{
+  "result": {
+    "complete_shards": "1-2,5,8-9,584,1973,2358",
+    "peers": [
+      {
+        "complete_shards": "1-2,8,47,371,464,554,653,857,1076,1402,1555,1708,1813,1867",
+        "public_key": "n9LxFZiySnfDSvfh23N94UxsFkCjWyrchTeKHcYE6tJJQL5iejb2"
+      },
+      {
+        "complete_shards": "8-9,584",
+        "ip": "192.168.1.132",
+        "public_key": "n9MN5xwYqbrj64rtfZAXQy7Y3sNxXZJeLt7Lj61a9DYEZ4SE2tQQ"
+      }
+    ]
+  },
+  "status": "success",
+  "type": "response"
+}
+```
+
+
+*JSON-RPC*
+
+```json
+200 OK
+
+{
+  "result": {
+    "complete_shards": "1-2,5,8-9,584,1973,2358",
+    "peers": [
+      {
+        "complete_shards": "1-2,8,47,371,464,554,653,857,1076,1402,1555,1708,1813,1867",
+        "public_key": "n9LxFZiySnfDSvfh23N94UxsFkCjWyrchTeKHcYE6tJJQL5iejb2"
+      },
+      {
+        "complete_shards": "8-9,584",
+        "ip": "192.168.1.132",
+        "public_key": "n9MN5xwYqbrj64rtfZAXQy7Y3sNxXZJeLt7Lj61a9DYEZ4SE2tQQ"
+      }
+    ],
+    "status": "success"
+  }
+}
+```
+
+
+<!-- MULTICODE_BLOCK_END -->
+
+The response follows the [standard format][], with a successful result containing the following fields:
+
+| `Field`           | Type   | Description                                     |
+|:------------------|:-------|:------------------------------------------------|
+| `complete_shards` | String | The range of history shards that are available across all servers that were searched. This may be disjointed. For example, `1-2,5,7-9` indicates that shards 1, 2, 5, 7, 8, and 9 are available. |
+| `peers`           | Array  | List of **Peer Shard Objects** (see below) describing which history shards each peer has available. Only includes servers that have [history sharding](history-sharding.html) enabled. |
+
+#### Peer Shard Objects
+
+Each member of the `peers` array of the response is an object that describes one server in the peer-to-peer network. These objects contain the following fields:
+
+
+| `Field`   | Type   | Description                                             |
+|:----------|:-------|:--------------------------------------------------------|
+| `complete_shards` | String | The range of history shards this peer has available. This may be disjointed. For example, `1-2,5,7-9` indicates that shards 1, 2, 5, 7, 8, and 9 are available. |
+| `ip` | String | _(May be omitted)_ The IP address of the peer this object describes. This may be an IPv4 or IPv6 address. Omitted if the server is a private peer. |
+| `public_key` | String | _(Omitted unless the request specified `"pubkey": true`)_ The public key this peer uses for peer-to-peer communications, in the XRP Ledger's [base58 format](base58-encodings.html). |
+
+
+### Possible Errors
+
+- Any of the [universal error types][].
+- `invalidParams` - One or more required fields were omitted from the request, or a provided field was specified as the wrong data type.
+
+
+<!--{# common link defs #}-->
+{% include '_snippets/rippled-api-links.md' %}
+{% include '_snippets/tx-type-links.md' %}
+{% include '_snippets/rippled_versions.md' %}