2020-10-07 18:12:17 -04:00
|
|
|
XMR to BTC Atomic Swap
|
|
|
|
|
======================
|
|
|
|
|
|
2021-03-04 23:47:16 -05:00
|
|
|
This repository hosts an MVP for atomically swapping BTC to XMR.
|
|
|
|
|
It implements the protocol described in [this](https://arxiv.org/abs/2101.12332) paper.
|
2020-10-07 18:12:17 -04:00
|
|
|
|
2021-03-04 23:47:16 -05:00
|
|
|
## Quick start
|
2020-10-08 18:46:44 -04:00
|
|
|
|
2021-03-04 23:47:16 -05:00
|
|
|
1. Download the [latest release](https://github.com/comit-network/xmr-btc-swap/releases/latest) for your operation system
|
|
|
|
|
2. Run the binary: `./swap buy-xmr --receive-address <YOUR MONERO ADDRESS>`
|
|
|
|
|
3. Follow the instructions printed to the terminal
|
2020-10-08 18:46:44 -04:00
|
|
|
|
2021-03-04 23:47:16 -05:00
|
|
|
## Limitations
|
2020-10-08 18:34:24 -04:00
|
|
|
|
2021-03-04 23:47:16 -05:00
|
|
|
For now, the MVP is `limited` to testnet3 on Bitcoin and `stagenet` on Monero.
|
2020-10-08 18:34:24 -04:00
|
|
|
|
2021-03-04 23:47:16 -05:00
|
|
|
## How it works
|
2020-10-08 18:34:24 -04:00
|
|
|
|
2021-03-04 23:47:16 -05:00
|
|
|
This repository primarily hosts two components:
|
2020-10-07 18:12:17 -04:00
|
|
|
|
2021-03-04 23:47:16 -05:00
|
|
|
- the `swap` CLI
|
|
|
|
|
- the `asb` service
|
2020-10-07 18:12:17 -04:00
|
|
|
|
2021-03-04 23:47:16 -05:00
|
|
|
### swap CLI
|
2020-10-07 18:12:17 -04:00
|
|
|
|
2021-03-04 23:47:16 -05:00
|
|
|
The `swap` CLI acts in the role of Bob and swaps BTC for XMR.
|
|
|
|
|
See `./swap --help` for a description of all commands.
|
|
|
|
|
The main command is `buy-xmr` which automatically connects to an instance of `asb`.
|
2020-10-07 18:12:17 -04:00
|
|
|
|
2021-03-04 23:47:16 -05:00
|
|
|
### asb service
|
2020-10-07 18:12:17 -04:00
|
|
|
|
2021-03-04 23:47:16 -05:00
|
|
|
`asb` is short for **a**utomated **s**wap **b**ackend (we are open to suggestions for better names!).
|
|
|
|
|
The service acts as the counter-party for the `swap` CLI in the role of Alice.
|
|
|
|
|
It provides the CLI with a quote and the liquidity necessary for swapping BTC into XMR.
|
2020-10-07 18:12:17 -04:00
|
|
|
|
2021-03-04 23:47:16 -05:00
|
|
|
## Contact
|
2020-10-07 18:12:17 -04:00
|
|
|
|
2021-03-04 23:47:16 -05:00
|
|
|
Feel free to reach to out us in the [COMIT-Monero Matrix channel](https://matrix.to/#/#comit-monero:matrix.org).
|
