Skip to main content

A framework to connect other cryptocurrencies to the Waves-Platform.

Project description


A framework to connect other cryptocurrencies to the Waves platform. Requires Python 3.5 or newer.

For detailed usage instructions please refer to the source code documentation that may be exported by using the commands described below. The framework exports a class Gateway. This class has to instantiated. Once done, the Gateway can be started by calling the run method on the resulting instance.

The constructor of the Gateway class requires instances of certain interfaces. Those interfaces define the required functionality that a concrete Gateway implementation has to provide. You may also take a look at an example implementation that realizes a Waves-Gateway for Litecoin:

How to install

pip install waves-gateway

Required packages for development

python3.5 -m pip install coverage mypy pylint Sphinx


The PyLint package is required for linting. Install it like this: pip install pylint.

python3.5 lint


The MyPy package performs static type analysis to prevent errors.

python3.5 mypy


python3.5 test

The convention is to write Unittests for every class in a separate file starting with test_ This is the default prefix of the python Unittest module.


python3.5 coverage

Documentation Generation

Creates a folder docs with the generated HTML documentation.

pip install . -U
python3.5 docs


Doctests are not used in this project. Write Unittests instead.


This project uses yapf ( as a formatting tool So, please format your code before commiting by running this:

python3.5 -m yapf -r waves_gateway --style pep8 --style {COLUMN_LIMIT:120} -i

The pipeline will fail if the code is not properly formatted.


First, run npm run build:prod to update the assets. After that, run python3.5 sdist to create an installable tar archive.

Publish to

twine upload --repository-url dist/*

Regular publish:

twine upload dist/*


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

waves_gateway-1.0.5.tar.gz (302.0 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page