forked from LBRYCommunity/lbry-sdk
docs
This commit is contained in:
Jack Robison
parent
e435a9f722
commit
c38928ff58
3 changed files with 149 additions and 79 deletions
|
|
@ -496,6 +496,13 @@
|
||||||
publish
|
publish
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#report_bug" title="report_bug" class="md-nav__link">
|
||||||
|
report_bug
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
|
|
@ -912,6 +919,13 @@
|
||||||
publish
|
publish
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#report_bug" title="report_bug" class="md-nav__link">
|
||||||
|
report_bug
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
|
|
@ -1642,7 +1656,7 @@ Usage:
|
||||||
file_list [--sd_hash=<sd_hash>] [--file_name=<file_name>] [--stream_hash=<stream_hash>]
|
file_list [--sd_hash=<sd_hash>] [--file_name=<file_name>] [--stream_hash=<stream_hash>]
|
||||||
[--rowid=<rowid>] [--claim_id=<claim_id>] [--outpoint=<outpoint>] [--txid=<txid>] [--nout=<nout>]
|
[--rowid=<rowid>] [--claim_id=<claim_id>] [--outpoint=<outpoint>] [--txid=<txid>] [--nout=<nout>]
|
||||||
[--channel_claim_id=<channel_claim_id>] [--channel_name=<channel_name>]
|
[--channel_claim_id=<channel_claim_id>] [--channel_name=<channel_name>]
|
||||||
[--claim_name=<claim_name>] [--full_status]
|
[--claim_name=<claim_name>] [--full_status] [--sort=<sort_method>...]
|
||||||
|
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
|
|
@ -1660,6 +1674,9 @@ Options:
|
||||||
--claim_name=<claim_name> : (str) get file with matching claim name
|
--claim_name=<claim_name> : (str) get file with matching claim name
|
||||||
--full_status : (bool) full status, populate the
|
--full_status : (bool) full status, populate the
|
||||||
'message' and 'size' fields
|
'message' and 'size' fields
|
||||||
|
--sort=<sort_method> : (str) sort by any property, like 'file_name'
|
||||||
|
or 'metadata.author'; to specify direction
|
||||||
|
append ',asc' or ',desc'
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
(list) List of files
|
(list) List of files
|
||||||
|
|
@ -1851,40 +1868,40 @@ Usage:
|
||||||
|
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
--name=<name> : (str) name of the content
|
--name=<name> : (str) name of the content
|
||||||
--bid=<bid> : (float) amount to back the claim
|
--bid=<bid> : (decimal) amount to back the claim
|
||||||
--metadata=<metadata> : (dict) ClaimDict to associate with the claim.
|
--metadata=<metadata> : (dict) ClaimDict to associate with the claim.
|
||||||
--file_path=<file_path> : (str) path to file to be associated with name. If provided,
|
--file_path=<file_path> : (str) path to file to be associated with name. If provided,
|
||||||
a lbry stream of this file will be used in 'sources'.
|
a lbry stream of this file will be used in 'sources'.
|
||||||
If no path is given but a sources dict is provided,
|
If no path is given but a sources dict is provided,
|
||||||
it will be used. If neither are provided, an
|
it will be used. If neither are provided, an
|
||||||
error is raised.
|
error is raised.
|
||||||
--fee=<fee> : (dict) Dictionary representing key fee to download content:
|
--fee=<fee> : (dict) Dictionary representing key fee to download content:
|
||||||
{
|
{
|
||||||
'currency': currency_symbol,
|
'currency': currency_symbol,
|
||||||
'amount': float,
|
'amount': decimal,
|
||||||
'address': str, optional
|
'address': str, optional
|
||||||
}
|
}
|
||||||
supported currencies: LBC, USD, BTC
|
supported currencies: LBC, USD, BTC
|
||||||
If an address is not provided a new one will be
|
If an address is not provided a new one will be
|
||||||
automatically generated. Default fee is zero.
|
automatically generated. Default fee is zero.
|
||||||
--title=<title> : (str) title of the publication
|
--title=<title> : (str) title of the publication
|
||||||
--description=<description> : (str) description of the publication
|
--description=<description> : (str) description of the publication
|
||||||
--author=<author> : (str) author of the publication
|
--author=<author> : (str) author of the publication
|
||||||
--language=<language> : (str) language of the publication
|
--language=<language> : (str) language of the publication
|
||||||
--license=<license> : (str) publication license
|
--license=<license> : (str) publication license
|
||||||
--license_url=<license_url> : (str) publication license url
|
--license_url=<license_url> : (str) publication license url
|
||||||
--thumbnail=<thumbnail> : (str) thumbnail url
|
--thumbnail=<thumbnail> : (str) thumbnail url
|
||||||
--preview=<preview> : (str) preview url
|
--preview=<preview> : (str) preview url
|
||||||
--nsfw=<nsfw> : (bool) title of the publication
|
--nsfw=<nsfw> : (bool) title of the publication
|
||||||
--sources=<sources> : (str) {'lbry_sd_hash': sd_hash} specifies sd hash of file
|
--sources=<sources> : (str) {'lbry_sd_hash': sd_hash} specifies sd hash of file
|
||||||
--channel_name=<channel_name> : (str) name of the publisher channel name in the wallet
|
--channel_name=<channel_name> : (str) name of the publisher channel name in the wallet
|
||||||
--channel_id=<channel_id> : (str) claim id of the publisher channel, does not check
|
--channel_id=<channel_id> : (str) claim id of the publisher channel, does not check
|
||||||
for channel claim being in the wallet. This allows
|
for channel claim being in the wallet. This allows
|
||||||
publishing to a channel where only the certificate
|
publishing to a channel where only the certificate
|
||||||
private key is in the wallet.
|
private key is in the wallet.
|
||||||
--claim_address=<claim_address> : (str) address where the claim is sent to, if not specified
|
--claim_address=<claim_address> : (str) address where the claim is sent to, if not specified
|
||||||
new address wil automatically be created
|
new address wil automatically be created
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
(dict) Dictionary containing result of the claim
|
(dict) Dictionary containing result of the claim
|
||||||
|
|
@ -1892,11 +1909,25 @@ Returns:
|
||||||
'tx' : (str) hex encoded transaction
|
'tx' : (str) hex encoded transaction
|
||||||
'txid' : (str) txid of resulting claim
|
'txid' : (str) txid of resulting claim
|
||||||
'nout' : (int) nout of the resulting claim
|
'nout' : (int) nout of the resulting claim
|
||||||
'fee' : (float) fee paid for the claim transaction
|
'fee' : (decimal) fee paid for the claim transaction
|
||||||
'claim_id' : (str) claim ID of the resulting claim
|
'claim_id' : (str) claim ID of the resulting claim
|
||||||
}
|
}
|
||||||
</code></pre>
|
</code></pre>
|
||||||
|
|
||||||
|
<h2 id="report_bug">report_bug</h2>
|
||||||
|
<pre><code class="text">Report a bug to slack
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
report_bug (<message> | --message=<message>)
|
||||||
|
|
||||||
|
|
||||||
|
Options:
|
||||||
|
--message=<message> : (str) Description of the bug
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
(bool) true if successful
|
||||||
|
</code></pre>
|
||||||
|
|
||||||
<h2 id="resolve">resolve</h2>
|
<h2 id="resolve">resolve</h2>
|
||||||
<pre><code class="text">Resolve given LBRY URIs
|
<pre><code class="text">Resolve given LBRY URIs
|
||||||
|
|
||||||
|
|
@ -1998,6 +2029,7 @@ Returns:
|
||||||
<bucket index>: [
|
<bucket index>: [
|
||||||
{
|
{
|
||||||
"address": (str) peer address,
|
"address": (str) peer address,
|
||||||
|
"port": (int) peer udp port
|
||||||
"node_id": (str) peer node id,
|
"node_id": (str) peer node id,
|
||||||
"blobs": (list) blob hashes announced by peer
|
"blobs": (list) blob hashes announced by peer
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -484,6 +484,13 @@
|
||||||
publish
|
publish
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#report_bug" title="report_bug" class="md-nav__link">
|
||||||
|
report_bug
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
|
|
@ -912,6 +919,13 @@
|
||||||
publish
|
publish
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#report_bug" title="report_bug" class="md-nav__link">
|
||||||
|
report_bug
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
|
|
@ -1538,6 +1552,9 @@ Args:
|
||||||
'claim_name' : (str) get file with matching claim name
|
'claim_name' : (str) get file with matching claim name
|
||||||
'full_status' : (bool) full status, populate the
|
'full_status' : (bool) full status, populate the
|
||||||
'message' and 'size' fields
|
'message' and 'size' fields
|
||||||
|
'sort' : (str) sort by any property, like 'file_name'
|
||||||
|
or 'metadata.author'; to specify direction
|
||||||
|
append ',asc' or ',desc'
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
(list) List of files
|
(list) List of files
|
||||||
|
|
@ -1691,40 +1708,40 @@ fee, title, description, author, language, license, license_url, thumbnail, prev
|
||||||
or sources. Individual arguments will overwrite the fields specified in metadata argument.
|
or sources. Individual arguments will overwrite the fields specified in metadata argument.
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
'name' (required) : (str) name of the content
|
'name' (required) : (str) name of the content
|
||||||
'bid' (required) : (float) amount to back the claim
|
'bid' (required) : (decimal) amount to back the claim
|
||||||
'metadata' : (dict) ClaimDict to associate with the claim.
|
'metadata' : (dict) ClaimDict to associate with the claim.
|
||||||
'file_path' : (str) path to file to be associated with name. If provided,
|
'file_path' : (str) path to file to be associated with name. If provided,
|
||||||
a lbry stream of this file will be used in 'sources'.
|
a lbry stream of this file will be used in 'sources'.
|
||||||
If no path is given but a sources dict is provided,
|
If no path is given but a sources dict is provided,
|
||||||
it will be used. If neither are provided, an
|
it will be used. If neither are provided, an
|
||||||
error is raised.
|
error is raised.
|
||||||
'fee' : (dict) Dictionary representing key fee to download content:
|
'fee' : (dict) Dictionary representing key fee to download content:
|
||||||
{
|
{
|
||||||
'currency': currency_symbol,
|
'currency': currency_symbol,
|
||||||
'amount': float,
|
'amount': decimal,
|
||||||
'address': str, optional
|
'address': str, optional
|
||||||
}
|
}
|
||||||
supported currencies: LBC, USD, BTC
|
supported currencies: LBC, USD, BTC
|
||||||
If an address is not provided a new one will be
|
If an address is not provided a new one will be
|
||||||
automatically generated. Default fee is zero.
|
automatically generated. Default fee is zero.
|
||||||
'title' : (str) title of the publication
|
'title' : (str) title of the publication
|
||||||
'description' : (str) description of the publication
|
'description' : (str) description of the publication
|
||||||
'author' : (str) author of the publication
|
'author' : (str) author of the publication
|
||||||
'language' : (str) language of the publication
|
'language' : (str) language of the publication
|
||||||
'license' : (str) publication license
|
'license' : (str) publication license
|
||||||
'license_url' : (str) publication license url
|
'license_url' : (str) publication license url
|
||||||
'thumbnail' : (str) thumbnail url
|
'thumbnail' : (str) thumbnail url
|
||||||
'preview' : (str) preview url
|
'preview' : (str) preview url
|
||||||
'nsfw' : (bool) title of the publication
|
'nsfw' : (bool) title of the publication
|
||||||
'sources' : (str) {'lbry_sd_hash': sd_hash} specifies sd hash of file
|
'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_name' : (str) name of the publisher channel name in the wallet
|
||||||
'channel_id' : (str) claim id of the publisher channel, does not check
|
'channel_id' : (str) claim id of the publisher channel, does not check
|
||||||
for channel claim being in the wallet. This allows
|
for channel claim being in the wallet. This allows
|
||||||
publishing to a channel where only the certificate
|
publishing to a channel where only the certificate
|
||||||
private key is in the wallet.
|
private key is in the wallet.
|
||||||
'claim_address' : (str) address where the claim is sent to, if not specified
|
'claim_address' : (str) address where the claim is sent to, if not specified
|
||||||
new address wil automatically be created
|
new address wil automatically be created
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
(dict) Dictionary containing result of the claim
|
(dict) Dictionary containing result of the claim
|
||||||
|
|
@ -1732,11 +1749,21 @@ Returns:
|
||||||
'tx' : (str) hex encoded transaction
|
'tx' : (str) hex encoded transaction
|
||||||
'txid' : (str) txid of resulting claim
|
'txid' : (str) txid of resulting claim
|
||||||
'nout' : (int) nout of the resulting claim
|
'nout' : (int) nout of the resulting claim
|
||||||
'fee' : (float) fee paid for the claim transaction
|
'fee' : (decimal) fee paid for the claim transaction
|
||||||
'claim_id' : (str) claim ID of the resulting claim
|
'claim_id' : (str) claim ID of the resulting claim
|
||||||
}
|
}
|
||||||
</code></pre>
|
</code></pre>
|
||||||
|
|
||||||
|
<h2 id="report_bug">report_bug</h2>
|
||||||
|
<pre><code class="text">Report a bug to slack
|
||||||
|
|
||||||
|
Args:
|
||||||
|
'message' (required) : (str) Description of the bug
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
(bool) true if successful
|
||||||
|
</code></pre>
|
||||||
|
|
||||||
<h2 id="resolve">resolve</h2>
|
<h2 id="resolve">resolve</h2>
|
||||||
<pre><code class="text">Resolve given LBRY URIs
|
<pre><code class="text">Resolve given LBRY URIs
|
||||||
|
|
||||||
|
|
@ -1826,6 +1853,7 @@ Returns:
|
||||||
<bucket index>: [
|
<bucket index>: [
|
||||||
{
|
{
|
||||||
"address": (str) peer address,
|
"address": (str) peer address,
|
||||||
|
"port": (int) peer udp port
|
||||||
"node_id": (str) peer node id,
|
"node_id": (str) peer node id,
|
||||||
"blobs": (list) blob hashes announced by peer
|
"blobs": (list) blob hashes announced by peer
|
||||||
}
|
}
|
||||||
|
|
|
||||||
File diff suppressed because one or more lines are too long
Loading…
Reference in a new issue