diff --git a/lbry/service/api.py b/lbry/service/api.py index b6a9cfe7c..119a9eaf4 100644 --- a/lbry/service/api.py +++ b/lbry/service/api.py @@ -612,7 +612,7 @@ class API: get [ | --file_name=] [ | --download_directory=] [ | --timeout=] - [--save_file=] [--wallet_id=] + [--save_file] [--wallet_id=] """ return await self.service.get( @@ -2755,7 +2755,7 @@ class API: List my transaction outputs. Usage: - txo list [--include_received_tips] [--resolve] [--order_by] + txo list [--include_received_tips] [--resolve] [--order_by=] {kwargs} """ diff --git a/lbry/service/metadata.py b/lbry/service/metadata.py index 0e4a26e67..466d8eb35 100644 --- a/lbry/service/metadata.py +++ b/lbry/service/metadata.py @@ -7045,7 +7045,7 @@ interface = { " get [ | --file_name=]", " [ | --download_directory=]", " [ | --timeout=]", - " [--save_file=] [--wallet_id=]" + " [--save_file] [--wallet_id=]" ] }, "arguments": [ @@ -7127,7 +7127,7 @@ interface = { } }, "cli": "get", - "help": "Download stream from a LBRY name.\n\nUsage:\n get [ | --file_name=]\n [ | --download_directory=]\n [ | --timeout=]\n [--save_file=] [--wallet_id=]\n\nOptions:\n --uri= : (str) uri of the content to download\n --file_name= : (str) specified name for the downloaded\n file, overrides the stream file name\n --download_directory= : (str) full path to the directory to\n download into\n --timeout= : (int) download timeout in number of\n seconds\n --save_file : (bool) save the file to the downloads\n directory\n --wallet_id= : (str) wallet to check for claim purchase\n reciepts\n\nReturns:\n (ManagedStream) \n {\n \"streaming_url\": \"(str) url to stream the file using range requests\",\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 }" + "help": "Download stream from a LBRY name.\n\nUsage:\n get [ | --file_name=]\n [ | --download_directory=]\n [ | --timeout=]\n [--save_file] [--wallet_id=]\n\nOptions:\n --uri= : (str) uri of the content to download\n --file_name= : (str) specified name for the downloaded\n file, overrides the stream file name\n --download_directory= : (str) full path to the directory to\n download into\n --timeout= : (int) download timeout in number of\n seconds\n --save_file : (bool) save the file to the downloads\n directory\n --wallet_id= : (str) wallet to check for claim purchase\n reciepts\n\nReturns:\n (ManagedStream) \n {\n \"streaming_url\": \"(str) url to stream the file using range requests\",\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 }" }, "peer_list": { "name": "list", @@ -11586,7 +11586,7 @@ interface = { "List my transaction outputs." ], "usage": [ - " txo list [--include_received_tips] [--resolve] [--order_by]" + " txo list [--include_received_tips] [--resolve] [--order_by=]" ], "kwargs": 13 }, @@ -11922,7 +11922,7 @@ interface = { ], "group": "txo", "cli": "txo list", - "help": "List my transaction outputs.\n\nUsage:\n txo list [--include_received_tips] [--resolve] [--order_by]\n [--type=...] [--txid=...] [--claim_id=...]\n [--channel_id=...] [--name=...] [--is_spent]\n [--is_not_spent] [--is_my_input_or_output] [--is_my_output]\n [--is_not_my_output] [--is_my_input] [--is_not_my_input]\n [--exclude_internal_transfers] [--account_id=...] [--page=]\n [--page_size=] [--include_total]\n\nOptions:\n --include_received_tips : (bool) calculate the amount of tips recieved for claim\n outputs\n --resolve : (bool) resolves each claim to provide additional\n metadata\n --order_by= : (str) field to order by: 'name', 'height', 'amount'\n and 'none'\n --type= : (str, list) claim type: stream, channel, support,\n purchase, collection, repost, other\n --txid= : (str, list) transaction id of outputs\n --claim_id= : (str, list) claim id\n --channel_id= : (str, list) claims in this channel\n --name= : (str, list) claim name\n --is_spent : (bool) only show spent txos\n --is_not_spent : (bool) only show not spent txos\n --is_my_input_or_output : (bool) txos which have your inputs or your outputs, if\n using this flag the other related flags are ignored.\n (\"--is_my_output\", \"--is_my_input\", etc)\n --is_my_output : (bool) show outputs controlled by you\n --is_not_my_output : (bool) show outputs not controlled by you\n --is_my_input : (bool) show outputs created by you\n --is_not_my_input : (bool) show outputs not created by you\n --exclude_internal_transfers : (bool) excludes any outputs that are exactly this\n combination: \"--is_my_input\" + \"--is_my_output\" + \"--\n type=other\" this allows to exclude \"change\" payments,\n this flag can be used in combination with any of the\n other flags\n --account_id= : (str, list) id(s) of the account(s) to query\n --page= : (int) page to return for paginating\n --page_size= : (int) number of items on page for pagination\n --include_total : (bool) calculate total number of items and pages\n\nReturns:\n (Paginated[Output]) \n {\n \"page\": \"Page number of the current items.\",\n \"page_size\": \"Number of items to show on a page.\",\n \"total_pages\": \"Total number of pages.\",\n \"total_items\": \"Total number of items.\",\n \"items\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ]\n }" + "help": "List my transaction outputs.\n\nUsage:\n txo list [--include_received_tips] [--resolve] [--order_by=]\n [--type=...] [--txid=...] [--claim_id=...]\n [--channel_id=...] [--name=...] [--is_spent]\n [--is_not_spent] [--is_my_input_or_output] [--is_my_output]\n [--is_not_my_output] [--is_my_input] [--is_not_my_input]\n [--exclude_internal_transfers] [--account_id=...] [--page=]\n [--page_size=] [--include_total]\n\nOptions:\n --include_received_tips : (bool) calculate the amount of tips recieved for claim\n outputs\n --resolve : (bool) resolves each claim to provide additional\n metadata\n --order_by= : (str) field to order by: 'name', 'height', 'amount'\n and 'none'\n --type= : (str, list) claim type: stream, channel, support,\n purchase, collection, repost, other\n --txid= : (str, list) transaction id of outputs\n --claim_id= : (str, list) claim id\n --channel_id= : (str, list) claims in this channel\n --name= : (str, list) claim name\n --is_spent : (bool) only show spent txos\n --is_not_spent : (bool) only show not spent txos\n --is_my_input_or_output : (bool) txos which have your inputs or your outputs, if\n using this flag the other related flags are ignored.\n (\"--is_my_output\", \"--is_my_input\", etc)\n --is_my_output : (bool) show outputs controlled by you\n --is_not_my_output : (bool) show outputs not controlled by you\n --is_my_input : (bool) show outputs created by you\n --is_not_my_input : (bool) show outputs not created by you\n --exclude_internal_transfers : (bool) excludes any outputs that are exactly this\n combination: \"--is_my_input\" + \"--is_my_output\" + \"--\n type=other\" this allows to exclude \"change\" payments,\n this flag can be used in combination with any of the\n other flags\n --account_id= : (str, list) id(s) of the account(s) to query\n --page= : (int) page to return for paginating\n --page_size= : (int) number of items on page for pagination\n --include_total : (bool) calculate total number of items and pages\n\nReturns:\n (Paginated[Output]) \n {\n \"page\": \"Page number of the current items.\",\n \"page_size\": \"Number of items to show on a page.\",\n \"total_pages\": \"Total number of pages.\",\n \"total_items\": \"Total number of items.\",\n \"items\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ]\n }" }, "txo_plot": { "name": "plot",