From 2d90cf63df2cd0c3f63d53a2a95ea5d888087f2a Mon Sep 17 00:00:00 2001 From: Arceliar Date: Mon, 10 Dec 2018 19:59:18 -0600 Subject: [PATCH] Add some information about dhtPing to admin.md --- admin.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/admin.md b/admin.md index 25e93bf..831032f 100644 --- a/admin.md +++ b/admin.md @@ -288,3 +288,18 @@ Removes an existing crypto-key source subnet. Returns: - Zero or more successful `string` source subnets in the `"removed"` section - Zero or more failed `string` source subnets in the `"not_removed"` section + +#### `dhtPing` + +Expects: +- `box_pub_key=` `string`, hex-encoded public key of the remote node to ping, in the same format as e.g. verbose output from a `getDHT` response +- `coords=` `string`, location of the remote node in the network, in the same format as e.g. a `getDHT` response +- `target=` `string`, hex-encoded 512-bit NodeID to ask about, affects what the response from the remote node will be, optional + +Asks a remote node to respond with information from the DHT + +Returns a `nodes` section with information about each node included in the DHT lookup response, indexed by IPv6. + +For each IPv6 address, this includes: +- `box_pub_key` (`string`) contains the `EncryptionPublicKey` of the remote node +- `coords` (`string`) contains the coordinates of the node on the spanning tree