Git-Mirrors/xmr-btc-swap
1
0
Fork 0
mirror of https://github.com/comit-network/xmr-btc-swap.git synced 2024-12-25 15:39:25 -05:00
Code Issues Packages Projects Releases Wiki Activity
Bitcoin–Monero Cross-chain Atomic Swap
1,557 Commits 73 Branches 28 Tags 81 MiB
Rust 99.8%
Shell 0.2%
93a69563a9
Go to file
bors[bot] 93a69563a9
Merge #606 
606: Script to list sellers and auto trigger swap + docs r=da-kami a=da-kami

Uses best price to determine the seller to swap with.

TODO:
- [x] Codebase to be tested on test-/stagenet.
- [x] Update readme
- [x] Update docs

This includes a couple of changes that I found while toying with the output and writing docs. Can drop the individual commits if necessary (but would need to adapt the docs then).

Co-authored-by: Daniel Karzel <daniel@comit.network>
Co-authored-by: Thomas Eizinger <thomas@eizinger.io>
2021-07-07 07:18:46 +00: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 Update docs with latest changes to CLI and ASB 2021-07-07 17:14:57 +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 Make struct-opt docs more consistent 2021-07-07 17:14:56 +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 Add the list-sellers command to the CLI 2021-07-06 20:03:18 +10:00
Cargo.toml Update secp256kfun and rand to latest version 2021-05-25 15:35:13 +10:00
CHANGELOG.md Change --data-dir for --data-base-dir 2021-07-07 17:14:55 +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 docs with latest changes to CLI and ASB 2021-07-07 17:14:57 +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.

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.

Contact

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