Madiator2011/lbry-sdk
1
0
Fork 0
forked from LBRYCommunity/lbry-sdk
Code Pull requests Activity

update api docs

Browse source
This commit is contained in:
Alex Grintsvayg 2017-09-20 11:19:23 -04:00
parent c98197f266
commit 875d512680
1 changed files with 41 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

64
docs/cli.md
View file

@ -22,18 +22,6 @@ Returns:
(bool) true if successful (bool) true if successful
``` ```
## blob_announce_all
```text
Announce all blobs to the DHT
Usage:
blob_announce_all
Returns:
(str) Success/fail message
```
## blob_delete ## blob_delete
```text ```text
@ -239,9 +227,9 @@ Returns:
'depth': (int) claim depth, 'depth': (int) claim depth,
'has_signature': (bool) included if decoded_claim 'has_signature': (bool) included if decoded_claim
'name': (str) claim name, 'name': (str) claim name,
'supports: (list) list of supports [{'txid': txid, 'supports: (list) list of supports [{'txid': (str) txid,
'nout': nout, 'nout': (int) nout,
'amount': amount}], 'amount': (float) amount}],
'txid': (str) claim txid, 'txid': (str) claim txid,
'nout': (str) claim nout, 'nout': (str) claim nout,
'signature_is_valid': (bool), included if has_signature, 'signature_is_valid': (bool), included if has_signature,
@ -719,15 +707,18 @@ Returns:
'depth': (int) claim depth, 'depth': (int) claim depth,
'has_signature': (bool) included if decoded_claim 'has_signature': (bool) included if decoded_claim
'name': (str) claim name, 'name': (str) claim name,
'supports: (list) list of supports [{'txid': txid, 'supports: (list) list of supports [{'txid': (str) txid,
'nout': nout, 'nout': (int) nout,
'amount': amount}], 'amount': (float) amount}],
'txid': (str) claim txid, 'txid': (str) claim txid,
'nout': (str) claim nout, 'nout': (str) claim nout,
'signature_is_valid': (bool), included if has_signature, 'signature_is_valid': (bool), included if has_signature,
'value': ClaimDict if decoded, otherwise hex string '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: If the uri resolves to a claim:
'claim': { 'claim': {
'address': (str) claim address, 'address': (str) claim address,
@ -741,9 +732,9 @@ Returns:
'has_signature': (bool) included if decoded_claim 'has_signature': (bool) included if decoded_claim
'name': (str) claim name, 'name': (str) claim name,
'channel_name': (str) channel name if claim is in a channel 'channel_name': (str) channel name if claim is in a channel
'supports: (list) list of supports [{'txid': txid, 'supports: (list) list of supports [{'txid': (str) txid,
'nout': nout, 'nout': (int) nout,
'amount': amount}] 'amount': (float) amount}]
'txid': (str) claim txid, 'txid': (str) claim txid,
'nout': (str) claim nout, 'nout': (str) claim nout,
'signature_is_valid': (bool), included if has_signature, 'signature_is_valid': (bool), included if has_signature,
@ -905,10 +896,37 @@ Returns:
List transactions belonging to wallet List transactions belonging to wallet
Usage: Usage:
transaction_list transaction_list [-t]
Options:
-t : Include claim tip information
Returns: Returns:
(list) List of transactions (list) List of transactions, where is_tip is null by default,
and set to a boolean if include_tip_info is true
{
"claim_info": (list) claim info if in txn [{"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 [{"amount": (float) support amount,
"claim_id": (str) claim id,
"claim_name": (str) claim name,
"is_tip": (null) default,
(bool) if include_tip_info is true,
"nout": (int) nout}],
"timestamp": (int) timestamp,
"txid": (str) txn id,
"update_info": (list) update info if in txn [{"amount": (float) updated amount,
"claim_id": (str) claim id,
"claim_name": (str) claim name,
"nout": (int) nout}],
"value": (float) value of txn
}
``` ```
## transaction_show ## transaction_show