Git-Mirrors/xmr-btc-swap
1
0
Fork 0
mirror of https://github.com/comit-network/xmr-btc-swap.git synced 2024-12-25 23:49:31 -05:00
Code Issues Packages Projects Releases Wiki Activity
Bitcoin–Monero Cross-chain Atomic Swap
1,495 Commits 73 Branches 28 Tags 81 MiB
Rust 99.8%
Shell 0.2%
ada5acb2b5
Go to file
bors[bot] ada5acb2b5
Merge #578 
578: Bump rust_decimal_macros from 1.14.1 to 1.14.3 r=thomaseizinger a=dependabot[bot]

Bumps [rust_decimal_macros](https://github.com/paupino/rust-decimal) from 1.14.1 to 1.14.3.
<details>
<summary>Commits</summary>
<ul>
<li><a href="b7cf68ed01"><code>b7cf68e</code></a> Merge branch 'SebRollen-SR/fix_ln_panic'</li>
<li><a href="8d2829b918"><code>8d2829b</code></a> Minor doc updates for version release</li>
<li><a href="092fdf8c8d"><code>092fdf8</code></a> fix panic in call to Decimal::ZERO.ln()</li>
<li><a href="3482ce1d23"><code>3482ce1</code></a> Merge pull request <a href="https://github-redirect.dependabot.com/paupino/rust-decimal/issues/396">#396</a> from c410-f3r/patch-3</li>
<li><a href="9365805c5f"><code>9365805</code></a> Update arithmetic.rs</li>
<li><a href="23750d8bd0"><code>23750d8</code></a> Merge pull request <a href="https://github-redirect.dependabot.com/paupino/rust-decimal/issues/383">#383</a> from c410-f3r/fuzz</li>
<li><a href="ab3bec8958"><code>ab3bec8</code></a> Merge branch 'master' into fuzz</li>
<li><a href="16b41cc58c"><code>16b41cc</code></a> Merge pull request <a href="https://github-redirect.dependabot.com/paupino/rust-decimal/issues/394">#394</a> from paupino/version/1.14.2</li>
<li><a href="c7bd3bf987"><code>c7bd3bf</code></a> Version 1.14.2</li>
<li><a href="f7f058312d"><code>f7f0583</code></a> Merge branch 'master' into fuzz</li>
<li>Additional commits viewable in <a href="https://github.com/paupino/rust-decimal/compare/1.14.1...1.14.3">compare view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=rust_decimal_macros&package-manager=cargo&previous-version=1.14.1&new-version=1.14.3)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

You can trigger a rebase of this PR 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>
2021-06-23 23:25:48 +00:00
.cargo .cargo/config.toml for specifying linker 2021-03-15 14:36:05 +11:00
.github Bump dprint/check from 1.4 to 1.5 2021-06-17 11:05:20 +00:00
docs/asb Update ASB readme 2021-05-24 16:00:31 +10:00
monero-harness Drop monero-wallet-rpc test container if errors 2021-06-23 15:07:36 +10:00
monero-rpc Update metadata and remove outdated config files / READMEs 2021-05-17 11:03:43 +10:00
monero-wallet Introduce monero-wallet crate 2021-04-30 10:28:46 +10:00
swap ASB aborts if CLI does not lock BTC 2021-06-23 17:54:42 +10:00
.gitignore Push cargo lock to git as we are building a binary 2020-12-01 09:31:41 +11:00
bors.toml Move recovery commands in dedicated module 2021-05-07 16:21:02 +10:00
Cargo.lock Merge #578 2021-06-23 23:25:48 +00:00
Cargo.toml Update secp256kfun and rand to latest version 2021-05-25 15:35:13 +10:00
CHANGELOG.md Changelog entry for price guarantee changes 2021-06-23 17:54:42 +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 the README for mainnet 2021-05-24 10:31:51 +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.

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):

  1. Download the latest swap binary release for your operating system
  2. 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 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 /dnsaddr/xmr-btc-asb.coblox.tech
  3. 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:

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.