From cbc9c876b59d9e87795ffc23dadd1ea2b28cd383 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E3=83=9D=E3=83=BC=E3=83=AB=20=E3=82=A6=E3=82=A7=E3=83=83?= =?UTF-8?q?=E3=83=96?= Date: Fri, 22 Jun 2018 16:13:30 -0500 Subject: [PATCH] Basic styling and structure for API documentation --- content/.vuepress/components/Slate.vue | 385 +++--- content/.vuepress/public/api.md | 1702 ++++++++++++++---------- content/.vuepress/theme/Layout.vue | 151 ++- content/api/index.md | 6 + package.json | 2 + 5 files changed, 1302 insertions(+), 944 deletions(-) create mode 100644 content/api/index.md diff --git a/content/.vuepress/components/Slate.vue b/content/.vuepress/components/Slate.vue index 31bca1e..1ae68af 100644 --- a/content/.vuepress/components/Slate.vue +++ b/content/.vuepress/components/Slate.vue @@ -1,194 +1,251 @@ \ No newline at end of file + // @import "../scss/partials/slate_variables"; + // @import "../scss/partials/slate_icons"; + // @import "../scss/partials/slate_style"; + + .slate { + width: 100%; height: 100%; + position: relative; + + &::after { + @include clearfix; + } + } + + .api__toc { + width: 200px; height: calc(100vh - 4rem); // navigation is 4rem tall + top: 4rem; left: 0; bottom: 0; + + background-color: $white; + border-right: 1px solid rgba($gray, 0.3); + float: left; + overflow-x: hidden; + overflow-y: auto; + position: fixed; + z-index: 3; + + &:not(.active) { + } + + &.active { + } + } + + .api__toc__search__results { + &:not(.active) { + } + + &.active { + } + } + + + + .api__content { + display: grid; + float: right; + grid-template-columns: repeat(auto-fit, minmax(50%, 1fr)); + width: calc(100% - 200px); + } + + .api__content__body, + .api__content__example { + padding: 2rem; + } + + .api__content__body { + border-bottom: 1px solid rgba($gray, 0.3); + } + + .api__content__example { + background-color: $black; + border-bottom: 1px solid rgba($white, 0.1); + color: $white; + } + diff --git a/content/.vuepress/public/api.md b/content/.vuepress/public/api.md index f96e327..43affe8 100644 --- a/content/.vuepress/public/api.md +++ b/content/.vuepress/public/api.md @@ -1,94 +1,129 @@ -# LBRY JSON-RPC API Documentation +::: api__content__body +# API Reference +At LBRY, we utilize JSON-RPC for our API. +::: + +::: api__content__example +``` +This is a work-in-progress! +``` +::: + + + +::: api__content__body ## blob_announce -> Returns: +Announce blobs to the DHT. +::: + +::: api__content__example +Returns: ``` - (bool) true if successful +(bool) true if successful ``` -Announce blobs to the DHT - ### Arguments -| Parameter | Description | -|:------------|:-----------------------------------------------------------------------| -| blob_hash | (str) announce a blob, specified by blob_hash | -| stream_hash | (str) announce all blobs associated withstream_hash | -| sd_hash | (str) announce all blobs associated withsd_hash and the sd_hash itself | +| Parameter | Description | +|:------------|:------------------------------------------------------------------------| +| blob_hash | (str) announce a blob, specified by blob_hash | +| stream_hash | (str) announce all blobs associated with stream_hash | +| sd_hash | (str) announce all blobs associated with sd_hash and the sd_hash itself | +::: + +::: api__content__body ## blob_availability -> Returns: +Get blob availability. +::: + +::: api__content__example +Returns: ``` - (dict) { - "is_available": - "reachable_peers": [":"], - "unreachable_peers": [":"] - } +(dict) { + "is_available": + "reachable_peers": [":"], + "unreachable_peers": [":"] +} ``` -Get blob availability - ### Arguments -| Parameter | Description | -|:---------------|:----------------------------------------------------------| -| blob_hash | (str) check availability for this blob hash | -| search_timeout | (int) how long to search for peers for the blobin the dht | -| blob_timeout | (int) how long to try downloading from a peer | +| Parameter | Description | +|:---------------|:-----------------------------------------------------------| +| blob_hash | (str) check availability for this blob hash | +| search_timeout | (int) how long to search for peers for the blob in the dht | +| blob_timeout | (int) how long to try downloading from a peer | +::: + +::: api__content__body ## blob_delete -> Returns: +Delete a blob. +::: + +::: api__content__example +Returns: ``` - (str) Success/fail message +(str) Success/fail message ``` -Delete a blob - ### Arguments | Parameter | Description | |:------------|:--------------------------------------| | blob_hash | (str) blob hash of the blob to delete | +::: + +::: api__content__body ## blob_get -> Returns: +Download and return a blob. +::: + +::: api__content__example +Returns: ``` - (str) Success/Fail message or (dict) decoded data +(str) Success/Fail message or (dict) decoded data ``` -Download and return a blob - ### Arguments -| Parameter | Description | -|:---------------------|:----------------------------------------------------------------------------------------------------------------| -| blob_hash *required* | (str) blob hash of the blob to get | -| timeout | (int) timeout in number of seconds | -| encoding | (str) by default no attempt at decodingis made, can be set to one of thefollowing decoders:'json' | -| payment_rate_manager | (str) if not given the default payment ratemanager will be used.supported alternative rate managers:'only-free' | +| Parameter | Description | +|:---------------------|:------------------------------------------------------------------------------------------------------------------| +| blob_hash *required* | (str) blob hash of the blob to get | +| timeout | (int) timeout in number of seconds | +| encoding | (str) by default no attempt at decoding is made, can be set to one of the following decoders: "json" | +| payment_rate_manager | (str) if not given the default payment rate manager will be used.supported alternative rate managers: "only-free" | +::: + +::: api__content__body ## blob_list -> Returns: +Returns blob hashes. If not given filters, returns all blobs known by the blob manager. +::: + +::: api__content__example +Returns: ``` - (list) List of blob hashes +(list) List of blob hashes ``` -Returns blob hashes. If not given filters, returns all blobs known by the blob manager - ### Arguments | Parameter | Description | @@ -100,148 +135,179 @@ Returns blob hashes. If not given filters, returns all blobs known by the blob m | sd_hash | (str) filter blobs by sd hash | | page_size | (int) results page size | | page | (int) page of results to return | +::: + +::: api__content__body ## blob_reflect -> Returns: +Reflects specified blobs. +::: + +::: api__content__example +Returns: ``` - (list) reflected blob hashes +(list) reflected blob hashes ``` -Reflects specified blobs - ### Arguments | Parameter | Description | |:-----------------|:------------------------| | reflector_server | (str) reflector address | +::: + +::: api__content__body ## blob_reflect_all -> Returns: +Reflects all saved blobs. +::: + +::: api__content__example +Returns: ``` - (bool) true if successful +(bool) true if successful ``` - -Reflects all saved blobs - -### Arguments - -| Parameter | Description | -|| +::: + +::: api__content__body ## block_show -> Returns: +Get contents of a block. +::: + +::: api__content__example +Returns: ``` - (dict) Requested block +(dict) Requested block ``` -Get contents of a block - ### Arguments | Parameter | Description | |:---------------------|:-------------------------------------| | blockhash *required* | (str) hash of the block to look up | | height *required* | (int) height of the block to look up | +::: + +::: api__content__body ## channel_export -> Returns: +Export serialized channel signing information for a given certificate claim id. +::: + +::: api__content__example +Returns: ``` - (str) Serialized certificate information +(str) Serialized certificate information ``` -Export serialized channel signing information for a given certificate claim id - ### Arguments | Parameter | Description | |:--------------------|:-------------------------------------------| | claim_id *required* | (str) Claim ID to export information about | +::: + +::: api__content__body ## channel_import -> Returns: +Import serialized channel signing information (to allow signing new claims to the channel). +::: + +::: api__content__example +Returns: ``` - (dict) Result dictionary +(dict) Result dictionary ``` -Import serialized channel signing information (to allow signing new claims to the channel) - ### Arguments | Parameter | Description | |:---------------------------------------|:-----------------------| | serialized_certificate_info *required* | (str) certificate info | +::: + +::: api__content__body ## channel_list -> Returns: +Get certificate claim infos for channels that can be published to. +::: + +::: api__content__example +Returns: ``` - (list) ClaimDict, includes 'is_mine' field to indicate if the certificate claim - is in the wallet. +(list) ClaimDict, includes 'is_mine' field to indicate if the certificate claim is in the wallet. ``` - -Get certificate claim infos for channels that can be published to - -### Arguments - -| Parameter | Description | -|| +::: + +::: api__content__body ## channel_new -> Returns: +Generate a publisher key and create a new "@" prefixed certificate claim. +::: + +::: api__content__example +Returns: ``` - (dict) Dictionary containing result of the claim - { - 'tx' : (str) hex encoded transaction - 'txid' : (str) txid of resulting claim - 'nout' : (int) nout of the resulting claim - 'fee' : (float) fee paid for the claim transaction - 'claim_id' : (str) claim ID of the resulting claim - } -``` +(dict) Dictionary containing result of the claim -Generate a publisher key and create a new '@' prefixed certificate claim +{ + "tx": (str) hex encoded transaction + "txid": (str) txid of resulting claim + "nout": (int) nout of the resulting claim + "fee": (float) fee paid for the claim transaction + "claim_id": (str) claim ID of the resulting claim +} +``` ### Arguments | Parameter | Description | |:------------------------|:--------------------------------------------| -| channel_name *required* | (str) name of the channel prefixed with '@' | +| channel_name *required* | (str) name of the channel prefixed with "@" | | amount *required* | (float) bid amount on the channel | +::: + +::: api__content__body ## claim_abandon -> Returns: +Abandon a name and reclaim credits from the claim. +::: + +::: api__content__example +Returns: ``` - (dict) Dictionary containing result of the claim - { - txid : (str) txid of resulting transaction - fee : (float) fee paid for the transaction - } -``` +(dict) Dictionary containing result of the claim -Abandon a name and reclaim credits from the claim +{ + "txid": (str) txid of resulting transaction + "fee": (float) fee paid for the transaction +} +``` ### Arguments @@ -250,147 +316,167 @@ Abandon a name and reclaim credits from the claim | claim_id | (str) claim_id of the claim to abandon | | txid | (str) txid of the claim to abandon | | nout | (int) nout of the claim to abandon | +::: + +::: api__content__body ## claim_list -> Returns: +List current claims and information about them for a given name. +::: + +::: api__content__example +Returns: ``` - (dict) State of claims assigned for the name - { - 'claims': (list) list of claims for the name - [ - { - 'amount': (float) amount assigned to the claim - 'effective_amount': (float) total amount assigned to the claim, - including supports - 'claim_id': (str) claim ID of the claim - 'height': (int) height of block containing the claim - 'txid': (str) txid of the claim - 'nout': (int) nout of the claim - 'permanent_url': (str) permanent url of the claim, - 'supports': (list) a list of supports attached to the claim - 'value': (str) the value of the claim - }, - ] - 'supports_without_claims': (list) supports without any claims attached to them - 'last_takeover_height': (int) the height of last takeover for the name - } -``` +(dict) State of claims assigned for the name -List current claims and information about them for a given name +{ + "claims": (list) list of claims for the name, + [{ + "amount": (float) amount assigned to the claim, + "claim_id": (str) claim ID of the claim, + "effective_amount": (float) total amount assigned to the claim, including supports, + "height": (int) height of block containing the claim, + "nout": (int) nout of the claim, + "permanent_url": (str) permanent url of the claim, + "supports": (list) a list of supports attached to the claim, + "txid": (str) txid of the claim, + "value": (str) the value of the claim + }], + "last_takeover_height": (int) the height of last takeover for the name, + "supports_without_claims": (list) supports without any claims attached to them +} +``` ### Arguments | Parameter | Description | |:----------------|:-------------------------------------------| | name *required* | (str) name of the claim to list info about | +::: + +::: api__content__body ## claim_list_by_channel -> Returns: +Get paginated claims in a channel specified by a channel uri. +::: + +::: api__content__example +Returns: ``` - { - resolved channel uri: { - If there was an error: - 'error': (str) error message +{ + resolved channel uri: { + If there was an error: + 'error': (str) error message - 'claims_in_channel': the total number of results for the channel, + 'claims_in_channel': the total number of results for the channel, - If a page of results was requested: - 'returned_page': page number returned, - 'claims_in_channel': [ - { - 'absolute_channel_position': (int) claim index number in sorted list of - claims which assert to be part of the - channel - 'address': (str) claim address, - 'amount': (float) claim amount, - 'effective_amount': (float) claim amount including supports, - 'claim_id': (str) claim id, - 'claim_sequence': (int) claim sequence number, - 'decoded_claim': (bool) whether or not the claim value was decoded, - 'height': (int) claim height, - 'depth': (int) claim depth, - 'has_signature': (bool) included if decoded_claim - 'name': (str) claim name, - 'supports: (list) list of supports [{'txid': (str) txid, - 'nout': (int) nout, - 'amount': (float) amount}], - 'txid': (str) claim txid, - 'nout': (str) claim nout, - 'signature_is_valid': (bool), included if has_signature, - 'value': ClaimDict if decoded, otherwise hex string - } - ], - } - } + If a page of results was requested: + 'returned_page': page number returned, + 'claims_in_channel': [{ + 'absolute_channel_position': (int) claim index number in sorted list of + claims which assert to be part of the + channel + 'address': (str) claim address, + 'amount': (float) claim amount, + 'effective_amount': (float) claim amount including supports, + 'claim_id': (str) claim id, + 'claim_sequence': (int) claim sequence number, + 'decoded_claim': (bool) whether or not the claim value was decoded, + 'height': (int) claim height, + 'depth': (int) claim depth, + 'has_signature': (bool) included if decoded_claim + 'name': (str) claim name, + 'supports: (list) list of supports [{ + 'txid': (str) txid, + 'nout': (int) nout, + 'amount': (float) amount + }], + 'txid': (str) claim txid, + 'nout': (str) claim nout, + 'signature_is_valid': (bool), included if has_signature, + 'value': ClaimDict if decoded, otherwise hex string + }] + } +} ``` -Get paginated claims in a channel specified by a channel uri - ### Arguments -| Parameter | Description | -|:---------------|:------------------------------------------------------------------------------------------| -| uri *required* | (str) uri of the channel | -| uris | (list) uris of the channel | -| page | (int) which page of results to return where page 1 is the firstpage, defaults to no pages | -| page_size | (int) number of results in a page, default of 10 | +| Parameter | Description | +|:---------------|:-------------------------------------------------------------------------------------------| +| uri *required* | (str) uri of the channel | +| uris | (list) uris of the channel | +| page | (int) which page of results to return where page 1 is the first page, defaults to no pages | +| page_size | (int) number of results in a page, default of 10 | +::: + +::: api__content__body ## claim_list_mine -> Returns: +List my name claims. +::: + +::: api__content__example +Returns: ``` - (list) List of name claims owned by user - [ - { - 'address': (str) address that owns the claim - 'amount': (float) amount assigned to the claim - 'blocks_to_expiration': (int) number of blocks until it expires - 'category': (str) "claim", "update" , or "support" - 'claim_id': (str) claim ID of the claim - 'confirmations': (int) number of blocks of confirmations for the claim - 'expiration_height': (int) the block height which the claim will expire - 'expired': (bool) true if expired, false otherwise - 'height': (int) height of the block containing the claim - 'is_spent': (bool) true if claim is abandoned, false otherwise - 'name': (str) name of the claim - 'permanent_url': (str) permanent url of the claim, - 'txid': (str) txid of the cliam - 'nout': (int) nout of the claim - 'value': (str) value of the claim - }, - ] -``` + (list) List of name claims owned by user -List my name claims + [ + { + 'address': (str) address that owns the claim + 'amount': (float) amount assigned to the claim + 'blocks_to_expiration': (int) number of blocks until it expires + 'category': (str) "claim", "update" , or "support" + 'claim_id': (str) claim ID of the claim + 'confirmations': (int) number of blocks of confirmations for the claim + 'expiration_height': (int) the block height which the claim will expire + 'expired': (bool) true if expired, false otherwise + 'height': (int) height of the block containing the claim + 'is_spent': (bool) true if claim is abandoned, false otherwise + 'name': (str) name of the claim + 'permanent_url': (str) permanent url of the claim, + 'txid': (str) txid of the cliam + 'nout': (int) nout of the claim + 'value': (str) value of the claim + } + ] +``` ### Arguments | Parameter | Description | || +::: + +::: api__content__body ## claim_new_support -> Returns: +Support a name claim. +::: + +::: api__content__example +Returns: ``` - (dict) Dictionary containing result of the claim - { - txid : (str) txid of resulting support claim - nout : (int) nout of the resulting support claim - fee : (float) fee paid for the transaction - } -``` + (dict) Dictionary containing result of the claim -Support a name claim + { + txid: (str) txid of resulting support claim + nout: (int) nout of the resulting support claim + fee: (float) fee paid for the transaction + } +``` ### Arguments @@ -399,107 +485,129 @@ Support a name claim | name *required* | (str) name of the claim to support | | claim_id *required* | (str) claim_id of the claim to support | | amount *required* | (float) amount of support | +::: + +::: api__content__body ## claim_renew -> Returns: +Renew claim(s) or support(s). +::: + +::: api__content__example +Returns: ``` - (dict) Dictionary where key is the the original claim's outpoint and - value is the result of the renewal - { - outpoint:{ + (dict) Dictionary where key is the the original claim's outpoint and + value is the result of the renewal - 'tx' : (str) hex encoded transaction - 'txid' : (str) txid of resulting claim - 'nout' : (int) nout of the resulting claim - 'fee' : (float) fee paid for the claim transaction - 'claim_id' : (str) claim ID of the resulting claim - }, + { + outpoint: { + 'tx': (str) hex encoded transaction + 'txid': (str) txid of resulting claim + 'nout': (int) nout of the resulting claim + 'fee': (float) fee paid for the claim transaction + 'claim_id': (str) claim ID of the resulting claim } + } ``` -Renew claim(s) or support(s) - ### Arguments | Parameter | Description | |:--------------------|:------------------------------------------------------------| | outpoint *required* | (str) outpoint of the claim to renew | | height *required* | (str) update claims expiring before or at this block height | +::: + +::: api__content__body ## claim_send_to_address -> Returns: +Send a name claim to an address. +::: + +::: api__content__example +Returns: ``` - (dict) Dictionary containing result of the claim - { - 'tx' : (str) hex encoded transaction - 'txid' : (str) txid of resulting claim - 'nout' : (int) nout of the resulting claim - 'fee' : (float) fee paid for the claim transaction - 'claim_id' : (str) claim ID of the resulting claim - } -``` + (dict) Dictionary containing result of the claim -Send a name claim to an address + { + 'tx' : (str) hex encoded transaction + 'txid' : (str) txid of resulting claim + 'nout' : (int) nout of the resulting claim + 'fee' : (float) fee paid for the claim transaction + 'claim_id' : (str) claim ID of the resulting claim + } +``` ### Arguments -| Parameter | Description | -|:--------------------|:--------------------------------------------------------------------------------------| -| claim_id *required* | (str) claim_id to send | -| address *required* | (str) address to send the claim to | -| amount | (int) Amount of credits to claim name for, defaults to the current amounton the claim | +| Parameter | Description | +|:--------------------|:---------------------------------------------------------------------------------------| +| claim_id *required* | (str) claim_id to send | +| address *required* | (str) address to send the claim to | +| amount | (int) Amount of credits to claim name for, defaults to the current amount on the claim | +::: + +::: api__content__body ## claim_show -> Returns: +Resolve claim info from txid/nout or with claim ID. +::: + +::: api__content__example +Returns: ``` - (dict) Dictionary containing claim info as below, + (dict) Dictionary containing claim info as below, - { - 'txid': (str) txid of claim - 'nout': (int) nout of claim - 'amount': (float) amount of claim - 'value': (str) value of claim - 'height' : (int) height of claim takeover - 'claim_id': (str) claim ID of claim - 'supports': (list) list of supports associated with claim - } + { + 'txid': (str) txid of claim + 'nout': (int) nout of claim + 'amount': (float) amount of claim + 'value': (str) value of claim + 'height' : (int) height of claim takeover + 'claim_id': (str) claim ID of claim + 'supports': (list) list of supports associated with claim + } - if claim cannot be resolved, dictionary as below will be returned + if claim cannot be resolved, dictionary as below will be returned - { - 'error': (str) reason for error - } + { + 'error': (str) reason for error + } ``` -Resolve claim info from txid/nout or with claim ID - ### Arguments -| Parameter | Description | -|:------------|:----------------------------------------------------------------| -| txid | (str) look for claim with this txid, nout mustalso be specified | -| nout | (int) look for claim with this nout, txid mustalso be specified | -| claim_id | (str) look for claim with this claim id | +| Parameter | Description | +|:------------|:-----------------------------------------------------------------| +| txid | (str) look for claim with this txid, nout must also be specified | +| nout | (int) look for claim with this nout, txid must also be specified | +| claim_id | (str) look for claim with this claim id | +::: + +::: api__content__body ## cli_test_command -> Returns: +This command is only for testing the CLI argument parsing. +::: + +::: api__content__example +Returns: ``` - pos args +pos args ``` -This command is only for testing the CLI argument parsing ### Arguments | Parameter | Description | @@ -510,56 +618,70 @@ This command is only for testing the CLI argument parsing | pos_args | pos args | | pos_arg2 | pos arg 2 | | pos_arg3 | pos arg 3 | +::: + +::: api__content__body ## commands -> Returns: +Return a list of available commands. +::: + +::: api__content__example +Returns: ``` - (list) list of available commands +(list) list of available commands ``` -Return a list of available commands - ### Arguments | Parameter | Description | || +::: + +::: api__content__body ## daemon_stop -> Returns: +Stop lbrynet-daemon. +::: + +::: api__content__example +Returns: ``` - (string) Shutdown message + (string) Shutdown message ``` -Stop lbrynet-daemon - ### Arguments | Parameter | Description | || +::: + +::: api__content__body ## file_delete -> Returns: +Delete a LBRY file. +::: + +::: api__content__example +Returns: ``` - (bool) true if deletion was successful +(bool) true if deletion was successful ``` -Delete a LBRY file - ### Arguments -| Parameter | Description | -|:-------------------------|:-------------------------------------------------------------------------------------------------------------------| -| delete_from_download_dir | (bool) delete file from download directory,instead of just deleting blobs | -| delete_all | (bool) if there are multiple matching files,allow the deletion of multiple files.Otherwise do not delete anything. | +| Parameter | Description | |:-------------------------|:-------------------------------------------------------------------------------------------------------------------| +| delete_from_download_dir | (bool) delete file from download directory, instead of just deleting blobs | +| delete_all | (bool) if there are multiple matching files, allow the deletion of multiple files. Otherwise do not delete anything. | | sd_hash | (str) delete by file sd hash | | file_name | (str) delete by file name in downloads folder | | stream_hash | (str) delete by file stream hash | @@ -570,145 +692,164 @@ Delete a LBRY file | claim_name | (str) delete by file claim name | | channel_claim_id | (str) delete by file channel claim id | | channel_name | (str) delete by file channel claim name | +::: + +::: api__content__body ## file_list -> Returns: +List files limited by optional filters. +::: + +::: api__content__example +Returns: ``` - (list) List of files +(list) List of files - [ - { - 'completed': (bool) true if download is completed, - 'file_name': (str) name of file, - 'download_directory': (str) download directory, - 'points_paid': (float) credit paid to download file, - 'stopped': (bool) true if download is stopped, - 'stream_hash': (str) stream hash of file, - 'stream_name': (str) stream name , - 'suggested_file_name': (str) suggested file name, - 'sd_hash': (str) sd hash of file, - 'download_path': (str) download path of file, - 'mime_type': (str) mime type of file, - 'key': (str) key attached to file, - 'total_bytes': (int) file size in bytes, None if full_status is false, - 'written_bytes': (int) written size in bytes, - 'blobs_completed': (int) num_completed, None if full_status is false, - 'blobs_in_stream': (int) None if full_status is false, - 'status': (str) downloader status, None if full_status is false, - 'claim_id': (str) None if full_status is false or if claim is not found, - 'outpoint': (str) None if full_status is false or if claim is not found, - 'txid': (str) None if full_status is false or if claim is not found, - 'nout': (int) None if full_status is false or if claim is not found, - 'metadata': (dict) None if full_status is false or if claim is not found, - 'channel_claim_id': (str) None if full_status is false or if claim is not found or signed, - 'channel_name': (str) None if full_status is false or if claim is not found or signed, - 'claim_name': (str) None if full_status is false or if claim is not found - }, - ] +[{ + "completed": (bool) true if download is completed, + "file_name": (str) name of file, + "download_directory": (str) download directory, + "points_paid": (float) credit paid to download file, + "stopped": (bool) true if download is stopped, + "stream_hash": (str) stream hash of file, + "stream_name": (str) stream name , + "suggested_file_name": (str) suggested file name, + "sd_hash": (str) sd hash of file, + "download_path": (str) download path of file, + "mime_type": (str) mime type of file, + "key": (str) key attached to file, + "total_bytes": (int) file size in bytes, None if full_status is false, + "written_bytes": (int) written size in bytes, + "blobs_completed": (int) num_completed, None if full_status is false, + "blobs_in_stream": (int) None if full_status is false, + "status": (str) downloader status, None if full_status is false, + "claim_id": (str) None if full_status is false or if claim is not found, + "outpoint": (str) None if full_status is false or if claim is not found, + "txid": (str) None if full_status is false or if claim is not found, + "nout": (int) None if full_status is false or if claim is not found, + "metadata": (dict) None if full_status is false or if claim is not found, + "channel_claim_id": (str) None if full_status is false or if claim is not found or signed, + "channel_name": (str) None if full_status is false or if claim is not found or signed, + "claim_name": (str) None if full_status is false or if claim is not found +}] ``` -List files limited by optional filters - ### Arguments -| Parameter | Description | -|:-----------------|:---------------------------------------------------------------------------------------------------------------| -| sd_hash | (str) get file with matching sd hash | -| file_name | (str) get file with matching file name in thedownloads folder | -| stream_hash | (str) get file with matching stream hash | -| rowid | (int) get file with matching row id | -| claim_id | (str) get file with matching claim id | -| outpoint | (str) get file with matching claim outpoint | -| txid | (str) get file with matching claim txid | -| nout | (int) get file with matching claim nout | -| channel_claim_id | (str) get file with matching channel claim id | -| channel_name | (str) get file with matching channel name | -| claim_name | (str) get file with matching claim name | -| full_status | (bool) full status, populate the'message' and 'size' fields | -| sort | (str) sort by any property, like 'file_name'or 'metadata.author'; to specify directionappend ',asc' or ',desc' | +| Parameter | Description | +|:-----------------|:-----------------------------------------------------------------------------------------------------------------| +| sd_hash | (str) get file with matching sd hash | +| file_name | (str) get file with matching file name in the downloads folder | +| stream_hash | (str) get file with matching stream hash | +| rowid | (int) get file with matching row id | +| claim_id | (str) get file with matching claim id | +| outpoint | (str) get file with matching claim outpoint | +| txid | (str) get file with matching claim txid | +| nout | (int) get file with matching claim nout | +| channel_claim_id | (str) get file with matching channel claim id | +| channel_name | (str) get file with matching channel name | +| claim_name | (str) get file with matching claim name | +| full_status | (bool) full status, populate the 'message' and 'size' fields | +| sort | (str) sort by any property, like 'file_name' or 'metadata.author'; to specify direction append ',asc' or ',desc' | +::: + +::: api__content__body ## file_reflect -> Returns: +Reflect all the blobs in a file matching the filter criteria. +::: + +::: api__content__example +Returns: ``` - (list) list of blobs reflected +(list) list of blobs reflected ``` -Reflect all the blobs in a file matching the filter criteria - ### Arguments -| Parameter | Description | -|:------------|:------------------------------------------------------------------------------------| -| sd_hash | (str) get file with matching sd hash | -| file_name | (str) get file with matching file name in thedownloads folder | -| stream_hash | (str) get file with matching stream hash | -| rowid | (int) get file with matching row id | -| reflector | (str) reflector server, ip address or urlby default choose a server from the config | +| Parameter | Description | +|:------------|:-------------------------------------------------------------------------------------| +| sd_hash | (str) get file with matching sd hash | +| file_name | (str) get file with matching file name in the downloads folder | +| stream_hash | (str) get file with matching stream hash | +| rowid | (int) get file with matching row id | +| reflector | (str) reflector server, ip address or url by default choose a server from the config | +::: + +::: api__content__body ## file_set_status -> Returns: +Start or stop downloading a file. +::: + +::: api__content__example +Returns: ``` - (str) Confirmation message +(str) Confirmation message ``` -Start or stop downloading a file - ### Arguments -| Parameter | Description | -|:------------------|:------------------------------------------------------------------------| -| status *required* | (str) one of "start" or "stop" | -| sd_hash | (str) set status of file with matching sd hash | -| file_name | (str) set status of file with matching file name in thedownloads folder | -| stream_hash | (str) set status of file with matching stream hash | -| rowid | (int) set status of file with matching row id | +| Parameter | Description | +|:------------------|:-------------------------------------------------------------------------| +| status *required* | (str) one of "start" or "stop" | +| sd_hash | (str) set status of file with matching sd hash | +| file_name | (str) set status of file with matching file name in the downloads folder | +| stream_hash | (str) set status of file with matching stream hash | +| rowid | (int) set status of file with matching row id | +::: + +::: api__content__body ## get -> Returns: - -``` - (dict) Dictionary containing information about the stream - { - 'completed': (bool) true if download is completed, - 'file_name': (str) name of file, - 'download_directory': (str) download directory, - 'points_paid': (float) credit paid to download file, - 'stopped': (bool) true if download is stopped, - 'stream_hash': (str) stream hash of file, - 'stream_name': (str) stream name , - 'suggested_file_name': (str) suggested file name, - 'sd_hash': (str) sd hash of file, - 'download_path': (str) download path of file, - 'mime_type': (str) mime type of file, - 'key': (str) key attached to file, - 'total_bytes': (int) file size in bytes, None if full_status is false, - 'written_bytes': (int) written size in bytes, - 'blobs_completed': (int) num_completed, None if full_status is false, - 'blobs_in_stream': (int) None if full_status is false, - 'status': (str) downloader status, None if full_status is false, - 'claim_id': (str) claim id, - 'outpoint': (str) claim outpoint string, - 'txid': (str) claim txid, - 'nout': (int) claim nout, - 'metadata': (dict) claim metadata, - 'channel_claim_id': (str) None if claim is not signed - 'channel_name': (str) None if claim is not signed - 'claim_name': (str) claim name - } -``` - Download stream from a LBRY name. +::: + +::: api__content__example +Returns: + +``` +(dict) Dictionary containing information about the stream + +{ + 'completed': (bool) true if download is completed, + 'file_name': (str) name of file, + 'download_directory': (str) download directory, + 'points_paid': (float) credit paid to download file, + 'stopped': (bool) true if download is stopped, + 'stream_hash': (str) stream hash of file, + 'stream_name': (str) stream name , + 'suggested_file_name': (str) suggested file name, + 'sd_hash': (str) sd hash of file, + 'download_path': (str) download path of file, + 'mime_type': (str) mime type of file, + 'key': (str) key attached to file, + 'total_bytes': (int) file size in bytes, None if full_status is false, + 'written_bytes': (int) written size in bytes, + 'blobs_completed': (int) num_completed, None if full_status is false, + 'blobs_in_stream': (int) None if full_status is false, + 'status': (str) downloader status, None if full_status is false, + 'claim_id': (str) claim id, + 'outpoint': (str) claim outpoint string, + 'txid': (str) claim txid, + 'nout': (int) claim nout, + 'metadata': (dict) claim metadata, + 'channel_claim_id': (str) None if claim is not signed + 'channel_name': (str) None if claim is not signed + 'claim_name': (str) claim name +} +``` ### Arguments @@ -717,88 +858,106 @@ Download stream from a LBRY name. | uri | (str) uri of the content to download | | file_name | (str) specified name for the downloaded file | | timeout | (int) download timeout in number of seconds | +::: + +::: api__content__body ## help -> Returns: +Return a useful message for an API command. +::: + +::: api__content__example +Returns: ``` - (str) Help message +(str) Help message ``` -Return a useful message for an API command - ### Arguments | Parameter | Description | |:------------|:--------------------------------------------| | command | (str) command to retrieve documentation for | +::: + +::: api__content__body ## peer_list -> Returns: +Get peers for blob hash. +::: + +::: api__content__example +Returns: ``` - (list) List of contact dictionaries {'host': , 'port': , 'node_id': } +(list) List of contact dictionaries {'host': , 'port': , 'node_id': } ``` -Get peers for blob hash - ### Arguments | Parameter | Description | |:---------------------|:----------------------------------------------| | blob_hash *required* | (str) find available peers for this blob hash | | timeout | (int) peer search timeout in seconds | +::: + +::: api__content__body ## peer_ping -> Returns: +Find and ping a peer by node id. +::: + +::: api__content__example +Returns: ``` - (str) pong, or {'error': } if an error is encountered +(str) pong, or {'error': } if an error is encountered ``` -Find and ping a peer by node id - ### Arguments | Parameter | Description | || +::: + +::: api__content__body ## publish -> Returns: - -``` - (dict) Dictionary containing result of the claim - { - 'tx' : (str) hex encoded transaction - 'txid' : (str) txid of resulting claim - 'nout' : (int) nout of the resulting claim - 'fee' : (decimal) fee paid for the claim transaction - 'claim_id' : (str) claim ID of the resulting claim - } -``` - -Make a new name claim and publish associated data to lbrynet, -update over existing claim if user already has a claim for name. +Make a new name claim and publish associated data to lbrynet, update over existing claim if user already has a claim for name. Fields required in the final Metadata are: - 'title' - 'description' - 'author' - 'language' - 'license' - 'nsfw' +- author +- description +- language +- license +- nsfw +- title -Metadata can be set by either using the metadata argument or by setting individual arguments -fee, title, description, author, language, license, license_url, thumbnail, preview, nsfw, -or sources. Individual arguments will overwrite the fields specified in metadata argument. +Metadata can be set by either using the metadata argument or by setting individual arguments fee, title, description, author, language, license, license_url, thumbnail, preview, nsfw, or sources. Individual arguments will overwrite the fields specified in metadata argument. +::: + +::: api__content__example +Returns: + +``` +(dict) Dictionary containing result of the claim + +{ + 'tx' : (str) hex encoded transaction + 'txid' : (str) txid of resulting claim + 'nout' : (int) nout of the resulting claim + 'fee' : (decimal) fee paid for the claim transaction + 'claim_id' : (str) claim ID of the resulting claim +} +``` ### Arguments @@ -807,8 +966,8 @@ or sources. Individual arguments will overwrite the fields specified in metadata | name *required* | (str) name of the content | | bid *required* | (decimal) amount to back the claim | | metadata | (dict) ClaimDict to associate with the claim. | -| file_path | (str) path to file to be associated with name. If provided,a lbry stream of this file will be used in 'sources'.If no path is given but a sources dict is provided,it will be used. If neither are provided, anerror is raised. | -| fee | (dict) Dictionary representing key fee to download content:{'currency': currency_symbol,'amount': decimal,'address': str, optional}supported currencies: LBC, USD, BTCIf an address is not provided a new one will beautomatically generated. Default fee is zero. | +| file_path | (str) path to file to be associated with name. If provided, a lbry stream of this file will be used in 'sources'. If no path is given but a sources dict is provided, it will be used. If neither are provided, an error is raised. | +| fee | (dict) Dictionary representing key fee to download content:{'currency': currency_symbol,'amount': decimal,'address': str, optional}supported currencies: LBC, USD, BTCIf an address is not provided a new one will be automatically generated. Default fee is zero. | | title | (str) title of the publication | | description | (str) description of the publication | | author | (str) author of the publication | @@ -820,89 +979,104 @@ or sources. Individual arguments will overwrite the fields specified in metadata | nsfw | (bool) title of the publication | | sources | (str) {'lbry_sd_hash': sd_hash} specifies sd hash of file | | channel_name | (str) name of the publisher channel name in the wallet | -| channel_id | (str) claim id of the publisher channel, does not checkfor channel claim being in the wallet. This allowspublishing to a channel where only the certificateprivate key is in the wallet. | -| claim_address | (str) address where the claim is sent to, if not specifiednew address wil automatically be created | +| channel_id | (str) claim id of the publisher channel, does not check for channel claim being in the wallet. This allows publishing to a channel where only the certificate private key is in the wallet. | +| claim_address | (str) address where the claim is sent to, if not specified new address will automatically be created | +::: + +::: api__content__body ## report_bug -> Returns: +Report a bug to Slack. +::: + +::: api__content__example +Returns: ``` - (bool) true if successful +(bool) true if successful ``` -Report a bug to slack - ### Arguments | Parameter | Description | |:-------------------|:-----------------------------| | message *required* | (str) Description of the bug | +::: + +::: api__content__body ## resolve -> Returns: +Resolve given LBRY URIs. +::: + +::: api__content__example +Returns: ``` - Dictionary of results, keyed by uri - '': { - If a resolution error occurs: - 'error': Error message +Dictionary of results, keyed by uri - If the uri resolves to a channel or a claim in a channel: - 'certificate': { - 'address': (str) claim address, - 'amount': (float) claim amount, - 'effective_amount': (float) claim amount including supports, - 'claim_id': (str) claim id, - 'claim_sequence': (int) claim sequence number, - 'decoded_claim': (bool) whether or not the claim value was decoded, - 'height': (int) claim height, - 'depth': (int) claim depth, - 'has_signature': (bool) included if decoded_claim - 'name': (str) claim name, - 'permanent_url': (str) permanent url of the certificate claim, - 'supports: (list) list of supports [{'txid': (str) txid, - 'nout': (int) nout, - 'amount': (float) amount}], - 'txid': (str) claim txid, - 'nout': (str) claim nout, - 'signature_is_valid': (bool), included if has_signature, - 'value': ClaimDict if decoded, otherwise hex string - } +'': { + If a resolution error occurs: + 'error': Error message - If the uri resolves to a channel: - 'claims_in_channel': (int) number of claims in the channel, + If the uri resolves to a channel or a claim in a channel: + 'certificate': { + 'address': (str) claim address, + 'amount': (float) claim amount, + 'effective_amount': (float) claim amount including supports, + 'claim_id': (str) claim id, + 'claim_sequence': (int) claim sequence number, + 'decoded_claim': (bool) whether or not the claim value was decoded, + 'height': (int) claim height, + 'depth': (int) claim depth, + 'has_signature': (bool) included if decoded_claim + 'name': (str) claim name, + 'permanent_url': (str) permanent url of the certificate claim, + 'supports: (list) list of supports [{ + 'txid': (str) txid, + 'nout': (int) nout, + 'amount': (float) amount + }], + 'txid': (str) claim txid, + 'nout': (str) claim nout, + 'signature_is_valid': (bool), included if has_signature, + 'value': ClaimDict if decoded, otherwise hex string + } - If the uri resolves to a claim: - 'claim': { - 'address': (str) claim address, - 'amount': (float) claim amount, - 'effective_amount': (float) claim amount including supports, - 'claim_id': (str) claim id, - 'claim_sequence': (int) claim sequence number, - 'decoded_claim': (bool) whether or not the claim value was decoded, - 'height': (int) claim height, - 'depth': (int) claim depth, - 'has_signature': (bool) included if decoded_claim - 'name': (str) claim name, - 'permanent_url': (str) permanent url of the claim, - 'channel_name': (str) channel name if claim is in a channel - 'supports: (list) list of supports [{'txid': (str) txid, - 'nout': (int) nout, - 'amount': (float) amount}] - 'txid': (str) claim txid, - 'nout': (str) claim nout, - 'signature_is_valid': (bool), included if has_signature, - 'value': ClaimDict if decoded, otherwise hex string - } - } + If the uri resolves to a channel: + 'claims_in_channel': (int) number of claims in the channel, + + If the uri resolves to a claim: + 'claim': { + 'address': (str) claim address, + 'amount': (float) claim amount, + 'effective_amount': (float) claim amount including supports, + 'claim_id': (str) claim id, + 'claim_sequence': (int) claim sequence number, + 'decoded_claim': (bool) whether or not the claim value was decoded, + 'height': (int) claim height, + 'depth': (int) claim depth, + 'has_signature': (bool) included if decoded_claim + 'name': (str) claim name, + 'permanent_url': (str) permanent url of the claim, + 'channel_name': (str) channel name if claim is in a channel + 'supports: (list) list of supports [{ + 'txid': (str) txid, + 'nout': (int) nout, + 'amount': (float) amount + }], + 'txid': (str) claim txid, + 'nout': (str) claim nout, + 'signature_is_valid': (bool), included if has_signature, + 'value': ClaimDict if decoded, otherwise hex string + } +} ``` -Resolve given LBRY URIs - ### Arguments | Parameter | Description | @@ -910,85 +1084,105 @@ Resolve given LBRY URIs | force | (bool) force refresh and ignore cache | | uri *required* | (str) uri to resolve | | uris | (list) uris to resolve | +::: + +::: api__content__body ## resolve_name -> Returns: +Resolve stream info from a LBRY name. +::: + +::: api__content__example +Returns: ``` - (dict) Metadata dictionary from name claim, None if the name is not - resolvable +(dict) Metadata dictionary from name claim, None if the name is not resolvable ``` -Resolve stream info from a LBRY name - ### Arguments | Parameter | Description | |:----------------|:--------------------------------------------| | name *required* | (str) the name to resolve | | force | (bool) force refresh and do not check cache | +::: + +::: api__content__body ## routing_table_get -> Returns: +Get DHT routing information. +::: + +::: api__content__example +Returns: ``` - (dict) dictionary containing routing and contact information - { - "buckets": { - : [ - { - "address": (str) peer address, - "port": (int) peer udp port - "node_id": (str) peer node id, - "blobs": (list) blob hashes announced by peer - } - ] - }, - "contacts": (list) contact node ids, - "blob_hashes": (list) all of the blob hashes stored by peers in the list of buckets, - "node_id": (str) the local dht node id - } -``` +(dict) dictionary containing routing and contact information -Get DHT routing information +{ + "buckets": { + : [ + { + "address": (str) peer address, + "port": (int) peer udp port + "node_id": (str) peer node id, + "blobs": (list) blob hashes announced by peer + } + ] + }, + "contacts": (list) contact node ids, + "blob_hashes": (list) all of the blob hashes stored by peers in the list of buckets, + "node_id": (str) the local dht node id +} +``` ### Arguments | Parameter | Description | || +::: + +::: api__content__body ## settings_get -> Returns: +Get daemon settings. +::: + +::: api__content__example +Returns: ``` - (dict) Dictionary of daemon settings - See ADJUSTABLE_SETTINGS in lbrynet/conf.py for full list of settings +(dict) Dictionary of daemon settings +See ADJUSTABLE_SETTINGS in lbrynet/conf.py for full list of settings ``` -Get daemon settings - ### Arguments | Parameter | Description | || +::: + +::: api__content__body ## settings_set -> Returns: +Set daemon settings. +::: + +::: api__content__example +Returns: ``` - (dict) Updated dictionary of daemon settings +(dict) Updated dictionary of daemon settings ``` -Set daemon settings - ### Arguments | Parameter | Description | @@ -997,7 +1191,7 @@ Set daemon settings | data_rate | (float) 0.0001 | | download_timeout | (int) 180 | | peer_port | (int) 3333 | -| max_key_fee | (dict) maximum key fee for downloads,in the format:{'currency': ,'amount': }.In the CLI, it must be an escaped JSON stringSupported currency symbols: LBC, USD, BTC | +| max_key_fee | (dict) maximum key fee for downloads, in the format: {'currency': ,'amount': }. In the CLI, it must be an escaped JSON stringSupported currency symbols: LBC, USD, BTC | | disable_max_key_fee | (bool) False | | use_upnp | (bool) True | | run_reflector_server | (bool) False | @@ -1006,349 +1200,422 @@ Set daemon settings | share_usage_data | (bool) True | | peer_search_timeout | (int) 3 | | sd_download_timeout | (int) 3 | -| auto_renew_claim_height_delta | (int) 0claims set to expire within this many blocks will beautomatically renewed after startup (if set to 0, renewswill not be made automatically) | +| auto_renew_claim_height_delta | (int) 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) | +::: + +::: api__content__body ## status -> Returns: +Get daemon status. +::: + +::: api__content__example +Returns: ``` - (dict) lbrynet-daemon status - { - 'lbry_id': lbry peer id, base58, - 'installation_id': installation id, base58, - 'is_running': bool, - 'is_first_run': bool, - 'startup_status': { - 'code': status code, - 'message': status message - }, - 'connection_status': { - 'code': connection status code, - 'message': connection status message - }, - 'blockchain_status': { - 'blocks': local blockchain height, - 'blocks_behind': remote_height - local_height, - 'best_blockhash': block hash of most recent block, - }, - 'wallet_is_encrypted': bool, +(dict) lbrynet-daemon status - 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 - } - } +{ + 'lbry_id': lbry peer id, base58, + 'installation_id': installation id, base58, + 'is_running': bool, + 'is_first_run': bool, + 'startup_status': { + 'code': status code, + 'message': status message + }, + 'connection_status': { + 'code': connection status code, + 'message': connection status message + }, + 'blockchain_status': { + 'blocks': local blockchain height, + 'blocks_behind': remote_height - local_height, + 'best_blockhash': block hash of most recent block + }, + '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 + } +} ``` -Get daemon status - ### Arguments | Parameter | Description | |:---------------|:-----------------------------------------| | session_status | (bool) include session status in results | +::: + +::: api__content__body ## stream_availability -> Returns: +Get stream availability for lbry uri. +::: + +::: api__content__example +Returns: ``` - (dict) { - 'is_available': , - 'did_decode': , - 'did_resolve': , - 'is_stream': , - 'num_blobs_in_stream': , - 'sd_hash': , - 'sd_blob_availability': see `blob_availability`, - 'head_blob_hash': , - 'head_blob_availability': see `blob_availability`, - 'use_upnp': , - 'upnp_redirect_is_set': , - 'error': | error message - } +(dict) { + 'is_available': , + 'did_decode': , + 'did_resolve': , + 'is_stream': , + 'num_blobs_in_stream': , + 'sd_hash': , + 'sd_blob_availability': see `blob_availability`, + 'head_blob_hash': , + 'head_blob_availability': see `blob_availability`, + 'use_upnp': , + 'upnp_redirect_is_set': , + 'error': | error message +} ``` -Get stream availability for lbry uri - ### Arguments -| Parameter | Description | -|:---------------|:----------------------------------------------------------| -| uri *required* | (str) check availability for this uri | -| search_timeout | (int) how long to search for peers for the blobin the dht | -| blob_timeout | (int) how long to try downloading from a peer | +| Parameter | Description | +|:---------------|:-----------------------------------------------------------| +| uri *required* | (str) check availability for this uri | +| search_timeout | (int) how long to search for peers for the blob in the dht | +| blob_timeout | (int) how long to try downloading from a peer | +::: + +::: api__content__body ## stream_cost_estimate -> Returns: +Get estimated cost for a lbry stream. +::: + +::: api__content__example +Returns: ``` - (float) Estimated cost in lbry credits, returns None if uri is not - resolvable +(float) Estimated cost in lbry credits, returns None if uri is not resolvable ``` -Get estimated cost for a lbry stream - ### Arguments -| Parameter | Description | -|:---------------|:-------------------------------------------------------------------------| -| uri *required* | (str) uri to use | -| size | (float) stream size in bytes. if provided an sd blob won't bedownloaded. | +| Parameter | Description | +|:---------------|:--------------------------------------------------------------------------| +| uri *required* | (str) uri to use | +| size | (float) stream size in bytes. If provided an sd blob won't be downloaded. | +::: + +::: api__content__body ## transaction_list -> Returns: +List transactions belonging to wallet. +::: + +::: api__content__example +Returns: ``` - (list) List of transactions +(list) List of transactions - { - "claim_info": (list) claim info if in txn [{ - "address": (str) address of claim, - "balance_delta": (float) bid amount, - "amount": (float) claim amount, - "claim_id": (str) claim id, - "claim_name": (str) claim name, - "nout": (int) nout - }], - "abandon_info": (list) abandon info if in txn [{ - "address": (str) address of abandoned claim, - "balance_delta": (float) returned amount, - "amount": (float) claim amount, - "claim_id": (str) claim id, - "claim_name": (str) claim name, - "nout": (int) nout - }], - "confirmations": (int) number of confirmations for the txn, - "date": (str) date and time of txn, - "fee": (float) txn fee, - "support_info": (list) support info if in txn [{ - "address": (str) address of support, - "balance_delta": (float) support amount, - "amount": (float) support amount, - "claim_id": (str) claim id, - "claim_name": (str) claim name, - "is_tip": (bool), - "nout": (int) nout - }], - "timestamp": (int) timestamp, - "txid": (str) txn id, - "update_info": (list) update info if in txn [{ - "address": (str) address of claim, - "balance_delta": (float) credited/debited - "amount": (float) absolute amount, - "claim_id": (str) claim id, - "claim_name": (str) claim name, - "nout": (int) nout - }], - "value": (float) value of txn - } +{ + "claim_info": (list) claim info if in txn [{ + "address": (str) address of claim, + "balance_delta": (float) bid amount, + "amount": (float) claim amount, + "claim_id": (str) claim id, + "claim_name": (str) claim name, + "nout": (int) nout + }], + "abandon_info": (list) abandon info if in txn [{ + "address": (str) address of abandoned claim, + "balance_delta": (float) returned amount, + "amount": (float) claim amount, + "claim_id": (str) claim id, + "claim_name": (str) claim name, + "nout": (int) nout + }], + "confirmations": (int) number of confirmations for the txn, + "date": (str) date and time of txn, + "fee": (float) txn fee, + "support_info": (list) support info if in txn [{ + "address": (str) address of support, + "balance_delta": (float) support amount, + "amount": (float) support amount, + "claim_id": (str) claim id, + "claim_name": (str) claim name, + "is_tip": (bool), + "nout": (int) nout + }], + "timestamp": (int) timestamp, + "txid": (str) txn id, + "update_info": (list) update info if in txn [{ + "address": (str) address of claim, + "balance_delta": (float) credited/debited + "amount": (float) absolute amount, + "claim_id": (str) claim id, + "claim_name": (str) claim name, + "nout": (int) nout + }], + "value": (float) value of txn +} ``` -List transactions belonging to wallet - ### Arguments | Parameter | Description | || +::: + +::: api__content__body ## transaction_show -> Returns: +Get a decoded transaction from a txid. +::: + +::: api__content__example +Returns: ``` - (dict) JSON formatted transaction +(dict) JSON formatted transaction ``` -Get a decoded transaction from a txid - ### Arguments | Parameter | Description | |:----------------|:------------------------------| | txid *required* | (str) txid of the transaction | +::: + +::: api__content__body ## utxo_list -> Returns: +List unspent transaction outputs. +::: + +::: api__content__example +Returns: ``` - (list) List of unspent transaction outputs (UTXOs) - [ - { - "address": (str) the output address - "amount": (float) unspent amount - "height": (int) block height - "is_claim": (bool) is the tx a claim - "is_coinbase": (bool) is the tx a coinbase tx - "is_support": (bool) is the tx a support - "is_update": (bool) is the tx an update - "nout": (int) nout of the output - "txid": (str) txid of the output - }, - ... - ] -``` +(list) List of unspent transaction outputs (UTXOs) -List unspent transaction outputs +[ + { + "address": (str) the output address + "amount": (float) unspent amount + "height": (int) block height + "is_claim": (bool) is the tx a claim + "is_coinbase": (bool) is the tx a coinbase tx + "is_support": (bool) is the tx a support + "is_update": (bool) is the tx an update + "nout": (int) nout of the output + "txid": (str) txid of the output + }, + ... +] +``` ### Arguments | Parameter | Description | || +::: + +::: api__content__body ## version -> Returns: +Get lbry version information. +::: + +::: api__content__example +Returns: ``` - (dict) Dictionary of lbry version information - { - 'build': (str) build type (e.g. "dev", "rc", "release"), - 'ip': (str) remote ip, if available, - 'lbrynet_version': (str) lbrynet_version, - 'lbryum_version': (str) lbryum_version, - 'lbryschema_version': (str) lbryschema_version, - 'os_release': (str) os release string - 'os_system': (str) os name - 'platform': (str) platform string - 'processor': (str) processor type, - 'python_version': (str) python version, - } -``` +(dict) Dictionary of lbry version information -Get lbry version information +{ + 'build': (str) build type (e.g. "dev", "rc", "release"), + 'ip': (str) remote ip, if available, + 'lbrynet_version': (str) lbrynet_version, + 'lbryum_version': (str) lbryum_version, + 'lbryschema_version': (str) lbryschema_version, + 'os_release': (str) os release string + 'os_system': (str) os name + 'platform': (str) platform string + 'processor': (str) processor type, + 'python_version': (str) python version +} +``` ### Arguments | Parameter | Description | || +::: + +::: api__content__body ## wallet_balance -> Returns: +Return the balance of the wallet. +::: + +::: api__content__example +Returns: ``` - (float) amount of lbry credits in wallet +(float) amount of lbry credits in wallet ``` -Return the balance of the wallet - ### Arguments -| Parameter | Description | -|:--------------------|:-----------------------------------------------------------------| -| address | (str) If provided only the balance for thisaddress will be given | -| include_unconfirmed | (bool) Include unconfirmed | +| Parameter | Description | +|:--------------------|:------------------------------------------------------------------| +| address | (str) If provided only the balance for this address will be given | +| include_unconfirmed | (bool) Include unconfirmed | +::: + +::: api__content__body ## wallet_decrypt -> Returns: +Decrypt an encrypted wallet, this will remove the wallet password. +::: + +::: api__content__example +Returns: ``` - (bool) true if wallet is decrypted, otherwise false +(bool) true if wallet is decrypted, otherwise false ``` -Decrypt an encrypted wallet, this will remove the wallet password - ### Arguments | Parameter | Description | || +::: + +::: api__content__body ## wallet_encrypt -> Returns: - -``` - (bool) true if wallet is decrypted, otherwise false -``` - Encrypt a wallet with a password, if the wallet is already encrypted this will update -the password +the password. +::: + +::: api__content__example +Returns: + +``` +(bool) true if wallet is decrypted, otherwise false +``` ### Arguments | Parameter | Description | |:------------------------|:-------------------------------------------------------| | new_password *required* | (str) password string to be used for encrypting wallet | +::: + +::: api__content__body ## wallet_is_address_mine -> Returns: - -``` - (bool) true, if address is associated with current wallet -``` - Checks if an address is associated with the current wallet. +::: + +::: api__content__example +Returns: + +``` +(bool) true, if address is associated with current wallet +``` ### Arguments | Parameter | Description | |:-------------------|:-----------------------| | address *required* | (str) address to check | +::: + +::: api__content__body ## wallet_list -> Returns: +List wallet addresses. +::: + +::: api__content__example +Returns: ``` - List of wallet addresses +List of wallet addresses ``` -List wallet addresses - ### Arguments | Parameter | Description | || +::: + +::: api__content__body ## wallet_new_address -> Returns: +Generate a new wallet address. +::: + +::: api__content__example +Returns: ``` - (str) New wallet address in base58 +(str) New wallet address in base58 ``` -Generate a new wallet address - ### Arguments | Parameter | Description | || +::: + +::: api__content__body ## wallet_prefill_addresses -> Returns: +Create new addresses, each containing `amount` credits. +::: + +::: api__content__example +Returns: ``` - (dict) the resulting transaction +(dict) the resulting transaction ``` -Create new addresses, each containing `amount` credits - ### Arguments | Parameter | Description | @@ -1356,47 +1623,54 @@ Create new addresses, each containing `amount` credits | no_broadcast | (bool) whether to broadcast or not | | num_addresses *required* | (int) num of addresses to create | | amount *required* | (float) initial amount in each address | +::: + +::: api__content__body ## wallet_public_key -> Returns: +Get public key from wallet address. +::: + +::: api__content__example +Returns: ``` - (list) list of public keys associated with address. - Could contain more than one public key if multisig. +(list) list of public keys associated with address. Could contain more than one public key if multisig. ``` -Get public key from wallet address - ### Arguments | Parameter | Description | |:-------------------|:----------------------------------------------| | address *required* | (str) address for which to get the public key | +::: + +::: api__content__body ## wallet_send -> Returns: +Send credits. If given an address, send credits to it. If given a claim id, send a tip to the owner of a claim specified by uri. A tip is a claim support where the recipient of the support is the claim address for the claim being supported. +::: + +::: api__content__example +Returns: ``` - If sending to an address: - (bool) true if payment successfully scheduled +If sending to an address: +(bool) true if payment successfully scheduled - If sending a claim tip: - (dict) Dictionary containing the result of the support - { - txid : (str) txid of resulting support claim - nout : (int) nout of the resulting support claim - fee : (float) fee paid for the transaction - } +If sending a claim tip: +(dict) Dictionary containing the result of the support +{ + txid : (str) txid of resulting support claim + nout : (int) nout of the resulting support claim + fee : (float) fee paid for the transaction +} ``` -Send credits. If given an address, send credits to it. If given a claim id, send a tip -to the owner of a claim specified by uri. A tip is a claim support where the recipient -of the support is the claim address for the claim being supported. - ### Arguments | Parameter | Description | @@ -1404,39 +1678,47 @@ of the support is the claim address for the claim being supported. | amount *required* | (float) amount of credit to send | | address *required* | (str) address to send credits to | | claim_id *required* | (float) claim_id of the claim to send to tip to | +::: + +::: api__content__body ## wallet_unlock -> Returns: +Unlock an encrypted wallet. +::: + +::: api__content__example +Returns: ``` - (bool) true if wallet is unlocked, otherwise false +(bool) true if wallet is unlocked, otherwise false ``` -Unlock an encrypted wallet - ### Arguments | Parameter | Description | |:--------------------|:------------------------------------| | password *required* | (str) password for unlocking wallet | +::: + +::: api__content__body ## wallet_unused_address -> Returns: +Return an address containing no balance, will create a new address if there is none. +::: + +::: api__content__example +Returns: ``` - (str) Unused wallet address in base58 +(str) Unused wallet address in base58 ``` -Return an address containing no balance, will create -a new address if there is none. - ### Arguments | Parameter | Description | || - - +::: diff --git a/content/.vuepress/theme/Layout.vue b/content/.vuepress/theme/Layout.vue index ffba395..38e7428 100644 --- a/content/.vuepress/theme/Layout.vue +++ b/content/.vuepress/theme/Layout.vue @@ -1,5 +1,10 @@ -