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

adds api examples to docs

Browse source
This commit is contained in:
jessop 2019-04-12 08:58:00 -04:00 • committed by Lex Berezhny
parent 0200756218
commit 7f5deaf6c8
2 changed files with 411 additions and 104 deletions

187
scripts/generate_json_api.py
View file

@ -66,108 +66,245 @@ class Examples(CommandTestCase):
async def play(self):
r = self.recorder
# general sdk
await r(
'List your accounts.',
'Get status',
'status'
)
await r(
'Get version',
'version'
)
await r(
'Get settings',
'settings', 'get'
)
# accounts
await r(
'List your accounts',
'account', 'list'
)
account = await r(
'Create an account.',
'Create an account',
'account', 'create', '"generated account"'
)
await r(
'Remove an account.',
'Remove an account',
'account', 'remove', account['id']
)
await r(
'Add an account from seed.',
'Add an account from seed',
'account', 'add', '"new account"', f"--seed=\"{account['seed']}\""
)
await r(
'Modify maximum number of times a change address can be reused.',
'Modify maximum number of times a change address can be reused',
'account', 'set', account['id'], '--change_max_uses=10'
)
# addresses
await r(
'List addresses in default account',
'address', 'list'
)
an_address = await r(
'Get an unused address',
'address', 'unused'
)
address_list_by_id = await r(
'List addresses in specified account',
'address', 'list', f"--account_id=\"{account['id']}\""
)
await r(
'Check if address is mine',
'address', 'is_mine', an_address
)
# sends/funds
transfer = await r(
'Transfer 2 LBC from default account to specific account',
'account', 'fund', f"--to_account=\"{account['id']}\"", "--amount=2.0", "--broadcast"
)
await self.on_transaction_dict(transfer)
await self.generate(1)
await self.on_transaction_dict(transfer)
await r(
'Get default account balance',
'account', 'balance'
)
txlist = await r(
'List your transactions',
'transaction', 'list'
)
await r(
'Get balance for specific account by id',
'account', 'balance', f"\"{account['id']}\""
)
spread_transaction = await r(
'Spread LBC between multiple addresses',
'account', 'fund', f"--to_account=\"{account['id']}\"", f"--from_account=\"{account['id']}\"", '--amount=1.5', '--outputs=2', '--broadcast'
)
await self.on_transaction_dict(spread_transaction)
await self.generate(1)
await self.on_transaction_dict(spread_transaction)
await r(
'Transfer all LBC to a specified account',
'account', 'fund', f"--from_account=\"{account['id']}\"", "--everything", "--broadcast"
)
# channels
channel = await r(
'Create a channel claim.',
'Create a channel claim',
'channel', 'create', '@channel', '1.0'
)
channel_id = channel['outputs'][0]['claim_id']
await self.on_transaction_dict(channel)
await self.generate(1)
await self.on_transaction_dict(channel)
await r(
'List your channel claims',
'channel', 'list'
)
await r(
'Paginate your channel claims',
'channel', 'list', '--page=1', '--page_size=20'
)
channel = await r(
'Update a channel claim.',
'Update a channel claim',
'channel', 'update', channel['outputs'][0]['claim_id'], '--title="New Channel"'
)
await self.on_transaction_dict(channel)
await self.generate(1)
await self.on_transaction_dict(channel)
# stream claims
with tempfile.NamedTemporaryFile() as file:
file.write(b'hello world')
file.flush()
stream = await r(
'Create a stream claim.',
'Create a stream claim',
'stream', 'create', 'astream', '1.0', file.name
)
await self.on_transaction_dict(stream)
await self.generate(1)
await self.on_transaction_dict(stream)
stream_id = stream['outputs'][0]['claim_id']
stream_name = stream['outputs'][0]['name']
stream = await r(
'Update a stream claim to add channel.',
'stream', 'update', stream['outputs'][0]['claim_id'],
f"--channel_id={channel['outputs'][0]['claim_id']}"
'Update a stream claim to add channel',
'stream', 'update', stream_id,
f"--channel_id=\"{channel_id}\""
)
await self.on_transaction_dict(stream)
await self.generate(1)
await self.on_transaction_dict(stream)
await r(
'List all your claims.',
'List all your claims',
'claim', 'list'
)
await r(
'Paginate your claims.',
'Paginate your claims',
'claim', 'list', '--page=1', '--page_size=20'
)
await r(
'List all your stream claims.',
'List all your stream claims',
'stream', 'list'
)
await r(
'Paginate your stream claims.',
'Paginate your stream claims',
'stream', 'list', '--page=1', '--page_size=20'
)
await r(
'List all your channel claims.',
'channel', 'list'
'Search for all claims in channel',
'claim', 'search', f"--channel_id=\"{channel_id}\""
)
await r(
'Paginate your channel claims.',
'channel', 'list', '--page=1', '--page_size=20'
'Search for claims matching a name',
'claim', 'search', f"--name=\"{stream_name}\""
)
# files
file_list_result = await r(
'List local files',
'file', 'list'
)
file_uri = f"{file_list_result[0]['claim_name']}#{file_list_result[0]['claim_id']}"
await r(
'Resolve a claim',
'resolve', file_uri
)
await r(
'List files matching a parameter',
'file', 'list', f"--claim_id=\"{file_list_result[0]['claim_id']}\""
)
await r(
'Delete a file',
'file', 'delete', f"--claim_id=\"{file_list_result[0]['claim_id']}\""
)
await r(
'Get a file',
'get', file_uri
)
# blobs
bloblist = await r(
'List your local blobs',
'blob', 'list'
)
await r(
'Delete a blob',
'blob', 'delete', f"{bloblist[0]}"
)
# abandon all the things
abandon_stream = await r(
'Abandon a stream claim.',
'stream', 'abandon', stream['outputs'][0]['claim_id']
'Abandon a stream claim',
'stream', 'abandon', stream_id
)
await self.on_transaction_dict(abandon_stream)
await self.generate(1)
await self.on_transaction_dict(abandon_stream)
abandon_channel = await r(
'Abandon a channel claim.',
'channel', 'abandon', channel['outputs'][0]['claim_id']
'Abandon a channel claim',
'channel', 'abandon', channel_id
)
await self.on_transaction_dict(abandon_channel)
await self.generate(1)
@ -177,7 +314,7 @@ class Examples(CommandTestCase):
file.write(b'hello world')
file.flush()
stream = await r(
'Publish a file.',
'Publish a file',
'publish', 'a-new-stream', '--bid=1.0', f'--file_path={file.name}'
)
await self.on_transaction_dict(stream)