mirror of
https://github.com/comit-network/xmr-btc-swap.git
synced 2024-06-26 06:32:10 +00:00
Bitcoin–Monero Cross-chain Atomic Swap
6ca7d0c55d
1345: build(deps): bump bdk from 0.27.1 to 0.28.0 r=delta1 a=dependabot[bot] Bumps [bdk](https://github.com/bitcoindevkit/bdk) from 0.27.1 to 0.28.0. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/bitcoindevkit/bdk/releases">bdk's releases</a>.</em></p> <blockquote> <h2>Release 0.27.2</h2> <h3>RELEASE YANKED FROM CRATES.IO</h3> <p>See: <a href="https://redirect.github.com/bitcoindevkit/bdk/issues/897">bitcoindevkit/bdk#897</a></p> <h3>Summary</h3> <p>Disable default-features for rust-bitcoin and rust-miniscript dependencies, and for rust-esplora-client optional dependency.</p> <h3>Changelog</h3> <p>Changed</p> <ul> <li>Set default-features = false for rust-bitcoin and rust-miniscript <a href="https://redirect.github.com/bitcoindevkit/bdk/issues/882">#882</a></li> <li>Update esplora client dependency to version 0.4 <a href="https://redirect.github.com/bitcoindevkit/bdk/issues/884">#884</a></li> </ul> <h2>What's Changed</h2> <ul> <li>Set dev-dependency base64ct version to <1.6.0 by <a href="https://github.com/notmandatory"><code>`@notmandatory</code></a>` in <a href="https://redirect.github.com/bitcoindevkit/bdk/pull/877">bitcoindevkit/bdk#877</a></li> <li>Set <code>default-features = false</code> for rust-bitcoin and rust-miniscript by <a href="https://github.com/benthecarman"><code>`@benthecarman</code></a>` in <a href="https://redirect.github.com/bitcoindevkit/bdk/pull/882">bitcoindevkit/bdk#882</a></li> <li>Update esplora client dependency to version 0.4 by <a href="https://github.com/notmandatory"><code>`@notmandatory</code></a>` in <a href="https://redirect.github.com/bitcoindevkit/bdk/pull/884">bitcoindevkit/bdk#884</a></li> <li>Bump version to 0.27.2 by <a href="https://github.com/notmandatory"><code>`@notmandatory</code></a>` in <a href="https://redirect.github.com/bitcoindevkit/bdk/pull/892">bitcoindevkit/bdk#892</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/bitcoindevkit/bdk/compare/v0.27.1...v0.27.2">https://github.com/bitcoindevkit/bdk/compare/v0.27.1...v0.27.2</a></p> </blockquote> </details> <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/bitcoindevkit/bdk/blob/master/CHANGELOG.md">bdk's changelog</a>.</em></p> <blockquote> <h1>Changelog</h1> <p>All notable changes to this project can be found here and in each release's git tag and can be viewed with <code>git tag -ln100 "v*"</code>. See also <a href="https://github.com/bitcoindevkit/bdk/blob/master/DEVELOPMENT_CYCLE.md">https://github.com/bitcoindevkit/bdk/blob/master/DEVELOPMENT_CYCLE.md</a> for more details.</p> <p>Contributors do not need to change this file but do need to add changelog details in their PR descriptions. The person making the next release will collect changelog details from included PRs and edit this file prior to each release.</p> <p>The format is based on <a href="https://keepachangelog.com/en/1.0.0/">Keep a Changelog</a>, and this project adheres to <a href="https://semver.org/spec/v2.0.0.html">Semantic Versioning</a>.</p> <h2>[Unreleased]</h2> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href=" |
||
|---|---|---|
| .cargo | ||
| .github | ||
| docs | ||
| monero-harness | ||
| monero-rpc | ||
| monero-wallet | ||
| swap | ||
| utils/gpg_keys | ||
| .gitignore | ||
| bors.toml | ||
| Cargo.lock | ||
| Cargo.toml | ||
| CHANGELOG.md | ||
| CONTRIBUTING.md | ||
| dprint.json | ||
| LICENSE | ||
| README.md | ||
| rust-toolchain.toml | ||
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
swapbinary 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 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.