mirror of https://github.com/comit-network/xmr-btc-swap.git synced 2024-12-18 04:14:32 -05:00

Bitcoin–Monero Cross-chain Atomic Swap

atomic-swap bitcoin hacktoberfest monero rust

Go to file

bors[bot] e5f52b1fbd Merge #1257 1257: Update CHANGELOG.md for 0.12.0 Release r=binarybaron a=binarybaron Co-authored-by: binarybaron <86064887+binarybaron@users.noreply.github.com>		2022-12-31 00:00:22 +00:00
.cargo	.cargo/config.toml for specifying linker	2021-03-15 14:36:05 +11:00
.github	build(deps): bump actions/checkout from 3.1.0 to 3.2.0	2022-12-13 11:02:01 +00:00
docs	Change example rendezvous node to `/dns4/discover.unstoppableswap.net/tcp/8888/p2p/12D3Ko...`	2022-04-22 14:51:37 +02:00
monero-harness	feat: upgrade monero images to v0.18.1.2	2022-11-07 09:53:50 +02:00
monero-rpc	fix(asb): use unlocked monero balance for quotes	2022-11-07 09:52:58 +02:00
monero-wallet	Update dependencies and rust-toolchain to 1.59	2022-03-12 13:05:36 +02:00
swap	Merge branch 'master' into monero-unlocked-balance	2022-12-28 18:41:35 +01:00
utils/gpg_keys	docs: add gpg key readme and delta1.asc	2022-08-11 13:05:21 +02:00
.gitignore	docs: update sqlx script and add ci	2022-11-30 15:30:32 +02:00
bors.toml	docs: update sqlx script and add ci	2022-11-30 15:30:32 +02:00
Cargo.lock	Merge branch 'master' into monero-unlocked-balance	2022-12-28 18:41:35 +01:00
Cargo.toml	Update secp256kfun and rand to latest version	2021-05-25 15:35:13 +10:00
CHANGELOG.md	Merge branch 'master' into binarybaron-patch-1	2022-12-30 22:42:31 +01:00
CONTRIBUTING.md	Create CONTRIBUTING.md	2021-06-29 10:58:00 +10:00
dprint.json	Upgrade libp2p and stabilized the version	2022-04-22 15:53:55 +02:00
LICENSE	Change license to GPLv3	2020-10-12 17:13:25 +11:00
README.md	chore: bump rust toolchain to 1.62	2022-10-19 15:02:38 +02:00
rust-toolchain.toml	chore: bump rust toolchain to 1.62	2022-10-19 15:02:38 +02: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.

Currently, swaps are only offered in one direction with the swap CLI on the buying side (send BTC, receive XMR). We are working on implementing a protocol where XMR moves first, but are currently blocked by advances on Monero itself. You can read this blogpost for more information.

Quick Start

Download the latest swap binary release for your operating system.
Find a seller to swap with:

./swap --testnet list-sellers

Swap with a seller:

./swap --testnet buy-xmr --receive-address <YOUR MONERO ADDRESS> --change-address <YOUR BITCOIN CHANGE ADDRESS> --seller <SELLER MULTIADDRESS>

For more detailed documentation on the CLI, see this README.

Becoming a Market Maker

Swapping of course needs two parties - and the CLI is only one of them: The taker that occasionally starts a swap with a market maker.

If you are interested in becoming a market maker you will want to run the second binary provided in this repository: asb - the Automated Swap Backend. Detailed documentation for the asb can be found in this README.

Safety

This software is using cryptography that has not been formally audited. While we do our best to make it safe, it is up to the user to evaluate whether or not it is safe to use for their purposes. Please also see section 15 and 16 of the license.

Keep in mind that swaps are complex protocols, it is recommended to not do anything fancy when moving coins in and out. It is not recommended to bump fees when swapping because it can have unpredictable side effects.

Contributing

We are encourage community contributions whether it be a bug fix or an improvement to the documentation. Please have a look at the contribution guidelines.

Rust Version Support

Please note that only the latest stable Rust toolchain is supported. All stable toolchains since 1.62 should work.

Contact

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