Skip to main content

Client library for Raiden Rest API

Project description

Raiden Python Client

Mad Devs CircleCI Maintainability Codecov PyPI version Documentation Status

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)

Built with Mad Devs support for the community

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for raiden-client, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size raiden_client-1.0.0-py3-none-any.whl (30.6 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size raiden-client-1.0.0.tar.gz (12.9 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page