XRP Ledger Apex is back in Amsterdam

Register Now
Documentation
/
References
/
HTTP / WebSocket APIs
/
Admin API Methods
/
Logging and Data Management Methods
/
crawl_shards
Last updated
Edit

crawl_shards

[Source]

Requests information from peer servers about which shards of historical ledger data they have available.

The crawl_shards method is an admin method that cannot be run by unprivileged users.

Request Format

An example of the request format:

  1. WebSocket
  2. JSON-RPC
{
  "command": "crawl_shards",
  "public_key": true,
  "limit": 0
}

Note: There is no command-line syntax for this method. Use the json method to access this from the command line.

The request includes the following fields:

FieldTypeDescription
public_keyBoolean(Optional) If true, the response includes the node public keys (for peer-to-peer communications) of servers that were crawled. The default is false.
limitNumber(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 maximum value is 3.

Caution: The number of peers potentially searched grows exponentially as limit increases. With a limit of 2 or 3, it can take several seconds for the server to respond to the API request.

Response Format

An example of a successful response:

  1. WebSocket
  2. JSON-RPC
{
  "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"
}

The response follows the standard format, with a successful result containing the following fields:

FieldTypeDescription
complete_shardsString(May be omitted) The range of history shards that are available on the local server. This may be an empty string, or a disjointed range. For example, 1-2,5,7-9 indicates that shards 1, 2, 5, 7, 8, and 9 are available. Omitted if this server does not have history sharding enabled.
peersArray(May be omitted) List of Peer Shard Objects (see below) describing which history shards each peer has available. The response omits this field if no peers within the number of hops specified by limit have any shards.

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. The list only includes peers that have at least one complete history shard available. Each object in the array has the following fields:

FieldTypeDescription
complete_shardsStringThe range of complete 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.
incomplete_shardsString(May be omitted) A comma-separated list of history shards this peer has partially downloaded, and percent completion for each. For example, 1:50,2:25 indicates that shard 1 is 50% downloaded and shard 2 is 25% downloaded. New in: rippled 1.8.1
public_keyString(Omitted unless the request specified "public_key": true) The public key this peer uses for peer-to-peer communications, in the XRP Ledger's base58 format.

The ip field is no longer provided. Removed in: rippled 1.8.1

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.
  • reportingUnsupported - (Reporting Mode servers only) This method is not available in Reporting Mode.