Skip to content

Commit 380b1b8

Browse files
authored
Changing public_key to pubkey
Passing `pubkey` as a request parameter doesn't do anything. We need to pass in `public_key` to get the desired result
1 parent 4c7b2ec commit 380b1b8

File tree

1 file changed

+4
-4
lines changed
  • content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods

1 file changed

+4
-4
lines changed

content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/crawl_shards.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ An example of the request format:
1616
```json
1717
{
1818
"command": "crawl_shards",
19-
"pubkey": true,
19+
"public_key": true,
2020
"limit": 0
2121
}
2222
```
@@ -28,7 +28,7 @@ An example of the request format:
2828
"method": "crawl_shards",
2929
"params": [
3030
{
31-
"pubkey": true,
31+
"public_key": true,
3232
"limit": 0
3333
}
3434
]
@@ -43,7 +43,7 @@ The request includes the following fields:
4343

4444
| `Field` | Type | Description |
4545
|:---------|:--------|:--------------------------------------------------------|
46-
| `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`. |
46+
| `public_key` | 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`. |
4747
| `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 maximum value is `3`. |
4848

4949
**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.
@@ -122,7 +122,7 @@ Each member of the `peers` array of the response is an object that describes one
122122
|:----------|:-------|:--------------------------------------------------------|
123123
| `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. |
124124
| `ip` | String | _(May be omitted)_ The IP address of the peer this object describes. This may be an IPv4 or IPv6 address. Omitted if this is a [private peer](peer-protocol.html#private-peers). |
125-
| `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). |
125+
| `public_key` | String | _(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](base58-encodings.html). |
126126

127127

128128
### Possible Errors

0 commit comments

Comments
 (0)