mirror of
https://github.com/comit-network/xmr-btc-swap.git
synced 2024-09-29 21:06:21 +00:00
Bitcoin–Monero Cross-chain Atomic Swap
59d5a6c096
1040: Bump actions/setup-python from 3 to 4 r=delta1 a=dependabot[bot] Bumps [actions/setup-python](https://github.com/actions/setup-python) from 3 to 4. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/actions/setup-python/releases">actions/setup-python's releases</a>.</em></p> <blockquote> <h2>v4.0.0</h2> <h3>What's Changed</h3> <ul> <li>Support for <code>python-version-file</code> input: <a href="https://github-redirect.dependabot.com/actions/setup-python/issues/336">#336</a></li> </ul> <p>Example of usage:</p> <pre lang="yaml"><code>- uses: actions/setup-python@v4 with: python-version-file: '.python-version' # Read python version from a file - run: python my_script.py </code></pre> <p>There is no default python version for this <code>setup-python</code> major version, the action requires to specify either <code>python-version</code> input or <code>python-version-file</code> input. If the <code>python-version</code> input is not specified the action will try to read required version from file from <code>python-version-file</code> input.</p> <ul> <li>Use pypyX.Y for PyPy <code>python-version</code> input: <a href="https://github-redirect.dependabot.com/actions/setup-python/issues/349">#349</a></li> </ul> <p>Example of usage:</p> <pre lang="yaml"><code>- uses: actions/setup-python@v4 with: python-version: 'pypy3.9' # pypy-X.Y kept for backward compatibility - run: python my_script.py </code></pre> <ul> <li> <p><code>RUNNER_TOOL_CACHE</code> environment variable is equal <code>AGENT_TOOLSDIRECTORY</code>: <a href="https://github-redirect.dependabot.com/actions/setup-python/issues/338">#338</a></p> </li> <li> <p>Bugfix: create missing <code>pypyX.Y</code> symlinks: <a href="https://github-redirect.dependabot.com/actions/setup-python/issues/347">#347</a></p> </li> <li> <p><code>PKG_CONFIG_PATH</code> environment variable: <a href="https://github-redirect.dependabot.com/actions/setup-python/issues/400">#400</a></p> </li> <li> <p>Added <code>python-path</code> output: <a href="https://github-redirect.dependabot.com/actions/setup-python/issues/405">#405</a> <code>python-path</code> output contains Python executable path.</p> </li> <li> <p>Updated <code>zeit/ncc</code> to <code>vercel/ncc</code> package: <a href="https://github-redirect.dependabot.com/actions/setup-python/issues/393">#393</a></p> </li> <li> <p>Bugfix: fixed output for prerelease version of poetry: <a href="https://github-redirect.dependabot.com/actions/setup-python/issues/409">#409</a></p> </li> <li> <p>Made <code>pythonLocation</code> environment variable consistent for Python and PyPy: <a href="https://github-redirect.dependabot.com/actions/setup-python/issues/418">#418</a></p> </li> <li> <p>Bugfix for <code>3.x-dev</code> syntax: <a href="https://github-redirect.dependabot.com/actions/setup-python/issues/417">#417</a></p> </li> <li> <p>Other improvements: <a href="https://github-redirect.dependabot.com/actions/setup-python/issues/318">#318</a> <a href="https://github-redirect.dependabot.com/actions/setup-python/issues/396">#396</a> <a href="https://github-redirect.dependabot.com/actions/setup-python/issues/384">#384</a> <a href="https://github-redirect.dependabot.com/actions/setup-python/issues/387">#387</a> <a href="https://github-redirect.dependabot.com/actions/setup-python/issues/388">#388</a></p> </li> </ul> <h2>Update actions/cache version to 2.0.2</h2> <p>In scope of this release we updated <code>actions/cache</code> package as the new version contains fixes related to GHES 3.5 (<a href="https://github-redirect.dependabot.com/actions/setup-python/pull/382">actions/setup-python#382</a>)</p> <h2>Add "cache-hit" output and fix "python-version" output for PyPy</h2> <p>This release introduces new output cache-hit (<a href="https://github-redirect.dependabot.com/actions/setup-python/pull/373">actions/setup-python#373</a>) and fix python-version output for PyPy (<a href="https://github-redirect.dependabot.com/actions/setup-python/pull/365">actions/setup-python#365</a>)</p> <p>The cache-hit output contains boolean value indicating that an exact match was found for the key. It shows that the action uses already existing cache or not. The output is available only if cache is enabled.</p> <!-- raw HTML omitted --> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href=" |
||
|---|---|---|
| .cargo | ||
| .github | ||
| docs | ||
| monero-harness | ||
| monero-rpc | ||
| monero-wallet | ||
| swap | ||
| .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 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.