Git-Mirrors/xmr-btc-swap
1
0
Fork 0
mirror of https://github.com/comit-network/xmr-btc-swap.git synced 2024-10-01 01:45:40 -04:00
Code Issues Packages Projects Releases Wiki Activity
Bitcoin–Monero Cross-chain Atomic Swap
2,255 Commits 72 Branches 27 Tags 73 MiB
Rust 99.8%
Shell 0.2%
00cfce57c7
Go to file
Byron Hambly 00cfce57c7
chore: fix dprint config and run fmt
2023-03-15 14:19:57 +02:00
.cargo .cargo/config.toml for specifying linker 2021-03-15 14:36:05 +11:00
.github chore: fix dprint config and run fmt 2023-03-15 14:19:57 +02: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 chore: fix dprint config and run fmt 2023-03-15 14:19:57 +02:00
monero-wallet Update dependencies and rust-toolchain to 1.59 2022-03-12 13:05:36 +02:00
swap chore: fix dprint config and run fmt 2023-03-15 14:19:57 +02: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 feat(swap): merge cancel/refund commands into one command 2023-01-08 12:53:56 +02:00
Cargo.lock build(deps): bump serde from 1.0.152 to 1.0.154 2023-03-09 11:58:03 +00:00
Cargo.toml Update secp256kfun and rand to latest version 2021-05-25 15:35:13 +10:00
CHANGELOG.md ci: update msrv and github actions toolchains 2023-01-10 14:57:09 +02:00
CONTRIBUTING.md Create CONTRIBUTING.md 2021-06-29 10:58:00 +10:00
dprint.json chore: fix dprint config and run fmt 2023-03-15 14:19:57 +02:00
LICENSE Change license to GPLv3 2020-10-12 17:13:25 +11:00
README.md readme: fix minor grammar error 2023-02-27 15:13:17 -05:00
rust-toolchain.toml ci: update msrv and github actions toolchains 2023-01-10 14:57:09 +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

  1. Download the latest swap binary release for your operating system.
  2. Find a seller to swap with:
./swap --testnet list-sellers
  1. 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 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.63 should work.

Contact

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