Skip to main content

Cross-chain atomic swaps between the networks of two cryptocurrencies.

Project description

Shuttle

Build Status PyPI Version Documentation Status Coverage Status

Shuttle is a python library for cross-chain atomic swaps between the networks of two cryptocurrencies. Cross-chain atomic swaps are the cheapest and most secure way to swap cryptocurrencies. It’s a brand new decentralized payment environment based on Hash Time Lock Contracts (HTLCs) protocol. Documentation

Available Cryptocurrencies

Shuttle has the following available cryptocurrencies to swap:

Cryptocurrencies Mainnet Testnet Solonet
Bitcoin BTC Yes Yes None
Bytom BTM, Assets Yes No No

Dependencies

Installation

PIP to install shuttle globally. For Linux sudo may be required.

$ pip install pyshuttle

For the versions available, see the tags on this repository.

Development

We welcome pull requests. To get started, just fork this repo, clone it locally, and run:

$ pip install -e .[tests] -r requirements.txt

Testing

Tests are still under development.

You can run the tests with:

$ pytest

Or use tox to run the complete suite against the full set of build targets, or pytest to run specific tests against a specific version of Python.

Contributing

Feel free to open an issue if you find a problem, or a pull request if you've solved an issue.

License

Distributed under the AGPL-3.0 license. See LICENSE for more information.

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 pyshuttle, version 0.3.4
Filename, size File type Python version Upload date Hashes
Filename, size pyshuttle-0.3.4-py3-none-any.whl (75.3 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size pyshuttle-0.3.4.tar.gz (57.1 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page