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

make accurate docstring of claim_show

Browse source
This commit is contained in:
Kay Kurokawa 2017-06-23 14:47:28 -04:00
parent 24035406d6
commit b355e9ed8e
1 changed files with 13 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
lbrynet/daemon/Daemon.py
View file

@ -1317,20 +1317,21 @@ class Daemon(AuthJSONRPCServer):
@defer.inlineCallbacks @defer.inlineCallbacks
def jsonrpc_claim_show(self, txid=None, nout=None, claim_id=None): def jsonrpc_claim_show(self, txid=None, nout=None, claim_id=None):
""" """
Resolve claim info from a LBRY name Resolve claim info from txid/nout or with claim ID
Usage: Usage:
claim_show [<txid> | --txid=<txid>] [<nout> | --nout=<nout>] claim_show [<txid> | --txid=<txid>] [<nout> | --nout=<nout>]
[<claim_id> | --claim_id=<claim_id>] [<claim_id> | --claim_id=<claim_id>]
Options: Options:
<txid>, --txid=<txid> : look for claim with this txid <txid>, --txid=<txid> : look for claim with this txid, nout must
<nout>, --nout=<nout> : look for claim with this nout also be specified
<nout>, --nout=<nout> : look for claim with this nout, txid must
also be specified
<claim_id>, --claim_id=<claim_id> : look for claim with this claim id <claim_id>, --claim_id=<claim_id> : look for claim with this claim id
Returns: Returns:
(dict) Dictionary contaning claim info, (bool) false if claim is not (dict) Dictionary containing claim info as below,
resolvable
{ {
'txid': (str) txid of claim 'txid': (str) txid of claim
@ -1341,6 +1342,13 @@ class Daemon(AuthJSONRPCServer):
'claim_id': (str) claim ID of claim 'claim_id': (str) claim ID of claim
'supports': (list) list of supports associated with claim 'supports': (list) list of supports associated with claim
} }
if claim cannot be resolved, dictionary as below will be returned
{
'error': (str) reason for error
}
""" """
if claim_id is not None and txid is None and nout is None: if claim_id is not None and txid is None and nout is None:
claim_results = yield self.session.wallet.get_claim_by_claim_id(claim_id) claim_results = yield self.session.wallet.get_claim_by_claim_id(claim_id)