Shurli App - alpha version
⚠️ IMPORTANT NOTE: Please use only small amounts of funds in your wallet while testing subatomic swaps
To build an independent GUI application that works with existing supported wallets to make sub-atomic trades.
- Komodod
- Komodo-ocean-qt
- Verus-desktop
- No current UI application for subatomic swaps
- No current way (atomic or subatomic) of swapping pirate
- No centralisation
- Implicit Security (financial aspect)
- Independent (shurli has its own blockchain)
- Open-source
- increase in subatomic swap users
- users in poor countries will be able to make smaller transactions
- increase in pirate and kmd transactions
- increase in privacy (because being able to swap between pirate and others etc)
- usable product
- motivates other projects to solve these problems better, adding to the richness of the ecosystem
- While reporting issues, please report all the debug data at Shurli Issues.
- Go v1.14+
- Git
- Komodo Daemon (dev branch compiled from https://github.com/jl777/komodo)
Follow this instruction guide and install Komodo and subatomic binaries on your system:
https://gist.github.com/himu007/add3181427bb53ab5dc5160537f0c238
At this stage, the required subatomic related API is only available via jl777's copy of komodo source code. So, you can either cross-compile the windows binaries and use those on your windows machine or you can try the debug komodo binaries we used in our development environment, which are available here: https://github.com/Meshbits/komodo/releases/tag/debug_release
It's best to not use these binaries for big amount of funds. Just use the linked komodod to start DEX blockchain which provides the required DEXP2P API. You can use other GUI wallets as usual for other subatomic supported cryptocurrencies.
On Ubuntu can follow this guide: https://github.com/golang/go/wiki/Ubuntu
sudo add-apt-repository ppa:longsleep/golang-backports
sudo apt update
sudo apt install golang-goOn Mac can install Go using brew.
brew update
brew install goIn Linux/Mac you must have a go directory under your $HOME directory in your OS.
If you don't find this directory then create the following:
mkdir -p $HOME/go/{bin,src,pkg}go get -u github.com/Meshbits/shurli
Once you have the komodod, komodo-cli and subatomic executables available (either by compilation or downloaded), you need to have these binaries accessible via Shurli's assets directory.
You'll find assets directory within the Shurli files.
The directory structure of the Shurli looks like this:
.
├── assets
│ └── subatomic.json
├── chains.json
├── config.json.sample
├── favicon.png
├── main.go
├── public
│ ├── coins
│ ├── css
│ ├── fapro
│ ├── gfonts
│ ├── images
│ └── js
├── sagoutil
├── templatesJust copy (or symlink on Linux/Windows) the komodod, komodo-cli and subatomic binaries to the assets/ directory where you see subatomic.json file located.
Make a copy of config.json file from config.json.sample file:
cd $HOME/go/src/github.com/Meshbits/shurli
cp config.json.sample config.jsonYou MUST update value of dex_pubkey, dex_handle, dex_recvzaddr, dex_recvtaddr in your config.json file before starting Shurli application.
dex_recvtaddr: is your KMD's public address. The address which starts with letterR.dex_pubkey: is pubkey of your KMD's public key. You can it from the your KMD wallet application.dex_recvzaddr: is the PIRATE's private address. The address which starts with letterz.dex_handle: it is very much like a unique username you want to use on Subatomic swaps. It will show to other traders when they will see your orders in orderbook. Your handle must with without space between letters.
"dex_nSPV": "1",
"dex_addnode": "136.243.58.134",
"dex_pubkey": "03_YOUR_PUBKEY_FROM_DEX",
"dex_handle": "SET_YOUR_HANDLE_FOR_SUBATOMIC",
"dex_recvzaddr": "YOUR_PIRATE_PRIVATE_ADDRRESS",
"dex_recvtaddr": "YOUR_KMD_PUBLIC_ADDRRESS"cd $HOME/go/src/github.com/Meshbits/shurli
makeThe build command will make a system executable binary named "shurli". To start Shurli execute the following command:
./shurli startIt will start Shurli in daemon mode, leaving Shurli running in background.
Now open http://localhost:8080
To stop Shurli you have to execute the stop command. Otherwise it will keep running in background. Stop with following command:
cd $HOME/go/src/github.com/Meshbits/shurli
./shurli stopIf starting Shurli as daemon using ./shurli start command, it will not show any logs on cosole output.
To view the logs you can check shurli.log file in Shurli directory.
Following example command on Linux/OSX will show updated prints being pushed to shurli.log file:
cd $HOME/go/src/github.com/Meshbits/shurli
tail -f shurli.logAnd Windows users can use the following command in PowerShell to check live shurli logs:
Get-Content .\shurli.log -Waityou can press CTRL+C to cancel tail or Get-Content command's output.
Release builds can be made cross platform. Means you can build Mac OS build on Linux, and Linux builds on Mac OS, thanks to Go's cross-compilation capabilities.
To make Linux distributable build execute the following command:
cd $HOME/go/src/github.com/Meshbits/shurli
make build-linuxAfter this command you'll find a directory dist/dist_unix in $HOME/go/src/github.com/Meshbits/shurli/.
All the required files for Shurli would be in dist/dist_unix. You can renamed or moved dist_unix to anywhere on the machine.
Or make a zip or tar.gz archive of it to distribute.
To make Mac OS distributable build execute the following command:
cd $HOME/go/src/github.com/Meshbits/shurli
make build-osxSmiliar to Linux build, for Mac OS you'll find dist/dist_osx in $HOME/go/src/github.com/Meshbits/shurli/.
You can rename, move or archive the dist_osx and distribute.
To make Windows distributable build execute the following command:
cd %USERPROFILE%\go\src\github.com\Meshbits\shurli
make build-winYou'll find the windows build files in dist/dist_win.
To clean all compiled files execute the following command:
cd $HOME/go/src/github.com/Meshbits/shurli
make cleanIt will delete all dist and binary files the build commands created.