Skip to content
RaiBlocks Node RPC Python Client
Branch: master
Clone or download
dourvaris Merge pull request #11 from Laurentiu-Andronache/master
add support for nano units, fix two small issues
Latest commit f26b8bc Mar 4, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs improvements done by the pre-commit hooks, they also solve my previou… Mar 1, 2019
src/nano add typing for id Mar 1, 2019
tests we can't remove this import from the test - in case there is code tha… Mar 1, 2019
.gitignore improvements done by the pre-commit hooks, they also solve my previou… Mar 1, 2019
.pre-commit-config.yaml add pre-commit hooks, most important one being black Mar 1, 2019
.travis.yml improvements done by the pre-commit hooks, they also solve my previou… Mar 1, 2019
CHANGELOG.rst specify changes for 2.1.0 Feb 9, 2019
LICENSE Initial commit Jan 7, 2018
README.rst add pre-commit hooks, most important one being black Mar 1, 2019
coverage.sh improvements done by the pre-commit hooks, they also solve my previou… Mar 1, 2019
coverage.svg Add coverage badge Jan 7, 2018
requirements-dev.pip improvements done by the pre-commit hooks, they also solve my previou… Mar 1, 2019
requirements.pip put old requirements back Mar 2, 2019
setup.cfg
setup.py improvements done by the pre-commit hooks, they also solve my previou… Mar 1, 2019

README.rst

Nano (RaiBlocks) Python Library

https://travis-ci.org/dourvaris/nano-python.svg?branch=1.0.0rc1 Documentation Status https://github.com/dourvaris/nano-python/raw/master/coverage.svg?sanitize=true https://img.shields.io/pypi/pyversions/nano-python.svg?style=flat-square

This library contains a python wrapper for the Nano (RaiBlocks) RPC server which tries to make it a little easier to work with by converting RPC responses to native python ones and exposing a pythonic api for making RPC calls.

Also included are utilities such as converting rai/xrb and interesting accounts

Installation

pip install nano-python

Documentation

https://nano-python.readthedocs.io/

RPC client

You can browse the available RPC methods list or check the RPC Client API documentation for examples of usage.

Warning

The RPC client DOES NOT handle timeouts or retries automatically since this could lead to unwanted retries of requests causing double spends. Keep this in mind when implementing retries.

When using version 10.0 of the RPC node, use the send id when making spends as described at https://github.com/nanocurrency/raiblocks/wiki/RPC-protocol#highly-recommended-id

>>> import nano
>>> rpc = nano.rpc.Client('http://localhost:7076')
>>> rpc.version()
{
    'rpc_version': 1,
    'store_version': 10,
    'node_vendor': 'RaiBlocks 9.0'
}
>>> rpc.peers()
{
    '[::ffff:75.171.168.5]:7075': 4,
    '[::ffff:108.44.38.183]:1032': 4
}

Crypto/Accounts

Conversion

>>> from nano import convert
>>> convert(12, from_unit='XRB', to_unit='raw')
Decimal('1.2E+31')

>>> convert(0.4, from_unit='krai', to_unit='XRB')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ValueError: float values can lead to unexpected
precision loss, please use a Decimal or string
eg. convert('0.4', 'krai', 'XRB')

>>> convert('0.4', from_unit='krai', to_unit='XRB')
Decimal('0.0004')

Known Accounts / Constants

>>> from nano import GENESIS_BLOCK_HASH
>>> GENESIS_BLOCK_HASH
'991CF190094C00F0B68E2E5F75F6BEE95A2E0BD93CEAA4A6734DB9F19B728948'
>>> from nano import KNOWN_ACCOUNT_IDS
>>> KNOWN_ACCOUNT_IDS['xrb_1ipx847tk8o46pwxt5qjdbncjqcbwcc1rrmqnkztrfjy5k7z4imsrata9est']
'Developer Fund'
>>> from nano import KNOWN_ACCOUNT_NAMES
>>> KNOWN_ACCOUNT_NAMES['Burn']
'xrb_1111111111111111111111111111111111111111111111111111hifc8npp'

Development

Setup

virtualenv venv
source venv/bin/activate
pip install -r requirements.pip -r requirements-dev.pip
python setup.py develop
pre-commit autoupdate
pre-commit install

Running tests

# regular
pytest

# coverage
./coverage

Building docs

cd docs

# generate once
make html

# live building
make live

Making a release

vim CHANGELOG.rst # update changes

bumpversion [major|minor|patch]

python setup.py upload
You can’t perform that action at this time.