mirror of https://github.com/comit-network/xmr-btc-swap.git synced 2024-10-01 01:45:40 -04:00

Bitcoin–Monero Cross-chain Atomic Swap

atomic-swap bitcoin hacktoberfest monero rust

Go to file

Thomas Eizinger ec4234fbb9 Merge `--seller-addr` and `--seller-peer-id` into `--seller` parameter This simplifies the CLI's interface.		2021-07-06 14:51:08 +10:00
.cargo	.cargo/config.toml for specifying linker	2021-03-15 14:36:05 +11:00
.github	Bump dprint/check from 1.4 to 1.5	2021-06-17 11:05:20 +00:00
docs/asb	Update ASB readme	2021-05-24 16:00:31 +10:00
monero-harness	Drop `monero-wallet-rpc` test container if errors	2021-06-23 15:07:36 +10:00
monero-rpc	Update metadata and remove outdated config files / READMEs	2021-05-17 11:03:43 +10:00
monero-wallet	Introduce monero-wallet crate	2021-04-30 10:28:46 +10:00
swap	Merge `--seller-addr` and `--seller-peer-id` into `--seller` parameter	2021-07-06 14:51:08 +10:00
.gitignore	Push cargo lock to git as we are building a binary	2020-12-01 09:31:41 +11:00
bors.toml	Move recovery commands in dedicated module	2021-05-07 16:21:02 +10:00
Cargo.lock	Merge #600 #601	2021-07-05 22:43:59 +00:00
Cargo.toml	Update secp256kfun and rand to latest version	2021-05-25 15:35:13 +10:00
CHANGELOG.md	Merge `--seller-addr` and `--seller-peer-id` into `--seller` parameter	2021-07-06 14:51:08 +10:00
CONTRIBUTING.md	Create CONTRIBUTING.md	2021-06-29 10:58:00 +10:00
dprint.json	Replace cargo-fmt with dprint	2021-05-25 16:11:48 +10:00
LICENSE	Change license to GPLv3	2020-10-12 17:13:25 +11:00
README.md	Update the README for mainnet	2021-05-24 10:31:51 +10:00
rust-toolchain.toml	Upgrade to Rust 1.53	2021-06-21 11:56:04 +10:00

README.md

XMR to BTC Atomic Swap

This repository hosts an MVP for atomically swapping BTC to XMR. It implements the protocol described in section 3 of this paper.

More information about the protocol in this presentation and this blog post.

Quick start - CLI

From version 0.6.0 onwards the software default to running on mainnet. It is recommended to try the software on testnet first, which can be achieved by providing the --testnet flag. This quickstart guide assumes that you are running the software on testnet (i.e. Bitcoin testnet3 and Monero stagenet):

Download the latest swap binary release for your operating system
Run the binary specifying the monero address where you wish to receive monero and the connection details of the seller: ./swap --testnet buy-xmr --receive-address <YOUR MONERO ADDRESS> --seller-peer-id <SELLERS PEER ID> --seller-addr <SELLERS MULTIADDRESS> You can generate a receive address using your monero wallet. The seller will provide you their peer id and multiaddress. We are running an asb instance on testnet. You can swap with to get familiar with the swap CLI. Our peer id is 12D3KooWCdMKjesXMJz1SiZ7HgotrxuqhQJbP5sgBm2BwP1cqThi and our multiaddress is /dnsaddr/xmr-btc-asb.coblox.tech
Follow the instructions printed to the terminal

For running the software on mainnet you just omit the --testnet flag. Running on mainnet will automatically apply sane defaults. Be aware that this software is still early-stage. Make sure to check --help and understand how the cancel and refund commands work before running on mainnet. You are running this software at your own risk. As always we recommend: Verify, don't trust. All code is available in this repository.

How it works

This repository primarily hosts two components:

the swap CLI
the asb service

swap CLI

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.

asb service

asb is short for automated swap backend (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.

For details on how to run the ASB please refer to the ASB docs.

Contact

Feel free to reach out to us in the COMIT-Monero Matrix channel.