Client library for Raiden Rest API
Project description
Raiden Python Client
Client library for Raiden node REST API. Documentation located at raiden-client-python.readthedocs.io
Installation
raiden-client run on Python 3.5+
Install from pypi:
$ pip install -U raiden-client
Or, clone repo and run:
$ pip install .
Usage examples
API interface
Full docs here
>>> from raiden_client import Client
>>> c = Client()
>>> c.address()
>>> c.tokens(token_address="0x2008730f6c4ebde1f4ae0c8b8bf968f53c341c45")
CLI usage
Full docs here
$ raiden-cli -h
usage: raiden-cli [-h] [--endpoint ENDPOINT] [--version VERSION]
{address,tokens,channels,channel,non-settled,pending-transfers,channel-open,channel-close,deposit-increase,withdraw-increase,token-register,connections,connect,disconnect,payment,payment-events,mint-token}
...
Raiden python client CLI
positional arguments:
{address,tokens,channels,channel,non-settled,pending-transfers,channel-open,channel-close,deposit-increase,withdraw-increase,token-register,connections,connect,disconnect,payment,payment-events,mint-token}
address Query node address
tokens Query list of registered tokens
channels Request a list of all unsettled channels
channel Request a channel detail
non-settled Partners with non-settled channels
pending-transfers List of uncompleted transfers
channel-open Opens / creates a channel
channel-close Close a channell
deposit-increase Increase channel deposit
withdraw-increase Increase channel deposit
token-register Registering a token by token address
connections Query details of all joined token networks
connect Automatically join a token network
disconnect Leave a token network
payment Initiate a payment
payment-events Querying payment events
mint-token API endpoints for testing
optional arguments:
-h, --help show this help message and exit
--endpoint ENDPOINT REST API endpoint (default: http://127.0.0.1:5001/)
--version VERSION API version (default: v1)
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
raiden-client-1.0.0.tar.gz
(12.9 kB
view hashes)
Built Distribution
Close
Hashes for raiden_client-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ec0706353ac81aea4301f147419213dd33052188c5ae4f1b0af35473026e540b |
|
MD5 | 687dc215bf4b3f120d1b160254b4a750 |
|
BLAKE2b-256 | 20bede2cb3413d32ee5b7b77712bba9875fa3d892413b8493a10e1451dc51f09 |