Skip to content

Judecoin/jude-btc-swap

Repository files navigation

JUDE to BTC Atomic Swap

This repository hosts an MVP for atomically swapping BTC to JUDE.

Currently, swaps are only offered in one direction with the swap CLI on the buying side (send BTC, receive JUDE). We are working on implementing a protocol where JUDE moves first, but are currently blocked by advances on Jude itself.

Quick Start

  1. Download the latest swap binary release for your operating system.
  2. Find a seller to swap with:
./swap --testnet list-sellers
  1. Swap with a seller:
./swap --testnet buy-jude --receive-address <YOUR JUDE 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.62 should work.

Contact

Feel free to reach out to us in the [email protected]

Releases

No releases published

Packages

No packages published

Languages