Git-Mirrors/xmr-btc-swap
1
0
Fork 0
mirror of https://github.com/comit-network/xmr-btc-swap.git synced 2024-12-28 17:09:37 -05:00
Code Issues Packages Projects Releases Wiki Activity
Bitcoin–Monero Cross-chain Atomic Swap
1,847 Commits 73 Branches 28 Tags 81 MiB
Rust 99.8%
Shell 0.2%
5a3675a06f
Go to file
Byron Hambly 5a3675a06f
Update dependencies and rust-toolchain to 1.59 
This commit updates the rust-toolchain to the current stable version
1.59, and fixes a number of new clippy warnings from that change.

Other changes:
    - updates backoff to 0.4
    - updates swap to 2021 edition
    - updates comfy-table to 5.0
    - updates monero-wallet to 2021 edition
    - updates moneor-harness to 2021 edition
    - updates bdk and rust_decimal
    - updates tokio-util to 0.7
    - updates workflow to use actions/setup-python@3
    - updates pem and serde_with
    - adds stable rust toolchain notice to readme
2022-03-12 13:05:36 +02:00
.cargo .cargo/config.toml for specifying linker 2021-03-15 14:36:05 +11:00
.github Update dependencies and rust-toolchain to 1.59 2022-03-12 13:05:36 +02:00
docs Add note to readme that --testnet swaps on monero stagenet 2021-09-02 13:47:29 +10:00
monero-harness Update dependencies and rust-toolchain to 1.59 2022-03-12 13:05:36 +02:00
monero-rpc Update dependencies and rust-toolchain to 1.59 2022-03-12 13:05:36 +02:00
monero-wallet Update dependencies and rust-toolchain to 1.59 2022-03-12 13:05:36 +02:00
swap Update dependencies and rust-toolchain to 1.59 2022-03-12 13:05:36 +02:00
.gitignore Push cargo lock to git as we are building a binary 2020-12-01 09:31:41 +11:00
bors.toml Remove flaky test 2021-10-07 10:00:17 +11:00
Cargo.lock Update dependencies and rust-toolchain to 1.59 2022-03-12 13:05:36 +02:00
Cargo.toml Update secp256kfun and rand to latest version 2021-05-25 15:35:13 +10:00
CHANGELOG.md Adjust quote based on Bitcoin balance 2022-03-07 19:30:31 +01: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 dependencies and rust-toolchain to 1.59 2022-03-12 13:05:36 +02:00
rust-toolchain.toml Update dependencies and rust-toolchain to 1.59 2022-03-12 13:05:36 +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 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.58 should work.

Contact

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