Shurli

Shurli App - Proof of Concept App for DEXP2P

⚠️ IMPORTANT NOTE: Please use only small amounts of funds in your wallet while testing subatomic swaps

⚠️ This is Proof of Concept App for DEXP2P so please expect breaking changes.

Objective

To build an independent Proof of Concept App for DEXP2P GUI application that works with existing supported wallets to make sub-atomic trades.

Currently supported

• Komodod
• Komodo-ocean-qt
• Verus-desktop

Why

• No current UI application for subatomic swaps
• No current way (atomic or subatomic) of swapping pirate

Principles

• No centralisation
• Implicit Security (financial aspect)
• Independent (shurli has its own blockchain)
• Open-source

What the success from this project will look like

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

What success for this project will look like

• usable product
• motivates other projects to solve these problems better, adding to the richness of the ecosystem

Current feature set we are working on

Code of conduct

• While reporting issues, please report all the debug data at Shurli Issues.

Getting Shurli application from release builds

If you don't know or don't want to compile Shurli yourself, you can get a pre-compiled binaries from the release page.

With pre-compiled Shurli application, you can ignore all next steps which are required for compiling Shurli on your own machine.

Getting Shurli application compiled from source code

If you wish to compile Shurli application yourself directly through source code follow along next steps.

Requirements

- Go v1.14+
- Git
- Komodo Daemon (dev branch compiled from https://github.com/jl777/komodo)

Install Git, Komodo and Subatomic binaries

Follow this instruction guide and install Komodo and subatomic binaries on your system: https://gist.github.com/himu007/add3181427bb53ab5dc5160537f0c238

Windows Komodo and Subatomic binaries

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.

Install Go on your system

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-go

On Mac can install Go using brew.

brew update
brew install go

Installing Shurli App

In 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

Copy or symlink Komodo and Subatomic binary to 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
├── templates

Just copy (or symlink on Linux/Windows) the komodod, komodo-cli and subatomic binaries to the assets/ directory where you see subatomic.json file located.

Build Shurli application

cd $HOME/go/src/github.com/Meshbits/shurli
make

Start Shurli App

The build command will make a system executable binary named "shurli". To start Shurli execute the following command:

./shurli start

It will start Shurli in daemon mode, leaving Shurli running in background.

And will also automatically open a web address in your default web browser, showing Shurli Dashboard.

NOTE: Shurli Dashboard at the moment is not automatically updated. You have to referesh the the web page manually to get latest status updates for the active blockchains showing on Shurli's dashboard.

Stop Shurli App

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 stop

Shurli logs

If 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.log

And Windows users can use the following command in PowerShell to check live shurli logs:

Get-Content .\shurli.log -Wait

you can press CTRL+C to cancel tail or Get-Content command's output.

Making a release build

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.

Linux build

To make Linux distributable build execute the following command:

cd $HOME/go/src/github.com/Meshbits/shurli
make build-linux

After 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.

Mac OS build

To make Mac OS distributable build execute the following command:

cd $HOME/go/src/github.com/Meshbits/shurli
make build-osx

Smiliar 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.

Windows build

To make Windows distributable build execute the following command:

cd %USERPROFILE%\go\src\github.com\Meshbits\shurli
make build-win

You'll find the windows build files in dist/dist_win.

Clean build

To clean all compiled files execute the following command:

cd $HOME/go/src/github.com/Meshbits/shurli
make clean

It will delete all dist and binary files the build commands created.