pabraksas / shuttle

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

Shuttle

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

• bytom-wallet-desktop - version 1.1.0 or greater.
• pip - To install packages from the Python Package Index and other indexes.
• python3 version 3.6 or greater.

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.