Welcome to BismuthClient’s documentation!

BismuthClient

https://img.shields.io/pypi/v/bismuthclient.svg https://img.shields.io/travis/EggPool/bismuthclient.svg Documentation Status

Bismuth python library to be used by dApps and clients.

Features

  • TODO

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Installation

Stable release

To install BismuthClient, run this command in your terminal:

$ pip install bismuthclient

This is the preferred method to install BismuthClient, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources

The sources for BismuthClient can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/EggPool/bismuthclient

Or download the tarball:

$ curl  -OL https://github.com/EggPool/bismuthclient/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Usage

To use BismuthClient in a project:

import bismuthclient

Import the native API cclient class:

from bismuthclient import rpcconnections

bismuthclient

bismuthclient package

Submodules

bismuthclient.async_client module

bismuthclient.bismuthapi module

Wrapper around the official Bismuth API from api.bismuth.live

WIP

bismuthclient.bismuthapi.get_wallet_servers_legacy(light_ip_list='', app_log=None)[source]

Use different methods to return the best possible list of wallet servers, sorted ip:port

bismuthclient.bismuthclient module

bismuthclient.bismuthcrypto module

bismuthclient.bismuthformat module

Formatting helpers for Bismuth

class bismuthclient.bismuthformat.AmountFormatter(amount)[source]

Bases: object

Format a BIS amount to string

amount
to_string(decimals=3, leading=0)[source]
class bismuthclient.bismuthformat.TxFormatter(tx)[source]

Bases: object

Formats a Bismuth Transaction

to_json(for_display=False)[source]
to_string()[source]
tx

bismuthclient.bismuthwallet module

bismuthclient.lwbench module

Wallet server benchmarking functions - ported from gui wallet, converted to use the native api class.

bismuthclient.lwbench.connectible(ipport)[source]

Helper: return True if the ip:port can be connected to, without sending any command.

bismuthclient.lwbench.convert_ip_port(ip, some_port)[source]

Helper: Get ip and port, but extract port from ip if ip was as ip:port

Parameters:
  • ip –
  • some_port – default port
Returns:

(ip, port)
bismuthclient.lwbench.time_measure(light_ip_list, app_log=None)[source]

Measure answer time for the servers in light_ip list

Parameters:
  • light_ip_list – a list of “ip:port” wallet servers
  • app_log – an optional logger
Returns:

A sorted light_ip list

bismuthclient.rpcconnections module

Bismuth default/legacy connection layer. Json over sockets This file is no more compatible with the Bismuth code, it’s been converted to a class EggPool 2018

class bismuthclient.rpcconnections.Connection(ipport, verbose=False, raw=False)[source]

Bases: object

Connection to a Bismuth Node. Handles auto reconnect when needed

check_connection()[source]

Check connection state and reconnect if needed.

close()[source]

Close the socket

command(command, options=None)[source]

Sends a command and return it’s raw result. options has to be a list. Each item of options will be sent separately. So If you ant to send a list, pass a list of list.

command_lock
ipport
last_activity
raw
sdef
stats
verbose

Module contents

Top-level package for BismuthClient.

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/EggPool/bismuthclient/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation

BismuthClient could always use more documentation, whether as part of the official BismuthClient docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/EggPool/bismuthclient/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up bismuthclient for local development.

  1. Fork the bismuthclient repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/bismuthclient.git

  3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

    $ mkvirtualenv bismuthclient
$ cd bismuthclient/
$ python setup.py develop

  4. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

    $ flake8 bismuthclient tests
$ python setup.py test or py.test
$ tox

    To get flake8 and tox, just pip install them into your virtualenv.

  6. Commit your changes and push your branch to GitHub:

    $ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
  3. The pull request should work for Python 2.7, 3.4, 3.5 and 3.6, and for PyPy. Check https://travis-ci.org/EggPool/bismuthclient/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ py.test tests.test_bismuthclient

Deploying

A reminder for the maintainers on how to deploy. Make sure all your changes are committed (including an entry in HISTORY.rst). Then run:

$ bumpversion patch # possible: major / minor / patch
$ git push
$ git push --tags

Travis will then deploy to PyPI if tests pass.

Credits

Development Lead

Contributors

None yet. Why not be the first?

History

0.0.1 (2018-11-17)

  • First release on PyPI.

0.0.2 (2018-11-20)

  • Alpha release

Indices and tables