Atomic Swap web interface front end with realtime reporting for Bitcoin to Monero atomic swaps.
Version 0.1.0 is now available. Windows and Linux binaries are available on the release page.
From your web browser on your phone or tablet, after starting swapfe, navigate to your computers LAN address port 3333 followed by /swapform i.e,
http://192.168.1.201:3333/swapformDeveloped by the Comit-Network, their command line interface (SWAP CLI) allows atomic swaps between the Bitcoin and Monero blockchain. You can download the Atomic Swap CLI to get started at the links below.
Latest Release Version (0.8.3): Linux Swap CLI Windows Swap CLI OS X Swap CLI
We suggest exploring the various command line options that you may need to use aside from swapfe. We would appreciate it if you could provide us with feedback when swapfe is not providing details for various commands - as some have not been tested. This will enable us to build a complete GUI for the surrounding swap cli.
swapfe is a GUI web interface to the comit-network swap command. It processes the json output of the swap CLI and interprets it producing a user interface within your web browser. It does this by starting its own "webserver" (flask), automatically opens your web-browser to the specified address, and allows you to interact with the swap CLI.
Currently, the first screen is the swap form. This is a UI for conducting a swap. It uses a known database of Market Makers (Atomic Swap Providers) from our xmrswap.me server. This database is checked against current swap providers and determines if they are online or not. You can use the swapfe web interface to choose an Atomic Swap Provider, or if you know another one that is not in the database, feel free to use that one as well.
swapfe will spin up a web-server and automatically open the web-browser to the swapform page as seen below.
From here you can choose a Seller Address from the table on the page, or enter your own seller address into 1. Next enter an unused Bitcoin change address into 2. Finally, input the Monero address you wish to receive the funds to in 3. Press submit, ONLY ONCE, as it will begin running the command and will display the output of swap CLI on the page it redirects you to.
The redirected page is continuously updated with the results of the swap in realtime. Please leave this page open until the swap finishes successfully or with an error. If a swap is currently live, do not close or go to a different page, as you will not be able to see the progress of the live swap.
Note: All progress of the swap can also be seen in JSON format within the terminal where you ran swapfe. This is used for debugging purposes and will be needed for other use cases when they arise.
Note 2: NO DATA IS SENT TO OUR SERVERS. This is a local only web-server that is only accessible by you. We do pull in the Seller Database from our server, but nothing is sent to our servers. NO LOGGING OF ANY KIND OTHER THAN WHAT YOU SEE IN YOUR LOCAL BROWSER AND IN THE CONSOLE.
Here are the results of the Live Swap page on a fully completed swap. Click on the image to see it in full scale.
As you can see, it provides a nice format with which to see the realtime progress of the active swap. Once your swap completes, you may navigate away from the page.
The most common occurrence when a swap fails is the ability to withdraw your funds from the local Bitcoin wallet that SWAP CLI uses. We provide an interface to allow the withdraw of your transferred BTC back to your private wallet.
One aspect of a failed swap is that generally, you can conduct a new swap using the existing Bitcoin funds with a new provider. Our interface handles this option as well. But, if you are just fed up and want your Bitcoin in a safe place and would rather not conduct a new swap you can use this form to do that. The following screenshot shows the Withdraw interface.
Click submit ONLY ONCE and it will redirect you to a new page telling you the status of your withdraw.
Another feature of swapfe is the ability to view the output of the history database from the Swap CLI database. A screenshot of the history can be seen below.
The swap cli database is very primitive as of now and just displays the SWAP ID and the state the swap finished in. As you can see, we conducted three successful swaps.
We have interpreted the output of the swap command when listing sellers for an arbritary rendezvous point. It pulls in the price, min, max qty and the seller address to a formatted table and displays it within the web browser. The seller form and results can be seen in the following screenshots:
We have successfully tested this on various error responses and completed swaps. It MUST be pointed out that not all use cases have arisen in our testing. This is why we need more people to test this interface so we can properly interpret the JSON results so they may be provided within the interface and appropriate responses can be implemented.
What you can do if the interface fails to provide you with a status that is acceptable is to provide us with the JSON output in the console you ran swapfe from. This will allow us to code an interpreter to the JSON output and be able to handle it within the UI.
We now have Windows (x86) and Linux (x86) standalone binaries.
The Windows (x86) binary was created using PyInstaller and contains all the necessary dependencies we have built in from the source. Simply download the binary release here and run it:
https://github.com/xmrswapme/swapfe/releases/tag/v0.0.3
- Dependencies: qrencode
https://github.com/xmrswapme/swapfe/releases/tag/v0.0.3
There is a .deb package for Debian distributions.
Run
sudo apt install ./swapfe_0.0.3_amd64.deb
swapfe will be installed in /usr/local/bin and the .deb wil isntall the qrencode dependency as well.
Because we have not signed swapfe.exe your Windows system may ask for permission and authorization to run the program. It may also requests permissions to run the swap CLI as well as that package is not signed either. Please allow these permissions to continue with the swap.
Also, we have created a folder in your system's user's home directory called AtomicSwaps/swap. This is where you will find the downloaded swap CLI from Comit-Network. Also, in this directory is where your swap CLI database files are. These contain your local Bitcoin and Monero wallets.
If you need to use the swap CLI for any reason outside of swapfe, please add the following option at the beginning of the command:
--data-base-dir HOMEDIR/AtomicSwaps/swap
or
--data-base-dir HOMEDIR\AtomicSwaps\swap
Where HOMEDIR is your user's home directory for the system you are on.
Simply clone this git repo using your favorite method. Using the git CLI you can simply do the following:
git clone https://github.com/xmrswapme/swapfe
- Python 3 or higher
- Flask
- psutil
- qrencode (linux) or qrcode.exe (windows)
- PyQt5
- BeautifuSoup
- requests
- xmr-btc-swap SWAP CLI
swapfe requires two extra dependencies to be able to run correclty. Issue the following comands in your console to install these requried packages.
pip install Flask
pip install psutil
pip install pyqt5
pip install bs4
pip install requests
sudo apt install qrencode
You must download the Swap CLI from Comit-network and install it in the directory where swapfe resides. For *NIX users you can download that by issuing the following command in your console:
wget -q -O- https://github.com/comit-network/xmr-btc-swap/releases/download/0.8.3/swap_0.8.3_Linux_x86_64.tar | tar x
Once you've installed the required dependencies you can then run swapfe. Simply run the following in your console window:
$ python swapfe.py
or
$ ./swapfe.py
It will spin up a web-server and open your default webbrowser to the location that provides the swap interface.
By default, the swapfe interface uses a tor-socks5 port of 9050. If you have the tor socks running on a different port, we currently don't have support for that. If you know how to read Python you can change that in the code.
If you are not running a tor instance on your machine swapfe will use the clearnet. This is by design of the Comit-network which defaults to tor and falls back to the clearnet if tor is not available.
What is nice about the way we designed a UI to the swap CLI is that it is able to run as a standalone web-server. This is particularly useful for any third-parties that want to be a custodian for Atomic Swaps.
Of course, it must be said that being a third party that wishes to conduct atomic swaps on users behalf goes against the whole ideology of an atomic swap not needing a trusted third party. Nevertheless, exposure to Monero/Bitcoin atomic swaps is necessary and if people are willing to forgo the primary reason behind them and enlist trust in a third party using our (or anyone else's) software; then so be it. So long as the network of atomic swap providers and users increases, we fully support the use of the software.
Because this is a Flask app one can ultimately use it with wsgi and the apache/nginx wsgi module. A little work needs to be done first. For one, if you are going to be a third party providing atomic swaps, then you need to edit the code to issue a unique --data-base-dir <uniqueID> with every instance. You will need to build in an interface to handle an internal swapID, separate from the one the SWAP CLI provides, for each user's case - so that you may conduct withdraws/refunds and the like from the appropriate wallet. Finally, you will need to create a wsgi startup file with the necessary SSL requirements and options.
We plan on providing this use case in future releases as we see the benefit of expanding the network. However, at this time, you will need to edit the code to make this work on you or your party's behalf.
Because this is a local and standalone web-server, a user can run this on a machine on their local network and connect to it from their phone or their tablet and run a swap through there. Hell. You can run a swap while you do the dishes or laundry. It's a use case, although we suggest using your computer.
We are reaching out to the Monero community for support. Testing swapfe and the various functions requires holding a decent amount of XMR. Donations will help us facilitate more functions, design implementations and features in future releases. If you are willing to donate, your donation, not matter how large or small, will go a long way to the maturity of this software.
XMR Address:
82YwMfwYghJ9ZQwuN1NujXZYqFv9UHQkHBobLCp4FdsGa72BS92eM2KfpmzQwZkXr68wmAUuMiXqsXuqScbqE7cTQFZjHth
Thank you.
