Bitcoin–Monero Cross-chain Atomic Swap

atomic-swap bitcoin hacktoberfest monero rust

You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Go to file

bors[bot] a8fb344fc8 Merge #431 #432 431: Bump async-trait from 0.1.49 to 0.1.50 r=thomaseizinger a=dependabot[bot] Bumps [async-trait](https://github.com/dtolnay/async-trait) from 0.1.49 to 0.1.50. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/dtolnay/async-trait/releases">async-trait's releases</a>.</em></p> <blockquote> <h2>0.1.50</h2> <ul> <li>Make compatible with <code>tokio::select</code>, <code>futures::select</code> and similar macros (<a href="https://github-redirect.dependabot.com/dtolnay/async-trait/issues/161">#161</a>)</li> </ul> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="`651ddc1131`"><code>651ddc1</code></a> Release 0.1.50</li> <li><a href="`979ecce801`"><code>979ecce</code></a> Merge pull request <a href="https://github-redirect.dependabot.com/dtolnay/async-trait/issues/162">#162</a> from dtolnay/select</li> <li><a href="`4db8933f5f`"><code>4db8933</code></a> Suppress clippy mut_mut pedantic lint in test suite</li> <li><a href="`54c5d9ca61`"><code>54c5d9c</code></a> Treat select macro always as expression</li> <li><a href="`62f9924834`"><code>62f9924</code></a> Add regression test for issue 161</li> <li>See full diff in <a href="https://github.com/dtolnay/async-trait/compare/0.1.49...0.1.50">compare view</a></li> </ul> </details> <br /> [![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=async-trait&package-manager=cargo&previous-version=0.1.49&new-version=0.1.50)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details> 432: Bump rust_decimal from 1.10.3 to 1.11.0 r=thomaseizinger a=dependabot[bot] Bumps [rust_decimal](https://github.com/paupino/rust-decimal) from 1.10.3 to 1.11.0. <details> <summary>Commits</summary> <ul> <li><a href="`b5ffa94060`"><code>b5ffa94</code></a> Merge pull request <a href="https://github-redirect.dependabot.com/paupino/rust-decimal/issues/344">#344</a> from paupino/version/1.11</li> <li><a href="`467a08d532`"><code>467a08d</code></a> Fix up readme.mdg</li> <li><a href="`9bf9e296ca`"><code>9bf9e29</code></a> Exclude generated tests</li> <li><a href="`e4d2f94c60`"><code>e4d2f94</code></a> Version 1.11</li> <li><a href="`4334b15bbe`"><code>4334b15</code></a> Merge pull request <a href="https://github-redirect.dependabot.com/paupino/rust-decimal/issues/343">#343</a> from paupino/issue/316</li> <li><a href="`711c0fb2af`"><code>711c0fb</code></a> Add macro tests to github workflow</li> <li><a href="`e524da308c`"><code>e524da3</code></a> Allow reexportable macros via feature flags</li> <li><a href="`e59749aa94`"><code>e59749a</code></a> Merge pull request <a href="https://github-redirect.dependabot.com/paupino/rust-decimal/issues/342">#342</a> from paupino/feature/docs</li> <li><a href="`432aede688`"><code>432aede</code></a> Merge branch 'master' into feature/docs</li> <li><a href="`a16e060982`"><code>a16e060</code></a> Update documentation</li> <li>Additional commits viewable in <a href="https://github.com/paupino/rust-decimal/compare/1.10.3...1.11.0">compare view</a></li> </ul> </details> <br /> [![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=rust_decimal&package-manager=cargo&previous-version=1.10.3&new-version=1.11.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>		3 years ago
.cargo	.cargo/config.toml for specifying linker	3 years ago
.github	Merge #412	3 years ago
docs/asb	Update ASB docs	3 years ago
monero-harness	Multiple swaps with the same peer	3 years ago
monero-rpc	Merge #405	3 years ago
swap	Upgrade to bdk 0.6	3 years ago
tokio-tar	Enforce consistent formatting of Markdown files	3 years ago
.dprintrc.json	Enforce consistent formatting of Markdown files	3 years ago
.gitignore	Push cargo lock to git as we are building a binary	4 years ago
CHANGELOG.md	Prepare release 0.5.0	3 years ago
Cargo.lock	Merge #431 #432	3 years ago
Cargo.toml	Split monero-harness into harness and rpc	3 years ago
LICENSE	Change license to GPLv3	4 years ago
README.md	Change the public ASB to use the default port	3 years ago
bors.toml	Multiple swaps with the same peer	3 years ago
rust-toolchain	Add asb to release including ARM build	3 years ago
rustfmt.toml	Change `imports_granularity` to module	3 years ago

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.

Quick start - CLI

Download the latest swap binary 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 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 an asb instance on testnet. You can swap with to get familiar with the swap CLI. Our peer id is 12D3KooWCdMKjesXMJz1SiZ7HgotrxuqhQJbP5sgBm2BwP1cqThi and our multiaddress is /dns4/xmr-btc-asb.coblox.tech/tcp/9939
Follow the instructions printed to the terminal

Limitations

For now, the MVP is limited to testnet3 on Bitcoin and stagenet on Monero.

How it works

This repository primarily hosts two components:

the swap CLI
the asb service

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.