5239 lines
508 KiB
JSON
5239 lines
508 KiB
JSON
{
|
|
"main": {
|
|
"doc": "Ungrouped commands.",
|
|
"commands": [
|
|
{
|
|
"name": "ffmpeg_find",
|
|
"description": "Get ffmpeg installation information",
|
|
"arguments": [],
|
|
"returns": "(dict) Dictionary of ffmpeg information\n {\n 'available': (bool) found ffmpeg,\n 'which': (str) path to ffmpeg,\n 'analyze_audio_volume': (bool) should ffmpeg analyze audio\n }",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "get",
|
|
"description": "Download stream from a LBRY name.",
|
|
"arguments": [
|
|
{
|
|
"name": "uri",
|
|
"type": "str",
|
|
"description": "uri of the content to download",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "file_name",
|
|
"type": "str",
|
|
"description": "specified name for the downloaded file, overrides the stream file name",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "download_directory",
|
|
"type": "str",
|
|
"description": "full path to the directory to download into",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "timeout",
|
|
"type": "int",
|
|
"description": "download timeout in number of seconds",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "save_file",
|
|
"type": "bool",
|
|
"description": "save the file to the downloads directory",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "wallet to check for claim purchase reciepts",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": " {\n \"streaming_url\": \"(str) url to stream the file using range requests\",\n \"completed\": \"(bool) true if download is completed\",\n \"file_name\": \"(str) name of file\",\n \"download_directory\": \"(str) download directory\",\n \"points_paid\": \"(float) credit paid to download file\",\n \"stopped\": \"(bool) true if download is stopped\",\n \"stream_hash\": \"(str) stream hash of file\",\n \"stream_name\": \"(str) stream name\",\n \"suggested_file_name\": \"(str) suggested file name\",\n \"sd_hash\": \"(str) sd hash of file\",\n \"download_path\": \"(str) download path of file\",\n \"mime_type\": \"(str) mime type of file\",\n \"key\": \"(str) key attached to file\",\n \"total_bytes_lower_bound\": \"(int) lower bound file size in bytes\",\n \"total_bytes\": \"(int) file upper bound size in bytes\",\n \"written_bytes\": \"(int) written size in bytes\",\n \"blobs_completed\": \"(int) number of fully downloaded blobs\",\n \"blobs_in_stream\": \"(int) total blobs on stream\",\n \"blobs_remaining\": \"(int) total blobs remaining to download\",\n \"status\": \"(str) downloader status\",\n \"claim_id\": \"(str) None if claim is not found else the claim id\",\n \"txid\": \"(str) None if claim is not found else the transaction id\",\n \"nout\": \"(int) None if claim is not found else the transaction output index\",\n \"outpoint\": \"(str) None if claim is not found else the tx and output\",\n \"metadata\": \"(dict) None if claim is not found else the claim metadata\",\n \"channel_claim_id\": \"(str) None if claim is not found or not signed\",\n \"channel_name\": \"(str) None if claim is not found or not signed\",\n \"claim_name\": \"(str) None if claim is not found else the claim name\",\n \"reflector_progress\": \"(int) reflector upload progress, 0 to 100\",\n \"uploading_to_reflector\": \"(bool) set to True when currently uploading to reflector\"\n }",
|
|
"examples": [
|
|
{
|
|
"title": "Get a file",
|
|
"curl": "curl -d'{\"method\": \"get\", \"params\": {\"uri\": \"astream#fe7ee643b50b724f6029f6edfe90d67b5512b3ae\"}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet get astream#fe7ee643b50b724f6029f6edfe90d67b5512b3ae",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"get\", \"params\": {\"uri\": \"astream#fe7ee643b50b724f6029f6edfe90d67b5512b3ae\"}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"added_on\": 1602862436,\n \"blobs_completed\": 1,\n \"blobs_in_stream\": 1,\n \"blobs_remaining\": 0,\n \"channel_claim_id\": \"5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"channel_name\": \"@channel\",\n \"claim_id\": \"fe7ee643b50b724f6029f6edfe90d67b5512b3ae\",\n \"claim_name\": \"astream\",\n \"completed\": true,\n \"confirmations\": 3,\n \"content_fee\": null,\n \"download_directory\": \"/tmp/tmpzzr985r8\",\n \"download_path\": \"/tmp/tmpzzr985r8/tmpk0n0x2sb\",\n \"file_name\": \"tmpk0n0x2sb\",\n \"height\": 214,\n \"is_fully_reflected\": false,\n \"key\": \"7acc8b9eac8e533c57b933928ab6fad0\",\n \"metadata\": {\n \"source\": {\n \"hash\": \"fdbd8e75a67f29f701a4e040385e2e23986303ea10239211af907fcbb83578b3e417cb71ce646efd0819dd8c088de1bd\",\n \"media_type\": \"application/octet-stream\",\n \"name\": \"tmpk0n0x2sb\",\n \"sd_hash\": \"d40576a4f0f745a868fafad794b3c5e1299cac415a911e55f6eef4395f524b63a649df4c8a75602ea1731a3c5d138b8d\",\n \"size\": \"11\"\n },\n \"stream_type\": \"binary\"\n },\n \"mime_type\": \"application/octet-stream\",\n \"nout\": 0,\n \"outpoint\": \"c620b71698533d88efa10c80d79a30b74464214cb0d893ec5ab4ec1c37d1676e:0\",\n \"points_paid\": 0.0,\n \"protobuf\": \"01f2d6950adda2502b543f042e4e8496b63a2bc95d1391e6159e2874bf75624f77339a61abf38b4da3237a5a52ad92aece2cefae8742c427064051fadb0dcfcc8f957b190341110ce64b8fd3f5cc874e16db11cbdc0a90010a8d010a30fdbd8e75a67f29f701a4e040385e2e23986303ea10239211af907fcbb83578b3e417cb71ce646efd0819dd8c088de1bd120b746d706b306e3078327362180b22186170706c69636174696f6e2f6f637465742d73747265616d3230d40576a4f0f745a868fafad794b3c5e1299cac415a911e55f6eef4395f524b63a649df4c8a75602ea1731a3c5d138b8d\",\n \"purchase_receipt\": null,\n \"reflector_progress\": 0,\n \"sd_hash\": \"d40576a4f0f745a868fafad794b3c5e1299cac415a911e55f6eef4395f524b63a649df4c8a75602ea1731a3c5d138b8d\",\n \"status\": \"finished\",\n \"stopped\": true,\n \"stream_hash\": \"6b8f6829a8820cd430d23b3de7dd67ad77a11d912b04ac5577014d51af877a0c3a094e8d3d9bc2ae6b2c13c2ea44e477\",\n \"stream_name\": \"tmpk0n0x2sb\",\n \"streaming_url\": \"http://localhost:5280/stream/d40576a4f0f745a868fafad794b3c5e1299cac415a911e55f6eef4395f524b63a649df4c8a75602ea1731a3c5d138b8d\",\n \"suggested_file_name\": \"tmpk0n0x2sb\",\n \"timestamp\": 1602862457,\n \"total_bytes\": 16,\n \"total_bytes_lower_bound\": 0,\n \"txid\": \"c620b71698533d88efa10c80d79a30b74464214cb0d893ec5ab4ec1c37d1676e\",\n \"uploading_to_reflector\": false,\n \"written_bytes\": 11\n }\n}"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "publish",
|
|
"description": "Create or replace a stream claim at a given name (use 'stream create/update' for more control).",
|
|
"arguments": [
|
|
{
|
|
"name": "name",
|
|
"type": "str",
|
|
"description": "name of the content (can only consist of a-z A-Z 0-9 and -(dash))",
|
|
"is_required": true
|
|
},
|
|
{
|
|
"name": "bid",
|
|
"type": "decimal",
|
|
"description": "amount to back the claim",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "file_path",
|
|
"type": "str",
|
|
"description": "path to file to be associated with name.",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "validate_file",
|
|
"type": "bool",
|
|
"description": "validate that the video container and encodings match common web browser support or that optimization succeeds if specified. FFmpeg is required",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "optimize_file",
|
|
"type": "bool",
|
|
"description": "transcode the video & audio if necessary to ensure common web browser support. FFmpeg is required",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "fee_currency",
|
|
"type": "string",
|
|
"description": "specify fee currency",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "fee_amount",
|
|
"type": "decimal",
|
|
"description": "content download fee",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "fee_address",
|
|
"type": "str",
|
|
"description": "address where to send fee payments, will use value from --claim_address if not provided",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "title",
|
|
"type": "str",
|
|
"description": "title of the publication",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "description",
|
|
"type": "str",
|
|
"description": "description of the publication",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "author",
|
|
"type": "str",
|
|
"description": "author of the publication. The usage for this field is not the same as for channels. The author field is used to credit an author who is not the publisher and is not represented by the channel. For example, a pdf file of 'The Odyssey' has an author of 'Homer' but may by published to a channel such as '@classics', or to no channel at all",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "tags",
|
|
"type": "list",
|
|
"description": "add content tags",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "languages",
|
|
"type": "list",
|
|
"description": "languages used by the channel, using RFC 5646 format, eg: for English `--languages=en` for Spanish (Spain) `--languages=es-ES` for Spanish (Mexican) `--languages=es-MX` for Chinese (Simplified) `--languages=zh-Hans` for Chinese (Traditional) `--languages=zh-Hant`",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "locations",
|
|
"type": "list",
|
|
"description": "locations relevant to the stream, consisting of 2 letter `country` code and a `state`, `city` and a postal `code` along with a `latitude` and `longitude`. for JSON RPC: pass a dictionary with aforementioned attributes as keys, eg: ... \"locations\": [{'country': 'US', 'state': 'NH'}] ... for command line: pass a colon delimited list with values in the following order: \"COUNTRY:STATE:CITY:CODE:LATITUDE:LONGITUDE\" making sure to include colon for blank values, for example to provide only the city: ... --locations=\"::Manchester\" with all values set: ... --locations=\"US:NH:Manchester:03101:42.990605:-71.460989\" optionally, you can just pass the \"LATITUDE:LONGITUDE\": ... --locations=\"42.990605:-71.460989\" finally, you can also pass JSON string of dictionary on the command line as you would via JSON RPC ... --locations=\"{'country': 'US', 'state': 'NH'}\"",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "license",
|
|
"type": "str",
|
|
"description": "publication license",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "license_url",
|
|
"type": "str",
|
|
"description": "publication license url",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "thumbnail_url",
|
|
"type": "str",
|
|
"description": "thumbnail url",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "release_time",
|
|
"type": "int",
|
|
"description": "original public release of content, seconds since UNIX epoch",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "width",
|
|
"type": "int",
|
|
"description": "image/video width, automatically calculated from media file",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "height",
|
|
"type": "int",
|
|
"description": "image/video height, automatically calculated from media file",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "duration",
|
|
"type": "int",
|
|
"description": "audio/video duration in seconds, automatically calculated",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "channel_id",
|
|
"type": "str",
|
|
"description": "claim id of the publisher channel",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "channel_name",
|
|
"type": "str",
|
|
"description": "name of publisher channel",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "channel_account_id",
|
|
"type": "str",
|
|
"description": "one or more account ids for accounts to look in for channel certificates, defaults to all accounts.",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "account_id",
|
|
"type": "str",
|
|
"description": "account to use for holding the transaction",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict operation to specific wallet",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "funding_account_ids",
|
|
"type": "list",
|
|
"description": "ids of accounts to fund this transaction",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "claim_address",
|
|
"type": "str",
|
|
"description": "address where the claim is sent to, if not specified it will be determined automatically from the account",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "preview",
|
|
"type": "bool",
|
|
"description": "do not broadcast the transaction",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "blocking",
|
|
"type": "bool",
|
|
"description": "wait until transaction is in mempool",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }",
|
|
"examples": [
|
|
{
|
|
"title": "Publish a file",
|
|
"curl": "curl -d'{\"method\": \"publish\", \"params\": {\"name\": \"a-new-stream\", \"bid\": \"1.0\", \"file_path\": \"/tmp/tmpzg66qsrc\", \"validate_file\": false, \"optimize_file\": false, \"tags\": [], \"languages\": [], \"locations\": [], \"channel_account_id\": [], \"funding_account_ids\": [], \"preview\": false, \"blocking\": false}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet publish a-new-stream --bid=1.0 --file_path=/tmp/tmpzg66qsrc",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"publish\", \"params\": {\"name\": \"a-new-stream\", \"bid\": \"1.0\", \"file_path\": \"/tmp/tmpzg66qsrc\", \"validate_file\": false, \"optimize_file\": false, \"tags\": [], \"languages\": [], \"locations\": [], \"channel_account_id\": [], \"funding_account_ids\": [], \"preview\": false, \"blocking\": false}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"height\": -2,\n \"hex\": \"0100000001b5c2fa21042c9c7902e2210e72f6e732356ce3fa8284a6d62b2230ada4c68778010000006b483045022100e650ed64dda5492752201f302c36d49ba40a2650eaaf1b241a1afb4cf2712b3d022070e3e9d610155cf3a0e61f7d84d92989927b7f159b52ea67cb18899f642b0049012102980b4392de9b4cd0090d3e81f5f85ef2f08c6dc2280eeb2bcfb58c6ddbf75908ffffffff0200e1f50500000000bfb50c612d6e65772d73747265616d4c94000a90010a8d010a30fdbd8e75a67f29f701a4e040385e2e23986303ea10239211af907fcbb83578b3e417cb71ce646efd0819dd8c088de1bd120b746d707a67363671737263180b22186170706c69636174696f6e2f6f637465742d73747265616d32300a4cf1efdc3d85ef48863f9fafd675bb9cc4e83c7f4bbec17f99e4dd6004a21c3317d08107e3e00e8d205102e2490e646d7576a914f16d76520d9764aa8658b40a8d7fd0a6a73ef41a88ace0b46217000000001976a9143c9f3b8c3c8f0a63a43f32ef3c5615875db424b288ac00000000\",\n \"inputs\": [\n {\n \"address\": \"mqeTenbgAseTRfcPJpmSXpUjRMNphrhjGu\",\n \"amount\": \"4.947555\",\n \"confirmations\": 4,\n \"height\": 215,\n \"nout\": 1,\n \"timestamp\": 1602862457,\n \"txid\": \"7887c6a4ad30222bd6a68482fae36c3532e7f6720e21e202799c2c0421fac2b5\",\n \"type\": \"payment\"\n }\n ],\n \"outputs\": [\n {\n \"address\": \"n3XWGrLR13rLfqCpeJDGFkb3DmyDr8a2Ry\",\n \"amount\": \"1.0\",\n \"claim_id\": \"dc9071a98355d66734dd63cac49ddf4cc1d7f871\",\n \"claim_op\": \"create\",\n \"confirmations\": -2,\n \"height\": -2,\n \"meta\": {},\n \"name\": \"a-new-stream\",\n \"normalized_name\": \"a-new-stream\",\n \"nout\": 0,\n \"permanent_url\": \"lbry://a-new-stream#dc9071a98355d66734dd63cac49ddf4cc1d7f871\",\n \"timestamp\": null,\n \"txid\": \"7e9f8a03143f9697dbf796d74e163f8457c7aa8dfea7e9fb3ee078ad3d8defaa\",\n \"type\": \"claim\",\n \"value\": {\n \"source\": {\n \"hash\": \"fdbd8e75a67f29f701a4e040385e2e23986303ea10239211af907fcbb83578b3e417cb71ce646efd0819dd8c088de1bd\",\n \"media_type\": \"application/octet-stream\",\n \"name\": \"tmpzg66qsrc\",\n \"sd_hash\": \"0a4cf1efdc3d85ef48863f9fafd675bb9cc4e83c7f4bbec17f99e4dd6004a21c3317d08107e3e00e8d205102e2490e64\",\n \"size\": \"11\"\n },\n \"stream_type\": \"binary\"\n },\n \"value_type\": \"stream\"\n },\n {\n \"address\": \"mm3VbEqmHhZ1vu69EMJC467JiPQQgbApbW\",\n \"amount\": \"3.923448\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 1,\n \"timestamp\": null,\n \"txid\": \"7e9f8a03143f9697dbf796d74e163f8457c7aa8dfea7e9fb3ee078ad3d8defaa\",\n \"type\": \"payment\"\n }\n ],\n \"total_fee\": \"0.024107\",\n \"total_input\": \"4.947555\",\n \"total_output\": \"4.923448\",\n \"txid\": \"7e9f8a03143f9697dbf796d74e163f8457c7aa8dfea7e9fb3ee078ad3d8defaa\"\n }\n}"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "resolve",
|
|
"description": "Get the claim that a URL refers to.",
|
|
"arguments": [
|
|
{
|
|
"name": "urls",
|
|
"type": "str, list",
|
|
"description": "one or more urls to resolve",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "wallet to check for claim purchase reciepts",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "new_sdk_server",
|
|
"type": "str",
|
|
"description": "URL of the new SDK server (EXPERIMENTAL)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "include_purchase_receipt",
|
|
"type": "bool",
|
|
"description": "lookup and include a receipt if this wallet has purchased the claim being resolved",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "include_is_my_output",
|
|
"type": "bool",
|
|
"description": "lookup and include a boolean indicating if claim being resolved is yours",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "include_sent_supports",
|
|
"type": "bool",
|
|
"description": "lookup and sum the total amount of supports you've made to this claim",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "include_sent_tips",
|
|
"type": "bool",
|
|
"description": "lookup and sum the total amount of tips you've made to this claim (only makes sense when claim is not yours)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "include_received_tips",
|
|
"type": "bool",
|
|
"description": "lookup and sum the total amount of tips you've received to this claim (only makes sense when claim is yours)",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": "Dictionary of results, keyed by url\n '<url>': {\n If a resolution error occurs:\n 'error': Error message\n\n If the url resolves to a channel or a claim in a channel:\n 'certificate': {\n 'address': (str) claim address,\n 'amount': (float) claim amount,\n 'effective_amount': (float) claim amount including supports,\n 'claim_id': (str) claim id,\n 'claim_sequence': (int) claim sequence number (or -1 if unknown),\n 'decoded_claim': (bool) whether or not the claim value was decoded,\n 'height': (int) claim height,\n 'confirmations': (int) claim depth,\n 'timestamp': (int) timestamp of the block that included this claim tx,\n 'has_signature': (bool) included if decoded_claim\n 'name': (str) claim name,\n 'permanent_url': (str) permanent url of the certificate claim,\n 'supports: (list) list of supports [{'txid': (str) txid,\n 'nout': (int) nout,\n 'amount': (float) amount}],\n 'txid': (str) claim txid,\n 'nout': (str) claim nout,\n 'signature_is_valid': (bool), included if has_signature,\n 'value': ClaimDict if decoded, otherwise hex string\n }\n\n If the url resolves to a channel:\n 'claims_in_channel': (int) number of claims in the channel,\n\n If the url resolves to a claim:\n 'claim': {\n 'address': (str) claim address,\n 'amount': (float) claim amount,\n 'effective_amount': (float) claim amount including supports,\n 'claim_id': (str) claim id,\n 'claim_sequence': (int) claim sequence number (or -1 if unknown),\n 'decoded_claim': (bool) whether or not the claim value was decoded,\n 'height': (int) claim height,\n 'depth': (int) claim depth,\n 'has_signature': (bool) included if decoded_claim\n 'name': (str) claim name,\n 'permanent_url': (str) permanent url of the claim,\n 'channel_name': (str) channel name if claim is in a channel\n 'supports: (list) list of supports [{'txid': (str) txid,\n 'nout': (int) nout,\n 'amount': (float) amount}]\n 'txid': (str) claim txid,\n 'nout': (str) claim nout,\n 'signature_is_valid': (bool), included if has_signature,\n 'value': ClaimDict if decoded, otherwise hex string\n }\n }",
|
|
"examples": [
|
|
{
|
|
"title": "Resolve a claim",
|
|
"curl": "curl -d'{\"method\": \"resolve\", \"params\": {\"urls\": [\"astream#fe7ee643b50b724f6029f6edfe90d67b5512b3ae\"], \"include_purchase_receipt\": false, \"include_is_my_output\": false, \"include_sent_supports\": false, \"include_sent_tips\": false, \"include_received_tips\": false}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet resolve astream#fe7ee643b50b724f6029f6edfe90d67b5512b3ae",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"resolve\", \"params\": {\"urls\": [\"astream#fe7ee643b50b724f6029f6edfe90d67b5512b3ae\"], \"include_purchase_receipt\": false, \"include_is_my_output\": false, \"include_sent_supports\": false, \"include_sent_tips\": false, \"include_received_tips\": false}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"astream#fe7ee643b50b724f6029f6edfe90d67b5512b3ae\": {\n \"address\": \"mzNC6CMEetGVw6QDGChpUM3HfV7DpWGZ7R\",\n \"amount\": \"1.0\",\n \"canonical_url\": \"lbry://@channel#5/astream#f\",\n \"claim_id\": \"fe7ee643b50b724f6029f6edfe90d67b5512b3ae\",\n \"claim_op\": \"update\",\n \"confirmations\": 3,\n \"height\": 214,\n \"is_channel_signature_valid\": true,\n \"meta\": {\n \"activation_height\": 213,\n \"creation_height\": 213,\n \"creation_timestamp\": 1602862457,\n \"effective_amount\": \"1.0\",\n \"expiration_height\": 263187,\n \"is_controlling\": true,\n \"reposted\": 0,\n \"support_amount\": \"0.0\",\n \"take_over_height\": 213,\n \"trending_global\": 0.0,\n \"trending_group\": 0,\n \"trending_local\": 0.0,\n \"trending_mixed\": 0.0\n },\n \"name\": \"astream\",\n \"normalized_name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"lbry://astream#fe7ee643b50b724f6029f6edfe90d67b5512b3ae\",\n \"short_url\": \"lbry://astream#f\",\n \"signing_channel\": {\n \"address\": \"mofqoKUmhmPTCoudQRXgjzGSDnCyJvZAZg\",\n \"amount\": \"1.0\",\n \"canonical_url\": \"lbry://@channel#5\",\n \"claim_id\": \"5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"claim_op\": \"update\",\n \"confirmations\": 7,\n \"has_signing_key\": false,\n \"height\": 210,\n \"meta\": {\n \"activation_height\": 209,\n \"claims_in_channel\": 1,\n \"creation_height\": 209,\n \"creation_timestamp\": 1602862456,\n \"effective_amount\": \"1.0\",\n \"expiration_height\": 263183,\n \"is_controlling\": true,\n \"reposted\": 0,\n \"support_amount\": \"0.0\",\n \"take_over_height\": 209,\n \"trending_global\": 0.0,\n \"trending_group\": 0,\n \"trending_local\": 0.0,\n \"trending_mixed\": 0.0\n },\n \"name\": \"@channel\",\n \"normalized_name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"lbry://@channel#5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"short_url\": \"lbry://@channel#5\",\n \"timestamp\": 1602862456,\n \"txid\": \"3ee8f25ad7bfef1d30e3fce0b212d77b74a495ef1d7635a8be77b96ffbe8e412\",\n \"type\": \"claim\",\n \"value\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a034200049b4cbe0f5275e7b1c170f458af09628ba75401fd95d0205ed9de9037b396f60936d555da2bc8dd09b1804b250f32d1bd07382bd3a4aaa2700b08b137b91f1159\",\n \"public_key_id\": \"mkVrRXQGgjhBaygCP3dNpbmtm5Yohno8q2\",\n \"title\": \"New Channel\"\n },\n \"value_type\": \"channel\"\n },\n \"timestamp\": 1602862457,\n \"txid\": \"c620b71698533d88efa10c80d79a30b74464214cb0d893ec5ab4ec1c37d1676e\",\n \"type\": \"claim\",\n \"value\": {\n \"source\": {\n \"hash\": \"fdbd8e75a67f29f701a4e040385e2e23986303ea10239211af907fcbb83578b3e417cb71ce646efd0819dd8c088de1bd\",\n \"media_type\": \"application/octet-stream\",\n \"name\": \"tmpk0n0x2sb\",\n \"sd_hash\": \"d40576a4f0f745a868fafad794b3c5e1299cac415a911e55f6eef4395f524b63a649df4c8a75602ea1731a3c5d138b8d\",\n \"size\": \"11\"\n },\n \"stream_type\": \"binary\"\n },\n \"value_type\": \"stream\"\n }\n }\n}"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "routing_table_get",
|
|
"description": "Get DHT routing information",
|
|
"arguments": [],
|
|
"returns": "(dict) dictionary containing routing and peer information\n {\n \"buckets\": {\n <bucket index>: [\n {\n \"address\": (str) peer address,\n \"udp_port\": (int) peer udp port,\n \"tcp_port\": (int) peer tcp port,\n \"node_id\": (str) peer node id,\n }\n ]\n },\n \"node_id\": (str) the local dht node id\n }",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "status",
|
|
"description": "Get daemon status",
|
|
"arguments": [],
|
|
"returns": "(dict) lbrynet-daemon status\n {\n 'installation_id': (str) installation id - base58,\n 'is_running': (bool),\n 'skipped_components': (list) [names of skipped components (str)],\n 'startup_status': { Does not include components which have been skipped\n 'blob_manager': (bool),\n 'blockchain_headers': (bool),\n 'database': (bool),\n 'dht': (bool),\n 'exchange_rate_manager': (bool),\n 'hash_announcer': (bool),\n 'peer_protocol_server': (bool),\n 'file_manager': (bool),\n 'libtorrent_component': (bool),\n 'upnp': (bool),\n 'wallet': (bool),\n },\n 'connection_status': {\n 'code': (str) connection status code,\n 'message': (str) connection status message\n },\n 'blockchain_headers': {\n 'downloading_headers': (bool),\n 'download_progress': (float) 0-100.0\n },\n 'wallet': {\n 'connected': (str) host and port of the connected spv server,\n 'blocks': (int) local blockchain height,\n 'blocks_behind': (int) remote_height - local_height,\n 'best_blockhash': (str) block hash of most recent block,\n 'is_encrypted': (bool),\n 'is_locked': (bool),\n 'connected_servers': (list) [\n {\n 'host': (str) server hostname,\n 'port': (int) server port,\n 'latency': (int) milliseconds\n }\n ],\n },\n 'libtorrent_component': {\n 'running': (bool) libtorrent was detected and started successfully,\n },\n 'dht': {\n 'node_id': (str) lbry dht node id - hex encoded,\n 'peers_in_routing_table': (int) the number of peers in the routing table,\n },\n 'blob_manager': {\n 'finished_blobs': (int) number of finished blobs in the blob manager,\n 'connections': {\n 'incoming_bps': {\n <source ip and tcp port>: (int) bytes per second received,\n },\n 'outgoing_bps': {\n <destination ip and tcp port>: (int) bytes per second sent,\n },\n 'total_outgoing_mps': (float) megabytes per second sent,\n 'total_incoming_mps': (float) megabytes per second received,\n 'time': (float) timestamp\n }\n },\n 'hash_announcer': {\n 'announce_queue_size': (int) number of blobs currently queued to be announced\n },\n 'file_manager': {\n 'managed_files': (int) count of files in the stream manager,\n },\n 'upnp': {\n 'aioupnp_version': (str),\n 'redirects': {\n <TCP | UDP>: (int) external_port,\n },\n 'gateway': (str) manufacturer and model,\n 'dht_redirect_set': (bool),\n 'peer_redirect_set': (bool),\n 'external_ip': (str) external ip address,\n }\n }",
|
|
"examples": [
|
|
{
|
|
"title": "Get status",
|
|
"curl": "curl -d'{\"method\": \"status\", \"params\": {}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet status",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"status\", \"params\": {}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"blob_manager\": {\n \"connections\": {\n \"incoming_bps\": {},\n \"max_incoming_mbs\": 0.0,\n \"max_outgoing_mbs\": 0.0,\n \"outgoing_bps\": {},\n \"total_incoming_mbs\": 0.0,\n \"total_outgoing_mbs\": 0.0,\n \"total_received\": 0,\n \"total_sent\": 0\n },\n \"finished_blobs\": 0\n },\n \"connection_status\": {\n \"code\": \"network_connection\",\n \"message\": \"Your internet connection appears to have been interrupted\"\n },\n \"ffmpeg_status\": {\n \"analyze_audio_volume\": true,\n \"available\": true,\n \"which\": \"/usr/bin/ffmpeg\"\n },\n \"file_manager\": {\n \"managed_files\": 0\n },\n \"installation_id\": \"V15UZPpbGpTXg7L4Z4e2PSwvkHpu9GfrP5kaev1rpg3CPeUt7HsbA6FwfVtHh8EAe\",\n \"is_running\": true,\n \"skipped_components\": [\n \"dht\",\n \"upnp\",\n \"hash_announcer\",\n \"peer_protocol_server\"\n ],\n \"startup_status\": {\n \"blob_manager\": true,\n \"database\": true,\n \"exchange_rate_manager\": true,\n \"file_manager\": true,\n \"libtorrent_component\": true,\n \"wallet\": true,\n \"wallet_server_payments\": true\n },\n \"wallet\": {\n \"available_servers\": 1,\n \"best_blockhash\": \"6b8c8af9b97544b81320fc87bce1b342d4eae95e7bedfa0b68c2051cdbd51f28\",\n \"blocks\": 206,\n \"blocks_behind\": 0,\n \"connected\": \"127.0.0.1:50002\",\n \"connected_features\": {\n \"daily_fee\": \"0\",\n \"description\": \"\",\n \"donation_address\": \"\",\n \"genesis_hash\": \"6e3fcf1299d4ec5d79c3a4c91d624a4acf9e2e173d95a1a0504f677669687556\",\n \"hash_function\": \"sha256\",\n \"hosts\": {},\n \"payment_address\": \"\",\n \"protocol_max\": \"0.99.0\",\n \"protocol_min\": \"0.54.0\",\n \"pruning\": null,\n \"server_version\": \"0.83.0\",\n \"trending_algorithm\": \"zscore\"\n },\n \"headers_synchronization_progress\": 100,\n \"known_servers\": 1,\n \"servers\": [\n {\n \"availability\": true,\n \"host\": \"localhost\",\n \"latency\": 0.010411103023216128,\n \"port\": 50002\n }\n ]\n },\n \"wallet_server_payments\": {\n \"max_fee\": \"0.0\",\n \"running\": false\n }\n }\n}"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "stop",
|
|
"description": "Stop lbrynet API server.",
|
|
"arguments": [],
|
|
"returns": "(string) Shutdown message",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "version",
|
|
"description": "Get lbrynet API server version information",
|
|
"arguments": [],
|
|
"returns": "(dict) Dictionary of lbry version information\n {\n 'processor': (str) processor type,\n 'python_version': (str) python version,\n 'platform': (str) platform string,\n 'os_release': (str) os release string,\n 'os_system': (str) os name,\n 'version': (str) lbrynet version,\n 'build': (str) \"dev\" | \"qa\" | \"rc\" | \"release\",\n }",
|
|
"examples": [
|
|
{
|
|
"title": "Get version",
|
|
"curl": "curl -d'{\"method\": \"version\", \"params\": {}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet version",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"version\", \"params\": {}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"build\": \"dev\",\n \"desktop\": \"GNOME\",\n \"distro\": {\n \"codename\": \"xenial\",\n \"id\": \"ubuntu\",\n \"like\": \"debian\",\n \"version\": \"16.04\",\n \"version_parts\": {\n \"build_number\": \"\",\n \"major\": \"16\",\n \"minor\": \"04\"\n }\n },\n \"lbrynet_version\": \"0.83.0\",\n \"os_release\": \"4.4.0-116-generic\",\n \"os_system\": \"Linux\",\n \"platform\": \"Linux-4.4.0-116-generic-x86_64-with-Ubuntu-16.04-xenial\",\n \"processor\": \"x86_64\",\n \"python_version\": \"3.7.5\",\n \"version\": \"0.83.0\"\n }\n}"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"account": {
|
|
"doc": "Create, modify and inspect wallet accounts.",
|
|
"commands": [
|
|
{
|
|
"name": "account_add",
|
|
"description": "Add a previously created account from a seed, private key or public key (read-only).\nSpecify --single_key for single address or vanity address accounts.",
|
|
"arguments": [
|
|
{
|
|
"name": "account_name",
|
|
"type": "str",
|
|
"description": "name of the account to add",
|
|
"is_required": true
|
|
},
|
|
{
|
|
"name": "seed",
|
|
"type": "str",
|
|
"description": "seed to generate new account from",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "private_key",
|
|
"type": "str",
|
|
"description": "private key for new account",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "public_key",
|
|
"type": "str",
|
|
"description": "public key for new account",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "single_key",
|
|
"type": "bool",
|
|
"description": "create single key account, default is multi-key",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict operation to specific wallet",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": " {\n \"id\": \"account_id\",\n \"is_default\": \"this account is used by default\",\n \"ledger\": \"name of crypto currency and network\",\n \"name\": \"optional account name\",\n \"seed\": \"human friendly words from which account can be recreated\",\n \"encrypted\": \"if account is encrypted\",\n \"private_key\": \"extended private key\",\n \"public_key\": \"extended public key\",\n \"address_generator\": \"settings for generating addresses\",\n \"modified_on\": \"date of last modification to account settings\"\n }",
|
|
"examples": [
|
|
{
|
|
"title": "Add an account from seed",
|
|
"curl": "curl -d'{\"method\": \"account_add\", \"params\": {\"account_name\": \"new account\", \"seed\": \"canyon divert wave luxury danger furnace age music fetch circle ship penalty\", \"single_key\": false}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet account add \"new account\" --seed=\"canyon divert wave luxury danger furnace age music fetch circle ship penalty\"",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"account_add\", \"params\": {\"account_name\": \"new account\", \"seed\": \"canyon divert wave luxury danger furnace age music fetch circle ship penalty\", \"single_key\": false}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"address_generator\": {\n \"change\": {\n \"gap\": 6,\n \"maximum_uses_per_address\": 1\n },\n \"name\": \"deterministic-chain\",\n \"receiving\": {\n \"gap\": 20,\n \"maximum_uses_per_address\": 1\n }\n },\n \"encrypted\": false,\n \"id\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"is_default\": false,\n \"ledger\": \"lbc_regtest\",\n \"modified_on\": 1602862425,\n \"name\": \"new account\",\n \"private_key\": \"tprv8ZgxMBicQKsPdKjSM3yfb29VuJBXyr9SJYQ7iAwXEsPA4NnGgDgFJu9KF3xDQJqEKPJLZbSd7EUAaYVqM9HMz92tG2BcDX2A1u59NVmBCM3\",\n \"public_key\": \"tpubD6NzVbkrYhZ4WnmEEheFzRocUKhU9BLLsqztzgypf9BYts33JcVqVPmBRBZkMfZCqjpgbRbmKwSisEW3w5Ex256TmeqXZfiMUEbRFn5TZPG\",\n \"seed\": \"canyon divert wave luxury danger furnace age music fetch circle ship penalty\"\n }\n}"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "account_balance",
|
|
"description": "Return the balance of an account",
|
|
"arguments": [
|
|
{
|
|
"name": "account_id",
|
|
"type": "str",
|
|
"description": "If provided only the balance for this account will be given. Otherwise default account.",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "balance for specific wallet",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "confirmations",
|
|
"type": "int",
|
|
"description": "Only include transactions with this many confirmed blocks.",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": "(decimal) amount of lbry credits in wallet",
|
|
"examples": [
|
|
{
|
|
"title": "Get default account balance",
|
|
"curl": "curl -d'{\"method\": \"account_balance\", \"params\": {}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet account balance",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"account_balance\", \"params\": {}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"available\": \"7.999876\",\n \"reserved\": \"0.0\",\n \"reserved_subtotals\": {\n \"claims\": \"0.0\",\n \"supports\": \"0.0\",\n \"tips\": \"0.0\"\n },\n \"total\": \"7.999876\"\n }\n}"
|
|
},
|
|
{
|
|
"title": "Get balance for specific account by id",
|
|
"curl": "curl -d'{\"method\": \"account_balance\", \"params\": {\"account_id\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\"}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet account balance \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\"",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"account_balance\", \"params\": {\"account_id\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\"}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"available\": \"2.0\",\n \"reserved\": \"0.0\",\n \"reserved_subtotals\": {\n \"claims\": \"0.0\",\n \"supports\": \"0.0\",\n \"tips\": \"0.0\"\n },\n \"total\": \"2.0\"\n }\n}"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "account_create",
|
|
"description": "Create a new account. Specify --single_key if you want to use\nthe same address for all transactions (not recommended).",
|
|
"arguments": [
|
|
{
|
|
"name": "account_name",
|
|
"type": "str",
|
|
"description": "name of the account to create",
|
|
"is_required": true
|
|
},
|
|
{
|
|
"name": "single_key",
|
|
"type": "bool",
|
|
"description": "create single key account, default is multi-key",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict operation to specific wallet",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": " {\n \"id\": \"account_id\",\n \"is_default\": \"this account is used by default\",\n \"ledger\": \"name of crypto currency and network\",\n \"name\": \"optional account name\",\n \"seed\": \"human friendly words from which account can be recreated\",\n \"encrypted\": \"if account is encrypted\",\n \"private_key\": \"extended private key\",\n \"public_key\": \"extended public key\",\n \"address_generator\": \"settings for generating addresses\",\n \"modified_on\": \"date of last modification to account settings\"\n }",
|
|
"examples": [
|
|
{
|
|
"title": "Create an account",
|
|
"curl": "curl -d'{\"method\": \"account_create\", \"params\": {\"account_name\": \"generated account\", \"single_key\": false}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet account create \"generated account\"",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"account_create\", \"params\": {\"account_name\": \"generated account\", \"single_key\": false}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"address_generator\": {\n \"change\": {\n \"gap\": 6,\n \"maximum_uses_per_address\": 1\n },\n \"name\": \"deterministic-chain\",\n \"receiving\": {\n \"gap\": 20,\n \"maximum_uses_per_address\": 1\n }\n },\n \"encrypted\": false,\n \"id\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"is_default\": false,\n \"ledger\": \"lbc_regtest\",\n \"modified_on\": 1602862425,\n \"name\": \"generated account\",\n \"private_key\": \"tprv8ZgxMBicQKsPdKjSM3yfb29VuJBXyr9SJYQ7iAwXEsPA4NnGgDgFJu9KF3xDQJqEKPJLZbSd7EUAaYVqM9HMz92tG2BcDX2A1u59NVmBCM3\",\n \"public_key\": \"tpubD6NzVbkrYhZ4WnmEEheFzRocUKhU9BLLsqztzgypf9BYts33JcVqVPmBRBZkMfZCqjpgbRbmKwSisEW3w5Ex256TmeqXZfiMUEbRFn5TZPG\",\n \"seed\": \"canyon divert wave luxury danger furnace age music fetch circle ship penalty\"\n }\n}"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "account_fund",
|
|
"description": "Transfer some amount (or --everything) to an account from another\naccount (can be the same account). Amounts are interpreted as LBC.\nYou can also spread the transfer across a number of --outputs (cannot\nbe used together with --everything).",
|
|
"arguments": [
|
|
{
|
|
"name": "to_account",
|
|
"type": "str",
|
|
"description": "send to this account",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "from_account",
|
|
"type": "str",
|
|
"description": "spend from this account",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "amount",
|
|
"type": "str",
|
|
"description": "the amount to transfer lbc",
|
|
"is_required": true
|
|
},
|
|
{
|
|
"name": "everything",
|
|
"type": "bool",
|
|
"description": "transfer everything (excluding claims), default: false.",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "outputs",
|
|
"type": "int",
|
|
"description": "split payment across many outputs, default: 1.",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "limit operation to specific wallet.",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "broadcast",
|
|
"type": "bool",
|
|
"description": "actually broadcast the transaction, default: false.",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }",
|
|
"examples": [
|
|
{
|
|
"title": "Transfer 2 LBC from default account to specific account",
|
|
"curl": "curl -d'{\"method\": \"account_fund\", \"params\": {\"to_account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\", \"amount\": \"2.0\", \"everything\": false, \"broadcast\": true}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet account fund --to_account=\"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\" --amount=2.0 --broadcast",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"account_fund\", \"params\": {\"to_account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\", \"amount\": \"2.0\", \"everything\": false, \"broadcast\": true}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"height\": -2,\n \"hex\": \"0100000001593d803c01161d9d524478df75cef6c11da8d87614e5223d31d1f3ab4a754308000000006b483045022100d755e3d2cc4065107b641336906586a7b159842d903782e6b160c90c39aef6dc02204ad601b3c40820c9695890025fb16a9545b8fd333f0370631773d62b2148b6cc012102da03d047c77c88fc85700096abca5ab15ce21e95ad4ff1e71d908fa3cc190995ffffffff0200c2eb0b000000001976a914bbd66d8f43ae842b769d041309a95819cbde14e388ac90d7ae2f000000001976a914bb6805e32be149c2d7510ba04c327fd34288016c88ac00000000\",\n \"inputs\": [\n {\n \"address\": \"mx9RtSnJXpvcsMBshzEfvEmpsqtQJh9HTN\",\n \"amount\": \"10.0\",\n \"confirmations\": 6,\n \"height\": 201,\n \"nout\": 0,\n \"timestamp\": 1602862455,\n \"txid\": \"0843754aabf3d1313d22e51476d8a81dc1f6ce75df7844529d1d16013c803d59\",\n \"type\": \"payment\"\n }\n ],\n \"outputs\": [\n {\n \"address\": \"mxe9XeEC5YThvqweuLJywuccfe7FGTmD4c\",\n \"amount\": \"2.0\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 0,\n \"timestamp\": null,\n \"txid\": \"6947372f3637caa782cdb49daf4c9cb4f06a8479152eee6691912f042d3d5358\",\n \"type\": \"payment\"\n },\n {\n \"address\": \"mxbsGa4jf99tDFJtiFtxyVJ7N3xPUsD9qo\",\n \"amount\": \"7.999876\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 1,\n \"timestamp\": null,\n \"txid\": \"6947372f3637caa782cdb49daf4c9cb4f06a8479152eee6691912f042d3d5358\",\n \"type\": \"payment\"\n }\n ],\n \"total_fee\": \"0.000124\",\n \"total_input\": \"10.0\",\n \"total_output\": \"9.999876\",\n \"txid\": \"6947372f3637caa782cdb49daf4c9cb4f06a8479152eee6691912f042d3d5358\"\n }\n}"
|
|
},
|
|
{
|
|
"title": "Spread LBC between multiple addresses",
|
|
"curl": "curl -d'{\"method\": \"account_fund\", \"params\": {\"to_account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\", \"from_account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\", \"amount\": \"1.5\", \"everything\": false, \"outputs\": 2, \"broadcast\": true}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet account fund --to_account=\"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\" --from_account=\"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\" --amount=1.5 --outputs=2 --broadcast",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"account_fund\", \"params\": {\"to_account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\", \"from_account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\", \"amount\": \"1.5\", \"everything\": false, \"outputs\": 2, \"broadcast\": true}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"height\": -2,\n \"hex\": \"010000000158533d2d042f919166ee2e1579846af0b49c4caf9db4cd82a7ca37362f374769000000006b483045022100c76e4f1ee55950017492b9bad6178e5f231e2b78b76b87cdb3b896e645525f3a02206c29691cfd6aa7dea5c8cefe77a019c056039b4ae69c794655116a6c583c6f070121021fa6ee5903084a3c68cf3219b09b83ffd1b25eae5d5ad66a708c1259e774c4cfffffffff03c0687804000000001976a9146a86d0525868bfe9f0287eb0792ac22dd73be8a488acc0687804000000001976a9146a86d0525868bfe9f0287eb0792ac22dd73be8a488ac6cb9fa02000000001976a914de0d514e0b0ec3cf293ec252dbbbad5842ac88cf88ac00000000\",\n \"inputs\": [\n {\n \"address\": \"mxe9XeEC5YThvqweuLJywuccfe7FGTmD4c\",\n \"amount\": \"2.0\",\n \"confirmations\": 1,\n \"height\": 207,\n \"nout\": 0,\n \"timestamp\": 1602862456,\n \"txid\": \"6947372f3637caa782cdb49daf4c9cb4f06a8479152eee6691912f042d3d5358\",\n \"type\": \"payment\"\n }\n ],\n \"outputs\": [\n {\n \"address\": \"mqEDRQrRnfFzaX6m2HSgdrCsCd7Vy6MDf2\",\n \"amount\": \"0.75\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 0,\n \"timestamp\": null,\n \"txid\": \"32b6cbd8343c4d508e333603db439e8a469bbe986f19d33a0ee7d44755f8b340\",\n \"type\": \"payment\"\n },\n {\n \"address\": \"mqEDRQrRnfFzaX6m2HSgdrCsCd7Vy6MDf2\",\n \"amount\": \"0.75\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 1,\n \"timestamp\": null,\n \"txid\": \"32b6cbd8343c4d508e333603db439e8a469bbe986f19d33a0ee7d44755f8b340\",\n \"type\": \"payment\"\n },\n {\n \"address\": \"n1m4FxpboAMcDtbVjnFoiqYTnoTmbUPm9H\",\n \"amount\": \"0.499859\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 2,\n \"timestamp\": null,\n \"txid\": \"32b6cbd8343c4d508e333603db439e8a469bbe986f19d33a0ee7d44755f8b340\",\n \"type\": \"payment\"\n }\n ],\n \"total_fee\": \"0.000141\",\n \"total_input\": \"2.0\",\n \"total_output\": \"1.999859\",\n \"txid\": \"32b6cbd8343c4d508e333603db439e8a469bbe986f19d33a0ee7d44755f8b340\"\n }\n}"
|
|
},
|
|
{
|
|
"title": "Transfer all LBC to a specified account",
|
|
"curl": "curl -d'{\"method\": \"account_fund\", \"params\": {\"from_account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\", \"everything\": true, \"broadcast\": true}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet account fund --from_account=\"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\" --everything --broadcast",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"account_fund\", \"params\": {\"from_account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\", \"everything\": true, \"broadcast\": true}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"height\": -2,\n \"hex\": \"010000000340b3f85547d4e70e3ad3196f98be9b468a9e43db0336338e504d3c34d8cbb632000000006b4830450221009286f4bb5c7772a63a8f112c778030299e5bd881eb438f7096c6fcfea2f298b20220610535e1cf672f1bae3769e68831ffd2548503d1b0c754408a4313562609266201210252ccb7fdb5a3df0ace8fec6ccfeafd779a3e7c8140e90837265284525e9220f6ffffffff40b3f85547d4e70e3ad3196f98be9b468a9e43db0336338e504d3c34d8cbb632010000006b483045022100c7f1430fda72968855d0023e05c664867290510b716dfaf248d9fee78af4e5b2022007ac25af1b07efb5fef962b8937d9164fea7739c50712538d26e44f67e3d317901210252ccb7fdb5a3df0ace8fec6ccfeafd779a3e7c8140e90837265284525e9220f6ffffffff40b3f85547d4e70e3ad3196f98be9b468a9e43db0336338e504d3c34d8cbb632020000006a47304402202e070692322d651350ad87d2a5a8af921a8b2b4c559247d07b9d74e64ce6bc41022034c4496122a92b2a22b7164d168e1b2746e80fe874dcb0f9dab5a16b1db0bb320121037074c41a3706b2b2694945c608d0b382ed414c60d5c3d2c688fe8f529a11952cffffffff015027eb0b000000001976a9143b6f1c1f03cf44fe2fb73c719d9360ce53426ce088ac00000000\",\n \"inputs\": [\n {\n \"address\": \"mqEDRQrRnfFzaX6m2HSgdrCsCd7Vy6MDf2\",\n \"amount\": \"0.75\",\n \"confirmations\": 1,\n \"height\": 208,\n \"nout\": 0,\n \"timestamp\": 1602862456,\n \"txid\": \"32b6cbd8343c4d508e333603db439e8a469bbe986f19d33a0ee7d44755f8b340\",\n \"type\": \"payment\"\n },\n {\n \"address\": \"mqEDRQrRnfFzaX6m2HSgdrCsCd7Vy6MDf2\",\n \"amount\": \"0.75\",\n \"confirmations\": 1,\n \"height\": 208,\n \"nout\": 1,\n \"timestamp\": 1602862456,\n \"txid\": \"32b6cbd8343c4d508e333603db439e8a469bbe986f19d33a0ee7d44755f8b340\",\n \"type\": \"payment\"\n },\n {\n \"address\": \"n1m4FxpboAMcDtbVjnFoiqYTnoTmbUPm9H\",\n \"amount\": \"0.499859\",\n \"confirmations\": 1,\n \"height\": 208,\n \"nout\": 2,\n \"timestamp\": 1602862456,\n \"txid\": \"32b6cbd8343c4d508e333603db439e8a469bbe986f19d33a0ee7d44755f8b340\",\n \"type\": \"payment\"\n }\n ],\n \"outputs\": [\n {\n \"address\": \"mkwDGRHqKvQXW9zwfumqrJUhiBDWbzPr1M\",\n \"amount\": \"1.999604\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 0,\n \"timestamp\": null,\n \"txid\": \"4b414b1e4adc47f05e343c46f0ad5193935628beb51056f6d26589bcba9b4916\",\n \"type\": \"payment\"\n }\n ],\n \"total_fee\": \"0.000255\",\n \"total_input\": \"1.999859\",\n \"total_output\": \"1.999604\",\n \"txid\": \"4b414b1e4adc47f05e343c46f0ad5193935628beb51056f6d26589bcba9b4916\"\n }\n}"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "account_list",
|
|
"description": "List details of all of the accounts or a specific account.",
|
|
"arguments": [
|
|
{
|
|
"name": "account_id",
|
|
"type": "str",
|
|
"description": "If provided only the balance for this account will be given",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "accounts in specific wallet",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "confirmations",
|
|
"type": "int",
|
|
"description": "required confirmations (default: 0)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "include_claims",
|
|
"type": "bool",
|
|
"description": "include claims, requires than a LBC account is specified (default: false)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "show_seed",
|
|
"type": "bool",
|
|
"description": "show the seed for the account",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "page",
|
|
"type": "int",
|
|
"description": "page to return during paginating",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "page_size",
|
|
"type": "int",
|
|
"description": "number of items on page during pagination",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": " {\n \"page\": \"Page number of the current items.\",\n \"page_size\": \"Number of items to show on a page.\",\n \"total_pages\": \"Total number of pages.\",\n \"total_items\": \"Total number of items.\",\n \"items\": [\n {\n \"id\": \"account_id\",\n \"is_default\": \"this account is used by default\",\n \"ledger\": \"name of crypto currency and network\",\n \"name\": \"optional account name\",\n \"seed\": \"human friendly words from which account can be recreated\",\n \"encrypted\": \"if account is encrypted\",\n \"private_key\": \"extended private key\",\n \"public_key\": \"extended public key\",\n \"address_generator\": \"settings for generating addresses\",\n \"modified_on\": \"date of last modification to account settings\"\n }\n ]\n }",
|
|
"examples": [
|
|
{
|
|
"title": "List your accounts",
|
|
"curl": "curl -d'{\"method\": \"account_list\", \"params\": {\"include_claims\": false, \"show_seed\": false}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet account list",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"account_list\", \"params\": {\"include_claims\": false, \"show_seed\": false}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"items\": [\n {\n \"address_generator\": {\n \"change\": {\n \"gap\": 6,\n \"maximum_uses_per_address\": 1\n },\n \"name\": \"deterministic-chain\",\n \"receiving\": {\n \"gap\": 20,\n \"maximum_uses_per_address\": 1\n }\n },\n \"certificates\": 0,\n \"coins\": 10.0,\n \"encrypted\": false,\n \"id\": \"myTjaQ7rr9opqoawJAkBwiAjVhTbgq8tXM\",\n \"is_default\": true,\n \"ledger\": \"lbc_regtest\",\n \"name\": \"Account #myTjaQ7rr9opqoawJAkBwiAjVhTbgq8tXM\",\n \"public_key\": \"tpubD6NzVbkrYhZ4Y8SWimAJbLYDuxaPvKDYMbSZQxqfHBRj11AbPTjykWJ87TReUKEeBqMMDYfwa7cPGKtWV22VXw6Y8gf13tXNt94cuyJ9Jzp\",\n \"satoshis\": 1000000000\n }\n ],\n \"page\": 1,\n \"page_size\": 20,\n \"total_items\": 1,\n \"total_pages\": 1\n }\n}"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "account_max_address_gap",
|
|
"description": "Finds ranges of consecutive addresses that are unused and returns the length\nof the longest such range: for change and receiving address chains. This is\nuseful to figure out ideal values to set for 'receiving_gap' and 'change_gap'\naccount settings.",
|
|
"arguments": [
|
|
{
|
|
"name": "account_id",
|
|
"type": "str",
|
|
"description": "account for which to get max gaps",
|
|
"is_required": true
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict operation to specific wallet",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": "(map) maximum gap for change and receiving addresses",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "account_remove",
|
|
"description": "Remove an existing account.",
|
|
"arguments": [
|
|
{
|
|
"name": "account_id",
|
|
"type": "str",
|
|
"description": "id of the account to remove",
|
|
"is_required": true
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict operation to specific wallet",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": " {\n \"id\": \"account_id\",\n \"is_default\": \"this account is used by default\",\n \"ledger\": \"name of crypto currency and network\",\n \"name\": \"optional account name\",\n \"seed\": \"human friendly words from which account can be recreated\",\n \"encrypted\": \"if account is encrypted\",\n \"private_key\": \"extended private key\",\n \"public_key\": \"extended public key\",\n \"address_generator\": \"settings for generating addresses\",\n \"modified_on\": \"date of last modification to account settings\"\n }",
|
|
"examples": [
|
|
{
|
|
"title": "Remove an account",
|
|
"curl": "curl -d'{\"method\": \"account_remove\", \"params\": {\"account_id\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\"}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet account remove mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"account_remove\", \"params\": {\"account_id\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\"}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"address_generator\": {\n \"change\": {\n \"gap\": 6,\n \"maximum_uses_per_address\": 1\n },\n \"name\": \"deterministic-chain\",\n \"receiving\": {\n \"gap\": 20,\n \"maximum_uses_per_address\": 1\n }\n },\n \"encrypted\": false,\n \"id\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"is_default\": false,\n \"ledger\": \"lbc_regtest\",\n \"modified_on\": 1602862425,\n \"name\": \"generated account\",\n \"private_key\": \"tprv8ZgxMBicQKsPdKjSM3yfb29VuJBXyr9SJYQ7iAwXEsPA4NnGgDgFJu9KF3xDQJqEKPJLZbSd7EUAaYVqM9HMz92tG2BcDX2A1u59NVmBCM3\",\n \"public_key\": \"tpubD6NzVbkrYhZ4WnmEEheFzRocUKhU9BLLsqztzgypf9BYts33JcVqVPmBRBZkMfZCqjpgbRbmKwSisEW3w5Ex256TmeqXZfiMUEbRFn5TZPG\",\n \"seed\": \"canyon divert wave luxury danger furnace age music fetch circle ship penalty\"\n }\n}"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "account_send",
|
|
"description": "Send the same number of credits to multiple addresses from a specific account (or default account).",
|
|
"arguments": [
|
|
{
|
|
"name": "account_id",
|
|
"type": "str",
|
|
"description": "account to fund the transaction",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict operation to specific wallet",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "preview",
|
|
"type": "bool",
|
|
"description": "do not broadcast the transaction",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "blocking",
|
|
"type": "bool",
|
|
"description": "wait until tx has synced",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "account_set",
|
|
"description": "Change various settings on an account.",
|
|
"arguments": [
|
|
{
|
|
"name": "account_id",
|
|
"type": "str",
|
|
"description": "id of the account to change",
|
|
"is_required": true
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict operation to specific wallet",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "default",
|
|
"type": "bool",
|
|
"description": "make this account the default",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "new_name",
|
|
"type": "str",
|
|
"description": "new name for the account",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "receiving_gap",
|
|
"type": "int",
|
|
"description": "set the gap for receiving addresses",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "receiving_max_uses",
|
|
"type": "int",
|
|
"description": "set the maximum number of times to use a receiving address",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "change_gap",
|
|
"type": "int",
|
|
"description": "set the gap for change addresses",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "change_max_uses",
|
|
"type": "int",
|
|
"description": "set the maximum number of times to use a change address",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": " {\n \"id\": \"account_id\",\n \"is_default\": \"this account is used by default\",\n \"ledger\": \"name of crypto currency and network\",\n \"name\": \"optional account name\",\n \"seed\": \"human friendly words from which account can be recreated\",\n \"encrypted\": \"if account is encrypted\",\n \"private_key\": \"extended private key\",\n \"public_key\": \"extended public key\",\n \"address_generator\": \"settings for generating addresses\",\n \"modified_on\": \"date of last modification to account settings\"\n }",
|
|
"examples": [
|
|
{
|
|
"title": "Modify maximum number of times a change address can be reused",
|
|
"curl": "curl -d'{\"method\": \"account_set\", \"params\": {\"account_id\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\", \"default\": false, \"change_max_uses\": 10}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet account set mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY --change_max_uses=10",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"account_set\", \"params\": {\"account_id\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\", \"default\": false, \"change_max_uses\": 10}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"address_generator\": {\n \"change\": {\n \"gap\": 6,\n \"maximum_uses_per_address\": 10\n },\n \"name\": \"deterministic-chain\",\n \"receiving\": {\n \"gap\": 20,\n \"maximum_uses_per_address\": 1\n }\n },\n \"encrypted\": false,\n \"id\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"is_default\": false,\n \"ledger\": \"lbc_regtest\",\n \"modified_on\": 1602862425,\n \"name\": \"new account\",\n \"private_key\": \"tprv8ZgxMBicQKsPdKjSM3yfb29VuJBXyr9SJYQ7iAwXEsPA4NnGgDgFJu9KF3xDQJqEKPJLZbSd7EUAaYVqM9HMz92tG2BcDX2A1u59NVmBCM3\",\n \"public_key\": \"tpubD6NzVbkrYhZ4WnmEEheFzRocUKhU9BLLsqztzgypf9BYts33JcVqVPmBRBZkMfZCqjpgbRbmKwSisEW3w5Ex256TmeqXZfiMUEbRFn5TZPG\",\n \"seed\": \"canyon divert wave luxury danger furnace age music fetch circle ship penalty\"\n }\n}"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"address": {
|
|
"doc": "List, generate and verify addresses.",
|
|
"commands": [
|
|
{
|
|
"name": "address_is_mine",
|
|
"description": "Checks if an address is associated with the current wallet.",
|
|
"arguments": [
|
|
{
|
|
"name": "address",
|
|
"type": "str",
|
|
"description": "address to check",
|
|
"is_required": true
|
|
},
|
|
{
|
|
"name": "account_id",
|
|
"type": "str",
|
|
"description": "id of the account to use",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict operation to specific wallet",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": "(bool) true, if address is associated with current wallet",
|
|
"examples": [
|
|
{
|
|
"title": "Check if address is mine",
|
|
"curl": "curl -d'{\"method\": \"address_is_mine\", \"params\": {\"address\": \"mvW5fF65d8WiGavNWjJcuQ6uRoa4AsSmLZ\"}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet address is_mine mvW5fF65d8WiGavNWjJcuQ6uRoa4AsSmLZ",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"address_is_mine\", \"params\": {\"address\": \"mvW5fF65d8WiGavNWjJcuQ6uRoa4AsSmLZ\"}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": true\n}"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "address_list",
|
|
"description": "List account addresses or details of single address.",
|
|
"arguments": [
|
|
{
|
|
"name": "address",
|
|
"type": "str",
|
|
"description": "just show details for single address",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "account_id",
|
|
"type": "str",
|
|
"description": "id of the account to use",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict operation to specific wallet",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "page",
|
|
"type": "int",
|
|
"description": "page to return during paginating",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "page_size",
|
|
"type": "int",
|
|
"description": "number of items on page during pagination",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": " {\n \"page\": \"Page number of the current items.\",\n \"page_size\": \"Number of items to show on a page.\",\n \"total_pages\": \"Total number of pages.\",\n \"total_items\": \"Total number of items.\",\n \"items\": [\n \"an address in base58\"\n ]\n }",
|
|
"examples": [
|
|
{
|
|
"title": "List addresses in default account",
|
|
"curl": "curl -d'{\"method\": \"address_list\", \"params\": {}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet address list",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"address_list\", \"params\": {}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"items\": [\n {\n \"account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"address\": \"mh9VwE8HKhw3QjPCPZh3PU6e3juobVGeME\",\n \"pubkey\": \"tpubDA9GDAntyJu4nEGYmLc4ihro5xv9bSSwfZTPEQQfN25mm2exgoUugfQE4ZMM3boheswEyS3zJMMYneaz2AuYowwhYFPZhYrPv5ktZz5xMQV\",\n \"used_times\": 0\n },\n {\n \"account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"address\": \"mh9fMDTWpwF954grmVnzzntFSWXk8KYy8B\",\n \"pubkey\": \"tpubDA9GDAntyJu4L5oH2g4AeUbTqNd4mnJF7T1xamBiV5hJTwLdqPT3YsGZToqMEZvWu4266AyyraszWAybYcAPP8PJonQPj3J2odScqVUvvxd\",\n \"used_times\": 0\n },\n {\n \"account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"address\": \"mj3pFoj1BLFA293quWByDf2WrSVn76Bvbz\",\n \"pubkey\": \"tpubDA9GDAntyJu4pLDopCn5sXCqmJSMD8f4J2mErt5E3pPmvY2o2xauN9wc2cgA217stad8Und2yumurTL5xpSqbnC95NC3wFik8VTqbWE9HbN\",\n \"used_times\": 0\n },\n {\n \"account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"address\": \"mmKD7WwB8A86K7RAtf7ncr79wgbvzfsJpe\",\n \"pubkey\": \"tpubDA9GDAntyJu4N6C1Craod75L2Kf1dK2KDCS3Q2s2xxWFo2KGtp9xhMVLjwQzCVYwDDXT7ZG2uNCjthqEJZdSeGcH7WgBSYcpJkwBPciGyKn\",\n \"used_times\": 0\n },\n {\n \"account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"address\": \"mmmGb7DUQec3QFrbi1m3MWC232phHGGDrX\",\n \"pubkey\": \"tpubDA9GDAntyJu53kygACiiUPY4Fm6Gf3AvGBk86noTQ6yZoczchTeiz49XnbaCHVnXM7tJRfnrUR73DUbAg4LMJNU5evYmbBfsuA87bn2U58M\",\n \"used_times\": 0\n },\n {\n \"account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"address\": \"mnY7nggBwEtNAKhpYhQWzA1AfeFo7G5AyD\",\n \"pubkey\": \"tpubDA9GDAntyJu4VEy1YcEvFNLKNTWEZFdPM9CFeLoreu4d7cmtTeHcTMkdE4i2sw4YAi5saSd6NEY9oh9WgiLcApK3GrBaoNUeRtG5BZxAnwD\",\n \"used_times\": 0\n },\n {\n \"account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"address\": \"moK5kBNW2hTfUpNPe1ZaQLgEq4Z8N5cj1A\",\n \"pubkey\": \"tpubDA9GDAntyJu4dudWYrKMLH5k8xe7F9BfzEt1tE16AQgRfaaknKQmGz1Z8Bt4ws3ZgFoD5D8ZF5fW1ziHaC7cJvgNagsP7jCXN5DsVuwCe99\",\n \"used_times\": 0\n },\n {\n \"account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"address\": \"moRQq9jHEJ6sL9cX6wq4A7EKTh5f8n8U9h\",\n \"pubkey\": \"tpubDA9GDAntyJu4RWtNN1XU4ny3qgphTYxToGUQRHZgJoS29hz7UcmLmsTeDUeToyfckDz94okiNkE6oRHh3v71auGJV6rai5Sff2sQxk3mBGB\",\n \"used_times\": 0\n },\n {\n \"account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"address\": \"moRkYbPJKGS8ihvNaedGzKQcskudaGdo6j\",\n \"pubkey\": \"tpubDA9GDAntyJu4Fvmm66NdhqkSx2xZJTbjCPhu1zTECuxM5RCTzmuozN9VyAFg8uM3S3nt1EKQqMycTnBoNFTThNHRuWYNz5rH7E9Jx9MyCun\",\n \"used_times\": 0\n },\n {\n \"account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"address\": \"mpqZ2sJifp18baqMntvEp3tgR8Kevo6vyV\",\n \"pubkey\": \"tpubDA9GDAntyJu4tboRaZAXEepzyJEDT29hxnu12gPpWoubZKEnM7XbbnenooLDtq6f7941UTEzkSrQs2ddRmEy14isbjgyHdvA163wcoMxrzN\",\n \"used_times\": 0\n },\n {\n \"account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"address\": \"mpvW6Ck65nk9fNUmMGmSdPFxTX4CsGw8Eb\",\n \"pubkey\": \"tpubDA9GDAntyJu4qzJ1846T1k1ynJfKK6NcLRm2NKrMpqnHADxzWkod9D2pBC9TtY4mQLmrTcmt18kVJaWnqXEMDC2zTWccf1MFNddpyxdexZa\",\n \"used_times\": 0\n },\n {\n \"account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"address\": \"mqEDRQrRnfFzaX6m2HSgdrCsCd7Vy6MDf2\",\n \"pubkey\": \"tpubDA9GDAntyJu4Q1UUt4uC8M5gp7phTP2E1FeU46kYzXb5VBGf5nU7cyUNsyPX2yLU76vp1ZLvkxJYCd6HeAptBfjE5T6YqfWtBYcKmGJLQ1q\",\n \"used_times\": 0\n },\n {\n \"account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"address\": \"mqHzaj6FHs9AePR7W5fFLTik7YDUaFUZRx\",\n \"pubkey\": \"tpubDA9GDAntyJu4iQrq8iPMTQ1YBzjcnMQuLUArHUPJ3snffAYaiYX1K691wxwnuLk1nLQq4wafiw7JDYEAWxNRr9BHwkqiyWq4ZDg3pgc1R7J\",\n \"used_times\": 0\n },\n {\n \"account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"address\": \"mr5hNzrQodvcRT7S7Jo7TdrGF8o5QYPSsx\",\n \"pubkey\": \"tpubDA9GDAntyJu4vriftRQep2iT7d7ZJfsNNhMgXCsNZsa7J6Czt1WEyNE2WQkuqsWswafmx6yYmqQQei3HHUedeqiBhiMdHxWUzVZvohGLXgs\",\n \"used_times\": 0\n },\n {\n \"account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"address\": \"mr9FzGLW7kH4t2vVJsqc98R9DNMnZT1PDZ\",\n \"pubkey\": \"tpubDA9GDAntyJu4LoaQBgqDM1xUkcUtRsS117uA9CDSmFrTR4GGi5X65VoUf7VDRE2oRKnrXDv2bNdfyMBJ23UQpcWhBHZhKM7GsbswhmhEw4T\",\n \"used_times\": 0\n },\n {\n \"account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"address\": \"mrGjJdkoEE5okDJDVJjNPYRm8xJks7TYc1\",\n \"pubkey\": \"tpubDA9GDAntyJu4fT9pBRSPRketsXUkxLhvswEZEG4Fx1e99GDUmpJnRyZoiyN3PaE1ToWazfcx74VQoNqzfhMxDARiGQVPu6JZVcuRRxGAw7d\",\n \"used_times\": 0\n },\n {\n \"account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"address\": \"msiyy9GyYHPW5Rt5EHmj7emfnmF1JHU3m7\",\n \"pubkey\": \"tpubDA9GDAntyJu4U9ERXE8UNUSPgvsM81GgwiYnnqHStaQuvn3M63mMR93B2H4c5554bcw5trZTwqxEiUaAGiKEk3s9Ht9sjmJF81Dy6LWrVzp\",\n \"used_times\": 0\n },\n {\n \"account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"address\": \"mtqf7EPwSBjtW1vjbU83FamYuyKtTS7KDK\",\n \"pubkey\": \"tpubDA9GDAntyJu4Hc41BXDR6TUUkFvMQwfiLcvu2XXNq3XArnJkcADYBJ4fQyEwfm6REuHBWQXGHttLdcMVfjHUaaY5pw33YbSHNq9cZLobRuP\",\n \"used_times\": 0\n },\n {\n \"account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"address\": \"muSxerMewUnvxG6mNTfn2kAuM6WsE2AApZ\",\n \"pubkey\": \"tpubDA9GDAntyJu4FHDttUSFJ4mXkGtEG2fMoe9UDQPgiFzYYuE56AcfekQaxcisyutCmzKRpFrkXfFMHZQjFpc9SHf58apmPdYfK9337qz8S1r\",\n \"used_times\": 0\n },\n {\n \"account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"address\": \"mv6icTd6xgDG4SeVciNJVcWStjkY3QCGif\",\n \"pubkey\": \"tpubDA9GDAntyJu4JJUHEUnbasSVEfZt9tY7K7GRSYp22jG8omR4zobsvu68ENx4JwRGmT9EhGpxfposbSnxJeeijNkaViBif4VWAH6dLNktftZ\",\n \"used_times\": 0\n }\n ],\n \"page\": 1,\n \"page_size\": 20,\n \"total_items\": 53,\n \"total_pages\": 3\n }\n}"
|
|
},
|
|
{
|
|
"title": "List addresses in specified account",
|
|
"curl": "curl -d'{\"method\": \"address_list\", \"params\": {\"account_id\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\"}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet address list --account_id=\"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\"",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"address_list\", \"params\": {\"account_id\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\"}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"items\": [\n {\n \"account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"address\": \"mh9VwE8HKhw3QjPCPZh3PU6e3juobVGeME\",\n \"pubkey\": \"tpubDA9GDAntyJu4nEGYmLc4ihro5xv9bSSwfZTPEQQfN25mm2exgoUugfQE4ZMM3boheswEyS3zJMMYneaz2AuYowwhYFPZhYrPv5ktZz5xMQV\",\n \"used_times\": 0\n },\n {\n \"account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"address\": \"mh9fMDTWpwF954grmVnzzntFSWXk8KYy8B\",\n \"pubkey\": \"tpubDA9GDAntyJu4L5oH2g4AeUbTqNd4mnJF7T1xamBiV5hJTwLdqPT3YsGZToqMEZvWu4266AyyraszWAybYcAPP8PJonQPj3J2odScqVUvvxd\",\n \"used_times\": 0\n },\n {\n \"account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"address\": \"mj3pFoj1BLFA293quWByDf2WrSVn76Bvbz\",\n \"pubkey\": \"tpubDA9GDAntyJu4pLDopCn5sXCqmJSMD8f4J2mErt5E3pPmvY2o2xauN9wc2cgA217stad8Und2yumurTL5xpSqbnC95NC3wFik8VTqbWE9HbN\",\n \"used_times\": 0\n },\n {\n \"account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"address\": \"mmKD7WwB8A86K7RAtf7ncr79wgbvzfsJpe\",\n \"pubkey\": \"tpubDA9GDAntyJu4N6C1Craod75L2Kf1dK2KDCS3Q2s2xxWFo2KGtp9xhMVLjwQzCVYwDDXT7ZG2uNCjthqEJZdSeGcH7WgBSYcpJkwBPciGyKn\",\n \"used_times\": 0\n },\n {\n \"account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"address\": \"mmmGb7DUQec3QFrbi1m3MWC232phHGGDrX\",\n \"pubkey\": \"tpubDA9GDAntyJu53kygACiiUPY4Fm6Gf3AvGBk86noTQ6yZoczchTeiz49XnbaCHVnXM7tJRfnrUR73DUbAg4LMJNU5evYmbBfsuA87bn2U58M\",\n \"used_times\": 0\n },\n {\n \"account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"address\": \"mnY7nggBwEtNAKhpYhQWzA1AfeFo7G5AyD\",\n \"pubkey\": \"tpubDA9GDAntyJu4VEy1YcEvFNLKNTWEZFdPM9CFeLoreu4d7cmtTeHcTMkdE4i2sw4YAi5saSd6NEY9oh9WgiLcApK3GrBaoNUeRtG5BZxAnwD\",\n \"used_times\": 0\n },\n {\n \"account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"address\": \"moK5kBNW2hTfUpNPe1ZaQLgEq4Z8N5cj1A\",\n \"pubkey\": \"tpubDA9GDAntyJu4dudWYrKMLH5k8xe7F9BfzEt1tE16AQgRfaaknKQmGz1Z8Bt4ws3ZgFoD5D8ZF5fW1ziHaC7cJvgNagsP7jCXN5DsVuwCe99\",\n \"used_times\": 0\n },\n {\n \"account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"address\": \"moRQq9jHEJ6sL9cX6wq4A7EKTh5f8n8U9h\",\n \"pubkey\": \"tpubDA9GDAntyJu4RWtNN1XU4ny3qgphTYxToGUQRHZgJoS29hz7UcmLmsTeDUeToyfckDz94okiNkE6oRHh3v71auGJV6rai5Sff2sQxk3mBGB\",\n \"used_times\": 0\n },\n {\n \"account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"address\": \"moRkYbPJKGS8ihvNaedGzKQcskudaGdo6j\",\n \"pubkey\": \"tpubDA9GDAntyJu4Fvmm66NdhqkSx2xZJTbjCPhu1zTECuxM5RCTzmuozN9VyAFg8uM3S3nt1EKQqMycTnBoNFTThNHRuWYNz5rH7E9Jx9MyCun\",\n \"used_times\": 0\n },\n {\n \"account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"address\": \"mpqZ2sJifp18baqMntvEp3tgR8Kevo6vyV\",\n \"pubkey\": \"tpubDA9GDAntyJu4tboRaZAXEepzyJEDT29hxnu12gPpWoubZKEnM7XbbnenooLDtq6f7941UTEzkSrQs2ddRmEy14isbjgyHdvA163wcoMxrzN\",\n \"used_times\": 0\n },\n {\n \"account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"address\": \"mpvW6Ck65nk9fNUmMGmSdPFxTX4CsGw8Eb\",\n \"pubkey\": \"tpubDA9GDAntyJu4qzJ1846T1k1ynJfKK6NcLRm2NKrMpqnHADxzWkod9D2pBC9TtY4mQLmrTcmt18kVJaWnqXEMDC2zTWccf1MFNddpyxdexZa\",\n \"used_times\": 0\n },\n {\n \"account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"address\": \"mqEDRQrRnfFzaX6m2HSgdrCsCd7Vy6MDf2\",\n \"pubkey\": \"tpubDA9GDAntyJu4Q1UUt4uC8M5gp7phTP2E1FeU46kYzXb5VBGf5nU7cyUNsyPX2yLU76vp1ZLvkxJYCd6HeAptBfjE5T6YqfWtBYcKmGJLQ1q\",\n \"used_times\": 0\n },\n {\n \"account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"address\": \"mqHzaj6FHs9AePR7W5fFLTik7YDUaFUZRx\",\n \"pubkey\": \"tpubDA9GDAntyJu4iQrq8iPMTQ1YBzjcnMQuLUArHUPJ3snffAYaiYX1K691wxwnuLk1nLQq4wafiw7JDYEAWxNRr9BHwkqiyWq4ZDg3pgc1R7J\",\n \"used_times\": 0\n },\n {\n \"account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"address\": \"mr5hNzrQodvcRT7S7Jo7TdrGF8o5QYPSsx\",\n \"pubkey\": \"tpubDA9GDAntyJu4vriftRQep2iT7d7ZJfsNNhMgXCsNZsa7J6Czt1WEyNE2WQkuqsWswafmx6yYmqQQei3HHUedeqiBhiMdHxWUzVZvohGLXgs\",\n \"used_times\": 0\n },\n {\n \"account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"address\": \"mr9FzGLW7kH4t2vVJsqc98R9DNMnZT1PDZ\",\n \"pubkey\": \"tpubDA9GDAntyJu4LoaQBgqDM1xUkcUtRsS117uA9CDSmFrTR4GGi5X65VoUf7VDRE2oRKnrXDv2bNdfyMBJ23UQpcWhBHZhKM7GsbswhmhEw4T\",\n \"used_times\": 0\n },\n {\n \"account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"address\": \"mrGjJdkoEE5okDJDVJjNPYRm8xJks7TYc1\",\n \"pubkey\": \"tpubDA9GDAntyJu4fT9pBRSPRketsXUkxLhvswEZEG4Fx1e99GDUmpJnRyZoiyN3PaE1ToWazfcx74VQoNqzfhMxDARiGQVPu6JZVcuRRxGAw7d\",\n \"used_times\": 0\n },\n {\n \"account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"address\": \"msiyy9GyYHPW5Rt5EHmj7emfnmF1JHU3m7\",\n \"pubkey\": \"tpubDA9GDAntyJu4U9ERXE8UNUSPgvsM81GgwiYnnqHStaQuvn3M63mMR93B2H4c5554bcw5trZTwqxEiUaAGiKEk3s9Ht9sjmJF81Dy6LWrVzp\",\n \"used_times\": 0\n },\n {\n \"account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"address\": \"mtqf7EPwSBjtW1vjbU83FamYuyKtTS7KDK\",\n \"pubkey\": \"tpubDA9GDAntyJu4Hc41BXDR6TUUkFvMQwfiLcvu2XXNq3XArnJkcADYBJ4fQyEwfm6REuHBWQXGHttLdcMVfjHUaaY5pw33YbSHNq9cZLobRuP\",\n \"used_times\": 0\n },\n {\n \"account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"address\": \"muSxerMewUnvxG6mNTfn2kAuM6WsE2AApZ\",\n \"pubkey\": \"tpubDA9GDAntyJu4FHDttUSFJ4mXkGtEG2fMoe9UDQPgiFzYYuE56AcfekQaxcisyutCmzKRpFrkXfFMHZQjFpc9SHf58apmPdYfK9337qz8S1r\",\n \"used_times\": 0\n },\n {\n \"account\": \"mqEbuKqeB8k7Bar1Rg9wVXWYvhHq1cAprY\",\n \"address\": \"mv6icTd6xgDG4SeVciNJVcWStjkY3QCGif\",\n \"pubkey\": \"tpubDA9GDAntyJu4JJUHEUnbasSVEfZt9tY7K7GRSYp22jG8omR4zobsvu68ENx4JwRGmT9EhGpxfposbSnxJeeijNkaViBif4VWAH6dLNktftZ\",\n \"used_times\": 0\n }\n ],\n \"page\": 1,\n \"page_size\": 20,\n \"total_items\": 26,\n \"total_pages\": 2\n }\n}"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "address_unused",
|
|
"description": "Return an address containing no balance, will create\na new address if there is none.",
|
|
"arguments": [
|
|
{
|
|
"name": "account_id",
|
|
"type": "str",
|
|
"description": "id of the account to use",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict operation to specific wallet",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": " \"an address in base58\"",
|
|
"examples": [
|
|
{
|
|
"title": "Get an unused address",
|
|
"curl": "curl -d'{\"method\": \"address_unused\", \"params\": {}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet address unused",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"address_unused\", \"params\": {}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": \"mvW5fF65d8WiGavNWjJcuQ6uRoa4AsSmLZ\"\n}"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"blob": {
|
|
"doc": "Blob management.",
|
|
"commands": [
|
|
{
|
|
"name": "blob_announce",
|
|
"description": "Announce blobs to the DHT",
|
|
"arguments": [
|
|
{
|
|
"name": "blob_hash",
|
|
"type": "str",
|
|
"description": "announce a blob, specified by blob_hash",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "stream_hash",
|
|
"type": "str",
|
|
"description": "announce all blobs associated with stream_hash",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "sd_hash",
|
|
"type": "str",
|
|
"description": "announce all blobs associated with sd_hash and the sd_hash itself",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": "(bool) true if successful",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "blob_delete",
|
|
"description": "Delete a blob",
|
|
"arguments": [
|
|
{
|
|
"name": "blob_hash",
|
|
"type": "str",
|
|
"description": "blob hash of the blob to delete",
|
|
"is_required": true
|
|
}
|
|
],
|
|
"returns": "(str) Success/fail message",
|
|
"examples": [
|
|
{
|
|
"title": "Delete a blob",
|
|
"curl": "curl -d'{\"method\": \"blob_delete\", \"params\": {\"blob_hash\": \"d40576a4f0f745a868fafad794b3c5e1299cac415a911e55f6eef4395f524b63a649df4c8a75602ea1731a3c5d138b8d\"}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet blob delete d40576a4f0f745a868fafad794b3c5e1299cac415a911e55f6eef4395f524b63a649df4c8a75602ea1731a3c5d138b8d",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"blob_delete\", \"params\": {\"blob_hash\": \"d40576a4f0f745a868fafad794b3c5e1299cac415a911e55f6eef4395f524b63a649df4c8a75602ea1731a3c5d138b8d\"}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": \"Deleted d40576a4f0f745a868fafad794b3c5e1299cac415a911e55f6eef4395f524b63a649df4c8a75602ea1731a3c5d138b8d\"\n}"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "blob_get",
|
|
"description": "Download and return a blob",
|
|
"arguments": [
|
|
{
|
|
"name": "blob_hash",
|
|
"type": "str",
|
|
"description": "blob hash of the blob to get",
|
|
"is_required": true
|
|
},
|
|
{
|
|
"name": "timeout",
|
|
"type": "int",
|
|
"description": "timeout in number of seconds",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": "(str) Success/Fail message or (dict) decoded data",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "blob_list",
|
|
"description": "Returns blob hashes. If not given filters, returns all blobs known by the blob manager",
|
|
"arguments": [
|
|
{
|
|
"name": "needed",
|
|
"type": "bool",
|
|
"description": "only return needed blobs",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "finished",
|
|
"type": "bool",
|
|
"description": "only return finished blobs",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "uri",
|
|
"type": "str",
|
|
"description": "filter blobs by stream in a uri",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "stream_hash",
|
|
"type": "str",
|
|
"description": "filter blobs by stream hash",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "sd_hash",
|
|
"type": "str",
|
|
"description": "filter blobs by sd hash",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "page",
|
|
"type": "int",
|
|
"description": "page to return during paginating",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "page_size",
|
|
"type": "int",
|
|
"description": "number of items on page during pagination",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": "(list) List of blob hashes",
|
|
"examples": [
|
|
{
|
|
"title": "List your local blobs",
|
|
"curl": "curl -d'{\"method\": \"blob_list\", \"params\": {\"needed\": false, \"finished\": false}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet blob list",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"blob_list\", \"params\": {\"needed\": false, \"finished\": false}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"items\": [\n \"d40576a4f0f745a868fafad794b3c5e1299cac415a911e55f6eef4395f524b63a649df4c8a75602ea1731a3c5d138b8d\",\n \"64389e7847bc5fbf401d21133bac00ed788c65dba6154026924dbcb72fe6aa37f9646cf78d7841685d503d8a747c6624\",\n \"a035353881b061795536e73b3fb84361a601a90cfdd928531a7c4e133800f46173f8bfd97a929844e521851805ece1b2\",\n \"f71fb71a3ddd6bd2ce60c6941c2f9faf5317510bf7ea65d56286fa17066405522ba4fc4880d0982c7cfce84375bf8507\"\n ],\n \"page\": 1,\n \"page_size\": 20,\n \"total_items\": 4,\n \"total_pages\": 1\n }\n}"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "blob_reflect",
|
|
"description": "Reflects specified blobs",
|
|
"arguments": [
|
|
{
|
|
"name": "reflector_server",
|
|
"type": "str",
|
|
"description": "reflector address",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": "(list) reflected blob hashes",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "blob_reflect_all",
|
|
"description": "Reflects all saved blobs",
|
|
"arguments": [],
|
|
"returns": "(bool) true if successful",
|
|
"examples": []
|
|
}
|
|
]
|
|
},
|
|
"channel": {
|
|
"doc": "Create, update, abandon and list your channel claims.",
|
|
"commands": [
|
|
{
|
|
"name": "channel_abandon",
|
|
"description": "Abandon one of my channel claims.",
|
|
"arguments": [
|
|
{
|
|
"name": "claim_id",
|
|
"type": "str",
|
|
"description": "claim_id of the claim to abandon",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "txid",
|
|
"type": "str",
|
|
"description": "txid of the claim to abandon",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "nout",
|
|
"type": "int",
|
|
"description": "nout of the claim to abandon",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "account_id",
|
|
"type": "str",
|
|
"description": "id of the account to use",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict operation to specific wallet",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "preview",
|
|
"type": "bool",
|
|
"description": "do not broadcast the transaction",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "blocking",
|
|
"type": "bool",
|
|
"description": "wait until abandon is in mempool",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }",
|
|
"examples": [
|
|
{
|
|
"title": "Abandon a channel claim",
|
|
"curl": "curl -d'{\"method\": \"channel_abandon\", \"params\": {\"claim_id\": \"5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\", \"preview\": false, \"blocking\": false}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet channel abandon 5dc92b3ab696844e2e043f542b50a2dd0a95d6f2",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"channel_abandon\", \"params\": {\"claim_id\": \"5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\", \"preview\": false, \"blocking\": false}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"height\": -2,\n \"hex\": \"010000000112e4e8fb6fb977bea835761def95a4747bd712b2e0fce3301defbfd75af2e83e000000006a47304402202ccafb731d9f42ab097e655526e8956c53def70018fb441489ab5ac7401a6b1702200d8c1ada5636d42a0c57bccfe16e292b078aa199fe4cc9df8c14c6cc9aa4758801210368cfa299e5d7db0b87e2ea90267a40e7de62ff496eebd05fbda7265a4de27b33ffffffff0134b7f505000000001976a914c017140cff818203be7ed9eb831d516beeae380e88ac00000000\",\n \"inputs\": [\n {\n \"address\": \"mofqoKUmhmPTCoudQRXgjzGSDnCyJvZAZg\",\n \"amount\": \"1.0\",\n \"claim_id\": \"5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"claim_op\": \"update\",\n \"confirmations\": 8,\n \"has_signing_key\": true,\n \"height\": 210,\n \"meta\": {},\n \"name\": \"@channel\",\n \"normalized_name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"lbry://@channel#5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"timestamp\": 1602862456,\n \"txid\": \"3ee8f25ad7bfef1d30e3fce0b212d77b74a495ef1d7635a8be77b96ffbe8e412\",\n \"type\": \"claim\",\n \"value\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a034200049b4cbe0f5275e7b1c170f458af09628ba75401fd95d0205ed9de9037b396f60936d555da2bc8dd09b1804b250f32d1bd07382bd3a4aaa2700b08b137b91f1159\",\n \"public_key_id\": \"mkVrRXQGgjhBaygCP3dNpbmtm5Yohno8q2\",\n \"title\": \"New Channel\"\n },\n \"value_type\": \"channel\"\n }\n ],\n \"outputs\": [\n {\n \"address\": \"my2dgPteE6c6TiFWk8hcfijZut58dE5FM3\",\n \"amount\": \"0.999893\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 0,\n \"timestamp\": null,\n \"txid\": \"fe572f8d040b941d2a2b8c863111e6213ed47075d35add195d9718e8ef119fe0\",\n \"type\": \"payment\"\n }\n ],\n \"total_fee\": \"0.000107\",\n \"total_input\": \"1.0\",\n \"total_output\": \"0.999893\",\n \"txid\": \"fe572f8d040b941d2a2b8c863111e6213ed47075d35add195d9718e8ef119fe0\"\n }\n}"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "channel_create",
|
|
"description": "Create a new channel by generating a channel private key and establishing an '@' prefixed claim.",
|
|
"arguments": [
|
|
{
|
|
"name": "name",
|
|
"type": "str",
|
|
"description": "name of the channel prefixed with '@'",
|
|
"is_required": true
|
|
},
|
|
{
|
|
"name": "bid",
|
|
"type": "decimal",
|
|
"description": "amount to back the claim",
|
|
"is_required": true
|
|
},
|
|
{
|
|
"name": "allow_duplicate_name",
|
|
"type": "bool",
|
|
"description": "create new channel even if one already exists with given name. default: false.",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "title",
|
|
"type": "str",
|
|
"description": "title of the publication",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "description",
|
|
"type": "str",
|
|
"description": "description of the publication",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "email",
|
|
"type": "str",
|
|
"description": "email of channel owner",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "website_url",
|
|
"type": "str",
|
|
"description": "website url",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "featured",
|
|
"type": "list",
|
|
"description": "claim_ids of featured content in channel",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "tags",
|
|
"type": "list",
|
|
"description": "content tags",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "languages",
|
|
"type": "list",
|
|
"description": "languages used by the channel, using RFC 5646 format, eg: for English `--languages=en` for Spanish (Spain) `--languages=es-ES` for Spanish (Mexican) `--languages=es-MX` for Chinese (Simplified) `--languages=zh-Hans` for Chinese (Traditional) `--languages=zh-Hant`",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "locations",
|
|
"type": "list",
|
|
"description": "locations of the channel, consisting of 2 letter `country` code and a `state`, `city` and a postal `code` along with a `latitude` and `longitude`. for JSON RPC: pass a dictionary with aforementioned attributes as keys, eg: ... \"locations\": [{'country': 'US', 'state': 'NH'}] ... for command line: pass a colon delimited list with values in the following order: \"COUNTRY:STATE:CITY:CODE:LATITUDE:LONGITUDE\" making sure to include colon for blank values, for example to provide only the city: ... --locations=\"::Manchester\" with all values set: ... --locations=\"US:NH:Manchester:03101:42.990605:-71.460989\" optionally, you can just pass the \"LATITUDE:LONGITUDE\": ... --locations=\"42.990605:-71.460989\" finally, you can also pass JSON string of dictionary on the command line as you would via JSON RPC ... --locations=\"{'country': 'US', 'state': 'NH'}\"",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "thumbnail_url",
|
|
"type": "str",
|
|
"description": "thumbnail url",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "cover_url",
|
|
"type": "str",
|
|
"description": "url of cover image",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "account_id",
|
|
"type": "str",
|
|
"description": "account to use for holding the transaction",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict operation to specific wallet",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "funding_account_ids",
|
|
"type": "list",
|
|
"description": "ids of accounts to fund this transaction",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "claim_address",
|
|
"type": "str",
|
|
"description": "address where the channel is sent to, if not specified it will be determined automatically from the account",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "preview",
|
|
"type": "bool",
|
|
"description": "do not broadcast the transaction",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "blocking",
|
|
"type": "bool",
|
|
"description": "wait until transaction is in mempool",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }",
|
|
"examples": [
|
|
{
|
|
"title": "Create a channel claim without metadata",
|
|
"curl": "curl -d'{\"method\": \"channel_create\", \"params\": {\"name\": \"@channel\", \"bid\": \"1.0\", \"featured\": [], \"tags\": [], \"languages\": [], \"locations\": [], \"funding_account_ids\": [], \"preview\": false, \"blocking\": false}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet channel create @channel 1.0",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"channel_create\", \"params\": {\"name\": \"@channel\", \"bid\": \"1.0\", \"featured\": [], \"tags\": [], \"languages\": [], \"locations\": [], \"funding_account_ids\": [], \"preview\": false, \"blocking\": false}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"height\": -2,\n \"hex\": \"010000000158533d2d042f919166ee2e1579846af0b49c4caf9db4cd82a7ca37362f374769010000006b483045022100b6ce1836a430d4394ddbf3dffa642a800b275729604725dbc1b7c6c81c56e53c02205a4fbfcc83265681ac90fc1e18676124371f746eb4d7b383a81e063cbcdee161012103d82be71a914cffdc96e54df3ee5e7b7e224078010ecc85fd19efd25a50f23a9fffffffff0200e1f5050000000084b508406368616e6e656c4c5d00125a0a583056301006072a8648ce3d020106052b8104000a034200049b4cbe0f5275e7b1c170f458af09628ba75401fd95d0205ed9de9037b396f60936d555da2bc8dd09b1804b250f32d1bd07382bd3a4aaa2700b08b137b91f11596d7576a914596f53ebf6552729fea4e2dbdc62e9662b8757c788acc462a029000000001976a91471452ebd78a856d51b47902e7224373cbfa308f488ac00000000\",\n \"inputs\": [\n {\n \"address\": \"mxbsGa4jf99tDFJtiFtxyVJ7N3xPUsD9qo\",\n \"amount\": \"7.999876\",\n \"confirmations\": 2,\n \"height\": 207,\n \"nout\": 1,\n \"timestamp\": 1602862456,\n \"txid\": \"6947372f3637caa782cdb49daf4c9cb4f06a8479152eee6691912f042d3d5358\",\n \"type\": \"payment\"\n }\n ],\n \"outputs\": [\n {\n \"address\": \"mofqoKUmhmPTCoudQRXgjzGSDnCyJvZAZg\",\n \"amount\": \"1.0\",\n \"claim_id\": \"5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"claim_op\": \"create\",\n \"confirmations\": -2,\n \"has_signing_key\": true,\n \"height\": -2,\n \"meta\": {},\n \"name\": \"@channel\",\n \"normalized_name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"lbry://@channel#5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"timestamp\": null,\n \"txid\": \"60a1a3111e5dd85cbc1040d931cbb09c86c078eeb11df6aebf5c5d8845e64629\",\n \"type\": \"claim\",\n \"value\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a034200049b4cbe0f5275e7b1c170f458af09628ba75401fd95d0205ed9de9037b396f60936d555da2bc8dd09b1804b250f32d1bd07382bd3a4aaa2700b08b137b91f1159\",\n \"public_key_id\": \"mkVrRXQGgjhBaygCP3dNpbmtm5Yohno8q2\"\n },\n \"value_type\": \"channel\"\n },\n {\n \"address\": \"mqqsXcxFmcQBN6JFR1hRE4UtDYtDXp1u4f\",\n \"amount\": \"6.983769\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 1,\n \"timestamp\": null,\n \"txid\": \"60a1a3111e5dd85cbc1040d931cbb09c86c078eeb11df6aebf5c5d8845e64629\",\n \"type\": \"payment\"\n }\n ],\n \"total_fee\": \"0.016107\",\n \"total_input\": \"7.999876\",\n \"total_output\": \"7.983769\",\n \"txid\": \"60a1a3111e5dd85cbc1040d931cbb09c86c078eeb11df6aebf5c5d8845e64629\"\n }\n}"
|
|
},
|
|
{
|
|
"title": "Create a channel claim with all metadata",
|
|
"curl": "curl -d'{\"method\": \"channel_create\", \"params\": {\"name\": \"@bigchannel\", \"bid\": \"1.0\", \"title\": \"Big Channel\", \"description\": \"A channel with lots of videos.\", \"email\": \"creator@smallmedia.com\", \"website_url\": \"http://smallmedia.com\", \"featured\": [], \"tags\": [\"music\", \"art\"], \"languages\": [\"pt-BR\", \"uk\"], \"locations\": [\"BR\", \"UA::Kiyv\"], \"thumbnail_url\": \"http://smallmedia.com/logo.jpg\", \"cover_url\": \"http://smallmedia.com/logo.jpg\", \"funding_account_ids\": [], \"preview\": false, \"blocking\": false}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet channel create @bigchannel 1.0 --title=\"Big Channel\" --description=\"A channel with lots of videos.\" --email=\"creator@smallmedia.com\" --tags=music --tags=art --languages=pt-BR --languages=uk --locations=BR --locations=UA::Kiyv --website_url=\"http://smallmedia.com\" --thumbnail_url=\"http://smallmedia.com/logo.jpg\" --cover_url=\"http://smallmedia.com/logo.jpg\"",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"channel_create\", \"params\": {\"name\": \"@bigchannel\", \"bid\": \"1.0\", \"title\": \"Big Channel\", \"description\": \"A channel with lots of videos.\", \"email\": \"creator@smallmedia.com\", \"website_url\": \"http://smallmedia.com\", \"featured\": [], \"tags\": [\"music\", \"art\"], \"languages\": [\"pt-BR\", \"uk\"], \"locations\": [\"BR\", \"UA::Kiyv\"], \"thumbnail_url\": \"http://smallmedia.com/logo.jpg\", \"cover_url\": \"http://smallmedia.com/logo.jpg\", \"funding_account_ids\": [], \"preview\": false, \"blocking\": false}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"height\": -2,\n \"hex\": \"010000000112e4e8fb6fb977bea835761def95a4747bd712b2e0fce3301defbfd75af2e83e010000006b483045022100f400356b4588a1106ca630f418e6737d39da0f522e09cbce2190ebac9d1713ac0220423d8cde9e4ede9985c47606c04bb941dea7bf2e6644f5f79b6eb169e50e8194012102dce4926e5905334758fab58a5ac2e143f6410c9bea71d9a4fd51560a8603ce0cffffffff0200e1f50500000000fd5001b50b406269676368616e6e656c4d25010012ab010a583056301006072a8648ce3d020106052b8104000a034200049909f498c2b3c3c649d91778426bfcf8dd895943e15567956a490a95b66876d7535efb3dd402c5d359c68bbebdc45118be228dfa1a553f556ce3bff01b6eb7fd121663726561746f7240736d616c6c6d656469612e636f6d1a15687474703a2f2f736d616c6c6d656469612e636f6d22202a1e687474703a2f2f736d616c6c6d656469612e636f6d2f6c6f676f2e6a7067420b426967204368616e6e656c4a1e41206368616e6e656c2077697468206c6f7473206f6620766964656f732e52202a1e687474703a2f2f736d616c6c6d656469612e636f6d2f6c6f676f2e6a70675a056d757369635a0361727462050883011820620308ab016a0208206a0908e9011a044b6979766d7576a914a45f9e7b68cd294a21fa75ee23c7fdfeb35f237b88ace221d305000000001976a9149ac52fa70e513b792b36846c00a6b23b4e72ee9988ac00000000\",\n \"inputs\": [\n {\n \"address\": \"moH3m15AhmpjZVZUwYEQciKNAnBqug5VwM\",\n \"amount\": \"1.9993355\",\n \"confirmations\": 1,\n \"height\": 210,\n \"nout\": 1,\n \"timestamp\": 1602862456,\n \"txid\": \"3ee8f25ad7bfef1d30e3fce0b212d77b74a495ef1d7635a8be77b96ffbe8e412\",\n \"type\": \"payment\"\n }\n ],\n \"outputs\": [\n {\n \"address\": \"mvW5fF65d8WiGavNWjJcuQ6uRoa4AsSmLZ\",\n \"amount\": \"1.0\",\n \"claim_id\": \"9289606d85caabe4c8adcc142eda730022d1b3bd\",\n \"claim_op\": \"create\",\n \"confirmations\": -2,\n \"has_signing_key\": true,\n \"height\": -2,\n \"meta\": {},\n \"name\": \"@bigchannel\",\n \"normalized_name\": \"@bigchannel\",\n \"nout\": 0,\n \"permanent_url\": \"lbry://@bigchannel#9289606d85caabe4c8adcc142eda730022d1b3bd\",\n \"timestamp\": null,\n \"txid\": \"cc77ce3035437425d1cd14b48ded892f1283f13d63e9756d1f589bf35d214347\",\n \"type\": \"claim\",\n \"value\": {\n \"cover\": {\n \"url\": \"http://smallmedia.com/logo.jpg\"\n },\n \"description\": \"A channel with lots of videos.\",\n \"email\": \"creator@smallmedia.com\",\n \"languages\": [\n \"pt-BR\",\n \"uk\"\n ],\n \"locations\": [\n {\n \"country\": \"BR\"\n },\n {\n \"city\": \"Kiyv\",\n \"country\": \"UA\"\n }\n ],\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a034200049909f498c2b3c3c649d91778426bfcf8dd895943e15567956a490a95b66876d7535efb3dd402c5d359c68bbebdc45118be228dfa1a553f556ce3bff01b6eb7fd\",\n \"public_key_id\": \"n3N9RDkMdpvemT83QfEWuJ1es1uNyVHydK\",\n \"tags\": [\n \"music\",\n \"art\"\n ],\n \"thumbnail\": {\n \"url\": \"http://smallmedia.com/logo.jpg\"\n },\n \"title\": \"Big Channel\",\n \"website_url\": \"http://smallmedia.com\"\n },\n \"value_type\": \"channel\"\n },\n {\n \"address\": \"mudJaL41pUBkS3VRifB26xD4YLNWDNVrau\",\n \"amount\": \"0.9772285\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 1,\n \"timestamp\": null,\n \"txid\": \"cc77ce3035437425d1cd14b48ded892f1283f13d63e9756d1f589bf35d214347\",\n \"type\": \"payment\"\n }\n ],\n \"total_fee\": \"0.022107\",\n \"total_input\": \"1.9993355\",\n \"total_output\": \"1.9772285\",\n \"txid\": \"cc77ce3035437425d1cd14b48ded892f1283f13d63e9756d1f589bf35d214347\"\n }\n}"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "channel_export",
|
|
"description": "Export channel private key.",
|
|
"arguments": [
|
|
{
|
|
"name": "channel_id",
|
|
"type": "str",
|
|
"description": "claim id of channel to export",
|
|
"is_required": true
|
|
},
|
|
{
|
|
"name": "channel_name",
|
|
"type": "str",
|
|
"description": "name of channel to export",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "account_id",
|
|
"type": "str",
|
|
"description": "one or more account ids for accounts to look in for channels, defaults to all accounts.",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict operation to specific wallet",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": "(str) serialized channel private key",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "channel_import",
|
|
"description": "Import serialized channel private key (to allow signing new streams to the channel)",
|
|
"arguments": [
|
|
{
|
|
"name": "channel_data",
|
|
"type": "str",
|
|
"description": "serialized channel, as exported by channel export",
|
|
"is_required": true
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "import into specific wallet",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": "(dict) Result dictionary",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "channel_list",
|
|
"description": "List my channel claims.",
|
|
"arguments": [
|
|
{
|
|
"name": "name",
|
|
"type": "str or list",
|
|
"description": "channel name",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "claim_id",
|
|
"type": "str or list",
|
|
"description": "channel id",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "is_spent",
|
|
"type": "bool",
|
|
"description": "shows previous channel updates and abandons",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "account_id",
|
|
"type": "str",
|
|
"description": "id of the account to use",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict results to specific wallet",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "page",
|
|
"type": "int",
|
|
"description": "page to return during paginating",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "page_size",
|
|
"type": "int",
|
|
"description": "number of items on page during pagination",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "resolve",
|
|
"type": "bool",
|
|
"description": "resolves each channel to provide additional metadata",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "no_totals",
|
|
"type": "bool",
|
|
"description": "do not calculate the total number of pages and items in result set (significant performance boost)",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": " {\n \"page\": \"Page number of the current items.\",\n \"page_size\": \"Number of items to show on a page.\",\n \"total_pages\": \"Total number of pages.\",\n \"total_items\": \"Total number of items.\",\n \"items\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ]\n }",
|
|
"examples": [
|
|
{
|
|
"title": "List your channel claims",
|
|
"curl": "curl -d'{\"method\": \"channel_list\", \"params\": {\"name\": [], \"claim_id\": [], \"is_spent\": false, \"resolve\": false, \"no_totals\": false}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet channel list",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"channel_list\", \"params\": {\"name\": [], \"claim_id\": [], \"is_spent\": false, \"resolve\": false, \"no_totals\": false}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"items\": [\n {\n \"address\": \"mofqoKUmhmPTCoudQRXgjzGSDnCyJvZAZg\",\n \"amount\": \"1.0\",\n \"claim_id\": \"5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"claim_op\": \"create\",\n \"confirmations\": 1,\n \"has_signing_key\": true,\n \"height\": 209,\n \"is_internal_transfer\": false,\n \"is_my_input\": true,\n \"is_my_output\": true,\n \"is_spent\": false,\n \"meta\": {},\n \"name\": \"@channel\",\n \"normalized_name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"lbry://@channel#5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"timestamp\": 1602862456,\n \"txid\": \"60a1a3111e5dd85cbc1040d931cbb09c86c078eeb11df6aebf5c5d8845e64629\",\n \"type\": \"claim\",\n \"value\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a034200049b4cbe0f5275e7b1c170f458af09628ba75401fd95d0205ed9de9037b396f60936d555da2bc8dd09b1804b250f32d1bd07382bd3a4aaa2700b08b137b91f1159\",\n \"public_key_id\": \"mkVrRXQGgjhBaygCP3dNpbmtm5Yohno8q2\"\n },\n \"value_type\": \"channel\"\n }\n ],\n \"page\": 1,\n \"page_size\": 20,\n \"total_items\": 1,\n \"total_pages\": 1\n }\n}"
|
|
},
|
|
{
|
|
"title": "Paginate your channel claims",
|
|
"curl": "curl -d'{\"method\": \"channel_list\", \"params\": {\"name\": [], \"claim_id\": [], \"is_spent\": false, \"page\": 1, \"page_size\": 20, \"resolve\": false, \"no_totals\": false}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet channel list --page=1 --page_size=20",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"channel_list\", \"params\": {\"name\": [], \"claim_id\": [], \"is_spent\": false, \"page\": 1, \"page_size\": 20, \"resolve\": false, \"no_totals\": false}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"items\": [\n {\n \"address\": \"mofqoKUmhmPTCoudQRXgjzGSDnCyJvZAZg\",\n \"amount\": \"1.0\",\n \"claim_id\": \"5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"claim_op\": \"create\",\n \"confirmations\": 1,\n \"has_signing_key\": true,\n \"height\": 209,\n \"is_internal_transfer\": false,\n \"is_my_input\": true,\n \"is_my_output\": true,\n \"is_spent\": false,\n \"meta\": {},\n \"name\": \"@channel\",\n \"normalized_name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"lbry://@channel#5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"timestamp\": 1602862456,\n \"txid\": \"60a1a3111e5dd85cbc1040d931cbb09c86c078eeb11df6aebf5c5d8845e64629\",\n \"type\": \"claim\",\n \"value\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a034200049b4cbe0f5275e7b1c170f458af09628ba75401fd95d0205ed9de9037b396f60936d555da2bc8dd09b1804b250f32d1bd07382bd3a4aaa2700b08b137b91f1159\",\n \"public_key_id\": \"mkVrRXQGgjhBaygCP3dNpbmtm5Yohno8q2\"\n },\n \"value_type\": \"channel\"\n }\n ],\n \"page\": 1,\n \"page_size\": 20,\n \"total_items\": 1,\n \"total_pages\": 1\n }\n}"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "channel_update",
|
|
"description": "Update an existing channel claim.",
|
|
"arguments": [
|
|
{
|
|
"name": "claim_id",
|
|
"type": "str",
|
|
"description": "claim_id of the channel to update",
|
|
"is_required": true
|
|
},
|
|
{
|
|
"name": "bid",
|
|
"type": "decimal",
|
|
"description": "amount to back the claim",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "title",
|
|
"type": "str",
|
|
"description": "title of the publication",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "description",
|
|
"type": "str",
|
|
"description": "description of the publication",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "email",
|
|
"type": "str",
|
|
"description": "email of channel owner",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "website_url",
|
|
"type": "str",
|
|
"description": "website url",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "featured",
|
|
"type": "list",
|
|
"description": "claim_ids of featured content in channel",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "clear_featured",
|
|
"type": "bool",
|
|
"description": "clear existing featured content (prior to adding new ones)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "tags",
|
|
"type": "list",
|
|
"description": "add content tags",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "clear_tags",
|
|
"type": "bool",
|
|
"description": "clear existing tags (prior to adding new ones)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "languages",
|
|
"type": "list",
|
|
"description": "languages used by the channel, using RFC 5646 format, eg: for English `--languages=en` for Spanish (Spain) `--languages=es-ES` for Spanish (Mexican) `--languages=es-MX` for Chinese (Simplified) `--languages=zh-Hans` for Chinese (Traditional) `--languages=zh-Hant`",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "clear_languages",
|
|
"type": "bool",
|
|
"description": "clear existing languages (prior to adding new ones)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "locations",
|
|
"type": "list",
|
|
"description": "locations of the channel, consisting of 2 letter `country` code and a `state`, `city` and a postal `code` along with a `latitude` and `longitude`. for JSON RPC: pass a dictionary with aforementioned attributes as keys, eg: ... \"locations\": [{'country': 'US', 'state': 'NH'}] ... for command line: pass a colon delimited list with values in the following order: \"COUNTRY:STATE:CITY:CODE:LATITUDE:LONGITUDE\" making sure to include colon for blank values, for example to provide only the city: ... --locations=\"::Manchester\" with all values set: ... --locations=\"US:NH:Manchester:03101:42.990605:-71.460989\" optionally, you can just pass the \"LATITUDE:LONGITUDE\": ... --locations=\"42.990605:-71.460989\" finally, you can also pass JSON string of dictionary on the command line as you would via JSON RPC ... --locations=\"{'country': 'US', 'state': 'NH'}\"",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "clear_locations",
|
|
"type": "bool",
|
|
"description": "clear existing locations (prior to adding new ones)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "thumbnail_url",
|
|
"type": "str",
|
|
"description": "thumbnail url",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "cover_url",
|
|
"type": "str",
|
|
"description": "url of cover image",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "account_id",
|
|
"type": "str",
|
|
"description": "account in which to look for channel (default: all)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict operation to specific wallet",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "funding_account_ids",
|
|
"type": "list",
|
|
"description": "ids of accounts to fund this transaction",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "claim_address",
|
|
"type": "str",
|
|
"description": "address where the channel is sent",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "new_signing_key",
|
|
"type": "bool",
|
|
"description": "generate a new signing key, will invalidate all previous publishes",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "preview",
|
|
"type": "bool",
|
|
"description": "do not broadcast the transaction",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "blocking",
|
|
"type": "bool",
|
|
"description": "wait until transaction is in mempool",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "replace",
|
|
"type": "bool",
|
|
"description": "instead of modifying specific values on the channel, this will clear all existing values and only save passed in values, useful for form submissions where all values are always set",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }",
|
|
"examples": [
|
|
{
|
|
"title": "Update a channel claim",
|
|
"curl": "curl -d'{\"method\": \"channel_update\", \"params\": {\"claim_id\": \"5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\", \"title\": \"New Channel\", \"featured\": [], \"clear_featured\": false, \"tags\": [], \"clear_tags\": false, \"languages\": [], \"clear_languages\": false, \"locations\": [], \"clear_locations\": false, \"new_signing_key\": false, \"funding_account_ids\": [], \"preview\": false, \"blocking\": false, \"replace\": false}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet channel update 5dc92b3ab696844e2e043f542b50a2dd0a95d6f2 --title=\"New Channel\"",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"channel_update\", \"params\": {\"claim_id\": \"5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\", \"title\": \"New Channel\", \"featured\": [], \"clear_featured\": false, \"tags\": [], \"clear_tags\": false, \"languages\": [], \"clear_languages\": false, \"locations\": [], \"clear_locations\": false, \"new_signing_key\": false, \"funding_account_ids\": [], \"preview\": false, \"blocking\": false, \"replace\": false}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"height\": -2,\n \"hex\": \"01000000022946e645885d5cbfaef61db1ee78c0869cb0cb31d94010bc5cd85d1e11a3a160000000006a47304402206468e077adeba3c21673ed78920c859588722d3a87fb732dad55f2517a5f6c8402206e310605a42dd6292f9fdd28fd9d98641f8d1f6449c28f16a99c8d917341033b01210368cfa299e5d7db0b87e2ea90267a40e7de62ff496eebd05fbda7265a4de27b33ffffffff16499bbabc8965d2f65610b5be2856939351adf0463c345ef047dc4a1e4b414b000000006a47304402207ec9d5cca07d5f1718c2186318362332b26023bd11b0c25a847bdb45941be5b70220571fa748c26741777916e639d6e1d43b00141f24f150315abbc086640ebb261d012103386e2ac35f59e8ad77be0888e75f2fd52963138f53f1accb21ceef9f45abc74effffffff0200e1f50500000000a6b708406368616e6e656c14f2d6950adda2502b543f042e4e8496b63a2bc95d4c6a00125a0a583056301006072a8648ce3d020106052b8104000a034200049b4cbe0f5275e7b1c170f458af09628ba75401fd95d0205ed9de9037b396f60936d555da2bc8dd09b1804b250f32d1bd07382bd3a4aaa2700b08b137b91f1159420b4e6577204368616e6e656c6d6d76a914596f53ebf6552729fea4e2dbdc62e9662b8757c788ac6ebeea0b000000001976a914551fbe93b46bf72e02981bc529201b0ab6016ddf88ac00000000\",\n \"inputs\": [\n {\n \"address\": \"mofqoKUmhmPTCoudQRXgjzGSDnCyJvZAZg\",\n \"amount\": \"1.0\",\n \"claim_id\": \"5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"claim_op\": \"create\",\n \"confirmations\": 1,\n \"has_signing_key\": true,\n \"height\": 209,\n \"meta\": {},\n \"name\": \"@channel\",\n \"normalized_name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"lbry://@channel#5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"timestamp\": 1602862456,\n \"txid\": \"60a1a3111e5dd85cbc1040d931cbb09c86c078eeb11df6aebf5c5d8845e64629\",\n \"type\": \"claim\",\n \"value\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a034200049b4cbe0f5275e7b1c170f458af09628ba75401fd95d0205ed9de9037b396f60936d555da2bc8dd09b1804b250f32d1bd07382bd3a4aaa2700b08b137b91f1159\",\n \"public_key_id\": \"mkVrRXQGgjhBaygCP3dNpbmtm5Yohno8q2\"\n },\n \"value_type\": \"channel\"\n },\n {\n \"address\": \"mkwDGRHqKvQXW9zwfumqrJUhiBDWbzPr1M\",\n \"amount\": \"1.999604\",\n \"confirmations\": 1,\n \"height\": 209,\n \"nout\": 0,\n \"timestamp\": 1602862456,\n \"txid\": \"4b414b1e4adc47f05e343c46f0ad5193935628beb51056f6d26589bcba9b4916\",\n \"type\": \"payment\"\n }\n ],\n \"outputs\": [\n {\n \"address\": \"mofqoKUmhmPTCoudQRXgjzGSDnCyJvZAZg\",\n \"amount\": \"1.0\",\n \"claim_id\": \"5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"claim_op\": \"update\",\n \"confirmations\": -2,\n \"has_signing_key\": true,\n \"height\": -2,\n \"meta\": {},\n \"name\": \"@channel\",\n \"normalized_name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"lbry://@channel#5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"timestamp\": null,\n \"txid\": \"3ee8f25ad7bfef1d30e3fce0b212d77b74a495ef1d7635a8be77b96ffbe8e412\",\n \"type\": \"claim\",\n \"value\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a034200049b4cbe0f5275e7b1c170f458af09628ba75401fd95d0205ed9de9037b396f60936d555da2bc8dd09b1804b250f32d1bd07382bd3a4aaa2700b08b137b91f1159\",\n \"public_key_id\": \"mkVrRXQGgjhBaygCP3dNpbmtm5Yohno8q2\",\n \"title\": \"New Channel\"\n },\n \"value_type\": \"channel\"\n },\n {\n \"address\": \"moH3m15AhmpjZVZUwYEQciKNAnBqug5VwM\",\n \"amount\": \"1.9993355\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 1,\n \"timestamp\": null,\n \"txid\": \"3ee8f25ad7bfef1d30e3fce0b212d77b74a495ef1d7635a8be77b96ffbe8e412\",\n \"type\": \"payment\"\n }\n ],\n \"total_fee\": \"0.0002685\",\n \"total_input\": \"2.999604\",\n \"total_output\": \"2.9993355\",\n \"txid\": \"3ee8f25ad7bfef1d30e3fce0b212d77b74a495ef1d7635a8be77b96ffbe8e412\"\n }\n}"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"claim": {
|
|
"doc": "List and search all types of claims.",
|
|
"commands": [
|
|
{
|
|
"name": "claim_list",
|
|
"description": "List my stream and channel claims.",
|
|
"arguments": [
|
|
{
|
|
"name": "claim_type",
|
|
"type": "str or list",
|
|
"description": "claim type: channel, stream, repost, collection",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "claim_id",
|
|
"type": "str or list",
|
|
"description": "claim id",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "channel_id",
|
|
"type": "str or list",
|
|
"description": "streams in this channel",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "name",
|
|
"type": "str or list",
|
|
"description": "claim name",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "is_spent",
|
|
"type": "bool",
|
|
"description": "shows previous claim updates and abandons",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "account_id",
|
|
"type": "str",
|
|
"description": "id of the account to query",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict results to specific wallet",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "page",
|
|
"type": "int",
|
|
"description": "page to return during paginating",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "page_size",
|
|
"type": "int",
|
|
"description": "number of items on page during pagination",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "resolve",
|
|
"type": "bool",
|
|
"description": "resolves each claim to provide additional metadata",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "order_by",
|
|
"type": "str",
|
|
"description": "field to order by: 'name', 'height', 'amount'",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "no_totals",
|
|
"type": "bool",
|
|
"description": "do not calculate the total number of pages and items in result set (significant performance boost)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "include_received_tips",
|
|
"type": "bool",
|
|
"description": "calculate the amount of tips recieved for claim outputs",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": " {\n \"page\": \"Page number of the current items.\",\n \"page_size\": \"Number of items to show on a page.\",\n \"total_pages\": \"Total number of pages.\",\n \"total_items\": \"Total number of items.\",\n \"items\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ]\n }",
|
|
"examples": [
|
|
{
|
|
"title": "List all your claims",
|
|
"curl": "curl -d'{\"method\": \"claim_list\", \"params\": {\"claim_type\": [], \"claim_id\": [], \"name\": [], \"is_spent\": false, \"channel_id\": [], \"resolve\": false, \"no_totals\": false, \"include_received_tips\": false}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet claim list",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"claim_list\", \"params\": {\"claim_type\": [], \"claim_id\": [], \"name\": [], \"is_spent\": false, \"channel_id\": [], \"resolve\": false, \"no_totals\": false, \"include_received_tips\": false}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"items\": [\n {\n \"address\": \"mzNC6CMEetGVw6QDGChpUM3HfV7DpWGZ7R\",\n \"amount\": \"1.0\",\n \"claim_id\": \"fe7ee643b50b724f6029f6edfe90d67b5512b3ae\",\n \"claim_op\": \"update\",\n \"confirmations\": 1,\n \"height\": 214,\n \"is_channel_signature_valid\": true,\n \"is_internal_transfer\": false,\n \"is_my_input\": true,\n \"is_my_output\": true,\n \"is_spent\": false,\n \"meta\": {},\n \"name\": \"astream\",\n \"normalized_name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"lbry://astream#fe7ee643b50b724f6029f6edfe90d67b5512b3ae\",\n \"signing_channel\": {\n \"address\": \"mofqoKUmhmPTCoudQRXgjzGSDnCyJvZAZg\",\n \"amount\": \"1.0\",\n \"claim_id\": \"5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"claim_op\": \"update\",\n \"confirmations\": 5,\n \"has_signing_key\": true,\n \"height\": 210,\n \"meta\": {},\n \"name\": \"@channel\",\n \"normalized_name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"lbry://@channel#5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"timestamp\": 1602862456,\n \"txid\": \"3ee8f25ad7bfef1d30e3fce0b212d77b74a495ef1d7635a8be77b96ffbe8e412\",\n \"type\": \"claim\",\n \"value\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a034200049b4cbe0f5275e7b1c170f458af09628ba75401fd95d0205ed9de9037b396f60936d555da2bc8dd09b1804b250f32d1bd07382bd3a4aaa2700b08b137b91f1159\",\n \"public_key_id\": \"mkVrRXQGgjhBaygCP3dNpbmtm5Yohno8q2\",\n \"title\": \"New Channel\"\n },\n \"value_type\": \"channel\"\n },\n \"timestamp\": 1602862457,\n \"txid\": \"c620b71698533d88efa10c80d79a30b74464214cb0d893ec5ab4ec1c37d1676e\",\n \"type\": \"claim\",\n \"value\": {\n \"source\": {\n \"hash\": \"fdbd8e75a67f29f701a4e040385e2e23986303ea10239211af907fcbb83578b3e417cb71ce646efd0819dd8c088de1bd\",\n \"media_type\": \"application/octet-stream\",\n \"name\": \"tmpk0n0x2sb\",\n \"sd_hash\": \"d40576a4f0f745a868fafad794b3c5e1299cac415a911e55f6eef4395f524b63a649df4c8a75602ea1731a3c5d138b8d\",\n \"size\": \"11\"\n },\n \"stream_type\": \"binary\"\n },\n \"value_type\": \"stream\"\n },\n {\n \"address\": \"mofqoKUmhmPTCoudQRXgjzGSDnCyJvZAZg\",\n \"amount\": \"1.0\",\n \"claim_id\": \"5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"claim_op\": \"update\",\n \"confirmations\": 5,\n \"has_signing_key\": true,\n \"height\": 210,\n \"is_internal_transfer\": false,\n \"is_my_input\": true,\n \"is_my_output\": true,\n \"is_spent\": false,\n \"meta\": {},\n \"name\": \"@channel\",\n \"normalized_name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"lbry://@channel#5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"timestamp\": 1602862456,\n \"txid\": \"3ee8f25ad7bfef1d30e3fce0b212d77b74a495ef1d7635a8be77b96ffbe8e412\",\n \"type\": \"claim\",\n \"value\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a034200049b4cbe0f5275e7b1c170f458af09628ba75401fd95d0205ed9de9037b396f60936d555da2bc8dd09b1804b250f32d1bd07382bd3a4aaa2700b08b137b91f1159\",\n \"public_key_id\": \"mkVrRXQGgjhBaygCP3dNpbmtm5Yohno8q2\",\n \"title\": \"New Channel\"\n },\n \"value_type\": \"channel\"\n }\n ],\n \"page\": 1,\n \"page_size\": 20,\n \"total_items\": 2,\n \"total_pages\": 1\n }\n}"
|
|
},
|
|
{
|
|
"title": "Paginate your claims",
|
|
"curl": "curl -d'{\"method\": \"claim_list\", \"params\": {\"claim_type\": [], \"claim_id\": [], \"name\": [], \"is_spent\": false, \"channel_id\": [], \"page\": 1, \"page_size\": 20, \"resolve\": false, \"no_totals\": false, \"include_received_tips\": false}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet claim list --page=1 --page_size=20",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"claim_list\", \"params\": {\"claim_type\": [], \"claim_id\": [], \"name\": [], \"is_spent\": false, \"channel_id\": [], \"page\": 1, \"page_size\": 20, \"resolve\": false, \"no_totals\": false, \"include_received_tips\": false}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"items\": [\n {\n \"address\": \"mzNC6CMEetGVw6QDGChpUM3HfV7DpWGZ7R\",\n \"amount\": \"1.0\",\n \"claim_id\": \"fe7ee643b50b724f6029f6edfe90d67b5512b3ae\",\n \"claim_op\": \"update\",\n \"confirmations\": 1,\n \"height\": 214,\n \"is_channel_signature_valid\": true,\n \"is_internal_transfer\": false,\n \"is_my_input\": true,\n \"is_my_output\": true,\n \"is_spent\": false,\n \"meta\": {},\n \"name\": \"astream\",\n \"normalized_name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"lbry://astream#fe7ee643b50b724f6029f6edfe90d67b5512b3ae\",\n \"signing_channel\": {\n \"address\": \"mofqoKUmhmPTCoudQRXgjzGSDnCyJvZAZg\",\n \"amount\": \"1.0\",\n \"claim_id\": \"5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"claim_op\": \"update\",\n \"confirmations\": 5,\n \"has_signing_key\": true,\n \"height\": 210,\n \"meta\": {},\n \"name\": \"@channel\",\n \"normalized_name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"lbry://@channel#5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"timestamp\": 1602862456,\n \"txid\": \"3ee8f25ad7bfef1d30e3fce0b212d77b74a495ef1d7635a8be77b96ffbe8e412\",\n \"type\": \"claim\",\n \"value\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a034200049b4cbe0f5275e7b1c170f458af09628ba75401fd95d0205ed9de9037b396f60936d555da2bc8dd09b1804b250f32d1bd07382bd3a4aaa2700b08b137b91f1159\",\n \"public_key_id\": \"mkVrRXQGgjhBaygCP3dNpbmtm5Yohno8q2\",\n \"title\": \"New Channel\"\n },\n \"value_type\": \"channel\"\n },\n \"timestamp\": 1602862457,\n \"txid\": \"c620b71698533d88efa10c80d79a30b74464214cb0d893ec5ab4ec1c37d1676e\",\n \"type\": \"claim\",\n \"value\": {\n \"source\": {\n \"hash\": \"fdbd8e75a67f29f701a4e040385e2e23986303ea10239211af907fcbb83578b3e417cb71ce646efd0819dd8c088de1bd\",\n \"media_type\": \"application/octet-stream\",\n \"name\": \"tmpk0n0x2sb\",\n \"sd_hash\": \"d40576a4f0f745a868fafad794b3c5e1299cac415a911e55f6eef4395f524b63a649df4c8a75602ea1731a3c5d138b8d\",\n \"size\": \"11\"\n },\n \"stream_type\": \"binary\"\n },\n \"value_type\": \"stream\"\n },\n {\n \"address\": \"mofqoKUmhmPTCoudQRXgjzGSDnCyJvZAZg\",\n \"amount\": \"1.0\",\n \"claim_id\": \"5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"claim_op\": \"update\",\n \"confirmations\": 5,\n \"has_signing_key\": true,\n \"height\": 210,\n \"is_internal_transfer\": false,\n \"is_my_input\": true,\n \"is_my_output\": true,\n \"is_spent\": false,\n \"meta\": {},\n \"name\": \"@channel\",\n \"normalized_name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"lbry://@channel#5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"timestamp\": 1602862456,\n \"txid\": \"3ee8f25ad7bfef1d30e3fce0b212d77b74a495ef1d7635a8be77b96ffbe8e412\",\n \"type\": \"claim\",\n \"value\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a034200049b4cbe0f5275e7b1c170f458af09628ba75401fd95d0205ed9de9037b396f60936d555da2bc8dd09b1804b250f32d1bd07382bd3a4aaa2700b08b137b91f1159\",\n \"public_key_id\": \"mkVrRXQGgjhBaygCP3dNpbmtm5Yohno8q2\",\n \"title\": \"New Channel\"\n },\n \"value_type\": \"channel\"\n }\n ],\n \"page\": 1,\n \"page_size\": 20,\n \"total_items\": 2,\n \"total_pages\": 1\n }\n}"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "claim_search",
|
|
"description": "Search for stream and channel claims on the blockchain.\n\nArguments marked with \"supports equality constraints\" allow prepending the\nvalue with an equality constraint such as '>', '>=', '<' and '<='\neg. --height=\">400000\" would limit results to only claims above 400k block height.",
|
|
"arguments": [
|
|
{
|
|
"name": "name",
|
|
"type": "str",
|
|
"description": "claim name (normalized)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "text",
|
|
"type": "str",
|
|
"description": "full text search",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "claim_id",
|
|
"type": "str",
|
|
"description": "full or partial claim id",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "claim_ids",
|
|
"type": "list",
|
|
"description": "list of full claim ids",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "txid",
|
|
"type": "str",
|
|
"description": "transaction id",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "nout",
|
|
"type": "str",
|
|
"description": "position in the transaction",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "channel",
|
|
"type": "str",
|
|
"description": "claims signed by this channel (argument is a URL which automatically gets resolved), see --channel_ids if you need to filter by multiple channels at the same time, includes claims with invalid signatures, use in conjunction with --valid_channel_signature",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "channel_ids",
|
|
"type": "list",
|
|
"description": "claims signed by any of these channels (arguments must be claim ids of the channels), includes claims with invalid signatures, implies --has_channel_signature, use in conjunction with --valid_channel_signature",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "not_channel_ids",
|
|
"type": "list",
|
|
"description": "exclude claims signed by any of these channels (arguments must be claim ids of the channels)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "has_channel_signature",
|
|
"type": "bool",
|
|
"description": "claims with a channel signature (valid or invalid)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "valid_channel_signature",
|
|
"type": "bool",
|
|
"description": "claims with a valid channel signature or no signature, use in conjunction with --has_channel_signature to only get claims with valid signatures",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "invalid_channel_signature",
|
|
"type": "bool",
|
|
"description": "claims with invalid channel signature or no signature, use in conjunction with --has_channel_signature to only get claims with invalid signatures",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "limit_claims_per_channel",
|
|
"type": "int",
|
|
"description": "only return up to the specified number of claims per channel",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "is_controlling",
|
|
"type": "bool",
|
|
"description": "winning claims of their respective name",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "public_key_id",
|
|
"type": "str",
|
|
"description": "only return channels having this public key id, this is the same key as used in the wallet file to map channel certificate private keys: {'public_key_id': 'private key'}",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "height",
|
|
"type": "int",
|
|
"description": "last updated block height (supports equality constraints)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "timestamp",
|
|
"type": "int",
|
|
"description": "last updated timestamp (supports equality constraints)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "creation_height",
|
|
"type": "int",
|
|
"description": "created at block height (supports equality constraints)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "creation_timestamp",
|
|
"type": "int",
|
|
"description": "created at timestamp (supports equality constraints)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "activation_height",
|
|
"type": "int",
|
|
"description": "height at which claim starts competing for name (supports equality constraints)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "expiration_height",
|
|
"type": "int",
|
|
"description": "height at which claim will expire (supports equality constraints)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "release_time",
|
|
"type": "int",
|
|
"description": "limit to claims self-described as having been released to the public on or after this UTC timestamp, when claim does not provide a release time the publish time is used instead (supports equality constraints)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "amount",
|
|
"type": "int",
|
|
"description": "limit by claim value (supports equality constraints)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "support_amount",
|
|
"type": "int",
|
|
"description": "limit by supports and tips received (supports equality constraints)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "effective_amount",
|
|
"type": "int",
|
|
"description": "limit by total value (initial claim value plus all tips and supports received), this amount is blank until claim has reached activation height (supports equality constraints)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "trending_group",
|
|
"type": "int",
|
|
"description": "group numbers 1 through 4 representing the trending groups of the content: 4 means content is trending globally and independently, 3 means content is not trending globally but is trending independently (locally), 2 means it is trending globally but not independently and 1 means it's not trending globally or locally (supports equality constraints)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "trending_mixed",
|
|
"type": "int",
|
|
"description": "trending amount taken from the global or local value depending on the trending group: 4 - global value, 3 - local value, 2 - global value, 1 - local value (supports equality constraints)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "trending_local",
|
|
"type": "int",
|
|
"description": "trending value calculated relative only to the individual contents past history (supports equality constraints)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "trending_global",
|
|
"type": "int",
|
|
"description": "trending value calculated relative to all trending content globally (supports equality constraints)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "reposted_claim_id",
|
|
"type": "str",
|
|
"description": "all reposts of the specified original claim id",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "reposted",
|
|
"type": "int",
|
|
"description": "claims reposted this many times (supports equality constraints)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "claim_type",
|
|
"type": "str",
|
|
"description": "filter by 'channel', 'stream' or 'unknown'",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "stream_types",
|
|
"type": "list",
|
|
"description": "filter by 'video', 'image', 'document', etc",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "media_types",
|
|
"type": "list",
|
|
"description": "filter by 'video/mp4', 'image/png', etc",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "fee_currency",
|
|
"type": "string",
|
|
"description": "specify fee currency: LBC, BTC, USD",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "fee_amount",
|
|
"type": "decimal",
|
|
"description": "content download fee (supports equality constraints)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "duration",
|
|
"type": "int",
|
|
"description": "duration of video or audio in seconds (supports equality constraints)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "any_tags",
|
|
"type": "list",
|
|
"description": "find claims containing any of the tags",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "all_tags",
|
|
"type": "list",
|
|
"description": "find claims containing every tag",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "not_tags",
|
|
"type": "list",
|
|
"description": "find claims not containing any of these tags",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "any_languages",
|
|
"type": "list",
|
|
"description": "find claims containing any of the languages",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "all_languages",
|
|
"type": "list",
|
|
"description": "find claims containing every language",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "not_languages",
|
|
"type": "list",
|
|
"description": "find claims not containing any of these languages",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "any_locations",
|
|
"type": "list",
|
|
"description": "find claims containing any of the locations",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "all_locations",
|
|
"type": "list",
|
|
"description": "find claims containing every location",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "not_locations",
|
|
"type": "list",
|
|
"description": "find claims not containing any of these locations",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "page",
|
|
"type": "int",
|
|
"description": "page to return during paginating",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "page_size",
|
|
"type": "int",
|
|
"description": "number of items on page during pagination",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "order_by",
|
|
"type": "list",
|
|
"description": "field to order by, default is descending order, to do an ascending order prepend ^ to the field name, eg. '^amount' available fields: 'name', 'height', 'release_time', 'publish_time', 'amount', 'effective_amount', 'support_amount', 'trending_group', 'trending_mixed', 'trending_local', 'trending_global', 'activation_height'",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "no_totals",
|
|
"type": "bool",
|
|
"description": "do not calculate the total number of pages and items in result set (significant performance boost)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "wallet to check for claim purchase reciepts",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "include_purchase_receipt",
|
|
"type": "bool",
|
|
"description": "lookup and include a receipt if this wallet has purchased the claim",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "include_is_my_output",
|
|
"type": "bool",
|
|
"description": "lookup and include a boolean indicating if claim being resolved is yours",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "new_sdk_server",
|
|
"type": "str",
|
|
"description": "URL of the new SDK server (EXPERIMENTAL)",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": " {\n \"page\": \"Page number of the current items.\",\n \"page_size\": \"Number of items to show on a page.\",\n \"total_pages\": \"Total number of pages.\",\n \"total_items\": \"Total number of items.\",\n \"items\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ]\n }",
|
|
"examples": [
|
|
{
|
|
"title": "Search for all claims in channel",
|
|
"curl": "curl -d'{\"method\": \"claim_search\", \"params\": {\"claim_ids\": [], \"channel\": \"@channel\", \"channel_ids\": [], \"not_channel_ids\": [], \"has_channel_signature\": false, \"valid_channel_signature\": false, \"invalid_channel_signature\": false, \"is_controlling\": false, \"stream_types\": [], \"media_types\": [], \"any_tags\": [], \"all_tags\": [], \"not_tags\": [], \"any_languages\": [], \"all_languages\": [], \"not_languages\": [], \"any_locations\": [], \"all_locations\": [], \"not_locations\": [], \"order_by\": [], \"include_purchase_receipt\": false, \"include_is_my_output\": false}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet claim search --channel=@channel",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"claim_search\", \"params\": {\"claim_ids\": [], \"channel\": \"@channel\", \"channel_ids\": [], \"not_channel_ids\": [], \"has_channel_signature\": false, \"valid_channel_signature\": false, \"invalid_channel_signature\": false, \"is_controlling\": false, \"stream_types\": [], \"media_types\": [], \"any_tags\": [], \"all_tags\": [], \"not_tags\": [], \"any_languages\": [], \"all_languages\": [], \"not_languages\": [], \"any_locations\": [], \"all_locations\": [], \"not_locations\": [], \"order_by\": [], \"include_purchase_receipt\": false, \"include_is_my_output\": false}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"blocked\": {\n \"channels\": [],\n \"total\": 0\n },\n \"items\": [\n {\n \"address\": \"mzNC6CMEetGVw6QDGChpUM3HfV7DpWGZ7R\",\n \"amount\": \"1.0\",\n \"canonical_url\": \"lbry://@channel#5/astream#f\",\n \"claim_id\": \"fe7ee643b50b724f6029f6edfe90d67b5512b3ae\",\n \"claim_op\": \"update\",\n \"confirmations\": 1,\n \"height\": 214,\n \"is_channel_signature_valid\": true,\n \"meta\": {\n \"activation_height\": 213,\n \"creation_height\": 213,\n \"creation_timestamp\": 1602862457,\n \"effective_amount\": \"1.0\",\n \"expiration_height\": 263187,\n \"is_controlling\": true,\n \"reposted\": 0,\n \"support_amount\": \"0.0\",\n \"take_over_height\": 213,\n \"trending_global\": 0.0,\n \"trending_group\": 0,\n \"trending_local\": 0.0,\n \"trending_mixed\": 0.0\n },\n \"name\": \"astream\",\n \"normalized_name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"lbry://astream#fe7ee643b50b724f6029f6edfe90d67b5512b3ae\",\n \"short_url\": \"lbry://astream#f\",\n \"signing_channel\": {\n \"address\": \"mofqoKUmhmPTCoudQRXgjzGSDnCyJvZAZg\",\n \"amount\": \"1.0\",\n \"canonical_url\": \"lbry://@channel#5\",\n \"claim_id\": \"5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"claim_op\": \"update\",\n \"confirmations\": 5,\n \"has_signing_key\": false,\n \"height\": 210,\n \"meta\": {\n \"activation_height\": 209,\n \"claims_in_channel\": 1,\n \"creation_height\": 209,\n \"creation_timestamp\": 1602862456,\n \"effective_amount\": \"1.0\",\n \"expiration_height\": 263183,\n \"is_controlling\": true,\n \"reposted\": 0,\n \"support_amount\": \"0.0\",\n \"take_over_height\": 209,\n \"trending_global\": 0.0,\n \"trending_group\": 0,\n \"trending_local\": 0.0,\n \"trending_mixed\": 0.0\n },\n \"name\": \"@channel\",\n \"normalized_name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"lbry://@channel#5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"short_url\": \"lbry://@channel#5\",\n \"timestamp\": 1602862456,\n \"txid\": \"3ee8f25ad7bfef1d30e3fce0b212d77b74a495ef1d7635a8be77b96ffbe8e412\",\n \"type\": \"claim\",\n \"value\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a034200049b4cbe0f5275e7b1c170f458af09628ba75401fd95d0205ed9de9037b396f60936d555da2bc8dd09b1804b250f32d1bd07382bd3a4aaa2700b08b137b91f1159\",\n \"public_key_id\": \"mkVrRXQGgjhBaygCP3dNpbmtm5Yohno8q2\",\n \"title\": \"New Channel\"\n },\n \"value_type\": \"channel\"\n },\n \"timestamp\": 1602862457,\n \"txid\": \"c620b71698533d88efa10c80d79a30b74464214cb0d893ec5ab4ec1c37d1676e\",\n \"type\": \"claim\",\n \"value\": {\n \"source\": {\n \"hash\": \"fdbd8e75a67f29f701a4e040385e2e23986303ea10239211af907fcbb83578b3e417cb71ce646efd0819dd8c088de1bd\",\n \"media_type\": \"application/octet-stream\",\n \"name\": \"tmpk0n0x2sb\",\n \"sd_hash\": \"d40576a4f0f745a868fafad794b3c5e1299cac415a911e55f6eef4395f524b63a649df4c8a75602ea1731a3c5d138b8d\",\n \"size\": \"11\"\n },\n \"stream_type\": \"binary\"\n },\n \"value_type\": \"stream\"\n }\n ],\n \"page\": 1,\n \"page_size\": 20,\n \"total_items\": 1,\n \"total_pages\": 1\n }\n}"
|
|
},
|
|
{
|
|
"title": "Search for claims matching a name",
|
|
"curl": "curl -d'{\"method\": \"claim_search\", \"params\": {\"name\": \"astream\", \"claim_ids\": [], \"channel_ids\": [], \"not_channel_ids\": [], \"has_channel_signature\": false, \"valid_channel_signature\": false, \"invalid_channel_signature\": false, \"is_controlling\": false, \"stream_types\": [], \"media_types\": [], \"any_tags\": [], \"all_tags\": [], \"not_tags\": [], \"any_languages\": [], \"all_languages\": [], \"not_languages\": [], \"any_locations\": [], \"all_locations\": [], \"not_locations\": [], \"order_by\": [], \"include_purchase_receipt\": false, \"include_is_my_output\": false}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet claim search --name=\"astream\"",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"claim_search\", \"params\": {\"name\": \"astream\", \"claim_ids\": [], \"channel_ids\": [], \"not_channel_ids\": [], \"has_channel_signature\": false, \"valid_channel_signature\": false, \"invalid_channel_signature\": false, \"is_controlling\": false, \"stream_types\": [], \"media_types\": [], \"any_tags\": [], \"all_tags\": [], \"not_tags\": [], \"any_languages\": [], \"all_languages\": [], \"not_languages\": [], \"any_locations\": [], \"all_locations\": [], \"not_locations\": [], \"order_by\": [], \"include_purchase_receipt\": false, \"include_is_my_output\": false}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"blocked\": {\n \"channels\": [],\n \"total\": 0\n },\n \"items\": [\n {\n \"address\": \"mzNC6CMEetGVw6QDGChpUM3HfV7DpWGZ7R\",\n \"amount\": \"1.0\",\n \"canonical_url\": \"lbry://@channel#5/astream#f\",\n \"claim_id\": \"fe7ee643b50b724f6029f6edfe90d67b5512b3ae\",\n \"claim_op\": \"update\",\n \"confirmations\": 1,\n \"height\": 214,\n \"is_channel_signature_valid\": true,\n \"meta\": {\n \"activation_height\": 213,\n \"creation_height\": 213,\n \"creation_timestamp\": 1602862457,\n \"effective_amount\": \"1.0\",\n \"expiration_height\": 263187,\n \"is_controlling\": true,\n \"reposted\": 0,\n \"support_amount\": \"0.0\",\n \"take_over_height\": 213,\n \"trending_global\": 0.0,\n \"trending_group\": 0,\n \"trending_local\": 0.0,\n \"trending_mixed\": 0.0\n },\n \"name\": \"astream\",\n \"normalized_name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"lbry://astream#fe7ee643b50b724f6029f6edfe90d67b5512b3ae\",\n \"short_url\": \"lbry://astream#f\",\n \"signing_channel\": {\n \"address\": \"mofqoKUmhmPTCoudQRXgjzGSDnCyJvZAZg\",\n \"amount\": \"1.0\",\n \"canonical_url\": \"lbry://@channel#5\",\n \"claim_id\": \"5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"claim_op\": \"update\",\n \"confirmations\": 5,\n \"has_signing_key\": false,\n \"height\": 210,\n \"meta\": {\n \"activation_height\": 209,\n \"claims_in_channel\": 1,\n \"creation_height\": 209,\n \"creation_timestamp\": 1602862456,\n \"effective_amount\": \"1.0\",\n \"expiration_height\": 263183,\n \"is_controlling\": true,\n \"reposted\": 0,\n \"support_amount\": \"0.0\",\n \"take_over_height\": 209,\n \"trending_global\": 0.0,\n \"trending_group\": 0,\n \"trending_local\": 0.0,\n \"trending_mixed\": 0.0\n },\n \"name\": \"@channel\",\n \"normalized_name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"lbry://@channel#5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"short_url\": \"lbry://@channel#5\",\n \"timestamp\": 1602862456,\n \"txid\": \"3ee8f25ad7bfef1d30e3fce0b212d77b74a495ef1d7635a8be77b96ffbe8e412\",\n \"type\": \"claim\",\n \"value\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a034200049b4cbe0f5275e7b1c170f458af09628ba75401fd95d0205ed9de9037b396f60936d555da2bc8dd09b1804b250f32d1bd07382bd3a4aaa2700b08b137b91f1159\",\n \"public_key_id\": \"mkVrRXQGgjhBaygCP3dNpbmtm5Yohno8q2\",\n \"title\": \"New Channel\"\n },\n \"value_type\": \"channel\"\n },\n \"timestamp\": 1602862457,\n \"txid\": \"c620b71698533d88efa10c80d79a30b74464214cb0d893ec5ab4ec1c37d1676e\",\n \"type\": \"claim\",\n \"value\": {\n \"source\": {\n \"hash\": \"fdbd8e75a67f29f701a4e040385e2e23986303ea10239211af907fcbb83578b3e417cb71ce646efd0819dd8c088de1bd\",\n \"media_type\": \"application/octet-stream\",\n \"name\": \"tmpk0n0x2sb\",\n \"sd_hash\": \"d40576a4f0f745a868fafad794b3c5e1299cac415a911e55f6eef4395f524b63a649df4c8a75602ea1731a3c5d138b8d\",\n \"size\": \"11\"\n },\n \"stream_type\": \"binary\"\n },\n \"value_type\": \"stream\"\n }\n ],\n \"page\": 1,\n \"page_size\": 20,\n \"total_items\": 1,\n \"total_pages\": 1\n }\n}"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"collection": {
|
|
"doc": "Create, update, list, resolve, and abandon collections.",
|
|
"commands": [
|
|
{
|
|
"name": "collection_abandon",
|
|
"description": "Abandon one of my collection claims.",
|
|
"arguments": [
|
|
{
|
|
"name": "claim_id",
|
|
"type": "str",
|
|
"description": "claim_id of the claim to abandon",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "txid",
|
|
"type": "str",
|
|
"description": "txid of the claim to abandon",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "nout",
|
|
"type": "int",
|
|
"description": "nout of the claim to abandon",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "account_id",
|
|
"type": "str",
|
|
"description": "id of the account to use",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict operation to specific wallet",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "preview",
|
|
"type": "bool",
|
|
"description": "do not broadcast the transaction",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "blocking",
|
|
"type": "bool",
|
|
"description": "wait until abandon is in mempool",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "collection_create",
|
|
"description": "Create a new collection.",
|
|
"arguments": [
|
|
{
|
|
"name": "name",
|
|
"type": "str",
|
|
"description": "name of the collection",
|
|
"is_required": true
|
|
},
|
|
{
|
|
"name": "bid",
|
|
"type": "decimal",
|
|
"description": "amount to back the claim",
|
|
"is_required": true
|
|
},
|
|
{
|
|
"name": "claims",
|
|
"type": "list",
|
|
"description": "claim ids to be included in the collection",
|
|
"is_required": true
|
|
},
|
|
{
|
|
"name": "allow_duplicate_name",
|
|
"type": "bool",
|
|
"description": "create new collection even if one already exists with given name. default: false.",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "title",
|
|
"type": "str",
|
|
"description": "title of the collection",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "description",
|
|
"type": "str",
|
|
"description": "description of the collection",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "tags",
|
|
"type": "list",
|
|
"description": "content tags",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "clear_languages",
|
|
"type": "bool",
|
|
"description": "clear existing languages (prior to adding new ones)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "languages",
|
|
"type": "list",
|
|
"description": "languages used by the collection, using RFC 5646 format, eg: for English `--languages=en` for Spanish (Spain) `--languages=es-ES` for Spanish (Mexican) `--languages=es-MX` for Chinese (Simplified) `--languages=zh-Hans` for Chinese (Traditional) `--languages=zh-Hant`",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "locations",
|
|
"type": "list",
|
|
"description": "locations of the collection, consisting of 2 letter `country` code and a `state`, `city` and a postal `code` along with a `latitude` and `longitude`. for JSON RPC: pass a dictionary with aforementioned attributes as keys, eg: ... \"locations\": [{'country': 'US', 'state': 'NH'}] ... for command line: pass a colon delimited list with values in the following order: \"COUNTRY:STATE:CITY:CODE:LATITUDE:LONGITUDE\" making sure to include colon for blank values, for example to provide only the city: ... --locations=\"::Manchester\" with all values set: ... --locations=\"US:NH:Manchester:03101:42.990605:-71.460989\" optionally, you can just pass the \"LATITUDE:LONGITUDE\": ... --locations=\"42.990605:-71.460989\" finally, you can also pass JSON string of dictionary on the command line as you would via JSON RPC ... --locations=\"{'country': 'US', 'state': 'NH'}\"",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "thumbnail_url",
|
|
"type": "str",
|
|
"description": "thumbnail url",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "account_id",
|
|
"type": "str",
|
|
"description": "account to use for holding the transaction",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict operation to specific wallet",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "funding_account_ids",
|
|
"type": "list",
|
|
"description": "ids of accounts to fund this transaction",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "claim_address",
|
|
"type": "str",
|
|
"description": "address where the collection is sent to, if not specified it will be determined automatically from the account",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "preview",
|
|
"type": "bool",
|
|
"description": "do not broadcast the transaction",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "blocking",
|
|
"type": "bool",
|
|
"description": "wait until transaction is in mempool",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "collection_list",
|
|
"description": "List my collection claims.",
|
|
"arguments": [
|
|
{
|
|
"name": "resolve_claims",
|
|
"type": "int",
|
|
"description": "resolve every claim",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "account_id",
|
|
"type": "str",
|
|
"description": "id of the account to use",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict results to specific wallet",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "page",
|
|
"type": "int",
|
|
"description": "page to return during paginating",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "page_size",
|
|
"type": "int",
|
|
"description": "number of items on page during pagination",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": " {\n \"page\": \"Page number of the current items.\",\n \"page_size\": \"Number of items to show on a page.\",\n \"total_pages\": \"Total number of pages.\",\n \"total_items\": \"Total number of items.\",\n \"items\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ]\n }",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "collection_resolve",
|
|
"description": "Resolve claims in the collection.",
|
|
"arguments": [
|
|
{
|
|
"name": "claim_id",
|
|
"type": "str",
|
|
"description": "claim id of the collection",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "url",
|
|
"type": "str",
|
|
"description": "url of the collection",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict results to specific wallet",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "page",
|
|
"type": "int",
|
|
"description": "page to return during paginating",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "page_size",
|
|
"type": "int",
|
|
"description": "number of items on page during pagination",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": " {\n \"page\": \"Page number of the current items.\",\n \"page_size\": \"Number of items to show on a page.\",\n \"total_pages\": \"Total number of pages.\",\n \"total_items\": \"Total number of items.\",\n \"items\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ]\n }",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "collection_update",
|
|
"description": "Update an existing collection claim.",
|
|
"arguments": [
|
|
{
|
|
"name": "claim_id",
|
|
"type": "str",
|
|
"description": "claim_id of the collection to update",
|
|
"is_required": true
|
|
},
|
|
{
|
|
"name": "bid",
|
|
"type": "decimal",
|
|
"description": "amount to back the claim",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "claims",
|
|
"type": "list",
|
|
"description": "claim ids",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "clear_claims",
|
|
"type": "bool",
|
|
"description": "clear existing claim references (prior to adding new ones)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "title",
|
|
"type": "str",
|
|
"description": "title of the collection",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "description",
|
|
"type": "str",
|
|
"description": "description of the collection",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "tags",
|
|
"type": "list",
|
|
"description": "add content tags",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "clear_tags",
|
|
"type": "bool",
|
|
"description": "clear existing tags (prior to adding new ones)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "languages",
|
|
"type": "list",
|
|
"description": "languages used by the collection, using RFC 5646 format, eg: for English `--languages=en` for Spanish (Spain) `--languages=es-ES` for Spanish (Mexican) `--languages=es-MX` for Chinese (Simplified) `--languages=zh-Hans` for Chinese (Traditional) `--languages=zh-Hant`",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "clear_languages",
|
|
"type": "bool",
|
|
"description": "clear existing languages (prior to adding new ones)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "locations",
|
|
"type": "list",
|
|
"description": "locations of the collection, consisting of 2 letter `country` code and a `state`, `city` and a postal `code` along with a `latitude` and `longitude`. for JSON RPC: pass a dictionary with aforementioned attributes as keys, eg: ... \"locations\": [{'country': 'US', 'state': 'NH'}] ... for command line: pass a colon delimited list with values in the following order: \"COUNTRY:STATE:CITY:CODE:LATITUDE:LONGITUDE\" making sure to include colon for blank values, for example to provide only the city: ... --locations=\"::Manchester\" with all values set: ... --locations=\"US:NH:Manchester:03101:42.990605:-71.460989\" optionally, you can just pass the \"LATITUDE:LONGITUDE\": ... --locations=\"42.990605:-71.460989\" finally, you can also pass JSON string of dictionary on the command line as you would via JSON RPC ... --locations=\"{'country': 'US', 'state': 'NH'}\"",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "clear_locations",
|
|
"type": "bool",
|
|
"description": "clear existing locations (prior to adding new ones)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "thumbnail_url",
|
|
"type": "str",
|
|
"description": "thumbnail url",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "account_id",
|
|
"type": "str",
|
|
"description": "account in which to look for collection (default: all)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict operation to specific wallet",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "funding_account_ids",
|
|
"type": "list",
|
|
"description": "ids of accounts to fund this transaction",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "claim_address",
|
|
"type": "str",
|
|
"description": "address where the collection is sent",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "new_signing_key",
|
|
"type": "bool",
|
|
"description": "generate a new signing key, will invalidate all previous publishes",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "preview",
|
|
"type": "bool",
|
|
"description": "do not broadcast the transaction",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "blocking",
|
|
"type": "bool",
|
|
"description": "wait until transaction is in mempool",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "replace",
|
|
"type": "bool",
|
|
"description": "instead of modifying specific values on the collection, this will clear all existing values and only save passed in values, useful for form submissions where all values are always set",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }",
|
|
"examples": []
|
|
}
|
|
]
|
|
},
|
|
"comment": {
|
|
"doc": "View, create and abandon comments.",
|
|
"commands": [
|
|
{
|
|
"name": "comment_abandon",
|
|
"description": "Abandon a comment published under your channel identity.",
|
|
"arguments": [
|
|
{
|
|
"name": "comment_id",
|
|
"type": "str",
|
|
"description": "The ID of the comment to be abandoned.",
|
|
"is_required": true
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict operation to specific wallet",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": "(dict) Object with the `comment_id` passed in as the key, and a flag indicating if it was abandoned\n {\n <comment_id> (str): {\n \"abandoned\": (bool)\n }\n }",
|
|
"examples": [
|
|
{
|
|
"title": "Abandon a comment",
|
|
"curl": "curl -d'{\"method\": \"comment_abandon\", \"params\": {\"comment_id\": \"34ffe236decc147c7c0c7e0c24c2e5380a312c1084e6ed7bb2c3332a89e95cbf\"}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet comment abandon 34ffe236decc147c7c0c7e0c24c2e5380a312c1084e6ed7bb2c3332a89e95cbf",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"comment_abandon\", \"params\": {\"comment_id\": \"34ffe236decc147c7c0c7e0c24c2e5380a312c1084e6ed7bb2c3332a89e95cbf\"}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"error\": {\n \"code\": -32000,\n \"data\": null,\n \"message\": \"could not get claim from sdk with claim id 5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\"\n },\n \"id\": 1,\n \"jsonrpc\": \"2.0\"\n }\n}"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "comment_create",
|
|
"description": "Create and associate a comment with a claim using your channel identity.",
|
|
"arguments": [
|
|
{
|
|
"name": "comment",
|
|
"type": "str",
|
|
"description": "Comment to be made, should be at most 2000 characters.",
|
|
"is_required": true
|
|
},
|
|
{
|
|
"name": "claim_id",
|
|
"type": "str",
|
|
"description": "The ID of the claim to comment on",
|
|
"is_required": true
|
|
},
|
|
{
|
|
"name": "parent_id",
|
|
"type": "str",
|
|
"description": "The ID of a comment to make a response to",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "channel_id",
|
|
"type": "str",
|
|
"description": "The ID of the channel you want to post under",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "channel_name",
|
|
"type": "str",
|
|
"description": "The channel you want to post as, prepend with a '@'",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "channel_account_id",
|
|
"type": "str",
|
|
"description": "one or more account ids for accounts to look in for channel certificates, defaults to all accounts",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict operation to specific wallet",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": "(dict) Comment object if successfully made, (None) otherwise\n {\n \"comment\": (str) The actual string as inputted by the user,\n \"comment_id\": (str) The Comment's unique identifier,\n \"claim_id\": (str) The claim commented on,\n \"channel_name\": (str) Name of the channel this was posted under, prepended with a '@',\n \"channel_id\": (str) The Channel Claim ID that this comment was posted under,\n \"is_pinned\": (boolean) Channel owner has pinned this comment,\n \"signature\": (str) The signature of the comment,\n \"signing_ts\": (str) The timestamp used to sign the comment,\n \"channel_url\": (str) Channel's URI in the ClaimTrie,\n \"parent_id\": (str) Comment this is replying to, (None) if this is the root,\n \"timestamp\": (int) The time at which comment was entered into the server at, in nanoseconds.\n }",
|
|
"examples": [
|
|
{
|
|
"title": "Posting a comment as your channel",
|
|
"curl": "curl -d'{\"method\": \"comment_create\", \"params\": {\"comment\": \"Thank you Based God\", \"claim_id\": \"fe7ee643b50b724f6029f6edfe90d67b5512b3ae\", \"channel_name\": \"@channel\", \"channel_account_id\": []}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet comment create --comment=\"Thank you Based God\" --channel_name=@channel --claim_id=fe7ee643b50b724f6029f6edfe90d67b5512b3ae",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"comment_create\", \"params\": {\"comment\": \"Thank you Based God\", \"claim_id\": \"fe7ee643b50b724f6029f6edfe90d67b5512b3ae\", \"channel_name\": \"@channel\", \"channel_account_id\": []}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"channel_id\": \"5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"channel_name\": \"@channel\",\n \"channel_url\": \"lbry://@channel#5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"claim_id\": \"fe7ee643b50b724f6029f6edfe90d67b5512b3ae\",\n \"comment\": \"Thank you Based God\",\n \"comment_id\": \"34ffe236decc147c7c0c7e0c24c2e5380a312c1084e6ed7bb2c3332a89e95cbf\",\n \"is_claim_signature_valid\": true,\n \"is_hidden\": false,\n \"is_pinned\": false,\n \"signature\": \"c9cf386ed5af52fa1beb060898c5590f4c7fe02010228e1db49dc42b5bcf2d83218825876ae75f60a42cee0bf27d311904299e10fa2b6daef158a38cf4deb06c\",\n \"signing_ts\": \"1602862434\",\n \"timestamp\": 1602862434\n }\n}"
|
|
},
|
|
{
|
|
"title": "Use the parent_id param to make replies",
|
|
"curl": "curl -d'{\"method\": \"comment_create\", \"params\": {\"comment\": \"I have photographic evidence confirming Sasquatch exists\", \"parent_id\": \"34ffe236decc147c7c0c7e0c24c2e5380a312c1084e6ed7bb2c3332a89e95cbf\", \"channel_name\": \"@channel\", \"channel_account_id\": []}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet comment create --comment=\"I have photographic evidence confirming Sasquatch exists\" --channel_name=@channel --parent_id=34ffe236decc147c7c0c7e0c24c2e5380a312c1084e6ed7bb2c3332a89e95cbf",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"comment_create\", \"params\": {\"comment\": \"I have photographic evidence confirming Sasquatch exists\", \"parent_id\": \"34ffe236decc147c7c0c7e0c24c2e5380a312c1084e6ed7bb2c3332a89e95cbf\", \"channel_name\": \"@channel\", \"channel_account_id\": []}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"channel_id\": \"5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"channel_name\": \"@channel\",\n \"channel_url\": \"lbry://@channel#5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"claim_id\": \"\",\n \"comment\": \"I have photographic evidence confirming Sasquatch exists\",\n \"comment_id\": \"bc36b0956118363b6b4ca20fed91c76f1e596ce0fc0ca0545366298fc6b22186\",\n \"is_claim_signature_valid\": true,\n \"is_hidden\": false,\n \"is_pinned\": false,\n \"parent_id\": \"34ffe236decc147c7c0c7e0c24c2e5380a312c1084e6ed7bb2c3332a89e95cbf\",\n \"signature\": \"459065ca93c600a81d51ea2038a6afad7eb0d03c94bd674f3b73cb14a0b65815d09eb788c40c30163e04cc1e48c6238f6c78a7ecda62aaf0e7afd7cd3b98b66a\",\n \"signing_ts\": \"1602862434\",\n \"timestamp\": 1602862435\n }\n}"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "comment_hide",
|
|
"description": "Hide a comment published to a claim you control.",
|
|
"arguments": [
|
|
{
|
|
"name": "comment_ids",
|
|
"type": "str, list",
|
|
"description": "one or more comment_id to hide.",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict operation to specific wallet",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": "lists containing the ids comments that are hidden and visible.\n\n {\n \"hidden\": (list) IDs of hidden comments.\n \"visible\": (list) IDs of visible comments.\n }",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "comment_list",
|
|
"description": "List comments associated with a claim.",
|
|
"arguments": [
|
|
{
|
|
"name": "claim_id",
|
|
"type": "str",
|
|
"description": "The claim on which the comment will be made on",
|
|
"is_required": true
|
|
},
|
|
{
|
|
"name": "parent_id",
|
|
"type": "str",
|
|
"description": "CommentId of a specific thread you'd like to see",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "page",
|
|
"type": "int",
|
|
"description": "The page you'd like to see in the comment list.",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "page_size",
|
|
"type": "int",
|
|
"description": "The amount of comments that you'd like to retrieve",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "skip_validation",
|
|
"type": "bool",
|
|
"description": "Skip resolving comments to validate channel names",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "include_replies",
|
|
"type": "bool",
|
|
"description": "Whether or not you want to include replies in list",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "is_channel_signature_valid",
|
|
"type": "bool",
|
|
"description": "Only include comments with valid signatures. [Warning: Paginated total size will not change, even if list reduces]",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "visible",
|
|
"type": "bool",
|
|
"description": "Select only Visible Comments",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "hidden",
|
|
"type": "bool",
|
|
"description": "Select only Hidden Comments",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": "(dict) Containing the list, and information about the paginated content:\n {\n \"page\": \"Page number of the current items.\",\n \"page_size\": \"Number of items to show on a page.\",\n \"total_pages\": \"Total number of pages.\",\n \"total_items\": \"Total number of items.\",\n \"items\": \"A List of dict objects representing comments.\"\n [\n {\n \"comment\": (str) The actual string as inputted by the user,\n \"comment_id\": (str) The Comment's unique identifier,\n \"channel_name\": (str) Name of the channel this was posted under, prepended with a '@',\n \"channel_id\": (str) The Channel Claim ID that this comment was posted under,\n \"signature\": (str) The signature of the comment,\n \"channel_url\": (str) Channel's URI in the ClaimTrie,\n \"parent_id\": (str) Comment this is replying to, (None) if this is the root,\n \"timestamp\": (int) The time at which comment was entered into the server at, in nanoseconds.\n },\n ...\n ]\n }",
|
|
"examples": [
|
|
{
|
|
"title": "List all comments on a claim",
|
|
"curl": "curl -d'{\"method\": \"comment_list\", \"params\": {\"claim_id\": \"fe7ee643b50b724f6029f6edfe90d67b5512b3ae\", \"include_replies\": true, \"skip_validation\": false, \"is_channel_signature_valid\": false, \"visible\": false, \"hidden\": false}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet comment list fe7ee643b50b724f6029f6edfe90d67b5512b3ae --include_replies",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"comment_list\", \"params\": {\"claim_id\": \"fe7ee643b50b724f6029f6edfe90d67b5512b3ae\", \"include_replies\": true, \"skip_validation\": false, \"is_channel_signature_valid\": false, \"visible\": false, \"hidden\": false}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"has_hidden_comments\": false,\n \"items\": [\n {\n \"channel_id\": \"5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"channel_name\": \"@channel\",\n \"channel_url\": \"lbry://@channel#5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"claim_id\": \"fe7ee643b50b724f6029f6edfe90d67b5512b3ae\",\n \"comment\": \"Thank you Based God\",\n \"comment_id\": \"34ffe236decc147c7c0c7e0c24c2e5380a312c1084e6ed7bb2c3332a89e95cbf\",\n \"is_channel_signature_valid\": true,\n \"is_hidden\": false,\n \"is_pinned\": false,\n \"signature\": \"c9cf386ed5af52fa1beb060898c5590f4c7fe02010228e1db49dc42b5bcf2d83218825876ae75f60a42cee0bf27d311904299e10fa2b6daef158a38cf4deb06c\",\n \"signing_ts\": \"1602862434\",\n \"timestamp\": 1602862434\n }\n ],\n \"page\": 1,\n \"page_size\": 50,\n \"total_items\": 1,\n \"total_pages\": 1\n }\n}"
|
|
},
|
|
{
|
|
"title": "List a comment thread replying to a top level comment",
|
|
"curl": "curl -d'{\"method\": \"comment_list\", \"params\": {\"claim_id\": \"fe7ee643b50b724f6029f6edfe90d67b5512b3ae\", \"parent_id\": \"34ffe236decc147c7c0c7e0c24c2e5380a312c1084e6ed7bb2c3332a89e95cbf\", \"include_replies\": false, \"skip_validation\": false, \"is_channel_signature_valid\": false, \"visible\": false, \"hidden\": false}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet comment list fe7ee643b50b724f6029f6edfe90d67b5512b3ae --parent_id=34ffe236decc147c7c0c7e0c24c2e5380a312c1084e6ed7bb2c3332a89e95cbf",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"comment_list\", \"params\": {\"claim_id\": \"fe7ee643b50b724f6029f6edfe90d67b5512b3ae\", \"parent_id\": \"34ffe236decc147c7c0c7e0c24c2e5380a312c1084e6ed7bb2c3332a89e95cbf\", \"include_replies\": false, \"skip_validation\": false, \"is_channel_signature_valid\": false, \"visible\": false, \"hidden\": false}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"has_hidden_comments\": false,\n \"page\": 1,\n \"page_size\": 50,\n \"total_items\": 0,\n \"total_pages\": 0\n }\n}"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "comment_pin",
|
|
"description": "Pin a comment published to a claim you control.",
|
|
"arguments": [
|
|
{
|
|
"name": "comment_id",
|
|
"type": "str",
|
|
"description": "Hash identifying the comment to pin",
|
|
"is_required": true
|
|
},
|
|
{
|
|
"name": "channel_id",
|
|
"type": "str",
|
|
"description": "The ID of channel owning the commented claim",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "channel_name",
|
|
"type": "str",
|
|
"description": "The name of channel owning the commented claim",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "remove",
|
|
"type": "bool",
|
|
"description": "remove the pin",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "channel_account_id",
|
|
"type": "str",
|
|
"description": "one or more account ids for accounts to look in",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict operation to specific wallet",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": "lists containing the ids comments that are hidden and visible.\n\n {\n \"hidden\": (list) IDs of hidden comments.\n \"visible\": (list) IDs of visible comments.\n }",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "comment_react",
|
|
"description": "Create and associate a reaction emoji with a comment using your channel identity.",
|
|
"arguments": [
|
|
{
|
|
"name": "comment_ids",
|
|
"type": "str",
|
|
"description": "one or more comment id reacted to, comma delimited",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "channel_id",
|
|
"type": "str",
|
|
"description": "The ID of channel reacting",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "channel_name",
|
|
"type": "str",
|
|
"description": "The name of the channel reacting",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict operation to specific wallet",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "channel_account_id",
|
|
"type": "str",
|
|
"description": "one or more account ids for accounts to look in",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "react_type",
|
|
"type": "str",
|
|
"description": "name of reaction type",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "remove",
|
|
"type": "bool",
|
|
"description": "remove specified react_type",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "clear_types",
|
|
"type": "str",
|
|
"description": "types to clear when adding another type",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": "(dict) Reaction object if successfully made, (None) otherwise\n {\n \"Reactions\": {\n <comment_id>: {\n <reaction_type>: (int) Count for this reaction\n ...\n }\n }",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "comment_react_list",
|
|
"description": "List reactions emoji with a claim using your channel identity.",
|
|
"arguments": [
|
|
{
|
|
"name": "comment_ids",
|
|
"type": "str",
|
|
"description": "The comment ids reacted to, comma delimited",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "channel_id",
|
|
"type": "str",
|
|
"description": "The ID of channel reacting",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "channel_name",
|
|
"type": "str",
|
|
"description": "The name of the channel reacting",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict operation to specific wallet",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "react_types",
|
|
"type": "str",
|
|
"description": "comma delimited reaction types",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": "(dict) Comment object if successfully made, (None) otherwise\n {\n \"my_reactions\": {\n <comment_id>: {\n <reaction_type>: (int) Count for this reaction type\n ...\n }\n }\n \"other_reactions\": {\n <comment_id>: {\n <reaction_type>: (int) Count for this reaction type\n ...\n }\n }\n }",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "comment_update",
|
|
"description": "Edit a comment published as one of your channels.",
|
|
"arguments": [
|
|
{
|
|
"name": "comment",
|
|
"type": "str",
|
|
"description": "New comment replacing the old one",
|
|
"is_required": true
|
|
},
|
|
{
|
|
"name": "comment_id",
|
|
"type": "str",
|
|
"description": "Hash identifying the comment to edit",
|
|
"is_required": true
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict operation to specific wallet",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": "(dict) Comment object if edit was successful, (None) otherwise\n {\n \"comment\": (str) The actual string as inputted by the user,\n \"comment_id\": (str) The Comment's unique identifier,\n \"claim_id\": (str) The claim commented on,\n \"channel_name\": (str) Name of the channel this was posted under, prepended with a '@',\n \"channel_id\": (str) The Channel Claim ID that this comment was posted under,\n \"signature\": (str) The signature of the comment,\n \"signing_ts\": (str) Timestamp used to sign the most recent signature,\n \"channel_url\": (str) Channel's URI in the ClaimTrie,\n \"is_pinned\": (boolean) Channel owner has pinned this comment,\n \"parent_id\": (str) Comment this is replying to, (None) if this is the root,\n \"timestamp\": (int) The time at which comment was entered into the server at, in nanoseconds.\n }",
|
|
"examples": [
|
|
{
|
|
"title": "Edit the contents of a comment",
|
|
"curl": "curl -d'{\"method\": \"comment_update\", \"params\": {\"comment\": \"Where there was once sasquatch, there is not\", \"comment_id\": \"34ffe236decc147c7c0c7e0c24c2e5380a312c1084e6ed7bb2c3332a89e95cbf\"}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet comment update Where there was once sasquatch, there is not --comment_id=34ffe236decc147c7c0c7e0c24c2e5380a312c1084e6ed7bb2c3332a89e95cbf",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"comment_update\", \"params\": {\"comment\": \"Where there was once sasquatch, there is not\", \"comment_id\": \"34ffe236decc147c7c0c7e0c24c2e5380a312c1084e6ed7bb2c3332a89e95cbf\"}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"error\": {\n \"code\": -32000,\n \"data\": null,\n \"message\": \"could not get claim from sdk with claim id 5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\"\n },\n \"id\": 1,\n \"jsonrpc\": \"2.0\"\n }\n}"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"file": {
|
|
"doc": "File management.",
|
|
"commands": [
|
|
{
|
|
"name": "file_delete",
|
|
"description": "Delete a LBRY file",
|
|
"arguments": [
|
|
{
|
|
"name": "delete_from_download_dir",
|
|
"type": "bool",
|
|
"description": "delete file from download directory, instead of just deleting blobs",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "delete_all",
|
|
"type": "bool",
|
|
"description": "if there are multiple matching files, allow the deletion of multiple files. Otherwise do not delete anything.",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "sd_hash",
|
|
"type": "str",
|
|
"description": "delete by file sd hash",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "file_name",
|
|
"type": "str",
|
|
"description": "delete by file name in downloads folder",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "stream_hash",
|
|
"type": "str",
|
|
"description": "delete by file stream hash",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "rowid",
|
|
"type": "int",
|
|
"description": "delete by file row id",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "claim_id",
|
|
"type": "str",
|
|
"description": "delete by file claim id",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "txid",
|
|
"type": "str",
|
|
"description": "delete by file claim txid",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "nout",
|
|
"type": "int",
|
|
"description": "delete by file claim nout",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "claim_name",
|
|
"type": "str",
|
|
"description": "delete by file claim name",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "channel_claim_id",
|
|
"type": "str",
|
|
"description": "delete by file channel claim id",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "channel_name",
|
|
"type": "str",
|
|
"description": "delete by file channel claim name",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": "(bool) true if deletion was successful",
|
|
"examples": [
|
|
{
|
|
"title": "Delete a file",
|
|
"curl": "curl -d'{\"method\": \"file_delete\", \"params\": {\"delete_from_download_dir\": false, \"delete_all\": false, \"claim_id\": \"fe7ee643b50b724f6029f6edfe90d67b5512b3ae\"}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet file delete --claim_id=\"fe7ee643b50b724f6029f6edfe90d67b5512b3ae\"",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"file_delete\", \"params\": {\"delete_from_download_dir\": false, \"delete_all\": false, \"claim_id\": \"fe7ee643b50b724f6029f6edfe90d67b5512b3ae\"}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": true\n}"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "file_list",
|
|
"description": "List files limited by optional filters",
|
|
"arguments": [
|
|
{
|
|
"name": "sd_hash",
|
|
"type": "str",
|
|
"description": "get file with matching sd hash",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "file_name",
|
|
"type": "str",
|
|
"description": "get file with matching file name in the downloads folder",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "stream_hash",
|
|
"type": "str",
|
|
"description": "get file with matching stream hash",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "rowid",
|
|
"type": "int",
|
|
"description": "get file with matching row id",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "added_on",
|
|
"type": "int",
|
|
"description": "get file with matching time of insertion",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "claim_id",
|
|
"type": "str",
|
|
"description": "get file with matching claim id(s)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "outpoint",
|
|
"type": "str",
|
|
"description": "get file with matching claim outpoint(s)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "txid",
|
|
"type": "str",
|
|
"description": "get file with matching claim txid",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "nout",
|
|
"type": "int",
|
|
"description": "get file with matching claim nout",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "channel_claim_id",
|
|
"type": "str",
|
|
"description": "get file with matching channel claim id(s)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "channel_name",
|
|
"type": "str",
|
|
"description": "get file with matching channel name",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "claim_name",
|
|
"type": "str",
|
|
"description": "get file with matching claim name",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "blobs_in_stream<blobs_in_stream>",
|
|
"type": "int",
|
|
"description": "get file with matching blobs in stream",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "download_path",
|
|
"type": "str",
|
|
"description": "get file with matching download path",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "uploading_to_reflector",
|
|
"type": "bool",
|
|
"description": "get files currently uploading to reflector",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "is_fully_reflected",
|
|
"type": "bool",
|
|
"description": "get files that have been uploaded to reflector",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "status",
|
|
"type": "str",
|
|
"description": "match by status, ( running | finished | stopped )",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "completed",
|
|
"type": "bool",
|
|
"description": "match only completed",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "blobs_remaining",
|
|
"type": "int",
|
|
"description": "amount of remaining blobs to download",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "sort",
|
|
"type": "str",
|
|
"description": "field to sort by (one of the above filter fields)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "comparison",
|
|
"type": "str",
|
|
"description": "logical comparison, (eq | ne | g | ge | l | le | in)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "page",
|
|
"type": "int",
|
|
"description": "page to return during paginating",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "page_size",
|
|
"type": "int",
|
|
"description": "number of items on page during pagination",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "add purchase receipts from this wallet",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": " {\n \"page\": \"Page number of the current items.\",\n \"page_size\": \"Number of items to show on a page.\",\n \"total_pages\": \"Total number of pages.\",\n \"total_items\": \"Total number of items.\",\n \"items\": [\n {\n \"streaming_url\": \"(str) url to stream the file using range requests\",\n \"completed\": \"(bool) true if download is completed\",\n \"file_name\": \"(str) name of file\",\n \"download_directory\": \"(str) download directory\",\n \"points_paid\": \"(float) credit paid to download file\",\n \"stopped\": \"(bool) true if download is stopped\",\n \"stream_hash\": \"(str) stream hash of file\",\n \"stream_name\": \"(str) stream name\",\n \"suggested_file_name\": \"(str) suggested file name\",\n \"sd_hash\": \"(str) sd hash of file\",\n \"download_path\": \"(str) download path of file\",\n \"mime_type\": \"(str) mime type of file\",\n \"key\": \"(str) key attached to file\",\n \"total_bytes_lower_bound\": \"(int) lower bound file size in bytes\",\n \"total_bytes\": \"(int) file upper bound size in bytes\",\n \"written_bytes\": \"(int) written size in bytes\",\n \"blobs_completed\": \"(int) number of fully downloaded blobs\",\n \"blobs_in_stream\": \"(int) total blobs on stream\",\n \"blobs_remaining\": \"(int) total blobs remaining to download\",\n \"status\": \"(str) downloader status\",\n \"claim_id\": \"(str) None if claim is not found else the claim id\",\n \"txid\": \"(str) None if claim is not found else the transaction id\",\n \"nout\": \"(int) None if claim is not found else the transaction output index\",\n \"outpoint\": \"(str) None if claim is not found else the tx and output\",\n \"metadata\": \"(dict) None if claim is not found else the claim metadata\",\n \"channel_claim_id\": \"(str) None if claim is not found or not signed\",\n \"channel_name\": \"(str) None if claim is not found or not signed\",\n \"claim_name\": \"(str) None if claim is not found else the claim name\",\n \"reflector_progress\": \"(int) reflector upload progress, 0 to 100\",\n \"uploading_to_reflector\": \"(bool) set to True when currently uploading to reflector\"\n }\n ]\n }",
|
|
"examples": [
|
|
{
|
|
"title": "List local files",
|
|
"curl": "curl -d'{\"method\": \"file_list\", \"params\": {\"reverse\": false}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet file list",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"file_list\", \"params\": {\"reverse\": false}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"items\": [\n {\n \"added_on\": null,\n \"blobs_completed\": 1,\n \"blobs_in_stream\": 1,\n \"blobs_remaining\": 0,\n \"channel_claim_id\": \"5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"channel_name\": \"@channel\",\n \"claim_id\": \"fe7ee643b50b724f6029f6edfe90d67b5512b3ae\",\n \"claim_name\": \"astream\",\n \"completed\": true,\n \"confirmations\": -1,\n \"content_fee\": null,\n \"download_directory\": null,\n \"download_path\": null,\n \"file_name\": null,\n \"height\": -1,\n \"is_fully_reflected\": true,\n \"key\": \"7acc8b9eac8e533c57b933928ab6fad0\",\n \"metadata\": {\n \"source\": {\n \"hash\": \"fdbd8e75a67f29f701a4e040385e2e23986303ea10239211af907fcbb83578b3e417cb71ce646efd0819dd8c088de1bd\",\n \"media_type\": \"application/octet-stream\",\n \"name\": \"tmpk0n0x2sb\",\n \"sd_hash\": \"d40576a4f0f745a868fafad794b3c5e1299cac415a911e55f6eef4395f524b63a649df4c8a75602ea1731a3c5d138b8d\",\n \"size\": \"11\"\n },\n \"stream_type\": \"binary\"\n },\n \"mime_type\": \"application/octet-stream\",\n \"nout\": 0,\n \"outpoint\": \"c620b71698533d88efa10c80d79a30b74464214cb0d893ec5ab4ec1c37d1676e:0\",\n \"points_paid\": 0.0,\n \"protobuf\": \"01f2d6950adda2502b543f042e4e8496b63a2bc95d1391e6159e2874bf75624f77339a61abf38b4da3237a5a52ad92aece2cefae8742c427064051fadb0dcfcc8f957b190341110ce64b8fd3f5cc874e16db11cbdc0a90010a8d010a30fdbd8e75a67f29f701a4e040385e2e23986303ea10239211af907fcbb83578b3e417cb71ce646efd0819dd8c088de1bd120b746d706b306e3078327362180b22186170706c69636174696f6e2f6f637465742d73747265616d3230d40576a4f0f745a868fafad794b3c5e1299cac415a911e55f6eef4395f524b63a649df4c8a75602ea1731a3c5d138b8d\",\n \"purchase_receipt\": null,\n \"reflector_progress\": 100,\n \"sd_hash\": \"d40576a4f0f745a868fafad794b3c5e1299cac415a911e55f6eef4395f524b63a649df4c8a75602ea1731a3c5d138b8d\",\n \"status\": \"finished\",\n \"stopped\": true,\n \"stream_hash\": \"6b8f6829a8820cd430d23b3de7dd67ad77a11d912b04ac5577014d51af877a0c3a094e8d3d9bc2ae6b2c13c2ea44e477\",\n \"stream_name\": \"tmpk0n0x2sb\",\n \"streaming_url\": \"http://localhost:5280/stream/d40576a4f0f745a868fafad794b3c5e1299cac415a911e55f6eef4395f524b63a649df4c8a75602ea1731a3c5d138b8d\",\n \"suggested_file_name\": \"tmpk0n0x2sb\",\n \"timestamp\": null,\n \"total_bytes\": 16,\n \"total_bytes_lower_bound\": 0,\n \"txid\": \"c620b71698533d88efa10c80d79a30b74464214cb0d893ec5ab4ec1c37d1676e\",\n \"uploading_to_reflector\": false,\n \"written_bytes\": 0\n },\n {\n \"added_on\": null,\n \"blobs_completed\": 1,\n \"blobs_in_stream\": 1,\n \"blobs_remaining\": 0,\n \"channel_claim_id\": \"5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"channel_name\": \"@channel\",\n \"claim_id\": \"dca7d8cee4b0dca9ac27d279bce24163b34d3237\",\n \"claim_name\": \"blank-image\",\n \"completed\": false,\n \"confirmations\": -1,\n \"content_fee\": null,\n \"download_directory\": null,\n \"download_path\": null,\n \"file_name\": null,\n \"height\": -1,\n \"is_fully_reflected\": true,\n \"key\": \"a3f6d1b054670be4d383c657da6e56cd\",\n \"metadata\": {\n \"author\": \"Picaso\",\n \"description\": \"A blank PNG that is 5x7.\",\n \"fee\": {\n \"address\": \"msnpXocjCvdA7rj6Pnn8v1NTxaHMXcAwJ2\",\n \"amount\": \"0.3\",\n \"currency\": \"LBC\"\n },\n \"image\": {\n \"height\": 7,\n \"width\": 5\n },\n \"languages\": [\n \"en\"\n ],\n \"license\": \"Public Domain\",\n \"license_url\": \"http://public-domain.org\",\n \"locations\": [\n {\n \"city\": \"Manchester\",\n \"country\": \"US\",\n \"state\": \"NH\"\n }\n ],\n \"release_time\": \"1602862432\",\n \"source\": {\n \"hash\": \"6c7df435d412c603390f593ef658c199817c7830ba3f16b7eadd8f99fa50e85dbd0d2b3dc61eadc33fe096e3872d1545\",\n \"media_type\": \"image/png\",\n \"name\": \"tmpej_krqnp.png\",\n \"sd_hash\": \"f71fb71a3ddd6bd2ce60c6941c2f9faf5317510bf7ea65d56286fa17066405522ba4fc4880d0982c7cfce84375bf8507\",\n \"size\": \"99\"\n },\n \"stream_type\": \"image\",\n \"tags\": [\n \"blank\",\n \"art\"\n ],\n \"thumbnail\": {\n \"url\": \"http://smallmedia.com/thumbnail.jpg\"\n },\n \"title\": \"Blank Image\"\n },\n \"mime_type\": \"image/png\",\n \"nout\": 0,\n \"outpoint\": \"7887c6a4ad30222bd6a68482fae36c3532e7f6720e21e202799c2c0421fac2b5:0\",\n \"points_paid\": 0.0,\n \"protobuf\": \"01f2d6950adda2502b543f042e4e8496b63a2bc95d8a307fd753f2435d4cdec111e0f36d3a883763fb9a1e37df849fc8277afe984e31cd3864ff9016437012b5053ddfb5e43ea03d565a1a57b2effb45b87f3c4bb50ae6010a82010a306c7df435d412c603390f593ef658c199817c7830ba3f16b7eadd8f99fa50e85dbd0d2b3dc61eadc33fe096e3872d1545120f746d70656a5f6b72716e702e706e6718632209696d6167652f706e673230f71fb71a3ddd6bd2ce60c6941c2f9faf5317510bf7ea65d56286fa17066405522ba4fc4880d0982c7cfce84375bf8507120650696361736f1a0d5075626c696320446f6d61696e2218687474703a2f2f7075626c69632d646f6d61696e2e6f726728e0faa6fc053222080112196f86a1af441ae42e3c56d3592fbcb2e63aee63817b81bc72cb188087a70e520408051007420b426c616e6b20496d6167654a184120626c616e6b20504e472074686174206973203578372e52252a23687474703a2f2f736d616c6c6d656469612e636f6d2f7468756d626e61696c2e6a70675a05626c616e6b5a03617274620208016a1308ec0112024e481a0a4d616e63686573746572\",\n \"purchase_receipt\": null,\n \"reflector_progress\": 100,\n \"sd_hash\": \"f71fb71a3ddd6bd2ce60c6941c2f9faf5317510bf7ea65d56286fa17066405522ba4fc4880d0982c7cfce84375bf8507\",\n \"status\": \"finished\",\n \"stopped\": true,\n \"stream_hash\": \"33c51b619905429a6bd8568e46eb680846c3836db0451e9ed9c35829cf1f5ab7f28e8aea8dd7f0351f7c77e9a250cf28\",\n \"stream_name\": \"tmpej_krqnp.png\",\n \"streaming_url\": \"http://localhost:5280/stream/f71fb71a3ddd6bd2ce60c6941c2f9faf5317510bf7ea65d56286fa17066405522ba4fc4880d0982c7cfce84375bf8507\",\n \"suggested_file_name\": \"tmpej_krqnp.png\",\n \"timestamp\": null,\n \"total_bytes\": 112,\n \"total_bytes_lower_bound\": 96,\n \"txid\": \"7887c6a4ad30222bd6a68482fae36c3532e7f6720e21e202799c2c0421fac2b5\",\n \"uploading_to_reflector\": false,\n \"written_bytes\": 0\n }\n ],\n \"page\": 1,\n \"page_size\": 20,\n \"total_items\": 2,\n \"total_pages\": 1\n }\n}"
|
|
},
|
|
{
|
|
"title": "List files matching a parameter",
|
|
"curl": "curl -d'{\"method\": \"file_list\", \"params\": {\"claim_id\": \"fe7ee643b50b724f6029f6edfe90d67b5512b3ae\", \"reverse\": false}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet file list --claim_id=\"fe7ee643b50b724f6029f6edfe90d67b5512b3ae\"",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"file_list\", \"params\": {\"claim_id\": \"fe7ee643b50b724f6029f6edfe90d67b5512b3ae\", \"reverse\": false}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"items\": [\n {\n \"added_on\": null,\n \"blobs_completed\": 1,\n \"blobs_in_stream\": 1,\n \"blobs_remaining\": 0,\n \"channel_claim_id\": \"5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"channel_name\": \"@channel\",\n \"claim_id\": \"fe7ee643b50b724f6029f6edfe90d67b5512b3ae\",\n \"claim_name\": \"astream\",\n \"completed\": true,\n \"confirmations\": 3,\n \"content_fee\": null,\n \"download_directory\": null,\n \"download_path\": null,\n \"file_name\": null,\n \"height\": 214,\n \"is_fully_reflected\": true,\n \"key\": \"7acc8b9eac8e533c57b933928ab6fad0\",\n \"metadata\": {\n \"source\": {\n \"hash\": \"fdbd8e75a67f29f701a4e040385e2e23986303ea10239211af907fcbb83578b3e417cb71ce646efd0819dd8c088de1bd\",\n \"media_type\": \"application/octet-stream\",\n \"name\": \"tmpk0n0x2sb\",\n \"sd_hash\": \"d40576a4f0f745a868fafad794b3c5e1299cac415a911e55f6eef4395f524b63a649df4c8a75602ea1731a3c5d138b8d\",\n \"size\": \"11\"\n },\n \"stream_type\": \"binary\"\n },\n \"mime_type\": \"application/octet-stream\",\n \"nout\": 0,\n \"outpoint\": \"c620b71698533d88efa10c80d79a30b74464214cb0d893ec5ab4ec1c37d1676e:0\",\n \"points_paid\": 0.0,\n \"protobuf\": \"01f2d6950adda2502b543f042e4e8496b63a2bc95d1391e6159e2874bf75624f77339a61abf38b4da3237a5a52ad92aece2cefae8742c427064051fadb0dcfcc8f957b190341110ce64b8fd3f5cc874e16db11cbdc0a90010a8d010a30fdbd8e75a67f29f701a4e040385e2e23986303ea10239211af907fcbb83578b3e417cb71ce646efd0819dd8c088de1bd120b746d706b306e3078327362180b22186170706c69636174696f6e2f6f637465742d73747265616d3230d40576a4f0f745a868fafad794b3c5e1299cac415a911e55f6eef4395f524b63a649df4c8a75602ea1731a3c5d138b8d\",\n \"purchase_receipt\": null,\n \"reflector_progress\": 100,\n \"sd_hash\": \"d40576a4f0f745a868fafad794b3c5e1299cac415a911e55f6eef4395f524b63a649df4c8a75602ea1731a3c5d138b8d\",\n \"status\": \"finished\",\n \"stopped\": true,\n \"stream_hash\": \"6b8f6829a8820cd430d23b3de7dd67ad77a11d912b04ac5577014d51af877a0c3a094e8d3d9bc2ae6b2c13c2ea44e477\",\n \"stream_name\": \"tmpk0n0x2sb\",\n \"streaming_url\": \"http://localhost:5280/stream/d40576a4f0f745a868fafad794b3c5e1299cac415a911e55f6eef4395f524b63a649df4c8a75602ea1731a3c5d138b8d\",\n \"suggested_file_name\": \"tmpk0n0x2sb\",\n \"timestamp\": 1602862457,\n \"total_bytes\": 16,\n \"total_bytes_lower_bound\": 0,\n \"txid\": \"c620b71698533d88efa10c80d79a30b74464214cb0d893ec5ab4ec1c37d1676e\",\n \"uploading_to_reflector\": false,\n \"written_bytes\": 0\n }\n ],\n \"page\": 1,\n \"page_size\": 20,\n \"total_items\": 1,\n \"total_pages\": 1\n }\n}"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "file_reflect",
|
|
"description": "Reflect all the blobs in a file matching the filter criteria",
|
|
"arguments": [
|
|
{
|
|
"name": "sd_hash",
|
|
"type": "str",
|
|
"description": "get file with matching sd hash",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "file_name",
|
|
"type": "str",
|
|
"description": "get file with matching file name in the downloads folder",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "stream_hash",
|
|
"type": "str",
|
|
"description": "get file with matching stream hash",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "rowid",
|
|
"type": "int",
|
|
"description": "get file with matching row id",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "reflector",
|
|
"type": "str",
|
|
"description": "reflector server, ip address or url by default choose a server from the config",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": "(list) list of blobs reflected",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "file_save",
|
|
"description": "Start saving a file to disk.",
|
|
"arguments": [
|
|
{
|
|
"name": "file_name",
|
|
"type": "str",
|
|
"description": "file name to save to",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "download_directory",
|
|
"type": "str",
|
|
"description": "directory to save into",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "sd_hash",
|
|
"type": "str",
|
|
"description": "save file with matching sd hash",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "stream_hash",
|
|
"type": "str",
|
|
"description": "save file with matching stream hash",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "rowid",
|
|
"type": "int",
|
|
"description": "save file with matching row id",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "claim_id",
|
|
"type": "str",
|
|
"description": "save file with matching claim id",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "txid",
|
|
"type": "str",
|
|
"description": "save file with matching claim txid",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "nout",
|
|
"type": "int",
|
|
"description": "save file with matching claim nout",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "claim_name",
|
|
"type": "str",
|
|
"description": "save file with matching claim name",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "channel_claim_id",
|
|
"type": "str",
|
|
"description": "save file with matching channel claim id",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "channel_name",
|
|
"type": "str",
|
|
"description": "save file with matching channel claim name",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": " {\n \"streaming_url\": \"(str) url to stream the file using range requests\",\n \"completed\": \"(bool) true if download is completed\",\n \"file_name\": \"(str) name of file\",\n \"download_directory\": \"(str) download directory\",\n \"points_paid\": \"(float) credit paid to download file\",\n \"stopped\": \"(bool) true if download is stopped\",\n \"stream_hash\": \"(str) stream hash of file\",\n \"stream_name\": \"(str) stream name\",\n \"suggested_file_name\": \"(str) suggested file name\",\n \"sd_hash\": \"(str) sd hash of file\",\n \"download_path\": \"(str) download path of file\",\n \"mime_type\": \"(str) mime type of file\",\n \"key\": \"(str) key attached to file\",\n \"total_bytes_lower_bound\": \"(int) lower bound file size in bytes\",\n \"total_bytes\": \"(int) file upper bound size in bytes\",\n \"written_bytes\": \"(int) written size in bytes\",\n \"blobs_completed\": \"(int) number of fully downloaded blobs\",\n \"blobs_in_stream\": \"(int) total blobs on stream\",\n \"blobs_remaining\": \"(int) total blobs remaining to download\",\n \"status\": \"(str) downloader status\",\n \"claim_id\": \"(str) None if claim is not found else the claim id\",\n \"txid\": \"(str) None if claim is not found else the transaction id\",\n \"nout\": \"(int) None if claim is not found else the transaction output index\",\n \"outpoint\": \"(str) None if claim is not found else the tx and output\",\n \"metadata\": \"(dict) None if claim is not found else the claim metadata\",\n \"channel_claim_id\": \"(str) None if claim is not found or not signed\",\n \"channel_name\": \"(str) None if claim is not found or not signed\",\n \"claim_name\": \"(str) None if claim is not found else the claim name\",\n \"reflector_progress\": \"(int) reflector upload progress, 0 to 100\",\n \"uploading_to_reflector\": \"(bool) set to True when currently uploading to reflector\"\n }",
|
|
"examples": [
|
|
{
|
|
"title": "Save a file to the downloads directory",
|
|
"curl": "curl -d'{\"method\": \"file_save\", \"params\": {\"sd_hash\": \"d40576a4f0f745a868fafad794b3c5e1299cac415a911e55f6eef4395f524b63a649df4c8a75602ea1731a3c5d138b8d\"}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet file save --sd_hash=\"d40576a4f0f745a868fafad794b3c5e1299cac415a911e55f6eef4395f524b63a649df4c8a75602ea1731a3c5d138b8d\"",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"file_save\", \"params\": {\"sd_hash\": \"d40576a4f0f745a868fafad794b3c5e1299cac415a911e55f6eef4395f524b63a649df4c8a75602ea1731a3c5d138b8d\"}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"added_on\": 1602862436,\n \"blobs_completed\": 1,\n \"blobs_in_stream\": 1,\n \"blobs_remaining\": 0,\n \"channel_claim_id\": \"5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"channel_name\": \"@channel\",\n \"claim_id\": \"fe7ee643b50b724f6029f6edfe90d67b5512b3ae\",\n \"claim_name\": \"astream\",\n \"completed\": true,\n \"confirmations\": 3,\n \"content_fee\": null,\n \"download_directory\": \"/tmp/tmpzzr985r8\",\n \"download_path\": \"/tmp/tmpzzr985r8/tmpk0n0x2sb_1\",\n \"file_name\": \"tmpk0n0x2sb_1\",\n \"height\": 214,\n \"is_fully_reflected\": false,\n \"key\": \"7acc8b9eac8e533c57b933928ab6fad0\",\n \"metadata\": {\n \"source\": {\n \"hash\": \"fdbd8e75a67f29f701a4e040385e2e23986303ea10239211af907fcbb83578b3e417cb71ce646efd0819dd8c088de1bd\",\n \"media_type\": \"application/octet-stream\",\n \"name\": \"tmpk0n0x2sb\",\n \"sd_hash\": \"d40576a4f0f745a868fafad794b3c5e1299cac415a911e55f6eef4395f524b63a649df4c8a75602ea1731a3c5d138b8d\",\n \"size\": \"11\"\n },\n \"stream_type\": \"binary\"\n },\n \"mime_type\": \"application/octet-stream\",\n \"nout\": 0,\n \"outpoint\": \"c620b71698533d88efa10c80d79a30b74464214cb0d893ec5ab4ec1c37d1676e:0\",\n \"points_paid\": 0.0,\n \"protobuf\": \"01f2d6950adda2502b543f042e4e8496b63a2bc95d1391e6159e2874bf75624f77339a61abf38b4da3237a5a52ad92aece2cefae8742c427064051fadb0dcfcc8f957b190341110ce64b8fd3f5cc874e16db11cbdc0a90010a8d010a30fdbd8e75a67f29f701a4e040385e2e23986303ea10239211af907fcbb83578b3e417cb71ce646efd0819dd8c088de1bd120b746d706b306e3078327362180b22186170706c69636174696f6e2f6f637465742d73747265616d3230d40576a4f0f745a868fafad794b3c5e1299cac415a911e55f6eef4395f524b63a649df4c8a75602ea1731a3c5d138b8d\",\n \"purchase_receipt\": null,\n \"reflector_progress\": 0,\n \"sd_hash\": \"d40576a4f0f745a868fafad794b3c5e1299cac415a911e55f6eef4395f524b63a649df4c8a75602ea1731a3c5d138b8d\",\n \"status\": \"finished\",\n \"stopped\": true,\n \"stream_hash\": \"6b8f6829a8820cd430d23b3de7dd67ad77a11d912b04ac5577014d51af877a0c3a094e8d3d9bc2ae6b2c13c2ea44e477\",\n \"stream_name\": \"tmpk0n0x2sb\",\n \"streaming_url\": \"http://localhost:5280/stream/d40576a4f0f745a868fafad794b3c5e1299cac415a911e55f6eef4395f524b63a649df4c8a75602ea1731a3c5d138b8d\",\n \"suggested_file_name\": \"tmpk0n0x2sb\",\n \"timestamp\": 1602862457,\n \"total_bytes\": 16,\n \"total_bytes_lower_bound\": 0,\n \"txid\": \"c620b71698533d88efa10c80d79a30b74464214cb0d893ec5ab4ec1c37d1676e\",\n \"uploading_to_reflector\": false,\n \"written_bytes\": 11\n }\n}"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "file_set_status",
|
|
"description": "Start or stop downloading a file",
|
|
"arguments": [
|
|
{
|
|
"name": "status",
|
|
"type": "str",
|
|
"description": "one of \"start\" or \"stop\"",
|
|
"is_required": true
|
|
},
|
|
{
|
|
"name": "sd_hash",
|
|
"type": "str",
|
|
"description": "set status of file with matching sd hash",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "file_name",
|
|
"type": "str",
|
|
"description": "set status of file with matching file name in the downloads folder",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "stream_hash",
|
|
"type": "str",
|
|
"description": "set status of file with matching stream hash",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "rowid",
|
|
"type": "int",
|
|
"description": "set status of file with matching row id",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": "(str) Confirmation message",
|
|
"examples": []
|
|
}
|
|
]
|
|
},
|
|
"peer": {
|
|
"doc": "DHT / Blob Exchange peer commands.",
|
|
"commands": [
|
|
{
|
|
"name": "peer_list",
|
|
"description": "Get peers for blob hash",
|
|
"arguments": [
|
|
{
|
|
"name": "blob_hash",
|
|
"type": "str",
|
|
"description": "find available peers for this blob hash",
|
|
"is_required": true
|
|
},
|
|
{
|
|
"name": "search_bottom_out_limit",
|
|
"type": "int",
|
|
"description": "the number of search probes in a row that don't find any new peers before giving up and returning",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "page",
|
|
"type": "int",
|
|
"description": "page to return during paginating",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "page_size",
|
|
"type": "int",
|
|
"description": "number of items on page during pagination",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": "(list) List of contact dictionaries {'address': <peer ip>, 'udp_port': <dht port>, 'tcp_port': <peer port>,\n 'node_id': <peer node id>}",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "peer_ping",
|
|
"description": "Send a kademlia ping to the specified peer. If address and port are provided the peer is directly pinged,\nif not provided the peer is located first.",
|
|
"arguments": [],
|
|
"returns": "(str) pong, or {'error': <error message>} if an error is encountered",
|
|
"examples": []
|
|
}
|
|
]
|
|
},
|
|
"preference": {
|
|
"doc": "Preferences management.",
|
|
"commands": [
|
|
{
|
|
"name": "preference_get",
|
|
"description": "Get preference value for key or all values if not key is passed in.",
|
|
"arguments": [
|
|
{
|
|
"name": "key",
|
|
"type": "str",
|
|
"description": "key associated with value",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict operation to specific wallet",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": "(dict) Dictionary of preference(s)",
|
|
"examples": [
|
|
{
|
|
"title": "Get preferences",
|
|
"curl": "curl -d'{\"method\": \"preference_get\", \"params\": {}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet preference get",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"preference_get\", \"params\": {}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"theme\": \"dark\"\n }\n}"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "preference_set",
|
|
"description": "Set preferences",
|
|
"arguments": [
|
|
{
|
|
"name": "key",
|
|
"type": "str",
|
|
"description": "key associated with value",
|
|
"is_required": true
|
|
},
|
|
{
|
|
"name": "value",
|
|
"type": "str",
|
|
"description": "key associated with value",
|
|
"is_required": true
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict operation to specific wallet",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": "(dict) Dictionary with key/value of new preference",
|
|
"examples": [
|
|
{
|
|
"title": "Set preference",
|
|
"curl": "curl -d'{\"method\": \"preference_set\", \"params\": {\"key\": \"theme\", \"value\": \"dark\"}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet preference set \"theme\" \"dark\"",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"preference_set\", \"params\": {\"key\": \"theme\", \"value\": \"dark\"}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"theme\": \"dark\"\n }\n}"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"purchase": {
|
|
"doc": "List and make purchases of claims.",
|
|
"commands": [
|
|
{
|
|
"name": "purchase_create",
|
|
"description": "Purchase a claim.",
|
|
"arguments": [
|
|
{
|
|
"name": "claim_id",
|
|
"type": "str",
|
|
"description": "claim id of claim to purchase",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "url",
|
|
"type": "str",
|
|
"description": "lookup claim to purchase by url",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict operation to specific wallet",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "funding_account_ids",
|
|
"type": "list",
|
|
"description": "ids of accounts to fund this transaction",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "allow_duplicate_purchase",
|
|
"type": "bool",
|
|
"description": "allow purchasing claim_id you already own",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "override_max_key_fee",
|
|
"type": "bool",
|
|
"description": "ignore max key fee for this purchase",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "preview",
|
|
"type": "bool",
|
|
"description": "do not broadcast the transaction",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "blocking",
|
|
"type": "bool",
|
|
"description": "wait until transaction is in mempool",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "purchase_list",
|
|
"description": "List my claim purchases.",
|
|
"arguments": [
|
|
{
|
|
"name": "claim_id",
|
|
"type": "str",
|
|
"description": "purchases for specific claim",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "resolve",
|
|
"type": "str",
|
|
"description": "include resolved claim information",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "account_id",
|
|
"type": "str",
|
|
"description": "id of the account to query",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict results to specific wallet",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "page",
|
|
"type": "int",
|
|
"description": "page to return during paginating",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "page_size",
|
|
"type": "int",
|
|
"description": "number of items on page during pagination",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": " {\n \"page\": \"Page number of the current items.\",\n \"page_size\": \"Number of items to show on a page.\",\n \"total_pages\": \"Total number of pages.\",\n \"total_items\": \"Total number of items.\",\n \"items\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ]\n }",
|
|
"examples": []
|
|
}
|
|
]
|
|
},
|
|
"settings": {
|
|
"doc": "Settings management.",
|
|
"commands": [
|
|
{
|
|
"name": "settings_clear",
|
|
"description": "Clear daemon settings",
|
|
"arguments": [],
|
|
"returns": "(dict) Updated dictionary of daemon settings",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "settings_get",
|
|
"description": "Get daemon settings",
|
|
"arguments": [],
|
|
"returns": "(dict) Dictionary of daemon settings\n See ADJUSTABLE_SETTINGS in lbry/conf.py for full list of settings",
|
|
"examples": [
|
|
{
|
|
"title": "Get settings",
|
|
"curl": "curl -d'{\"method\": \"settings_get\", \"params\": {}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet settings get",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"settings_get\", \"params\": {}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"allowed_origin\": \"\",\n \"announce_head_and_sd_only\": true,\n \"api\": \"localhost:5279\",\n \"audio_encoder\": \"aac -b:a 160k\",\n \"blob_download_timeout\": 30.0,\n \"blob_lru_cache_size\": 0,\n \"blockchain_name\": \"lbrycrd_regtest\",\n \"coin_selection_strategy\": \"standard\",\n \"comment_server\": \"https://comments.lbry.com/api/v2\",\n \"components_to_skip\": [\n \"dht\",\n \"upnp\",\n \"hash_announcer\",\n \"peer_protocol_server\"\n ],\n \"concurrent_blob_announcers\": 10,\n \"concurrent_reflector_uploads\": 10,\n \"config\": \"/home/lex/.local/share/lbry/lbrynet/daemon_settings.yml\",\n \"data_dir\": \"/tmp/tmpzzr985r8\",\n \"download_dir\": \"/tmp/tmpzzr985r8\",\n \"download_timeout\": 30.0,\n \"ffmpeg_path\": \"\",\n \"fixed_peer_delay\": 2.0,\n \"fixed_peers\": [\n [\n \"127.0.0.1\",\n 5567\n ]\n ],\n \"known_dht_nodes\": [],\n \"lbryum_servers\": [\n [\n \"127.0.0.1\",\n 50001\n ]\n ],\n \"max_connections_per_download\": 4,\n \"max_key_fee\": {\n \"amount\": 50.0,\n \"currency\": \"USD\"\n },\n \"max_wallet_server_fee\": \"0.0\",\n \"network_interface\": \"0.0.0.0\",\n \"node_rpc_timeout\": 5.0,\n \"peer_connect_timeout\": 3.0,\n \"prometheus_port\": 0,\n \"reflect_streams\": true,\n \"reflector_servers\": [\n [\n \"127.0.0.1\",\n 5566\n ]\n ],\n \"save_blobs\": true,\n \"save_files\": true,\n \"save_resolved_claims\": true,\n \"share_usage_data\": false,\n \"split_buckets_under_index\": 1,\n \"streaming_get\": true,\n \"streaming_server\": \"localhost:5280\",\n \"tcp_port\": 3333,\n \"track_bandwidth\": true,\n \"transaction_cache_size\": 100000,\n \"udp_port\": 4444,\n \"use_upnp\": false,\n \"video_bitrate_maximum\": 5000000,\n \"video_encoder\": \"libx264 -crf 24 -preset faster -pix_fmt yuv420p\",\n \"video_scaler\": \"-vf \\\"scale=if(gte(iw\\\\,ih)\\\\,min(1920\\\\,iw)\\\\,-2):if(lt(iw\\\\,ih)\\\\,min(1920\\\\,ih)\\\\,-2)\\\" -maxrate 5500K -bufsize 5000K\",\n \"volume_analysis_time\": 240,\n \"volume_filter\": \"\",\n \"wallet_dir\": \"/tmp/tmpzzr985r8\",\n \"wallets\": [\n \"default_wallet\"\n ]\n }\n}"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "settings_set",
|
|
"description": "Set daemon settings",
|
|
"arguments": [],
|
|
"returns": "(dict) Updated dictionary of daemon settings",
|
|
"examples": [
|
|
{
|
|
"title": "Set settings",
|
|
"curl": "curl -d'{\"method\": \"settings_set\", \"params\": {\"key\": \"tcp_port\", \"value\": 99}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet settings set \"tcp_port\" 99",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"settings_set\", \"params\": {\"key\": \"tcp_port\", \"value\": 99}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"tcp_port\": 99\n }\n}"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"stream": {
|
|
"doc": "Create, update, abandon, list and inspect your stream claims.",
|
|
"commands": [
|
|
{
|
|
"name": "stream_abandon",
|
|
"description": "Abandon one of my stream claims.",
|
|
"arguments": [
|
|
{
|
|
"name": "claim_id",
|
|
"type": "str",
|
|
"description": "claim_id of the claim to abandon",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "txid",
|
|
"type": "str",
|
|
"description": "txid of the claim to abandon",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "nout",
|
|
"type": "int",
|
|
"description": "nout of the claim to abandon",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "account_id",
|
|
"type": "str",
|
|
"description": "id of the account to use",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict operation to specific wallet",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "preview",
|
|
"type": "bool",
|
|
"description": "do not broadcast the transaction",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "blocking",
|
|
"type": "bool",
|
|
"description": "wait until abandon is in mempool",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }",
|
|
"examples": [
|
|
{
|
|
"title": "Abandon a stream claim",
|
|
"curl": "curl -d'{\"method\": \"stream_abandon\", \"params\": {\"claim_id\": \"fe7ee643b50b724f6029f6edfe90d67b5512b3ae\", \"preview\": false, \"blocking\": false}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet stream abandon fe7ee643b50b724f6029f6edfe90d67b5512b3ae",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"stream_abandon\", \"params\": {\"claim_id\": \"fe7ee643b50b724f6029f6edfe90d67b5512b3ae\", \"preview\": false, \"blocking\": false}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"height\": -2,\n \"hex\": \"01000000016e67d1371cecb45aec93d8b04c216444b7309ad7800ca1ef883d539816b720c6000000006a47304402201a739f6404a0d2b3c7e6f37167b0b8b7d334cf6921df2a0e957f0fdf28810d0f02201738ca4c8a0406a2a1cf6e3a2f1edb3c9696c5e0dc3a2a3f262b7528446895b20121021ef1cb2d0e5f2d4afebf3f9a2c51b78d55a2fa584070831c33a540f7900b7d27ffffffff0134b7f505000000001976a9145013cace93019f49485a11c39bf6c22d246d5f6d88ac00000000\",\n \"inputs\": [\n {\n \"address\": \"mzNC6CMEetGVw6QDGChpUM3HfV7DpWGZ7R\",\n \"amount\": \"1.0\",\n \"claim_id\": \"fe7ee643b50b724f6029f6edfe90d67b5512b3ae\",\n \"claim_op\": \"update\",\n \"confirmations\": 3,\n \"height\": 214,\n \"meta\": {},\n \"name\": \"astream\",\n \"normalized_name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"lbry://astream#fe7ee643b50b724f6029f6edfe90d67b5512b3ae\",\n \"timestamp\": 1602862457,\n \"txid\": \"c620b71698533d88efa10c80d79a30b74464214cb0d893ec5ab4ec1c37d1676e\",\n \"type\": \"claim\",\n \"value\": {\n \"source\": {\n \"hash\": \"fdbd8e75a67f29f701a4e040385e2e23986303ea10239211af907fcbb83578b3e417cb71ce646efd0819dd8c088de1bd\",\n \"media_type\": \"application/octet-stream\",\n \"name\": \"tmpk0n0x2sb\",\n \"sd_hash\": \"d40576a4f0f745a868fafad794b3c5e1299cac415a911e55f6eef4395f524b63a649df4c8a75602ea1731a3c5d138b8d\",\n \"size\": \"11\"\n },\n \"stream_type\": \"binary\"\n },\n \"value_type\": \"stream\"\n }\n ],\n \"outputs\": [\n {\n \"address\": \"mnpN4b33fqF5jCN4yRJU1ts5ZSvfBRDWcX\",\n \"amount\": \"0.999893\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 0,\n \"timestamp\": null,\n \"txid\": \"3ee7e6c2c25b891aa56475edbe8583d6e8e324692890ef8eb013c6506879a408\",\n \"type\": \"payment\"\n }\n ],\n \"total_fee\": \"0.000107\",\n \"total_input\": \"1.0\",\n \"total_output\": \"0.999893\",\n \"txid\": \"3ee7e6c2c25b891aa56475edbe8583d6e8e324692890ef8eb013c6506879a408\"\n }\n}"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "stream_cost_estimate",
|
|
"description": "Get estimated cost for a lbry stream",
|
|
"arguments": [
|
|
{
|
|
"name": "uri",
|
|
"type": "str",
|
|
"description": "uri to use",
|
|
"is_required": true
|
|
}
|
|
],
|
|
"returns": "(float) Estimated cost in lbry credits, returns None if uri is not\n resolvable",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "stream_create",
|
|
"description": "Make a new stream claim and announce the associated file to lbrynet.",
|
|
"arguments": [
|
|
{
|
|
"name": "name",
|
|
"type": "str",
|
|
"description": "name of the content (can only consist of a-z A-Z 0-9 and -(dash))",
|
|
"is_required": true
|
|
},
|
|
{
|
|
"name": "bid",
|
|
"type": "decimal",
|
|
"description": "amount to back the claim",
|
|
"is_required": true
|
|
},
|
|
{
|
|
"name": "file_path",
|
|
"type": "str",
|
|
"description": "path to file to be associated with name.",
|
|
"is_required": true
|
|
},
|
|
{
|
|
"name": "validate_file",
|
|
"type": "bool",
|
|
"description": "validate that the video container and encodings match common web browser support or that optimization succeeds if specified. FFmpeg is required",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "optimize_file",
|
|
"type": "bool",
|
|
"description": "transcode the video & audio if necessary to ensure common web browser support. FFmpeg is required",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "allow_duplicate_name",
|
|
"type": "bool",
|
|
"description": "create new claim even if one already exists with given name. default: false.",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "fee_currency",
|
|
"type": "string",
|
|
"description": "specify fee currency",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "fee_amount",
|
|
"type": "decimal",
|
|
"description": "content download fee",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "fee_address",
|
|
"type": "str",
|
|
"description": "address where to send fee payments, will use value from --claim_address if not provided",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "title",
|
|
"type": "str",
|
|
"description": "title of the publication",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "description",
|
|
"type": "str",
|
|
"description": "description of the publication",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "author",
|
|
"type": "str",
|
|
"description": "author of the publication. The usage for this field is not the same as for channels. The author field is used to credit an author who is not the publisher and is not represented by the channel. For example, a pdf file of 'The Odyssey' has an author of 'Homer' but may by published to a channel such as '@classics', or to no channel at all",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "tags",
|
|
"type": "list",
|
|
"description": "add content tags",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "languages",
|
|
"type": "list",
|
|
"description": "languages used by the channel, using RFC 5646 format, eg: for English `--languages=en` for Spanish (Spain) `--languages=es-ES` for Spanish (Mexican) `--languages=es-MX` for Chinese (Simplified) `--languages=zh-Hans` for Chinese (Traditional) `--languages=zh-Hant`",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "locations",
|
|
"type": "list",
|
|
"description": "locations relevant to the stream, consisting of 2 letter `country` code and a `state`, `city` and a postal `code` along with a `latitude` and `longitude`. for JSON RPC: pass a dictionary with aforementioned attributes as keys, eg: ... \"locations\": [{'country': 'US', 'state': 'NH'}] ... for command line: pass a colon delimited list with values in the following order: \"COUNTRY:STATE:CITY:CODE:LATITUDE:LONGITUDE\" making sure to include colon for blank values, for example to provide only the city: ... --locations=\"::Manchester\" with all values set: ... --locations=\"US:NH:Manchester:03101:42.990605:-71.460989\" optionally, you can just pass the \"LATITUDE:LONGITUDE\": ... --locations=\"42.990605:-71.460989\" finally, you can also pass JSON string of dictionary on the command line as you would via JSON RPC ... --locations=\"{'country': 'US', 'state': 'NH'}\"",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "license",
|
|
"type": "str",
|
|
"description": "publication license",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "license_url",
|
|
"type": "str",
|
|
"description": "publication license url",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "thumbnail_url",
|
|
"type": "str",
|
|
"description": "thumbnail url",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "release_time",
|
|
"type": "int",
|
|
"description": "original public release of content, seconds since UNIX epoch",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "width",
|
|
"type": "int",
|
|
"description": "image/video width, automatically calculated from media file",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "height",
|
|
"type": "int",
|
|
"description": "image/video height, automatically calculated from media file",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "duration",
|
|
"type": "int",
|
|
"description": "audio/video duration in seconds, automatically calculated",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "channel_id",
|
|
"type": "str",
|
|
"description": "claim id of the publisher channel",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "channel_name",
|
|
"type": "str",
|
|
"description": "name of the publisher channel",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "channel_account_id",
|
|
"type": "str",
|
|
"description": "one or more account ids for accounts to look in for channel certificates, defaults to all accounts.",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "account_id",
|
|
"type": "str",
|
|
"description": "account to use for holding the transaction",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict operation to specific wallet",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "funding_account_ids",
|
|
"type": "list",
|
|
"description": "ids of accounts to fund this transaction",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "claim_address",
|
|
"type": "str",
|
|
"description": "address where the claim is sent to, if not specified it will be determined automatically from the account",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "preview",
|
|
"type": "bool",
|
|
"description": "do not broadcast the transaction",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "blocking",
|
|
"type": "bool",
|
|
"description": "wait until transaction is in mempool",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }",
|
|
"examples": [
|
|
{
|
|
"title": "Create a stream claim without metadata",
|
|
"curl": "curl -d'{\"method\": \"stream_create\", \"params\": {\"name\": \"astream\", \"bid\": \"1.0\", \"file_path\": \"/tmp/tmpk0n0x2sb\", \"validate_file\": false, \"optimize_file\": false, \"tags\": [], \"languages\": [], \"locations\": [], \"channel_account_id\": [], \"funding_account_ids\": [], \"preview\": false, \"blocking\": false}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet stream create astream 1.0 /tmp/tmpk0n0x2sb",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"stream_create\", \"params\": {\"name\": \"astream\", \"bid\": \"1.0\", \"file_path\": \"/tmp/tmpk0n0x2sb\", \"validate_file\": false, \"optimize_file\": false, \"tags\": [], \"languages\": [], \"locations\": [], \"channel_account_id\": [], \"funding_account_ids\": [], \"preview\": false, \"blocking\": false}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"height\": -2,\n \"hex\": \"01000000012946e645885d5cbfaef61db1ee78c0869cb0cb31d94010bc5cd85d1e11a3a160010000006b483045022100c2f28f3469f168c9bae13f8db2d5efa37cb806c3c6130ca4c85d22c49da0d3220220717880093ff7d0142930c2012176cc89667aa82d3b6d3cc8aa79bf4934602ff1012103e475aa118245138c9c60728635f29a02c3f7509332d7a73cf7f50321527e089fffffffff0200e1f50500000000bab5076173747265616d4c94000a90010a8d010a30fdbd8e75a67f29f701a4e040385e2e23986303ea10239211af907fcbb83578b3e417cb71ce646efd0819dd8c088de1bd120b746d706b306e3078327362180b22186170706c69636174696f6e2f6f637465742d73747265616d3230d40576a4f0f745a868fafad794b3c5e1299cac415a911e55f6eef4395f524b63a649df4c8a75602ea1731a3c5d138b8d6d7576a914cec22985383752987fece466729c85a74f17a45588ac38fb9423000000001976a914f84bdf86b89b4754c88e23739b81a59b4d74173988ac00000000\",\n \"inputs\": [\n {\n \"address\": \"mqqsXcxFmcQBN6JFR1hRE4UtDYtDXp1u4f\",\n \"amount\": \"6.983769\",\n \"confirmations\": 4,\n \"height\": 209,\n \"nout\": 1,\n \"timestamp\": 1602862456,\n \"txid\": \"60a1a3111e5dd85cbc1040d931cbb09c86c078eeb11df6aebf5c5d8845e64629\",\n \"type\": \"payment\"\n }\n ],\n \"outputs\": [\n {\n \"address\": \"mzNC6CMEetGVw6QDGChpUM3HfV7DpWGZ7R\",\n \"amount\": \"1.0\",\n \"claim_id\": \"fe7ee643b50b724f6029f6edfe90d67b5512b3ae\",\n \"claim_op\": \"create\",\n \"confirmations\": -2,\n \"height\": -2,\n \"meta\": {},\n \"name\": \"astream\",\n \"normalized_name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"lbry://astream#fe7ee643b50b724f6029f6edfe90d67b5512b3ae\",\n \"timestamp\": null,\n \"txid\": \"6dec60b76943a027438ca3b86aef60f33feded0acf8b5ec3381bf8894cf2d6aa\",\n \"type\": \"claim\",\n \"value\": {\n \"source\": {\n \"hash\": \"fdbd8e75a67f29f701a4e040385e2e23986303ea10239211af907fcbb83578b3e417cb71ce646efd0819dd8c088de1bd\",\n \"media_type\": \"application/octet-stream\",\n \"name\": \"tmpk0n0x2sb\",\n \"sd_hash\": \"d40576a4f0f745a868fafad794b3c5e1299cac415a911e55f6eef4395f524b63a649df4c8a75602ea1731a3c5d138b8d\",\n \"size\": \"11\"\n },\n \"stream_type\": \"binary\"\n },\n \"value_type\": \"stream\"\n },\n {\n \"address\": \"n49pmPPUVED3aiwTfRe75yKpjXBhGCFx4n\",\n \"amount\": \"5.969662\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 1,\n \"timestamp\": null,\n \"txid\": \"6dec60b76943a027438ca3b86aef60f33feded0acf8b5ec3381bf8894cf2d6aa\",\n \"type\": \"payment\"\n }\n ],\n \"total_fee\": \"0.014107\",\n \"total_input\": \"6.983769\",\n \"total_output\": \"6.969662\",\n \"txid\": \"6dec60b76943a027438ca3b86aef60f33feded0acf8b5ec3381bf8894cf2d6aa\"\n }\n}"
|
|
},
|
|
{
|
|
"title": "Create an image stream claim with all metadata and fee",
|
|
"curl": "curl -d'{\"method\": \"stream_create\", \"params\": {\"name\": \"blank-image\", \"bid\": \"1.0\", \"file_path\": \"/tmp/tmpej_krqnp.png\", \"validate_file\": false, \"optimize_file\": false, \"fee_currency\": \"LBC\", \"fee_amount\": \"0.3\", \"title\": \"Blank Image\", \"description\": \"A blank PNG that is 5x7.\", \"author\": \"Picaso\", \"tags\": [\"blank\", \"art\"], \"languages\": [\"en\"], \"locations\": [\"US:NH:Manchester\"], \"license\": \"Public Domain\", \"license_url\": \"http://public-domain.org\", \"thumbnail_url\": \"http://smallmedia.com/thumbnail.jpg\", \"release_time\": 1602862432, \"channel_id\": \"5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\", \"channel_account_id\": [], \"funding_account_ids\": [], \"preview\": false, \"blocking\": false}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet stream create blank-image 1.0 /tmp/tmpej_krqnp.png --tags=blank --tags=art --languages=en --locations=US:NH:Manchester --fee_currency=LBC --fee_amount=0.3 --title=\"Blank Image\" --description=\"A blank PNG that is 5x7.\" --author=Picaso --license=\"Public Domain\" --license_url=http://public-domain.org --thumbnail_url=\"http://smallmedia.com/thumbnail.jpg\" --release_time=1602862432 --channel_id=\"5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\"",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"stream_create\", \"params\": {\"name\": \"blank-image\", \"bid\": \"1.0\", \"file_path\": \"/tmp/tmpej_krqnp.png\", \"validate_file\": false, \"optimize_file\": false, \"fee_currency\": \"LBC\", \"fee_amount\": \"0.3\", \"title\": \"Blank Image\", \"description\": \"A blank PNG that is 5x7.\", \"author\": \"Picaso\", \"tags\": [\"blank\", \"art\"], \"languages\": [\"en\"], \"locations\": [\"US:NH:Manchester\"], \"license\": \"Public Domain\", \"license_url\": \"http://public-domain.org\", \"thumbnail_url\": \"http://smallmedia.com/thumbnail.jpg\", \"release_time\": 1602862432, \"channel_id\": \"5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\", \"channel_account_id\": [], \"funding_account_ids\": [], \"preview\": false, \"blocking\": false}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"height\": -2,\n \"hex\": \"0100000001aad6f24c89f81b38c35e8bcf0aeded3ff360ef6ab8a38c4327a04369b760ec6d010000006a473044022069b670698da195fcbcf94c16d60a145c633ea83d1cb42ef2405b4fdcc28e650a022035d8648a3ee03e2c212c308a2018a5bbb8dcc8412640af2bc865f17ca9083ebb0121025d0514acddc1ed8a9f55fdb651595a9184dd00637c9cb7a9903968ae6aea2c90ffffffff0200e1f50500000000fddc01b50b626c616e6b2d696d6167654db10101f2d6950adda2502b543f042e4e8496b63a2bc95d8a307fd753f2435d4cdec111e0f36d3a883763fb9a1e37df849fc8277afe984e31cd3864ff9016437012b5053ddfb5e43ea03d565a1a57b2effb45b87f3c4bb50ae6010a82010a306c7df435d412c603390f593ef658c199817c7830ba3f16b7eadd8f99fa50e85dbd0d2b3dc61eadc33fe096e3872d1545120f746d70656a5f6b72716e702e706e6718632209696d6167652f706e673230f71fb71a3ddd6bd2ce60c6941c2f9faf5317510bf7ea65d56286fa17066405522ba4fc4880d0982c7cfce84375bf8507120650696361736f1a0d5075626c696320446f6d61696e2218687474703a2f2f7075626c69632d646f6d61696e2e6f726728e0faa6fc053222080112196f86a1af441ae42e3c56d3592fbcb2e63aee63817b81bc72cb188087a70e520408051007420b426c616e6b20496d6167654a184120626c616e6b20504e472074686174206973203578372e52252a23687474703a2f2f736d616c6c6d656469612e636f6d2f7468756d626e61696c2e6a70675a05626c616e6b5a03617274620208016a1308ec0112024e481a0a4d616e636865737465726d7576a91486a1af441ae42e3c56d3592fbcb2e63aee63817b88acac5e7d1d000000001976a9146f1cad0aebad9ea189bde7ed4e3b3d60780a21d888ac00000000\",\n \"inputs\": [\n {\n \"address\": \"n49pmPPUVED3aiwTfRe75yKpjXBhGCFx4n\",\n \"amount\": \"5.969662\",\n \"confirmations\": 2,\n \"height\": 213,\n \"nout\": 1,\n \"timestamp\": 1602862457,\n \"txid\": \"6dec60b76943a027438ca3b86aef60f33feded0acf8b5ec3381bf8894cf2d6aa\",\n \"type\": \"payment\"\n }\n ],\n \"outputs\": [\n {\n \"address\": \"msnpXocjCvdA7rj6Pnn8v1NTxaHMXcAwJ2\",\n \"amount\": \"1.0\",\n \"claim_id\": \"dca7d8cee4b0dca9ac27d279bce24163b34d3237\",\n \"claim_op\": \"create\",\n \"confirmations\": -2,\n \"height\": -2,\n \"is_channel_signature_valid\": true,\n \"meta\": {},\n \"name\": \"blank-image\",\n \"normalized_name\": \"blank-image\",\n \"nout\": 0,\n \"permanent_url\": \"lbry://blank-image#dca7d8cee4b0dca9ac27d279bce24163b34d3237\",\n \"signing_channel\": {\n \"address\": \"mofqoKUmhmPTCoudQRXgjzGSDnCyJvZAZg\",\n \"amount\": \"1.0\",\n \"claim_id\": \"5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"claim_op\": \"update\",\n \"confirmations\": 5,\n \"has_signing_key\": true,\n \"height\": 210,\n \"meta\": {},\n \"name\": \"@channel\",\n \"normalized_name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"lbry://@channel#5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"timestamp\": 1602862456,\n \"txid\": \"3ee8f25ad7bfef1d30e3fce0b212d77b74a495ef1d7635a8be77b96ffbe8e412\",\n \"type\": \"claim\",\n \"value\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a034200049b4cbe0f5275e7b1c170f458af09628ba75401fd95d0205ed9de9037b396f60936d555da2bc8dd09b1804b250f32d1bd07382bd3a4aaa2700b08b137b91f1159\",\n \"public_key_id\": \"mkVrRXQGgjhBaygCP3dNpbmtm5Yohno8q2\",\n \"title\": \"New Channel\"\n },\n \"value_type\": \"channel\"\n },\n \"timestamp\": null,\n \"txid\": \"7887c6a4ad30222bd6a68482fae36c3532e7f6720e21e202799c2c0421fac2b5\",\n \"type\": \"claim\",\n \"value\": {\n \"author\": \"Picaso\",\n \"description\": \"A blank PNG that is 5x7.\",\n \"fee\": {\n \"address\": \"msnpXocjCvdA7rj6Pnn8v1NTxaHMXcAwJ2\",\n \"amount\": \"0.3\",\n \"currency\": \"LBC\"\n },\n \"image\": {\n \"height\": 7,\n \"width\": 5\n },\n \"languages\": [\n \"en\"\n ],\n \"license\": \"Public Domain\",\n \"license_url\": \"http://public-domain.org\",\n \"locations\": [\n {\n \"city\": \"Manchester\",\n \"country\": \"US\",\n \"state\": \"NH\"\n }\n ],\n \"release_time\": \"1602862432\",\n \"source\": {\n \"hash\": \"6c7df435d412c603390f593ef658c199817c7830ba3f16b7eadd8f99fa50e85dbd0d2b3dc61eadc33fe096e3872d1545\",\n \"media_type\": \"image/png\",\n \"name\": \"tmpej_krqnp.png\",\n \"sd_hash\": \"f71fb71a3ddd6bd2ce60c6941c2f9faf5317510bf7ea65d56286fa17066405522ba4fc4880d0982c7cfce84375bf8507\",\n \"size\": \"99\"\n },\n \"stream_type\": \"image\",\n \"tags\": [\n \"blank\",\n \"art\"\n ],\n \"thumbnail\": {\n \"url\": \"http://smallmedia.com/thumbnail.jpg\"\n },\n \"title\": \"Blank Image\"\n },\n \"value_type\": \"stream\"\n },\n {\n \"address\": \"mqeTenbgAseTRfcPJpmSXpUjRMNphrhjGu\",\n \"amount\": \"4.947555\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 1,\n \"timestamp\": null,\n \"txid\": \"7887c6a4ad30222bd6a68482fae36c3532e7f6720e21e202799c2c0421fac2b5\",\n \"type\": \"payment\"\n }\n ],\n \"total_fee\": \"0.022107\",\n \"total_input\": \"5.969662\",\n \"total_output\": \"5.947555\",\n \"txid\": \"7887c6a4ad30222bd6a68482fae36c3532e7f6720e21e202799c2c0421fac2b5\"\n }\n}"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "stream_list",
|
|
"description": "List my stream claims.",
|
|
"arguments": [
|
|
{
|
|
"name": "name",
|
|
"type": "str or list",
|
|
"description": "stream name",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "claim_id",
|
|
"type": "str or list",
|
|
"description": "stream id",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "is_spent",
|
|
"type": "bool",
|
|
"description": "shows previous stream updates and abandons",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "account_id",
|
|
"type": "str",
|
|
"description": "id of the account to query",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict results to specific wallet",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "page",
|
|
"type": "int",
|
|
"description": "page to return during paginating",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "page_size",
|
|
"type": "int",
|
|
"description": "number of items on page during pagination",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "resolve",
|
|
"type": "bool",
|
|
"description": "resolves each stream to provide additional metadata",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "no_totals",
|
|
"type": "bool",
|
|
"description": "do not calculate the total number of pages and items in result set (significant performance boost)",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": " {\n \"page\": \"Page number of the current items.\",\n \"page_size\": \"Number of items to show on a page.\",\n \"total_pages\": \"Total number of pages.\",\n \"total_items\": \"Total number of items.\",\n \"items\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ]\n }",
|
|
"examples": [
|
|
{
|
|
"title": "List all your stream claims",
|
|
"curl": "curl -d'{\"method\": \"stream_list\", \"params\": {\"name\": [], \"claim_id\": [], \"is_spent\": false, \"resolve\": false, \"no_totals\": false}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet stream list",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"stream_list\", \"params\": {\"name\": [], \"claim_id\": [], \"is_spent\": false, \"resolve\": false, \"no_totals\": false}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"items\": [\n {\n \"address\": \"mzNC6CMEetGVw6QDGChpUM3HfV7DpWGZ7R\",\n \"amount\": \"1.0\",\n \"claim_id\": \"fe7ee643b50b724f6029f6edfe90d67b5512b3ae\",\n \"claim_op\": \"update\",\n \"confirmations\": 1,\n \"height\": 214,\n \"is_channel_signature_valid\": true,\n \"is_internal_transfer\": false,\n \"is_my_input\": true,\n \"is_my_output\": true,\n \"is_spent\": false,\n \"meta\": {},\n \"name\": \"astream\",\n \"normalized_name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"lbry://astream#fe7ee643b50b724f6029f6edfe90d67b5512b3ae\",\n \"signing_channel\": {\n \"address\": \"mofqoKUmhmPTCoudQRXgjzGSDnCyJvZAZg\",\n \"amount\": \"1.0\",\n \"claim_id\": \"5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"claim_op\": \"update\",\n \"confirmations\": 5,\n \"has_signing_key\": true,\n \"height\": 210,\n \"meta\": {},\n \"name\": \"@channel\",\n \"normalized_name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"lbry://@channel#5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"timestamp\": 1602862456,\n \"txid\": \"3ee8f25ad7bfef1d30e3fce0b212d77b74a495ef1d7635a8be77b96ffbe8e412\",\n \"type\": \"claim\",\n \"value\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a034200049b4cbe0f5275e7b1c170f458af09628ba75401fd95d0205ed9de9037b396f60936d555da2bc8dd09b1804b250f32d1bd07382bd3a4aaa2700b08b137b91f1159\",\n \"public_key_id\": \"mkVrRXQGgjhBaygCP3dNpbmtm5Yohno8q2\",\n \"title\": \"New Channel\"\n },\n \"value_type\": \"channel\"\n },\n \"timestamp\": 1602862457,\n \"txid\": \"c620b71698533d88efa10c80d79a30b74464214cb0d893ec5ab4ec1c37d1676e\",\n \"type\": \"claim\",\n \"value\": {\n \"source\": {\n \"hash\": \"fdbd8e75a67f29f701a4e040385e2e23986303ea10239211af907fcbb83578b3e417cb71ce646efd0819dd8c088de1bd\",\n \"media_type\": \"application/octet-stream\",\n \"name\": \"tmpk0n0x2sb\",\n \"sd_hash\": \"d40576a4f0f745a868fafad794b3c5e1299cac415a911e55f6eef4395f524b63a649df4c8a75602ea1731a3c5d138b8d\",\n \"size\": \"11\"\n },\n \"stream_type\": \"binary\"\n },\n \"value_type\": \"stream\"\n },\n {\n \"address\": \"mzNC6CMEetGVw6QDGChpUM3HfV7DpWGZ7R\",\n \"amount\": \"1.0\",\n \"claim_id\": \"fe7ee643b50b724f6029f6edfe90d67b5512b3ae\",\n \"claim_op\": \"create\",\n \"confirmations\": 2,\n \"height\": 213,\n \"is_internal_transfer\": false,\n \"is_my_input\": true,\n \"is_my_output\": true,\n \"is_spent\": true,\n \"meta\": {},\n \"name\": \"astream\",\n \"normalized_name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"lbry://astream#fe7ee643b50b724f6029f6edfe90d67b5512b3ae\",\n \"timestamp\": 1602862457,\n \"txid\": \"6dec60b76943a027438ca3b86aef60f33feded0acf8b5ec3381bf8894cf2d6aa\",\n \"type\": \"claim\",\n \"value\": {\n \"source\": {\n \"hash\": \"fdbd8e75a67f29f701a4e040385e2e23986303ea10239211af907fcbb83578b3e417cb71ce646efd0819dd8c088de1bd\",\n \"media_type\": \"application/octet-stream\",\n \"name\": \"tmpk0n0x2sb\",\n \"sd_hash\": \"d40576a4f0f745a868fafad794b3c5e1299cac415a911e55f6eef4395f524b63a649df4c8a75602ea1731a3c5d138b8d\",\n \"size\": \"11\"\n },\n \"stream_type\": \"binary\"\n },\n \"value_type\": \"stream\"\n }\n ],\n \"page\": 1,\n \"page_size\": 20,\n \"total_items\": 2,\n \"total_pages\": 1\n }\n}"
|
|
},
|
|
{
|
|
"title": "Paginate your stream claims",
|
|
"curl": "curl -d'{\"method\": \"stream_list\", \"params\": {\"name\": [], \"claim_id\": [], \"is_spent\": false, \"page\": 1, \"page_size\": 20, \"resolve\": false, \"no_totals\": false}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet stream list --page=1 --page_size=20",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"stream_list\", \"params\": {\"name\": [], \"claim_id\": [], \"is_spent\": false, \"page\": 1, \"page_size\": 20, \"resolve\": false, \"no_totals\": false}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"items\": [\n {\n \"address\": \"mzNC6CMEetGVw6QDGChpUM3HfV7DpWGZ7R\",\n \"amount\": \"1.0\",\n \"claim_id\": \"fe7ee643b50b724f6029f6edfe90d67b5512b3ae\",\n \"claim_op\": \"update\",\n \"confirmations\": 1,\n \"height\": 214,\n \"is_channel_signature_valid\": true,\n \"is_internal_transfer\": false,\n \"is_my_input\": true,\n \"is_my_output\": true,\n \"is_spent\": false,\n \"meta\": {},\n \"name\": \"astream\",\n \"normalized_name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"lbry://astream#fe7ee643b50b724f6029f6edfe90d67b5512b3ae\",\n \"signing_channel\": {\n \"address\": \"mofqoKUmhmPTCoudQRXgjzGSDnCyJvZAZg\",\n \"amount\": \"1.0\",\n \"claim_id\": \"5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"claim_op\": \"update\",\n \"confirmations\": 5,\n \"has_signing_key\": true,\n \"height\": 210,\n \"meta\": {},\n \"name\": \"@channel\",\n \"normalized_name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"lbry://@channel#5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"timestamp\": 1602862456,\n \"txid\": \"3ee8f25ad7bfef1d30e3fce0b212d77b74a495ef1d7635a8be77b96ffbe8e412\",\n \"type\": \"claim\",\n \"value\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a034200049b4cbe0f5275e7b1c170f458af09628ba75401fd95d0205ed9de9037b396f60936d555da2bc8dd09b1804b250f32d1bd07382bd3a4aaa2700b08b137b91f1159\",\n \"public_key_id\": \"mkVrRXQGgjhBaygCP3dNpbmtm5Yohno8q2\",\n \"title\": \"New Channel\"\n },\n \"value_type\": \"channel\"\n },\n \"timestamp\": 1602862457,\n \"txid\": \"c620b71698533d88efa10c80d79a30b74464214cb0d893ec5ab4ec1c37d1676e\",\n \"type\": \"claim\",\n \"value\": {\n \"source\": {\n \"hash\": \"fdbd8e75a67f29f701a4e040385e2e23986303ea10239211af907fcbb83578b3e417cb71ce646efd0819dd8c088de1bd\",\n \"media_type\": \"application/octet-stream\",\n \"name\": \"tmpk0n0x2sb\",\n \"sd_hash\": \"d40576a4f0f745a868fafad794b3c5e1299cac415a911e55f6eef4395f524b63a649df4c8a75602ea1731a3c5d138b8d\",\n \"size\": \"11\"\n },\n \"stream_type\": \"binary\"\n },\n \"value_type\": \"stream\"\n },\n {\n \"address\": \"mzNC6CMEetGVw6QDGChpUM3HfV7DpWGZ7R\",\n \"amount\": \"1.0\",\n \"claim_id\": \"fe7ee643b50b724f6029f6edfe90d67b5512b3ae\",\n \"claim_op\": \"create\",\n \"confirmations\": 2,\n \"height\": 213,\n \"is_internal_transfer\": false,\n \"is_my_input\": true,\n \"is_my_output\": true,\n \"is_spent\": true,\n \"meta\": {},\n \"name\": \"astream\",\n \"normalized_name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"lbry://astream#fe7ee643b50b724f6029f6edfe90d67b5512b3ae\",\n \"timestamp\": 1602862457,\n \"txid\": \"6dec60b76943a027438ca3b86aef60f33feded0acf8b5ec3381bf8894cf2d6aa\",\n \"type\": \"claim\",\n \"value\": {\n \"source\": {\n \"hash\": \"fdbd8e75a67f29f701a4e040385e2e23986303ea10239211af907fcbb83578b3e417cb71ce646efd0819dd8c088de1bd\",\n \"media_type\": \"application/octet-stream\",\n \"name\": \"tmpk0n0x2sb\",\n \"sd_hash\": \"d40576a4f0f745a868fafad794b3c5e1299cac415a911e55f6eef4395f524b63a649df4c8a75602ea1731a3c5d138b8d\",\n \"size\": \"11\"\n },\n \"stream_type\": \"binary\"\n },\n \"value_type\": \"stream\"\n }\n ],\n \"page\": 1,\n \"page_size\": 20,\n \"total_items\": 2,\n \"total_pages\": 1\n }\n}"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "stream_repost",
|
|
"description": "Creates a claim that references an existing stream by its claim id.",
|
|
"arguments": [
|
|
{
|
|
"name": "name",
|
|
"type": "str",
|
|
"description": "name of the content (can only consist of a-z A-Z 0-9 and -(dash))",
|
|
"is_required": true
|
|
},
|
|
{
|
|
"name": "bid",
|
|
"type": "decimal",
|
|
"description": "amount to back the claim",
|
|
"is_required": true
|
|
},
|
|
{
|
|
"name": "claim_id",
|
|
"type": "str",
|
|
"description": "id of the claim being reposted",
|
|
"is_required": true
|
|
},
|
|
{
|
|
"name": "allow_duplicate_name",
|
|
"type": "bool",
|
|
"description": "create new claim even if one already exists with given name. default: false.",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "channel_id",
|
|
"type": "str",
|
|
"description": "claim id of the publisher channel",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "channel_name",
|
|
"type": "str",
|
|
"description": "name of the publisher channel",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "channel_account_id",
|
|
"type": "str",
|
|
"description": "one or more account ids for accounts to look in for channel certificates, defaults to all accounts.",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "account_id",
|
|
"type": "str",
|
|
"description": "account to use for holding the transaction",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict operation to specific wallet",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "funding_account_ids",
|
|
"type": "list",
|
|
"description": "ids of accounts to fund this transaction",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "claim_address",
|
|
"type": "str",
|
|
"description": "address where the claim is sent to, if not specified it will be determined automatically from the account",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "preview",
|
|
"type": "bool",
|
|
"description": "do not broadcast the transaction",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "blocking",
|
|
"type": "bool",
|
|
"description": "wait until transaction is in mempool",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "stream_update",
|
|
"description": "Update an existing stream claim and if a new file is provided announce it to lbrynet.",
|
|
"arguments": [
|
|
{
|
|
"name": "claim_id",
|
|
"type": "str",
|
|
"description": "id of the stream claim to update",
|
|
"is_required": true
|
|
},
|
|
{
|
|
"name": "bid",
|
|
"type": "decimal",
|
|
"description": "amount to back the claim",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "file_path",
|
|
"type": "str",
|
|
"description": "path to file to be associated with name.",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "validate_file",
|
|
"type": "bool",
|
|
"description": "validate that the video container and encodings match common web browser support or that optimization succeeds if specified. FFmpeg is required and file_path must be specified.",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "optimize_file",
|
|
"type": "bool",
|
|
"description": "transcode the video & audio if necessary to ensure common web browser support. FFmpeg is required and file_path must be specified.",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "file_name",
|
|
"type": "str",
|
|
"description": "override file name, defaults to name from file_path.",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "file_size",
|
|
"type": "str",
|
|
"description": "override file size, otherwise automatically computed.",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "file_hash",
|
|
"type": "str",
|
|
"description": "override file hash, otherwise automatically computed.",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "fee_currency",
|
|
"type": "string",
|
|
"description": "specify fee currency",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "fee_amount",
|
|
"type": "decimal",
|
|
"description": "content download fee",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "fee_address",
|
|
"type": "str",
|
|
"description": "address where to send fee payments, will use value from --claim_address if not provided",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "clear_fee",
|
|
"type": "bool",
|
|
"description": "clear previously set fee",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "title",
|
|
"type": "str",
|
|
"description": "title of the publication",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "description",
|
|
"type": "str",
|
|
"description": "description of the publication",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "author",
|
|
"type": "str",
|
|
"description": "author of the publication. The usage for this field is not the same as for channels. The author field is used to credit an author who is not the publisher and is not represented by the channel. For example, a pdf file of 'The Odyssey' has an author of 'Homer' but may by published to a channel such as '@classics', or to no channel at all",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "tags",
|
|
"type": "list",
|
|
"description": "add content tags",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "clear_tags",
|
|
"type": "bool",
|
|
"description": "clear existing tags (prior to adding new ones)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "languages",
|
|
"type": "list",
|
|
"description": "languages used by the channel, using RFC 5646 format, eg: for English `--languages=en` for Spanish (Spain) `--languages=es-ES` for Spanish (Mexican) `--languages=es-MX` for Chinese (Simplified) `--languages=zh-Hans` for Chinese (Traditional) `--languages=zh-Hant`",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "clear_languages",
|
|
"type": "bool",
|
|
"description": "clear existing languages (prior to adding new ones)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "locations",
|
|
"type": "list",
|
|
"description": "locations relevant to the stream, consisting of 2 letter `country` code and a `state`, `city` and a postal `code` along with a `latitude` and `longitude`. for JSON RPC: pass a dictionary with aforementioned attributes as keys, eg: ... \"locations\": [{'country': 'US', 'state': 'NH'}] ... for command line: pass a colon delimited list with values in the following order: \"COUNTRY:STATE:CITY:CODE:LATITUDE:LONGITUDE\" making sure to include colon for blank values, for example to provide only the city: ... --locations=\"::Manchester\" with all values set: ... --locations=\"US:NH:Manchester:03101:42.990605:-71.460989\" optionally, you can just pass the \"LATITUDE:LONGITUDE\": ... --locations=\"42.990605:-71.460989\" finally, you can also pass JSON string of dictionary on the command line as you would via JSON RPC ... --locations=\"{'country': 'US', 'state': 'NH'}\"",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "clear_locations",
|
|
"type": "bool",
|
|
"description": "clear existing locations (prior to adding new ones)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "license",
|
|
"type": "str",
|
|
"description": "publication license",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "license_url",
|
|
"type": "str",
|
|
"description": "publication license url",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "thumbnail_url",
|
|
"type": "str",
|
|
"description": "thumbnail url",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "release_time",
|
|
"type": "int",
|
|
"description": "original public release of content, seconds since UNIX epoch",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "width",
|
|
"type": "int",
|
|
"description": "image/video width, automatically calculated from media file",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "height",
|
|
"type": "int",
|
|
"description": "image/video height, automatically calculated from media file",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "duration",
|
|
"type": "int",
|
|
"description": "audio/video duration in seconds, automatically calculated",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "channel_id",
|
|
"type": "str",
|
|
"description": "claim id of the publisher channel",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "channel_name",
|
|
"type": "str",
|
|
"description": "name of the publisher channel",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "clear_channel",
|
|
"type": "bool",
|
|
"description": "remove channel signature",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "channel_account_id",
|
|
"type": "str",
|
|
"description": "one or more account ids for accounts to look in for channel certificates, defaults to all accounts.",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "account_id",
|
|
"type": "str",
|
|
"description": "account in which to look for stream (default: all)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict operation to specific wallet",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "funding_account_ids",
|
|
"type": "list",
|
|
"description": "ids of accounts to fund this transaction",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "claim_address",
|
|
"type": "str",
|
|
"description": "address where the claim is sent to, if not specified it will be determined automatically from the account",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "preview",
|
|
"type": "bool",
|
|
"description": "do not broadcast the transaction",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "blocking",
|
|
"type": "bool",
|
|
"description": "wait until transaction is in mempool",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "replace",
|
|
"type": "bool",
|
|
"description": "instead of modifying specific values on the stream, this will clear all existing values and only save passed in values, useful for form submissions where all values are always set",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }",
|
|
"examples": [
|
|
{
|
|
"title": "Update a stream claim to add channel",
|
|
"curl": "curl -d'{\"method\": \"stream_update\", \"params\": {\"claim_id\": \"fe7ee643b50b724f6029f6edfe90d67b5512b3ae\", \"validate_file\": false, \"optimize_file\": false, \"clear_fee\": false, \"tags\": [], \"clear_tags\": false, \"languages\": [], \"clear_languages\": false, \"locations\": [], \"clear_locations\": false, \"channel_id\": \"5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\", \"clear_channel\": false, \"channel_account_id\": [], \"funding_account_ids\": [], \"preview\": false, \"blocking\": false, \"replace\": false}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet stream update fe7ee643b50b724f6029f6edfe90d67b5512b3ae --channel_id=\"5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\"",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"stream_update\", \"params\": {\"claim_id\": \"fe7ee643b50b724f6029f6edfe90d67b5512b3ae\", \"validate_file\": false, \"optimize_file\": false, \"clear_fee\": false, \"tags\": [], \"clear_tags\": false, \"languages\": [], \"clear_languages\": false, \"locations\": [], \"clear_locations\": false, \"channel_id\": \"5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\", \"clear_channel\": false, \"channel_account_id\": [], \"funding_account_ids\": [], \"preview\": false, \"blocking\": false, \"replace\": false}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"height\": -2,\n \"hex\": \"0100000002aad6f24c89f81b38c35e8bcf0aeded3ff360ef6ab8a38c4327a04369b760ec6d000000006a473044022059a3af9cb2fa8f77b777271c6b76b298d1ea8bb1c590efd1d8972b28985cbe50022063a41682e98bff3c8b478ce0c0c79940465897dd2dfcc8a420ff67204936f8030121021ef1cb2d0e5f2d4afebf3f9a2c51b78d55a2fa584070831c33a540f7900b7d27ffffffff4743215df39b581f6d75e9633df183122f89ed8db414cdd12574433530ce77cc010000006b483045022100b8886916522d73d8007f00163d4a497a3e80655d1058d884d5a1c7c2f7ea3a31022006d653c4a79ba85f5f58d6a57b3cae6fb2659495aa099b3e2fe1600a787ed20f012103907a04d6a55e4deff127af3ce813364bd35ac96c8fbf45c7dfa00aefcbc9ffeeffffffff0200e1f50500000000fd2301b7076173747265616d14aeb312557bd690feedf629604f720bb543e67efe4ce801f2d6950adda2502b543f042e4e8496b63a2bc95d1391e6159e2874bf75624f77339a61abf38b4da3237a5a52ad92aece2cefae8742c427064051fadb0dcfcc8f957b190341110ce64b8fd3f5cc874e16db11cbdc0a90010a8d010a30fdbd8e75a67f29f701a4e040385e2e23986303ea10239211af907fcbb83578b3e417cb71ce646efd0819dd8c088de1bd120b746d706b306e3078327362180b22186170706c69636174696f6e2f6f637465742d73747265616d3230d40576a4f0f745a868fafad794b3c5e1299cac415a911e55f6eef4395f524b63a649df4c8a75602ea1731a3c5d138b8d6d6d76a914cec22985383752987fece466729c85a74f17a45588ac32a0d205000000001976a9147a143358896b6a1ffb15d9a5b24b27ba9375650088ac00000000\",\n \"inputs\": [\n {\n \"address\": \"mzNC6CMEetGVw6QDGChpUM3HfV7DpWGZ7R\",\n \"amount\": \"1.0\",\n \"claim_id\": \"fe7ee643b50b724f6029f6edfe90d67b5512b3ae\",\n \"claim_op\": \"create\",\n \"confirmations\": 1,\n \"height\": 213,\n \"meta\": {},\n \"name\": \"astream\",\n \"normalized_name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"lbry://astream#fe7ee643b50b724f6029f6edfe90d67b5512b3ae\",\n \"timestamp\": 1602862457,\n \"txid\": \"6dec60b76943a027438ca3b86aef60f33feded0acf8b5ec3381bf8894cf2d6aa\",\n \"type\": \"claim\",\n \"value\": {\n \"source\": {\n \"hash\": \"fdbd8e75a67f29f701a4e040385e2e23986303ea10239211af907fcbb83578b3e417cb71ce646efd0819dd8c088de1bd\",\n \"media_type\": \"application/octet-stream\",\n \"name\": \"tmpk0n0x2sb\",\n \"sd_hash\": \"d40576a4f0f745a868fafad794b3c5e1299cac415a911e55f6eef4395f524b63a649df4c8a75602ea1731a3c5d138b8d\",\n \"size\": \"11\"\n },\n \"stream_type\": \"binary\"\n },\n \"value_type\": \"stream\"\n },\n {\n \"address\": \"mudJaL41pUBkS3VRifB26xD4YLNWDNVrau\",\n \"amount\": \"0.9772285\",\n \"confirmations\": 3,\n \"height\": 211,\n \"nout\": 1,\n \"timestamp\": 1602862456,\n \"txid\": \"cc77ce3035437425d1cd14b48ded892f1283f13d63e9756d1f589bf35d214347\",\n \"type\": \"payment\"\n }\n ],\n \"outputs\": [\n {\n \"address\": \"mzNC6CMEetGVw6QDGChpUM3HfV7DpWGZ7R\",\n \"amount\": \"1.0\",\n \"claim_id\": \"fe7ee643b50b724f6029f6edfe90d67b5512b3ae\",\n \"claim_op\": \"update\",\n \"confirmations\": -2,\n \"height\": -2,\n \"is_channel_signature_valid\": true,\n \"meta\": {},\n \"name\": \"astream\",\n \"normalized_name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"lbry://astream#fe7ee643b50b724f6029f6edfe90d67b5512b3ae\",\n \"signing_channel\": {\n \"address\": \"mofqoKUmhmPTCoudQRXgjzGSDnCyJvZAZg\",\n \"amount\": \"1.0\",\n \"claim_id\": \"5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"claim_op\": \"update\",\n \"confirmations\": 4,\n \"has_signing_key\": true,\n \"height\": 210,\n \"meta\": {},\n \"name\": \"@channel\",\n \"normalized_name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"lbry://@channel#5dc92b3ab696844e2e043f542b50a2dd0a95d6f2\",\n \"timestamp\": 1602862456,\n \"txid\": \"3ee8f25ad7bfef1d30e3fce0b212d77b74a495ef1d7635a8be77b96ffbe8e412\",\n \"type\": \"claim\",\n \"value\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a034200049b4cbe0f5275e7b1c170f458af09628ba75401fd95d0205ed9de9037b396f60936d555da2bc8dd09b1804b250f32d1bd07382bd3a4aaa2700b08b137b91f1159\",\n \"public_key_id\": \"mkVrRXQGgjhBaygCP3dNpbmtm5Yohno8q2\",\n \"title\": \"New Channel\"\n },\n \"value_type\": \"channel\"\n },\n \"timestamp\": null,\n \"txid\": \"c620b71698533d88efa10c80d79a30b74464214cb0d893ec5ab4ec1c37d1676e\",\n \"type\": \"claim\",\n \"value\": {\n \"source\": {\n \"hash\": \"fdbd8e75a67f29f701a4e040385e2e23986303ea10239211af907fcbb83578b3e417cb71ce646efd0819dd8c088de1bd\",\n \"media_type\": \"application/octet-stream\",\n \"name\": \"tmpk0n0x2sb\",\n \"sd_hash\": \"d40576a4f0f745a868fafad794b3c5e1299cac415a911e55f6eef4395f524b63a649df4c8a75602ea1731a3c5d138b8d\",\n \"size\": \"11\"\n },\n \"stream_type\": \"binary\"\n },\n \"value_type\": \"stream\"\n },\n {\n \"address\": \"mreSw1yCRKLMwFHs2rBudyvHxrr6arskSU\",\n \"amount\": \"0.9768965\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 1,\n \"timestamp\": null,\n \"txid\": \"c620b71698533d88efa10c80d79a30b74464214cb0d893ec5ab4ec1c37d1676e\",\n \"type\": \"payment\"\n }\n ],\n \"total_fee\": \"0.000332\",\n \"total_input\": \"1.9772285\",\n \"total_output\": \"1.9768965\",\n \"txid\": \"c620b71698533d88efa10c80d79a30b74464214cb0d893ec5ab4ec1c37d1676e\"\n }\n}"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"support": {
|
|
"doc": "Create, list and abandon all types of supports.",
|
|
"commands": [
|
|
{
|
|
"name": "support_abandon",
|
|
"description": "Abandon supports, including tips, of a specific claim, optionally\nkeeping some amount as supports.",
|
|
"arguments": [
|
|
{
|
|
"name": "claim_id",
|
|
"type": "str",
|
|
"description": "claim_id of the support to abandon",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "txid",
|
|
"type": "str",
|
|
"description": "txid of the claim to abandon",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "nout",
|
|
"type": "int",
|
|
"description": "nout of the claim to abandon",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "keep",
|
|
"type": "decimal",
|
|
"description": "amount of lbc to keep as support",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "account_id",
|
|
"type": "str",
|
|
"description": "id of the account to use",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict operation to specific wallet",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "preview",
|
|
"type": "bool",
|
|
"description": "do not broadcast the transaction",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "blocking",
|
|
"type": "bool",
|
|
"description": "wait until abandon is in mempool",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "support_create",
|
|
"description": "Create a support or a tip for name claim.",
|
|
"arguments": [
|
|
{
|
|
"name": "claim_id",
|
|
"type": "str",
|
|
"description": "claim_id of the claim to support",
|
|
"is_required": true
|
|
},
|
|
{
|
|
"name": "amount",
|
|
"type": "decimal",
|
|
"description": "amount of support",
|
|
"is_required": true
|
|
},
|
|
{
|
|
"name": "tip",
|
|
"type": "bool",
|
|
"description": "send support to claim owner, default: false.",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "channel_id",
|
|
"type": "str",
|
|
"description": "claim id of the supporters identity channel",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "channel_name",
|
|
"type": "str",
|
|
"description": "name of the supporters identity channel",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "channel_account_id",
|
|
"type": "str",
|
|
"description": "one or more account ids for accounts to look in for channel certificates, defaults to all accounts.",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "account_id",
|
|
"type": "str",
|
|
"description": "account to use for holding the transaction",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict operation to specific wallet",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "funding_account_ids",
|
|
"type": "list",
|
|
"description": "ids of accounts to fund this transaction",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "preview",
|
|
"type": "bool",
|
|
"description": "do not broadcast the transaction",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "blocking",
|
|
"type": "bool",
|
|
"description": "wait until transaction is in mempool",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "support_list",
|
|
"description": "List staked supports and sent/received tips.",
|
|
"arguments": [
|
|
{
|
|
"name": "name",
|
|
"type": "str or list",
|
|
"description": "claim name",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "claim_id",
|
|
"type": "str or list",
|
|
"description": "claim id",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "received",
|
|
"type": "bool",
|
|
"description": "only show received (tips)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "sent",
|
|
"type": "bool",
|
|
"description": "only show sent (tips)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "staked",
|
|
"type": "bool",
|
|
"description": "only show my staked supports",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "is_spent",
|
|
"type": "bool",
|
|
"description": "show abandoned supports",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "account_id",
|
|
"type": "str",
|
|
"description": "id of the account to query",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict results to specific wallet",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "page",
|
|
"type": "int",
|
|
"description": "page to return during paginating",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "page_size",
|
|
"type": "int",
|
|
"description": "number of items on page during pagination",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "no_totals",
|
|
"type": "bool",
|
|
"description": "do not calculate the total number of pages and items in result set (significant performance boost)",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": " {\n \"page\": \"Page number of the current items.\",\n \"page_size\": \"Number of items to show on a page.\",\n \"total_pages\": \"Total number of pages.\",\n \"total_items\": \"Total number of items.\",\n \"items\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ]\n }",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "support_sum",
|
|
"description": "List total staked supports for a claim, grouped by the channel that signed the support.\n+\n+ If claim_id is a channel claim, you can use --include_channel_content to also include supports for\n+ content claims in the channel.\n\n !!!! NOTE: PAGINATION DOES NOT DO ANYTHING AT THE MOMENT !!!!!",
|
|
"arguments": [
|
|
{
|
|
"name": "claim_id",
|
|
"type": "str",
|
|
"description": "claim id",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "new_sdk_server",
|
|
"type": "str",
|
|
"description": "URL of the new SDK server (EXPERIMENTAL)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "include_channel_content",
|
|
"type": "bool",
|
|
"description": "if claim_id is for a channel, include supports for claims in that channel",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "page",
|
|
"type": "int",
|
|
"description": "page to return during paginating",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "page_size",
|
|
"type": "int",
|
|
"description": "number of items on page during pagination",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": " {\n \"page\": \"Page number of the current items.\",\n \"page_size\": \"Number of items to show on a page.\",\n \"total_pages\": \"Total number of pages.\",\n \"total_items\": \"Total number of items.\",\n \"items\": [\n \"glorious data in dictionary\"\n ]\n }",
|
|
"examples": []
|
|
}
|
|
]
|
|
},
|
|
"sync": {
|
|
"doc": "Wallet synchronization.",
|
|
"commands": [
|
|
{
|
|
"name": "sync_apply",
|
|
"description": "Apply incoming synchronization data, if provided, and return a sync hash and update wallet data.\n\nWallet must be unlocked to perform this operation.\n\nIf \"encrypt-on-disk\" preference is True and supplied password is different from local password,\nor there is no local password (because local wallet was not encrypted), then the supplied password\nwill be used for local encryption (overwriting previous local encryption password).",
|
|
"arguments": [
|
|
{
|
|
"name": "password",
|
|
"type": "str",
|
|
"description": "password to decrypt incoming and encrypt outgoing data",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "data",
|
|
"type": "str",
|
|
"description": "incoming sync data, if any",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "wallet being sync'ed",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "blocking",
|
|
"type": "bool",
|
|
"description": "wait until any new accounts have sync'ed",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": "(map) sync hash and data",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "sync_hash",
|
|
"description": "Deterministic hash of the wallet.",
|
|
"arguments": [
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "wallet for which to generate hash",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": "(str) sha256 hash of wallet",
|
|
"examples": []
|
|
}
|
|
]
|
|
},
|
|
"tracemalloc": {
|
|
"doc": "Controls and queries tracemalloc memory tracing tools for troubleshooting.",
|
|
"commands": [
|
|
{
|
|
"name": "tracemalloc_disable",
|
|
"description": "Disable tracemalloc memory tracing",
|
|
"arguments": [],
|
|
"returns": "(bool) is it tracing?",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "tracemalloc_enable",
|
|
"description": "Enable tracemalloc memory tracing",
|
|
"arguments": [],
|
|
"returns": "(bool) is it tracing?",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "tracemalloc_top",
|
|
"description": "Show most common objects, the place that created them and their size.",
|
|
"arguments": [
|
|
{
|
|
"name": "items",
|
|
"type": "int",
|
|
"description": "maximum items to return, from the most common",
|
|
"is_required": true
|
|
}
|
|
],
|
|
"returns": "(dict) dictionary containing most common objects in memory\n {\n \"line\": (str) filename and line number where it was created,\n \"code\": (str) code that created it,\n \"size\": (int) size in bytes, for each \"memory block\",\n \"count\" (int) number of memory blocks\n }",
|
|
"examples": []
|
|
}
|
|
]
|
|
},
|
|
"transaction": {
|
|
"doc": "Transaction management.",
|
|
"commands": [
|
|
{
|
|
"name": "transaction_list",
|
|
"description": "List transactions belonging to wallet",
|
|
"arguments": [
|
|
{
|
|
"name": "account_id",
|
|
"type": "str",
|
|
"description": "id of the account to query",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict results to specific wallet",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "page",
|
|
"type": "int",
|
|
"description": "page to return during paginating",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "page_size",
|
|
"type": "int",
|
|
"description": "number of items on page during pagination",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": "(list) List of transactions\n\n {\n \"claim_info\": (list) claim info if in txn [{\n \"address\": (str) address of claim,\n \"balance_delta\": (float) bid amount,\n \"amount\": (float) claim amount,\n \"claim_id\": (str) claim id,\n \"claim_name\": (str) claim name,\n \"nout\": (int) nout\n }],\n \"abandon_info\": (list) abandon info if in txn [{\n \"address\": (str) address of abandoned claim,\n \"balance_delta\": (float) returned amount,\n \"amount\": (float) claim amount,\n \"claim_id\": (str) claim id,\n \"claim_name\": (str) claim name,\n \"nout\": (int) nout\n }],\n \"confirmations\": (int) number of confirmations for the txn,\n \"date\": (str) date and time of txn,\n \"fee\": (float) txn fee,\n \"support_info\": (list) support info if in txn [{\n \"address\": (str) address of support,\n \"balance_delta\": (float) support amount,\n \"amount\": (float) support amount,\n \"claim_id\": (str) claim id,\n \"claim_name\": (str) claim name,\n \"is_tip\": (bool),\n \"nout\": (int) nout\n }],\n \"timestamp\": (int) timestamp,\n \"txid\": (str) txn id,\n \"update_info\": (list) update info if in txn [{\n \"address\": (str) address of claim,\n \"balance_delta\": (float) credited/debited\n \"amount\": (float) absolute amount,\n \"claim_id\": (str) claim id,\n \"claim_name\": (str) claim name,\n \"nout\": (int) nout\n }],\n \"value\": (float) value of txn\n }",
|
|
"examples": [
|
|
{
|
|
"title": "List your transactions",
|
|
"curl": "curl -d'{\"method\": \"transaction_list\", \"params\": {}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet transaction list",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"transaction_list\", \"params\": {}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"items\": [\n {\n \"abandon_info\": [],\n \"claim_info\": [],\n \"confirmations\": 1,\n \"date\": \"2020-10-16 11:34\",\n \"fee\": \"-0.000124\",\n \"purchase_info\": [],\n \"support_info\": [],\n \"timestamp\": 1602862456,\n \"txid\": \"6947372f3637caa782cdb49daf4c9cb4f06a8479152eee6691912f042d3d5358\",\n \"update_info\": [],\n \"value\": \"0.0\"\n },\n {\n \"abandon_info\": [],\n \"claim_info\": [],\n \"confirmations\": 7,\n \"date\": \"2020-10-16 11:34\",\n \"fee\": \"0.0\",\n \"purchase_info\": [],\n \"support_info\": [],\n \"timestamp\": 1602862455,\n \"txid\": \"0843754aabf3d1313d22e51476d8a81dc1f6ce75df7844529d1d16013c803d59\",\n \"update_info\": [],\n \"value\": \"10.0\"\n }\n ],\n \"page\": 1,\n \"page_size\": 20,\n \"total_items\": 2,\n \"total_pages\": 1\n }\n}"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "transaction_show",
|
|
"description": "Get a decoded transaction from a txid",
|
|
"arguments": [
|
|
{
|
|
"name": "txid",
|
|
"type": "str",
|
|
"description": "txid of the transaction",
|
|
"is_required": true
|
|
}
|
|
],
|
|
"returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }",
|
|
"examples": []
|
|
}
|
|
]
|
|
},
|
|
"txo": {
|
|
"doc": "List and sum transaction outputs.",
|
|
"commands": [
|
|
{
|
|
"name": "txo_list",
|
|
"description": "List my transaction outputs.",
|
|
"arguments": [
|
|
{
|
|
"name": "type",
|
|
"type": "str or list",
|
|
"description": "claim type: stream, channel, support, purchase, collection, repost, other",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "txid",
|
|
"type": "str or list",
|
|
"description": "transaction id of outputs",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "claim_id",
|
|
"type": "str or list",
|
|
"description": "claim id",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "channel_id",
|
|
"type": "str or list",
|
|
"description": "claims in this channel",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "name",
|
|
"type": "str or list",
|
|
"description": "claim name",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "is_spent",
|
|
"type": "bool",
|
|
"description": "only show spent txos",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "is_not_spent",
|
|
"type": "bool",
|
|
"description": "only show not spent txos",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "is_my_input_or_output",
|
|
"type": "bool",
|
|
"description": "txos which have your inputs or your outputs, if using this flag the other related flags are ignored (--is_my_output, --is_my_input, etc)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "is_my_output",
|
|
"type": "bool",
|
|
"description": "show outputs controlled by you",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "is_not_my_output",
|
|
"type": "bool",
|
|
"description": "show outputs not controlled by you",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "is_my_input",
|
|
"type": "bool",
|
|
"description": "show outputs created by you",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "is_not_my_input",
|
|
"type": "bool",
|
|
"description": "show outputs not created by you",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "exclude_internal_transfers",
|
|
"type": "bool",
|
|
"description": "excludes any outputs that are exactly this combination: \"--is_my_input --is_my_output --type=other\" this allows to exclude \"change\" payments, this flag can be used in combination with any of the other flags",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "include_received_tips",
|
|
"type": "bool",
|
|
"description": "calculate the amount of tips recieved for claim outputs",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "account_id",
|
|
"type": "str",
|
|
"description": "id of the account to query",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict results to specific wallet",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "page",
|
|
"type": "int",
|
|
"description": "page to return during paginating",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "page_size",
|
|
"type": "int",
|
|
"description": "number of items on page during pagination",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "resolve",
|
|
"type": "bool",
|
|
"description": "resolves each claim to provide additional metadata",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "order_by",
|
|
"type": "str",
|
|
"description": "field to order by: 'name', 'height', 'amount' and 'none'",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "no_totals",
|
|
"type": "bool",
|
|
"description": "do not calculate the total number of pages and items in result set (significant performance boost)",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": " {\n \"page\": \"Page number of the current items.\",\n \"page_size\": \"Number of items to show on a page.\",\n \"total_pages\": \"Total number of pages.\",\n \"total_items\": \"Total number of items.\",\n \"items\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ]\n }",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "txo_plot",
|
|
"description": "Plot transaction output sum over days.",
|
|
"arguments": [
|
|
{
|
|
"name": "type",
|
|
"type": "str or list",
|
|
"description": "claim type: stream, channel, support, purchase, collection, repost, other",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "txid",
|
|
"type": "str or list",
|
|
"description": "transaction id of outputs",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "claim_id",
|
|
"type": "str or list",
|
|
"description": "claim id",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "name",
|
|
"type": "str or list",
|
|
"description": "claim name",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "is_spent",
|
|
"type": "bool",
|
|
"description": "only show spent txos",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "is_not_spent",
|
|
"type": "bool",
|
|
"description": "only show not spent txos",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "is_my_input_or_output",
|
|
"type": "bool",
|
|
"description": "txos which have your inputs or your outputs, if using this flag the other related flags are ignored (--is_my_output, --is_my_input, etc)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "is_my_output",
|
|
"type": "bool",
|
|
"description": "show outputs controlled by you",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "is_not_my_output",
|
|
"type": "bool",
|
|
"description": "show outputs not controlled by you",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "is_my_input",
|
|
"type": "bool",
|
|
"description": "show outputs created by you",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "is_not_my_input",
|
|
"type": "bool",
|
|
"description": "show outputs not created by you",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "exclude_internal_transfers",
|
|
"type": "bool",
|
|
"description": "excludes any outputs that are exactly this combination: \"--is_my_input --is_my_output --type=other\" this allows to exclude \"change\" payments, this flag can be used in combination with any of the other flags",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "account_id",
|
|
"type": "str",
|
|
"description": "id of the account to query",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict results to specific wallet",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "days_back",
|
|
"type": "int",
|
|
"description": "number of days back from today (not compatible with --start_day, --days_after, --end_day)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "start_day",
|
|
"type": "date",
|
|
"description": "start on specific date (YYYY-MM-DD) (instead of --days_back)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "days_after",
|
|
"type": "int",
|
|
"description": "end number of days after --start_day (instead of --end_day)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "end_day",
|
|
"type": "date",
|
|
"description": "end on specific date (YYYY-MM-DD) (instead of --days_after)",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": "List[Dict]",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "txo_spend",
|
|
"description": "Spend transaction outputs, batching into multiple transactions as necessary.",
|
|
"arguments": [
|
|
{
|
|
"name": "type",
|
|
"type": "str or list",
|
|
"description": "claim type: stream, channel, support, purchase, collection, repost, other",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "txid",
|
|
"type": "str or list",
|
|
"description": "transaction id of outputs",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "claim_id",
|
|
"type": "str or list",
|
|
"description": "claim id",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "channel_id",
|
|
"type": "str or list",
|
|
"description": "claims in this channel",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "name",
|
|
"type": "str or list",
|
|
"description": "claim name",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "is_my_input",
|
|
"type": "bool",
|
|
"description": "show outputs created by you",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "is_not_my_input",
|
|
"type": "bool",
|
|
"description": "show outputs not created by you",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "exclude_internal_transfers",
|
|
"type": "bool",
|
|
"description": "excludes any outputs that are exactly this combination: \"--is_my_input --is_my_output --type=other\" this allows to exclude \"change\" payments, this flag can be used in combination with any of the other flags",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "account_id",
|
|
"type": "str",
|
|
"description": "id of the account to query",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict results to specific wallet",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "preview",
|
|
"type": "bool",
|
|
"description": "do not broadcast the transaction",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "blocking",
|
|
"type": "bool",
|
|
"description": "wait until abandon is in mempool",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "batch_size",
|
|
"type": "int",
|
|
"description": "number of txos to spend per transactions",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "include_full_tx",
|
|
"type": "bool",
|
|
"description": "include entire tx in output and not just the txid",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": " [\n {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }\n ]",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "txo_sum",
|
|
"description": "Sum of transaction outputs.",
|
|
"arguments": [
|
|
{
|
|
"name": "type",
|
|
"type": "str or list",
|
|
"description": "claim type: stream, channel, support, purchase, collection, repost, other",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "txid",
|
|
"type": "str or list",
|
|
"description": "transaction id of outputs",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "claim_id",
|
|
"type": "str or list",
|
|
"description": "claim id",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "name",
|
|
"type": "str or list",
|
|
"description": "claim name",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "is_spent",
|
|
"type": "bool",
|
|
"description": "only show spent txos",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "is_not_spent",
|
|
"type": "bool",
|
|
"description": "only show not spent txos",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "is_my_input_or_output",
|
|
"type": "bool",
|
|
"description": "txos which have your inputs or your outputs, if using this flag the other related flags are ignored (--is_my_output, --is_my_input, etc)",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "is_my_output",
|
|
"type": "bool",
|
|
"description": "show outputs controlled by you",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "is_not_my_output",
|
|
"type": "bool",
|
|
"description": "show outputs not controlled by you",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "is_my_input",
|
|
"type": "bool",
|
|
"description": "show outputs created by you",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "is_not_my_input",
|
|
"type": "bool",
|
|
"description": "show outputs not created by you",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "exclude_internal_transfers",
|
|
"type": "bool",
|
|
"description": "excludes any outputs that are exactly this combination: \"--is_my_input --is_my_output --type=other\" this allows to exclude \"change\" payments, this flag can be used in combination with any of the other flags",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "account_id",
|
|
"type": "str",
|
|
"description": "id of the account to query",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict results to specific wallet",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": "int",
|
|
"examples": []
|
|
}
|
|
]
|
|
},
|
|
"utxo": {
|
|
"doc": "Unspent transaction management.",
|
|
"commands": [
|
|
{
|
|
"name": "utxo_list",
|
|
"description": "List unspent transaction outputs",
|
|
"arguments": [
|
|
{
|
|
"name": "account_id",
|
|
"type": "str",
|
|
"description": "id of the account to query",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict results to specific wallet",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "page",
|
|
"type": "int",
|
|
"description": "page to return during paginating",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "page_size",
|
|
"type": "int",
|
|
"description": "number of items on page during pagination",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": " {\n \"page\": \"Page number of the current items.\",\n \"page_size\": \"Number of items to show on a page.\",\n \"total_pages\": \"Total number of pages.\",\n \"total_items\": \"Total number of items.\",\n \"items\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ]\n }",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "utxo_release",
|
|
"description": "When spending a UTXO it is locally locked to prevent double spends;\noccasionally this can result in a UTXO being locked which ultimately\ndid not get spent (failed to broadcast, spend transaction was not\naccepted by blockchain node, etc). This command releases the lock\non all UTXOs in your account.",
|
|
"arguments": [
|
|
{
|
|
"name": "account_id",
|
|
"type": "str",
|
|
"description": "id of the account to query",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict operation to specific wallet",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": "None",
|
|
"examples": []
|
|
}
|
|
]
|
|
},
|
|
"wallet": {
|
|
"doc": "Create, modify and inspect wallets.",
|
|
"commands": [
|
|
{
|
|
"name": "wallet_add",
|
|
"description": "Add existing wallet.",
|
|
"arguments": [
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "wallet file name",
|
|
"is_required": true
|
|
}
|
|
],
|
|
"returns": " {\n \"id\": \"wallet_id\",\n \"name\": \"optional wallet name\"\n }",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "wallet_balance",
|
|
"description": "Return the balance of a wallet",
|
|
"arguments": [
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "balance for specific wallet",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "confirmations",
|
|
"type": "int",
|
|
"description": "Only include transactions with this many confirmed blocks.",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": "(decimal) amount of lbry credits in wallet",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "wallet_create",
|
|
"description": "Create a new wallet.",
|
|
"arguments": [
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "wallet file name",
|
|
"is_required": true
|
|
},
|
|
{
|
|
"name": "skip_on_startup",
|
|
"type": "bool",
|
|
"description": "don't add wallet to daemon_settings.yml",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "create_account",
|
|
"type": "bool",
|
|
"description": "generates the default account",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "single_key",
|
|
"type": "bool",
|
|
"description": "used with --create_account, creates single-key account",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": " {\n \"id\": \"wallet_id\",\n \"name\": \"optional wallet name\"\n }",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "wallet_decrypt",
|
|
"description": "Decrypt an encrypted wallet, this will remove the wallet password. The wallet must be unlocked to decrypt it",
|
|
"arguments": [
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict operation to specific wallet",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": "(bool) true if wallet is decrypted, otherwise false",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "wallet_encrypt",
|
|
"description": "Encrypt an unencrypted wallet with a password",
|
|
"arguments": [
|
|
{
|
|
"name": "new_password",
|
|
"type": "str",
|
|
"description": "password to encrypt account",
|
|
"is_required": true
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict operation to specific wallet",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": "(bool) true if wallet is decrypted, otherwise false",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "wallet_list",
|
|
"description": "List wallets.",
|
|
"arguments": [
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "show specific wallet only",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "page",
|
|
"type": "int",
|
|
"description": "page to return during paginating",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "page_size",
|
|
"type": "int",
|
|
"description": "number of items on page during pagination",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": " {\n \"page\": \"Page number of the current items.\",\n \"page_size\": \"Number of items to show on a page.\",\n \"total_pages\": \"Total number of pages.\",\n \"total_items\": \"Total number of items.\",\n \"items\": [\n {\n \"id\": \"wallet_id\",\n \"name\": \"optional wallet name\"\n }\n ]\n }",
|
|
"examples": [
|
|
{
|
|
"title": "List your wallets",
|
|
"curl": "curl -d'{\"method\": \"wallet_list\", \"params\": {}}' http://localhost:5279/",
|
|
"lbrynet": "lbrynet wallet list",
|
|
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"wallet_list\", \"params\": {}}).json()",
|
|
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"items\": [\n {\n \"id\": \"my_wallet.json\",\n \"name\": \"Wallet\"\n }\n ],\n \"page\": 1,\n \"page_size\": 20,\n \"total_items\": 1,\n \"total_pages\": 1\n }\n}"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "wallet_lock",
|
|
"description": "Lock an unlocked wallet",
|
|
"arguments": [
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict operation to specific wallet",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": "(bool) true if wallet is locked, otherwise false",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "wallet_reconnect",
|
|
"description": "Reconnects ledger network client, applying new configurations.",
|
|
"arguments": [],
|
|
"returns": "None",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "wallet_remove",
|
|
"description": "Remove an existing wallet.",
|
|
"arguments": [
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "name of wallet to remove",
|
|
"is_required": true
|
|
}
|
|
],
|
|
"returns": " {\n \"id\": \"wallet_id\",\n \"name\": \"optional wallet name\"\n }",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "wallet_send",
|
|
"description": "Send the same number of credits to multiple addresses using all accounts in wallet to\nfund the transaction and the default account to receive any change.",
|
|
"arguments": [
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict operation to specific wallet",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "change_account_id",
|
|
"type": "str",
|
|
"description": "account where change will go",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "funding_account_ids",
|
|
"type": "str",
|
|
"description": "accounts to fund the transaction",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "preview",
|
|
"type": "bool",
|
|
"description": "do not broadcast the transaction",
|
|
"is_required": false
|
|
},
|
|
{
|
|
"name": "blocking",
|
|
"type": "bool",
|
|
"description": "wait until tx has synced",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_received\": \"true if txo was sent from external account to this account\",\n \"is_spent\": \"true if txo is spent\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'purchase'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim', 'support' or 'purchase', this is the claim id\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"value\": \"when type is 'claim' or 'support' with payload, this is the decoded protobuf payload\",\n \"value_type\": \"determines the type of the 'value' field: 'channel', 'stream', etc\",\n \"protobuf\": \"hex encoded raw protobuf version of 'value' field\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"claim\": \"for purchase outputs only, metadata of purchased claim\",\n \"reposted_claim\": \"for repost claims only, metadata of claim being reposted\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\",\n \"purchase_receipt\": \"metadata for the purchase transaction associated with this claim\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "wallet_status",
|
|
"description": "Status of wallet including encryption/lock state.",
|
|
"arguments": [
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "status of specific wallet",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": "Dictionary of wallet status information.",
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "wallet_unlock",
|
|
"description": "Unlock an encrypted wallet",
|
|
"arguments": [
|
|
{
|
|
"name": "password",
|
|
"type": "str",
|
|
"description": "password to use for unlocking",
|
|
"is_required": true
|
|
},
|
|
{
|
|
"name": "wallet_id",
|
|
"type": "str",
|
|
"description": "restrict operation to specific wallet",
|
|
"is_required": false
|
|
}
|
|
],
|
|
"returns": "(bool) true if wallet is unlocked, otherwise false",
|
|
"examples": []
|
|
}
|
|
]
|
|
}
|
|
} |