LBRYCommunity/lbry-sdk
1
0
Fork 1
Code Issues Pull requests Projects Releases 282 Packages Wiki Activity

docs

Browse source
This commit is contained in:
Jack Robison 2017-12-05 14:06:04 -05:00
parent 4c0692bd7a
commit 7bb5448325
No known key found for this signature in database
GPG key ID: 284699E7404E3CFF
1 changed files with 31 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
docs/cli.md
View file

@ -314,6 +314,29 @@ Return:
} }
``` ```
## claim_renew
```text
Renew claim(s) or support(s)
Usage:
claim_renew (<outpoint> | --outpoint=<outpoint>) | (<height> | --height=<height>)
Return:
(dict) Dictionary where key is the the original claim's outpoint and
value is the result of the renewal
{
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
},
}
```
## claim_send_to_address ## claim_send_to_address
```text ```text
@ -822,6 +845,8 @@ Usage:
[<share_usage_data> | --share_usage_data=<share_usage_data>] [<share_usage_data> | --share_usage_data=<share_usage_data>]
[<peer_search_timeout> | --peer_search_timeout=<peer_search_timeout>] [<peer_search_timeout> | --peer_search_timeout=<peer_search_timeout>]
[<sd_download_timeout> | --sd_download_timeout=<sd_download_timeout>] [<sd_download_timeout> | --sd_download_timeout=<sd_download_timeout>]
[<auto_renew_claim_height_delta>
| --auto_renew_claim_height_delta=<auto_renew_claim_height_delta]
Options: Options:
<download_directory>, --download_directory=<download_directory> : (str) <download_directory>, --download_directory=<download_directory> : (str)
@ -846,6 +871,12 @@ Options:
<share_usage_data>, --share_usage_data=<share_usage_data> : (bool), True <share_usage_data>, --share_usage_data=<share_usage_data> : (bool), True
<peer_search_timeout>, --peer_search_timeout=<peer_search_timeout> : (int), 3 <peer_search_timeout>, --peer_search_timeout=<peer_search_timeout> : (int), 3
<sd_download_timeout>, --sd_download_timeout=<sd_download_timeout> : (int), 3 <sd_download_timeout>, --sd_download_timeout=<sd_download_timeout> : (int), 3
<auto_renew_claim_height_delta>,
--auto_renew_claim_height_delta=<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)
Returns: Returns:
(dict) Updated dictionary of daemon settings (dict) Updated dictionary of daemon settings