mirror of
https://github.com/comit-network/xmr-btc-swap.git
synced 2024-10-31 15:20:15 +00:00
Bitcoin–Monero Cross-chain Atomic Swap
5dcae81bc3
549: Bump Swatinem/rust-cache from 1.2.0 to 1.3.0 r=thomaseizinger a=dependabot[bot] Bumps [Swatinem/rust-cache](https://github.com/Swatinem/rust-cache) from 1.2.0 to 1.3.0. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/Swatinem/rust-cache/releases">Swatinem/rust-cache's releases</a>.</em></p> <blockquote> <h2>v1.3.0</h2> <ul> <li>Use Rust toolchain file as additional cache key.</li> <li>Allow for a configurable target-dir.</li> </ul> </blockquote> </details> <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/Swatinem/rust-cache/blob/v1/CHANGELOG.md">Swatinem/rust-cache's changelog</a>.</em></p> <blockquote> <h2>1.3.0</h2> <ul> <li>Use Rust toolchain file as additional cache key.</li> <li>Allow for a configurable target-dir.</li> </ul> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href=" |
||
|---|---|---|
| .cargo | ||
| .github | ||
| docs/asb | ||
| monero-harness | ||
| monero-rpc | ||
| monero-wallet | ||
| swap | ||
| .gitignore | ||
| bors.toml | ||
| Cargo.lock | ||
| Cargo.toml | ||
| CHANGELOG.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.
Quick start - CLI
From version 0.6.0 onwards the software default to running on mainnet.
It is recommended to try the software on testnet first, which can be achieved by providing the --testnet flag.
This quickstart guide assumes that you are running the software on testnet (i.e. Bitcoin testnet3 and Monero stagenet):
- Download the latest
swapbinary release for your operating system - Run the binary specifying the monero address where you wish to receive monero and the connection details of the seller:
./swap --testnet buy-xmr --receive-address <YOUR MONERO ADDRESS> --seller-peer-id <SELLERS PEER ID> --seller-addr <SELLERS MULTIADDRESS>You can generate a receive address using your monero wallet. The seller will provide you their peer id and multiaddress. We are running anasbinstance on testnet. You can swap with to get familiar with theswapCLI. Our peer id is12D3KooWCdMKjesXMJz1SiZ7HgotrxuqhQJbP5sgBm2BwP1cqThiand our multiaddress is/dnsaddr/xmr-btc-asb.coblox.tech - Follow the instructions printed to the terminal
For running the software on mainnet you just omit the --testnet flag.
Running on mainnet will automatically apply sane defaults.
Be aware that this software is still early-stage.
Make sure to check --help and understand how the cancel and refund commands work before running on mainnet.
You are running this software at your own risk.
As always we recommend: Verify, don't trust.
All code is available in this repository.
How it works
This repository primarily hosts two components:
- the
swapCLI - the
asbservice
swap CLI
The swap CLI acts in the role of Bob and swaps BTC for XMR.
See ./swap --help for a description of all commands.
The main command is buy-xmr which automatically connects to an instance of asb.
asb service
asb is short for automated swap backend (we are open to suggestions for better names!).
The service acts as the counter-party for the swap CLI in the role of Alice.
It provides the CLI with a quote and the liquidity necessary for swapping BTC into XMR.
For details on how to run the ASB please refer to the ASB docs.
Contact
Feel free to reach out to us in the COMIT-Monero Matrix channel.