From 82ce2ccee622f9ea5dcb5031c037a1237b3f10de Mon Sep 17 00:00:00 2001 From: Jack Robison Date: Tue, 19 Feb 2019 17:26:08 -0500 Subject: [PATCH] update docs --- docs/api.json | 308 +++++--------------------------- lbrynet/extras/daemon/Daemon.py | 29 +-- 2 files changed, 62 insertions(+), 275 deletions(-) diff --git a/docs/api.json b/docs/api.json index 1709d752d..fbda58ccc 100644 --- a/docs/api.json +++ b/docs/api.json @@ -76,7 +76,7 @@ }, { "name": "account_decrypt", - "description": "Decrypt an encrypted account, this will remove the wallet password", + "description": "Decrypt an encrypted account, this will remove the wallet password. The account must be unlocked to decrypt it", "arguments": [ { "name": "account_id", @@ -376,31 +376,6 @@ ], "returns": "(bool) true if successful" }, - { - "name": "blob_availability", - "description": "Get blob availability", - "arguments": [ - { - "name": "blob_hash", - "type": "str", - "description": "check availability for this blob hash", - "is_required": true - }, - { - "name": "search_timeout", - "type": "int", - "description": "how long to search for peers for the blob in the dht", - "is_required": false - }, - { - "name": "blob_timeout", - "type": "int", - "description": "how long to try downloading from a peer", - "is_required": false - } - ], - "returns": "(dict) {\n \"is_available\": \n \"reachable_peers\": [\":\"],\n \"unreachable_peers\": [\":\"]\n }" - }, { "name": "blob_delete", "description": "Delete a blob", @@ -429,18 +404,6 @@ "type": "int", "description": "timeout in number of seconds", "is_required": false - }, - { - "name": "encoding", - "type": "str", - "description": "by default no attempt at decoding is made, can be set to one of the following decoders: 'json'", - "is_required": false - }, - { - "name": "payment_rate_manager", - "type": "str", - "description": "if not given the default payment rate manager will be used. supported alternative rate managers: 'only-free'", - "is_required": false } ], "returns": "(str) Success/Fail message or (dict) decoded data" @@ -820,12 +783,6 @@ ], "returns": "(dict) Dictionary containing the transaction information\n {\n \"hex\": (str) raw transaction,\n \"inputs\": (list) inputs(dict) used for the transaction,\n \"outputs\": (list) outputs(dict) for the transaction,\n \"total_fee\": (int) fee in dewies,\n \"total_input\": (int) total of inputs in dewies,\n \"total_output\": (int) total of outputs in dewies(input - fees),\n \"txid\": (str) txid of the transaction,\n }" }, - { - "name": "commands", - "description": "Return a list of available commands", - "arguments": [], - "returns": "(list) list of available commands" - }, { "name": "file_delete", "description": "Delete a LBRY file", @@ -975,14 +932,32 @@ "description": "get file with matching claim name", "is_required": false }, + { + "name": "blobs_in_stream", + "type": "int", + "description": "get file with matching blobs in stream", + "is_required": false + }, + { + "name": "blobs_remaining", + "type": "int", + "description": "amount of remaining blobs to download", + "is_required": false + }, { "name": "sort", "type": "str", - "description": "sort by any property, like 'file_name' or 'metadata.author'; to specify direction append ',asc' or ',desc'", + "description": "field to sort by (one of the above filter fields)", + "is_required": false + }, + { + "name": "comparison", + "type": "str", + "description": "logical comparision, (eq | ne | g | ge | l | le)", "is_required": false } ], - "returns": "(list) List of files\n\n [\n {\n 'completed': (bool) true if download is completed,\n 'file_name': (str) name of file,\n 'download_directory': (str) download directory,\n 'points_paid': (float) credit paid to download file,\n 'stopped': (bool) true if download is stopped,\n 'stream_hash': (str) stream hash of file,\n 'stream_name': (str) stream name ,\n 'suggested_file_name': (str) suggested file name,\n 'sd_hash': (str) sd hash of file,\n 'download_path': (str) download path of file,\n 'mime_type': (str) mime type of file,\n 'key': (str) key attached to file,\n 'total_bytes': (int) file size in bytes,\n 'written_bytes': (int) written size in bytes,\n 'blobs_completed': (int) number of fully downloaded blobs,\n 'blobs_in_stream': (int) total blobs on stream,\n 'status': (str) downloader status\n 'claim_id': (str) None if claim is not found else the claim id,\n 'outpoint': (str) None if claim is not found else the tx and output,\n 'txid': (str) None if claim is not found else the transaction id,\n 'nout': (int) None if claim is not found else the transaction output index,\n 'metadata': (dict) None if claim is not found else the claim metadata,\n 'channel_claim_id': (str) None if claim is not found or not signed,\n 'channel_name': (str) None if claim is not found or not signed,\n 'claim_name': (str) None if claim is not found else the claim name\n },\n ]" + "returns": "(list) List of files\n\n [\n {\n 'completed': (bool) true if download is completed,\n 'file_name': (str) name of file,\n 'download_directory': (str) download directory,\n 'points_paid': (float) credit paid to download file,\n 'stopped': (bool) true if download is stopped,\n 'stream_hash': (str) stream hash of file,\n 'stream_name': (str) stream name ,\n 'suggested_file_name': (str) suggested file name,\n 'sd_hash': (str) sd hash of file,\n 'download_path': (str) download path of file,\n 'mime_type': (str) mime type of file,\n 'key': (str) key attached to file,\n 'total_bytes_lower_bound': (int) lower bound file size in bytes,\n 'total_bytes': (int) file upper bound size in bytes,\n 'written_bytes': (int) written size in bytes,\n 'blobs_completed': (int) number of fully downloaded blobs,\n 'blobs_in_stream': (int) total blobs on stream,\n 'blobs_remaining': (int) total blobs remaining to download,\n 'status': (str) downloader status\n 'claim_id': (str) None if claim is not found else the claim id,\n 'txid': (str) None if claim is not found else the transaction id,\n 'nout': (int) None if claim is not found else the transaction output index,\n 'outpoint': (str) None if claim is not found else the tx and output,\n 'metadata': (dict) None if claim is not found else the claim metadata,\n 'channel_claim_id': (str) None if claim is not found or not signed,\n 'channel_name': (str) None if claim is not found or not signed,\n 'claim_name': (str) None if claim is not found else the claim name\n },\n ]\n}" }, { "name": "file_reflect", @@ -1083,19 +1058,6 @@ ], "returns": "(dict) Dictionary containing information about the stream\n {\n 'completed': (bool) true if download is completed,\n 'file_name': (str) name of file,\n 'download_directory': (str) download directory,\n 'points_paid': (float) credit paid to download file,\n 'stopped': (bool) true if download is stopped,\n 'stream_hash': (str) stream hash of file,\n 'stream_name': (str) stream name ,\n 'suggested_file_name': (str) suggested file name,\n 'sd_hash': (str) sd hash of file,\n 'download_path': (str) download path of file,\n 'mime_type': (str) mime type of file,\n 'key': (str) key attached to file,\n 'total_bytes': (int) file size in bytes,\n 'written_bytes': (int) written size in bytes,\n 'blobs_completed': (int) number of fully downloaded blobs,\n 'blobs_in_stream': (int) total blobs on stream,\n 'status': (str) downloader status,\n 'claim_id': (str) claim id,\n 'outpoint': (str) claim outpoint string,\n 'txid': (str) claim txid,\n 'nout': (int) claim nout,\n 'metadata': (dict) claim metadata,\n 'channel_claim_id': (str) None if claim is not signed\n 'channel_name': (str) None if claim is not signed\n 'claim_name': (str) claim name\n }" }, - { - "name": "help", - "description": "Return a useful message for an API command", - "arguments": [ - { - "name": "command", - "type": "str", - "description": "command to retrieve documentation for", - "is_required": false - } - ], - "returns": "(str) Help message" - }, { "name": "peer_list", "description": "Get peers for blob hash", @@ -1107,31 +1069,18 @@ "is_required": true }, { - "name": "timeout", + "name": "search_bottom_out_limit", "type": "int", - "description": "peer search timeout in seconds", + "description": "the number of search probes in a row that don't find any new peers before giving up and returning", "is_required": false } ], - "returns": "(list) List of contact dictionaries {'host': , 'port': , 'node_id': }" + "returns": "(list) List of contact dictionaries {'address': , 'udp_port': , 'tcp_port': ,\n 'node_id': }" }, { "name": "peer_ping", "description": "Send a kademlia ping to the specified peer. If address and port are provided the peer is directly pinged,\nif not provided the peer is located first.", - "arguments": [ - { - "name": "address", - "type": "str", - "description": "ip address of the peer", - "is_required": false - }, - { - "name": "port", - "type": "int", - "description": "udp port of the peer", - "is_required": false - } - ], + "arguments": [], "returns": "(str) pong, or {'error': } if an error is encountered" }, { @@ -1222,12 +1171,6 @@ "description": "whether the content is nsfw", "is_required": false }, - { - "name": "sources", - "type": "str", - "description": "{'lbry_sd_hash': sd_hash} specifies sd hash of file", - "is_required": false - }, { "name": "channel_name", "type": "str", @@ -1276,53 +1219,22 @@ }, { "name": "resolve", - "description": "Resolve given LBRY URIs", + "description": "Get the claim that a URL refers to.", "arguments": [ { - "name": "force", - "type": "bool", - "description": "force refresh and ignore cache", - "is_required": false - }, - { - "name": "uri", - "type": "str", - "description": "uri to resolve", - "is_required": true - }, - { - "name": "uris", - "type": "list", - "description": "uris to resolve", + "name": "urls", + "type": "str, list", + "description": "one or more urls to resolve", "is_required": false } ], - "returns": "Dictionary of results, keyed by uri\n '': {\n If a resolution error occurs:\n 'error': Error message\n\n If the uri resolves to a channel or a claim in a channel:\n 'certificate': {\n 'address': (str) claim address,\n 'amount': (float) claim amount,\n 'effective_amount': (float) claim amount including supports,\n 'claim_id': (str) claim id,\n 'claim_sequence': (int) claim sequence number,\n 'decoded_claim': (bool) whether or not the claim value was decoded,\n 'height': (int) claim height,\n 'depth': (int) claim depth,\n 'has_signature': (bool) included if decoded_claim\n 'name': (str) claim name,\n 'permanent_url': (str) permanent url of the certificate claim,\n 'supports: (list) list of supports [{'txid': (str) txid,\n 'nout': (int) nout,\n 'amount': (float) amount}],\n 'txid': (str) claim txid,\n 'nout': (str) claim nout,\n 'signature_is_valid': (bool), included if has_signature,\n 'value': ClaimDict if decoded, otherwise hex string\n }\n\n If the uri resolves to a channel:\n 'claims_in_channel': (int) number of claims in the channel,\n\n If the uri resolves to a claim:\n 'claim': {\n 'address': (str) claim address,\n 'amount': (float) claim amount,\n 'effective_amount': (float) claim amount including supports,\n 'claim_id': (str) claim id,\n 'claim_sequence': (int) claim sequence number,\n 'decoded_claim': (bool) whether or not the claim value was decoded,\n 'height': (int) claim height,\n 'depth': (int) claim depth,\n 'has_signature': (bool) included if decoded_claim\n 'name': (str) claim name,\n 'permanent_url': (str) permanent url of the claim,\n 'channel_name': (str) channel name if claim is in a channel\n 'supports: (list) list of supports [{'txid': (str) txid,\n 'nout': (int) nout,\n 'amount': (float) amount}]\n 'txid': (str) claim txid,\n 'nout': (str) claim nout,\n 'signature_is_valid': (bool), included if has_signature,\n 'value': ClaimDict if decoded, otherwise hex string\n }\n }" - }, - { - "name": "resolve_name", - "description": "Resolve stream info from a LBRY name", - "arguments": [ - { - "name": "name", - "type": "str", - "description": "the name to resolve", - "is_required": true - }, - { - "name": "force", - "type": "bool", - "description": "force refresh and do not check cache", - "is_required": false - } - ], - "returns": "(dict) Metadata dictionary from name claim, None if the name is not\n resolvable" + "returns": "Dictionary of results, keyed by url\n '': {\n If a resolution error occurs:\n 'error': Error message\n\n If the url resolves to a channel or a claim in a channel:\n 'certificate': {\n 'address': (str) claim address,\n 'amount': (float) claim amount,\n 'effective_amount': (float) claim amount including supports,\n 'claim_id': (str) claim id,\n 'claim_sequence': (int) claim sequence number,\n 'decoded_claim': (bool) whether or not the claim value was decoded,\n 'height': (int) claim height,\n 'depth': (int) claim depth,\n 'has_signature': (bool) included if decoded_claim\n 'name': (str) claim name,\n 'permanent_url': (str) permanent url of the certificate claim,\n 'supports: (list) list of supports [{'txid': (str) txid,\n 'nout': (int) nout,\n 'amount': (float) amount}],\n 'txid': (str) claim txid,\n 'nout': (str) claim nout,\n 'signature_is_valid': (bool), included if has_signature,\n 'value': ClaimDict if decoded, otherwise hex string\n }\n\n If the url resolves to a channel:\n 'claims_in_channel': (int) number of claims in the channel,\n\n If the url resolves to a claim:\n 'claim': {\n 'address': (str) claim address,\n 'amount': (float) claim amount,\n 'effective_amount': (float) claim amount including supports,\n 'claim_id': (str) claim id,\n 'claim_sequence': (int) claim sequence number,\n 'decoded_claim': (bool) whether or not the claim value was decoded,\n 'height': (int) claim height,\n 'depth': (int) claim depth,\n 'has_signature': (bool) included if decoded_claim\n 'name': (str) claim name,\n 'permanent_url': (str) permanent url of the claim,\n 'channel_name': (str) channel name if claim is in a channel\n 'supports: (list) list of supports [{'txid': (str) txid,\n 'nout': (int) nout,\n 'amount': (float) amount}]\n 'txid': (str) claim txid,\n 'nout': (str) claim nout,\n 'signature_is_valid': (bool), included if has_signature,\n 'value': ClaimDict if decoded, otherwise hex string\n }\n }" }, { "name": "routing_table_get", "description": "Get DHT routing information", "arguments": [], - "returns": "(dict) dictionary containing routing and contact information\n {\n \"buckets\": {\n : [\n {\n \"address\": (str) peer address,\n \"port\": (int) peer udp port\n \"node_id\": (str) peer node id,\n \"blobs\": (list) blob hashes announced by peer\n }\n ]\n },\n \"contacts\": (list) contact node ids,\n \"blob_hashes\": (list) all of the blob hashes stored by peers in the list of buckets,\n \"node_id\": (str) the local dht node id\n }" + "returns": "(dict) dictionary containing routing and peer information\n {\n \"buckets\": {\n : [\n {\n \"address\": (str) peer address,\n \"udp_port\": (int) peer udp port,\n \"tcp_port\": (int) peer tcp port,\n \"node_id\": (str) peer node id,\n }\n ]\n },\n \"node_id\": (str) the local dht node id\n }" }, { "name": "settings_get", @@ -1333,131 +1245,21 @@ { "name": "settings_set", "description": "Set daemon settings", - "arguments": [ - { - "name": "download_directory", - "type": "str", - "description": "path of download directory", - "is_required": false - }, - { - "name": "data_rate", - "type": "float", - "description": "0.0001", - "is_required": false - }, - { - "name": "download_timeout", - "type": "int", - "description": "180", - "is_required": false - }, - { - "name": "peer_port", - "type": "int", - "description": "3333", - "is_required": false - }, - { - "name": "max_key_fee", - "type": "dict", - "description": "maximum key fee for downloads, in the format: { 'currency': , 'amount': }. In the CLI, it must be an escaped JSON string Supported currency symbols: LBC, USD, BTC", - "is_required": false - }, - { - "name": "disable_max_key_fee", - "type": "bool", - "description": "False", - "is_required": false - }, - { - "name": "use_upnp", - "type": "bool", - "description": "True", - "is_required": false - }, - { - "name": "run_reflector_server", - "type": "bool", - "description": "False", - "is_required": false - }, - { - "name": "cache_time", - "type": "int", - "description": "150", - "is_required": false - }, - { - "name": "reflect_uploads", - "type": "bool", - "description": "True", - "is_required": false - }, - { - "name": "share_usage_data", - "type": "bool", - "description": "True", - "is_required": false - }, - { - "name": "peer_search_timeout", - "type": "int", - "description": "3", - "is_required": false - }, - { - "name": "sd_download_timeout", - "type": "int", - "description": "3", - "is_required": false - }, - { - "name": "auto_renew_claim_height_delta", - "type": "int", - "description": "0 claims set to expire within this many blocks will be automatically renewed after startup (if set to 0, renews will not be made automatically)", - "is_required": false - } - ], + "arguments": [], "returns": "(dict) Updated dictionary of daemon settings" }, { "name": "status", "description": "Get daemon status", "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 'is_locked': (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 'upnp': {\n 'aioupnp_version': (str),\n 'redirects': {\n : (int) external_port,\n },\n 'gateway': (str) manufacturer and model,\n 'dht_redirect_set': (bool),\n 'peer_redirect_set': (bool),\n 'external_ip': (str) external ip address,\n }\n }" + "returns": "(dict) lbrynet-daemon status\n {\n 'installation_id': (str) installation id - base58,\n 'is_running': (bool),\n 'skipped_components': (list) [names of skipped components (str)],\n 'startup_status': { Does not include components which have been skipped\n 'blob_manager': (bool),\n 'blockchain_headers': (bool),\n 'database': (bool),\n 'dht': (bool),\n 'exchange_rate_manager': (bool),\n 'hash_announcer': (bool),\n 'peer_protocol_server': (bool),\n 'stream_manager': (bool),\n 'upnp': (bool),\n 'wallet': (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 'is_locked': (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 'stream_manager': {\n 'managed_files': (int) count of files in the stream manager,\n },\n 'upnp': {\n 'aioupnp_version': (str),\n 'redirects': {\n : (int) external_port,\n },\n 'gateway': (str) manufacturer and model,\n 'dht_redirect_set': (bool),\n 'peer_redirect_set': (bool),\n 'external_ip': (str) external ip address,\n }\n }" }, { "name": "stop", - "description": "Stop lbrynet", + "description": "Stop lbrynet API server.", "arguments": [], "returns": "(string) Shutdown message" }, - { - "name": "stream_availability", - "description": "Get stream availability for lbry uri", - "arguments": [ - { - "name": "uri", - "type": "str", - "description": "check availability for this uri", - "is_required": true - }, - { - "name": "search_timeout", - "type": "int", - "description": "how long to search for peers for the blob in the dht", - "is_required": false - }, - { - "name": "blob_timeout", - "type": "int", - "description": "how long to try downloading from a peer", - "is_required": false - } - ], - "returns": "(dict) {\n 'is_available': ,\n 'did_decode': ,\n 'did_resolve': ,\n 'is_stream': ,\n 'num_blobs_in_stream': ,\n 'sd_hash': ,\n 'sd_blob_availability': see `blob_availability`,\n 'head_blob_hash': ,\n 'head_blob_availability': see `blob_availability`,\n 'use_upnp': ,\n 'upnp_redirect_is_set': ,\n 'error': | error message\n }" - }, { "name": "stream_cost_estimate", "description": "Get estimated cost for a lbry stream", @@ -1467,12 +1269,6 @@ "type": "str", "description": "uri to use", "is_required": true - }, - { - "name": "size", - "type": "float", - "description": "stream size in bytes. if provided an sd blob won't be downloaded.", - "is_required": false } ], "returns": "(float) Estimated cost in lbry credits, returns None if uri is not\n resolvable" @@ -1541,35 +1337,23 @@ "returns": "(list) List of unspent transaction outputs (UTXOs)\n [\n {\n \"address\": (str) the output address\n \"amount\": (float) unspent amount\n \"height\": (int) block height\n \"is_claim\": (bool) is the tx a claim\n \"is_coinbase\": (bool) is the tx a coinbase tx\n \"is_support\": (bool) is the tx a support\n \"is_update\": (bool) is the tx an update\n \"nout\": (int) nout of the output\n \"txid\": (str) txid of the output\n },\n ...\n ]" }, { - "name": "version", - "description": "Get lbry version information", - "arguments": [], - "returns": "(dict) Dictionary of lbry version information\n {\n 'build': (str) build type (e.g. \"dev\", \"rc\", \"release\"),\n 'ip': (str) remote ip, if available,\n 'lbrynet_version': (str) lbrynet_version,\n 'lbryum_version': (str) lbryum_version,\n 'lbryschema_version': (str) lbryschema_version,\n 'os_release': (str) os release string\n 'os_system': (str) os name\n 'platform': (str) platform string\n 'processor': (str) processor type,\n 'python_version': (str) python version,\n }" - }, - { - "name": "wallet_prefill_addresses", - "description": "Create new UTXOs, each containing `amount` credits", + "name": "utxo_release", + "description": "When spending a UTXO it is locally locked to prevent double spends;\noccasionally this can result in a UTXO being locked which ultimately\ndid not get spent (failed to broadcast, spend transaction was not\naccepted by blockchain node, etc). This command releases the lock\non all UTXOs in your account.", "arguments": [ { - "name": "no_broadcast", - "type": "bool", - "description": "whether to broadcast or not", + "name": "account_id", + "type": "str", + "description": "id of the account to query", "is_required": false - }, - { - "name": "num_addresses", - "type": "int", - "description": "num of addresses to create", - "is_required": true - }, - { - "name": "amount", - "type": "decimal", - "description": "initial amount in each address", - "is_required": true } ], - "returns": "(dict) the resulting transaction" + "returns": "None" + }, + { + "name": "version", + "description": "Get lbrynet API server version information", + "arguments": [], + "returns": "(dict) Dictionary of lbry version information\n {\n 'build': (str) build type (e.g. \"dev\", \"rc\", \"release\"),\n 'ip': (str) remote ip, if available,\n 'lbrynet_version': (str) lbrynet_version,\n 'lbryum_version': (str) lbryum_version,\n 'lbryschema_version': (str) lbryschema_version,\n 'os_release': (str) os release string\n 'os_system': (str) os name\n 'platform': (str) platform string\n 'processor': (str) processor type,\n 'python_version': (str) python version,\n }" }, { "name": "wallet_send", diff --git a/lbrynet/extras/daemon/Daemon.py b/lbrynet/extras/daemon/Daemon.py index 6bb5b8fb4..586f4ded8 100644 --- a/lbrynet/extras/daemon/Daemon.py +++ b/lbrynet/extras/daemon/Daemon.py @@ -625,19 +625,16 @@ class Daemon(metaclass=JSONRPCServerType): 'is_running': (bool), '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), + 'database': (bool), + 'dht': (bool), 'exchange_rate_manager': (bool), + 'hash_announcer': (bool), + 'peer_protocol_server': (bool), + 'stream_manager': (bool), + 'upnp': (bool), + 'wallet': (bool), }, 'connection_status': { 'code': (str) connection status code, @@ -664,8 +661,8 @@ class Daemon(metaclass=JSONRPCServerType): '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, + 'stream_manager': { + 'managed_files': (int) count of files in the stream manager, }, 'upnp': { 'aioupnp_version': (str), @@ -778,7 +775,10 @@ class Daemon(metaclass=JSONRPCServerType): Set daemon settings Usage: - settings_set + settings_set () () + + Options: + None Returns: (dict) Updated dictionary of daemon settings @@ -2812,6 +2812,9 @@ class Daemon(metaclass=JSONRPCServerType): Usage: peer_ping ( | --node_id=) (
| --address=
) ( | --port=) + Options: + None + Returns: (str) pong, or {'error': } if an error is encountered """