docs

docs/cli/index.html

@@ -482,6 +482,13 @@
     peer_list
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#peer_ping" title="peer_ping" class="md-nav__link">
+    peer_ping
+  </a>
+  
 </li>
       
         <li class="md-nav__item">
@@ -891,6 +898,13 @@
     peer_list
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#peer_ping" title="peer_ping" class="md-nav__link">
+    peer_ping
+  </a>
+  
 </li>
       
         <li class="md-nav__item">
@@ -1087,11 +1101,9 @@
 Usage:
     blob_announce [&lt;blob_hash&gt; | --blob_hash=&lt;blob_hash&gt;]
                   [&lt;stream_hash&gt; | --stream_hash=&lt;stream_hash&gt;] | [&lt;sd_hash&gt; | --sd_hash=&lt;sd_hash&gt;]
-                  [--announce_all]
 
 
 Options:
-    --announce_all               :  (bool)  announce all the blobs possessed by user
     --blob_hash=&lt;blob_hash&gt;      :  (str)  announce a blob, specified by blob_hash
     --stream_hash=&lt;stream_hash&gt;  :  (str)  announce all blobs associated with
                                            stream_hash
@@ -1194,7 +1206,7 @@ Usage:
 
 
 Options:
-    --reflector_server=&lt;reflector_server&gt;         (str)  :  reflector  address
+    --reflector_server=&lt;reflector_server&gt;  :  (str)  reflector address
 
 Returns:
     (list) reflected blob hashes
@@ -1795,7 +1807,21 @@ Options:
     --timeout=&lt;timeout&gt;      :  (int)  peer search timeout in seconds
 
 Returns:
-    (list) List of contacts
+    (list) List of contact dictionaries {'host': &lt;peer ip&gt;, 'port': &lt;peer port&gt;, 'node_id': &lt;peer node id&gt;}
+</code></pre>
+
+<h2 id="peer_ping">peer_ping</h2>
+<pre><code class="text">Find and ping a peer by node id
+
+Usage:
+    peer_ping (&lt;node_id&gt; | --node_id=&lt;node_id&gt;)
+
+
+Options:
+          None
+
+Returns:
+    (str) pong, or {'error': &lt;error message&gt;} if an error is encountered
 </code></pre>
 
 <h2 id="publish">publish</h2>
@@ -2052,12 +2078,11 @@ Returns:
 <pre><code class="text">Get daemon status
 
 Usage:
-    status [--session_status] [--dht_status]
+    status [--session_status]
 
 
 Options:
     --session_status  :  (bool)  include session status in results
-    --dht_status      :  (bool)  include dht network and peer status
 
 Returns:
     (dict) lbrynet-daemon status
@@ -2088,18 +2113,6 @@ Returns:
                 'announce_queue_size': number of blobs currently queued to be announced
                 'should_announce_blobs': number of blobs that should be announced
             }
-
-        If given the dht status option:
-            'dht_status': {
-                'kbps_received': current kbps receiving,
-                'kbps_sent': current kdps being sent,
-                'total_bytes_sent': total bytes sent,
-                'total_bytes_received': total bytes received,
-                'queries_received': number of queries received per second,
-                'queries_sent': number of queries sent per second,
-                'recent_contacts': count of recently contacted peers,
-                'unique_contacts': count of unique peers
-            },
     }
 </code></pre>
 

docs/index.html

@@ -470,6 +470,13 @@
     peer_list
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#peer_ping" title="peer_ping" class="md-nav__link">
+    peer_ping
+  </a>
+  
 </li>
       
         <li class="md-nav__item">
@@ -891,6 +898,13 @@
     peer_list
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#peer_ping" title="peer_ping" class="md-nav__link">
+    peer_ping
+  </a>
+  
 </li>
       
         <li class="md-nav__item">
@@ -1085,7 +1099,6 @@
 <pre><code class="text">Announce blobs to the DHT
 
 Args:
-    'announce_all'  :  (bool)  announce all the blobs possessed by user
     'blob_hash'    :  (str)  announce a blob, specified by blob_hash
     'stream_hash'  :  (str)  announce all blobs associated with
                              stream_hash
@@ -1162,7 +1175,7 @@ Returns:
 <pre><code class="text">Reflects specified blobs
 
 Args:
-    'reflector_server'  :  reflector  address
+    'reflector_server'  :  (str)  reflector address
 
 Returns:
     (list) reflected blob hashes
@@ -1648,7 +1661,17 @@ Args:
     'timeout'               :  (int)  peer search timeout in seconds
 
 Returns:
-    (list) List of contacts
+    (list) List of contact dictionaries {'host': &lt;peer ip&gt;, 'port': &lt;peer port&gt;, 'node_id': &lt;peer node id&gt;}
+</code></pre>
+
+<h2 id="peer_ping">peer_ping</h2>
+<pre><code class="text">Find and ping a peer by node id
+
+Args:
+          None
+
+Returns:
+    (str) pong, or {'error': &lt;error message&gt;} if an error is encountered
 </code></pre>
 
 <h2 id="publish">publish</h2>
@@ -1863,7 +1886,6 @@ Returns:
 
 Args:
     'session_status'  :  (bool)  include session status in results
-    'dht_status'      :  (bool)  include dht network and peer status
 
 Returns:
     (dict) lbrynet-daemon status
@@ -1894,18 +1916,6 @@ Returns:
                 'announce_queue_size': number of blobs currently queued to be announced
                 'should_announce_blobs': number of blobs that should be announced
             }
-
-        If given the dht status option:
-            'dht_status': {
-                'kbps_received': current kbps receiving,
-                'kbps_sent': current kdps being sent,
-                'total_bytes_sent': total bytes sent,
-                'total_bytes_received': total bytes received,
-                'queries_received': number of queries received per second,
-                'queries_sent': number of queries sent per second,
-                'recent_contacts': count of recently contacted peers,
-                'unique_contacts': count of unique peers
-            },
     }
 </code></pre>