diff --git a/docs/api.json b/docs/api.json index ab2945f1c..550523a03 100644 --- a/docs/api.json +++ b/docs/api.json @@ -1045,15 +1045,8 @@ "description": "Set daemon settings" }, { - "arguments": [ - { - "is_required": false, - "type": "bool", - "name": "session_status", - "description": "include session status in results" - } - ], - "returns": "(dict) lbrynet-daemon status\n {\n 'installation_id': (str) installation id - base58,\n 'is_running': (bool),\n 'is_first_run': bool,\n 'skipped_components': (list) [names of skipped components (str)],\n 'startup_status': { Does not include components which have been skipped\n 'database': (bool),\n 'wallet': (bool),\n 'session': (bool),\n 'dht': (bool),\n 'hash_announcer': (bool),\n 'stream_identifier': (bool),\n 'file_manager': (bool),\n 'peer_protocol_server': (bool),\n 'reflector': (bool),\n 'upnp': (bool),\n 'exchange_rate_manager': (bool),\n },\n 'connection_status': {\n 'code': (str) connection status code,\n 'message': (str) connection status message\n },\n 'blockchain_status': {\n 'blocks': (int) local blockchain height,\n 'blocks_behind': (int) remote_height - local_height,\n 'best_blockhash': (str) block hash of most recent block,\n },\n 'dht_node_status': {\n 'node_id': (str) lbry dht node id - hex encoded,\n 'peers_in_routing_table': (int) the number of peers in the routing table,\n },\n 'wallet_is_encrypted': (bool),\n If given the session status option:\n 'session_status': {\n 'managed_blobs': (int) count of blobs in the blob manager,\n 'managed_streams': (int) count of streams in the file manager,\n 'announce_queue_size': (int) number of blobs currently queued to be announced,\n 'should_announce_blobs': (int) number of blobs that should be announced,\n }\n }", + "arguments": [], + "returns": "(dict) lbrynet-daemon status\n {\n 'installation_id': (str) installation id - base58,\n 'is_running': (bool),\n 'is_first_run': bool,\n 'skipped_components': (list) [names of skipped components (str)],\n 'startup_status': { Does not include components which have been skipped\n 'database': (bool),\n 'wallet': (bool),\n 'session': (bool),\n 'dht': (bool),\n 'hash_announcer': (bool),\n 'stream_identifier': (bool),\n 'file_manager': (bool),\n 'blob_manager': (bool),\n 'blockchain_headers': (bool),\n 'peer_protocol_server': (bool),\n 'reflector': (bool),\n 'upnp': (bool),\n 'exchange_rate_manager': (bool),\n },\n 'connection_status': {\n 'code': (str) connection status code,\n 'message': (str) connection status message\n },\n 'blockchain_headers': {\n 'downloading_headers': (bool),\n 'download_progress': (float) 0-100.0\n },\n 'wallet': {\n 'blocks': (int) local blockchain height,\n 'blocks_behind': (int) remote_height - local_height,\n 'best_blockhash': (str) block hash of most recent block,\n 'is_encrypted': (bool)\n },\n 'dht': {\n 'node_id': (str) lbry dht node id - hex encoded,\n 'peers_in_routing_table': (int) the number of peers in the routing table,\n },\n 'blob_manager': {\n 'finished_blobs': (int) number of finished blobs in the blob manager,\n },\n 'hash_announcer': {\n 'announce_queue_size': (int) number of blobs currently queued to be announced\n },\n 'file_manager': {\n 'managed_files': (int) count of files in the file manager,\n }\n }", "name": "status", "description": "Get daemon status" }, diff --git a/docs/cli/index.html b/docs/cli/index.html index 49bff2650..3918ab67b 100644 --- a/docs/cli/index.html +++ b/docs/cli/index.html @@ -1579,12 +1579,12 @@ Usage: Options: - --a_arg : a arg - --b_arg : b arg - --pos_arg=<pos_arg> : pos arg - --pos_args=<pos_args> : pos args - --pos_arg2=<pos_arg2> : pos arg 2 - --pos_arg3=<pos_arg3> : pos arg 3 + --a_arg : (bool) a arg + --b_arg : (bool) b arg + --pos_arg=<pos_arg> : (int) pos arg + --pos_args=<pos_args> : (int) pos args + --pos_arg2=<pos_arg2> : (int) pos arg 2 + --pos_arg3=<pos_arg3> : (int) pos arg 3 Returns: pos args @@ -1828,14 +1828,16 @@ Returns:
Find and ping a peer by node id
+Send a kademlia ping to the specified peer. If address and port are provided the peer is directly pinged,
+if not provided the peer is located first.
Usage:
- peer_ping (<node_id> | --node_id=<node_id>)
+ peer_ping (<node_id> | --node_id=<node_id>) [<address> | --address=<address>] [<port> | --port=<port>]
Options:
- None
+ --address=<address> : (str) ip address of the peer
+ --port=<port> : (int) udp port of the peer
Returns:
(str) pong, or {'error': <error message>} if an error is encountered
@@ -2110,41 +2112,61 @@ Returns:
Get daemon status
Usage:
- status [--session_status]
+ status
Options:
- --session_status : (bool) include session status in results
+ None
Returns:
(dict) lbrynet-daemon status
{
- 'lbry_id': lbry peer id, base58,
- 'installation_id': installation id, base58,
- 'is_running': bool,
+ 'installation_id': (str) installation id - base58,
+ 'is_running': (bool),
'is_first_run': bool,
- 'startup_status': {
- 'code': status code,
- 'message': status message
+ 'skipped_components': (list) [names of skipped components (str)],
+ 'startup_status': { Does not include components which have been skipped
+ 'database': (bool),
+ 'wallet': (bool),
+ 'session': (bool),
+ 'dht': (bool),
+ 'hash_announcer': (bool),
+ 'stream_identifier': (bool),
+ 'file_manager': (bool),
+ 'blob_manager': (bool),
+ 'blockchain_headers': (bool),
+ 'peer_protocol_server': (bool),
+ 'reflector': (bool),
+ 'upnp': (bool),
+ 'exchange_rate_manager': (bool),
},
'connection_status': {
- 'code': connection status code,
- 'message': connection status message
+ 'code': (str) connection status code,
+ 'message': (str) connection status message
},
- 'blockchain_status': {
- 'blocks': local blockchain height,
- 'blocks_behind': remote_height - local_height,
- 'best_blockhash': block hash of most recent block,
+ 'blockchain_headers': {
+ 'downloading_headers': (bool),
+ 'download_progress': (float) 0-100.0
},
- 'wallet_is_encrypted': bool,
-
- If given the session status option:
- 'session_status': {
- 'managed_blobs': count of blobs in the blob manager,
- 'managed_streams': count of streams in the file manager
- 'announce_queue_size': number of blobs currently queued to be announced
- 'should_announce_blobs': number of blobs that should be announced
- }
+ 'wallet': {
+ 'blocks': (int) local blockchain height,
+ 'blocks_behind': (int) remote_height - local_height,
+ 'best_blockhash': (str) block hash of most recent block,
+ 'is_encrypted': (bool)
+ },
+ 'dht': {
+ 'node_id': (str) lbry dht node id - hex encoded,
+ 'peers_in_routing_table': (int) the number of peers in the routing table,
+ },
+ 'blob_manager': {
+ 'finished_blobs': (int) number of finished blobs in the blob manager,
+ },
+ 'hash_announcer': {
+ 'announce_queue_size': (int) number of blobs currently queued to be announced
+ },
+ 'file_manager': {
+ 'managed_files': (int) count of files in the file manager,
+ }
}
@@ -2563,4 +2585,4 @@ Returns: