Skip to content
This repository has been archived by the owner on Feb 1, 2024. It is now read-only.

Kelp CLI v1.11.0 and Kelp GUI v1.0.0-rc2 (beta)
Compare
Choose a tag to compare
@nikhilsaraf nikhilsaraf released this 15 Feb 16:48
· 36 commits to master since this release
v1.11.0
b0d8617
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.

This release contains v1.11.0 of the Kelp CLI and also includes v1.0.0-rc2 of the Kelp GUI (beta).
Download links at the bottom of this release under “Assets”.

* * * * * * * * * * * * * * ** * * * * * * * * * * * * * ** * * * * * * * * * * * * * ** * * * * * * * * * * * * * * * *
This version is not the latest version and is not supported on the currently active version of the Stellar Protocol.
Please see the latest version at the top of the releases page for a version that is compatible with the Stellar test network and main network
* * * * * * * * * * * * * * ** * * * * * * * * * * * * * ** * * * * * * * * * * * * * ** * * * * * * * * * * * * * * * *

Changes

Notable changes since v1.10.0:

  • Kelp GUI (beta) now available to run on Stellar mainnet
  • Speed up network requests for faster performance of bot across the board
  • deprecate TICK_INTERVAL_SECONDS in favor of TICK_INTERVAL_MILLIS since we can run faster on centralized exchanges now
  • log time taken for update loop
  • Many reliability improvements to the mirror trading template along with some new config options
  • new buy_twap trading template
  • Tested Bitstamp Integration for trading
  • invoking the kelp binary (CLI version) produces the help screen instead of automatically spinning up the GUI now.
  • Kelp GUI: better error propagation from backend to frontend in GUI for feedback to user
  • Kelp GUI: fixed spread value percentages displayed in the GUI against each bot

See the CHANGELOG for more details on this release.

New Kelp GUI v1.0.0-rc2 (beta)

This is a release-candidate because it is experimental, unpolished, and still has several known bugs.
When creating a bot you can now choose to run on the Stellar main network.

Download for your relevant platform (macOS = darwin) and unzip, double-click to use.

Running Instructions

Instructional Video to help get you started.

Take a look at each platform below for specific installation instructions, you will need them for each platform!

Windows

You need to run the kelp-start.bat file to start kelp. If you double-click on kelp.exe it will not work.

This requires you to have Windows 10 and to enable the Ubuntu on Windows Subsystem for Linux (WSL). Look at this Youtube Video (steps 1 and 2 only) on how to install WSL and an Ubuntu linux distribution on Windows.

Follow instructions for Linux below, from within your WSL environment, if you run into any issues.

Note: Windows does not currently support the Electron wrapper and will open up Kelp GUI (beta) directly in your browser window.

Linux

You may need to install dependencies for electron. The full list of dependencies for different flavors of Linux can be found at https://www.electronjs.org/docs/development/build-instructions-linux

Example command to run on Ubuntu to ensure that you have all the dependencies:

sudo apt-get install -y build-essential clang libdbus-1-dev libgtk-3-dev libnotify-dev libgnome-keyring-dev libasound2-dev libcap-dev libcups2-dev libxtst-dev libxss1 libnss3-dev gcc-multilib g++-multilib curl gperf bison python-dbusmock openjdk-8-jre libX11-xcb-dev libstdc++6

Additionally ensure that these dependencies exist:

sudo apt-install -y unzip

MacOS

This version is not code signed for MacOS so you will be asked to confirm whether you want to run the application several times, but there is a workaround.

You need to copy Kelp.app from the DMG file into the /Applications folder (Applications shortcut in the DMG) and run it from /Applications. If you open it from the dmg directly it may fail without any error. Once it is in applications, right click the application and then select Open, which tells the OS that you are sure you want to open the application. See the instructional video for an example of this.

Limitations

  1. This will only run on the test network for now [enabled on Stellar main network as off Kelp GUI v1.0.0-rc2 (beta)]
  2. Some known issues that need to be ironed out, you can follow all open issues here

How can I get more tokens on the Stellar Test Network?

The secret key for the COUPON:GBMMZMK2DC4FFP4CAI6KCVNCQ7WLO5A7DQU7EC7WGHRDQBZB763X4OQI asset issuer is SANPCJHHXCPRN6IIZRBEQXS5M3L2LY7EYQLAVTYD56KL3V7ABO4I3ISZ

Additionally, if you create any token against the GBMMZMK2DC4FFP4CAI6KCVNCQ7WLO5A7DQU7EC7WGHRDQBZB763X4OQI issuer account the Kelp GUI will automatically create a trustline for you and will issue you 1,000 units of that asset.

Where can I get help if I am stuck

The new #kelp channel on the stellar.pubic keybase channel

You can contact me on keybase: @nikhilsaraf and Twitter: @nikhilsaraf9

CLI

Note that Kelp CLI supports trading on 100+ centralized exchanges and you can see the full list of supported exchanges by running ./kelp exchanges.

Sample usage of Kelp's features are described in more detail in the sample config files for v1.11.0 located here.

Upgrade Instructions

Download the package for your platform. After you untar the downloaded file, change to the generated directory (kelp-v1.11.0) and invoke the kelp binary.

Here's an example to get you started (replace filename with the name of the file that you download):

tar xvf filename
cd kelp-v1.11.0
./kelp

To run the bot in simulation mode, try this command:

./kelp trade -c sample_trader.cfg -s buysell -f sample_buysell.cfg --sim

Note: this version is fully compatible with existing config files.

Checksum

You can compare the MD5 hash of the downloaded tar file to the appropriate hash below to verify the integrity of your download.

MD5(kelp-v1.11.0-darwin-amd64.tar)= da97575b404c9b81a3025f53cb72cab2
MD5(kelp-v1.11.0-linux-amd64.tar)= ebda90232c99056e1d82028d66e759a0
MD5(kelp-v1.11.0-linux-arm5.tar)= 1a036045884cf350e3e95707fe7840a8
MD5(kelp-v1.11.0-linux-arm6.tar)= 133c23983e13958364cdf941af04386b
MD5(kelp-v1.11.0-linux-arm64.tar)= 0edc24b0f519869fc6e90dc21a27a7b6
MD5(kelp-v1.11.0-linux-arm7.tar)= a469d6736bd6df23dbb9b137ee062925
MD5(kelp-v1.11.0-windows-amd64.tar)= 6e5592f0d7a4bb288b5f98a8c14bb70a

Help Getting Started

Be sure to check out our walkthroughs section in the README for a quick intro on how to get started with Kelp.

We welcome any feedback that you have. Feel free to open a bug report or submit a feature request, we're listening to what you have to say.

You can contact me on keybase: @nikhilsaraf and Twitter: @nikhilsaraf9

Hope you enjoy this release!

Note: macos = darwin

Assets 12
Loading