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
1,733 Commits 72 Branches 27 Tags 73 MiB
Rust 99.8%
Shell 0.2%
sqlite2
Go to file
rishflab f12879782f Add subcommand to print config 
This subcommand has been introduced to make it easy for users to find the location of the deprecated sled database in case they wish to delete it.
This feature should also resolve difficulties users were facing when trying to find where xmr-btc-swap was storing their data.
2021-09-29 10:04:20 +10:00
.cargo .cargo/config.toml for specifying linker 2021-03-15 14:36:05 +11:00
.github Bump dprint/check from 1.5 to 2.0 2021-09-13 11:07:09 +00:00
docs Add note to readme that --testnet swaps on monero stagenet 2021-09-02 13:47:29 +10:00
monero-harness Drop monero-wallet-rpc test container if errors 2021-06-23 15:07:36 +10:00
monero-rpc Load wallet in monero-wallet-rpc on demand if necessary 2021-08-27 09:39:29 +10:00
monero-wallet Introduce monero-wallet crate 2021-04-30 10:28:46 +10:00
swap Add subcommand to print config 2021-09-29 10:04:20 +10:00
.gitignore Push cargo lock to git as we are building a binary 2020-12-01 09:31:41 +11:00
bors.toml Make --force the default behaviour for manual recovery 2021-09-09 18:08:18 +10:00
Cargo.lock Add sqlite database implementation 2021-09-28 15:56:14 +10:00
Cargo.toml Update secp256kfun and rand to latest version 2021-05-25 15:35:13 +10:00
CHANGELOG.md Add subcommand to print config 2021-09-29 10:04:20 +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 Improve discoverability of contribution guidelines 2021-09-02 10:48:04 +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.

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.

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.

Contact

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