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

Kelp CLI v1.12.0 and Kelp GUI v1.0.0-rc2 (beta)

Latest
Latest
Compare
Choose a tag to compare
@nikhilsaraf nikhilsaraf released this 05 Nov 20:56
· 2 commits to master since this release
v1.12.0
01389b8

* * * * * * * * * * * * * * ** * * * * * * * * * * * * * ** * * * * * * * * * * * * * ** * * * * * * * * * * * * * ** *
Upgrade to this version of Kelp by November 3rd 2021 for uninterrupted use of Kelp on the Stellar Network.
All prior versions of Kelp are deprecated immediately because they will not work with protocol 18.
This version of Kelp is fully compatible with existing config files.
* * * * * * * * * * * * * * ** * * * * * * * * * * * * * ** * * * * * * * * * * * * * ** * * * * * * * * * * * * * ** *

This release contains v1.12.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”.

Changes

Notable improvements since v1.11.0:

  • Kelp GUI: run a single GUI server with multi-tenant users (i.e. better multi-user performance)
  • Kelp GUI: run in server-only mode on a remote server with the --enable-kaas flag (i.e. doesn't bring up the browser/electron on startup)
  • Kelp GUI: Auth0 support for controlled multi-tenant access (see sample_gui.cfg file, run as ./kelp server -c sample_gui.cfg)
  • Script to Automate WSL and Ubuntu Installation on Windows (easier to use on those platforms)
  • support for open exchange rates for forex currency data
  • improve precision for BTC markets
  • Improve fill tracking for SDEX (faster, better rate limit handling)
  • Security updates

Notable fixes since v1.11.0:

  • Upgrade to use stellar/go@horizonclient-v8.0.0 and fix outage from Stellar protocol 18 upgrade
  • Kelp GUI: add scrolling to welcome screen
  • Kelp GUI: Price feed dropdown looks empty on chrome on Windows

See the CHANGELOG for more details on this release.

Upgrade Instructions

Download the package for your platform. After you untar the downloaded file, change to the generated directory (kelp-v1.12.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.12.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(KelpGUI__gui-v1.0.0-rc2__cli-v1.12.0__darwin-amd64.dmg)= c6c5b38db1351b44d2ef2db54c89677d
MD5(KelpGUI__gui-v1.0.0-rc2__cli-v1.12.0__linux-amd64.zip)= 2f95871f86dbacca433ca168853423ea
MD5(KelpGUI__gui-v1.0.0-rc2__cli-v1.12.0__windows-amd64.zip)= b4a1464fe68f439d50a5d85e5513b15d
MD5(kelp-v1.12.0-darwin-amd64.tar)= b5c287b6cd51e2f23ed0ff94268a468c
MD5(kelp-v1.12.0-linux-amd64.tar)= ffb7d7fbcd6596cc743b1dcc6c1b25cd
MD5(kelp-v1.12.0-linux-arm5.tar)= aae1c4bc844113c42bade400422c9b8f
MD5(kelp-v1.12.0-linux-arm6.tar)= 01bb638f8d1add7c32fee03b7d7c72c7
MD5(kelp-v1.12.0-linux-arm64.tar)= 5611e018c2c9704959eec58bdf29c5b5
MD5(kelp-v1.12.0-linux-arm7.tar)= eec9b8eae7ab3bd06db05d1fcab091ce
MD5(kelp-v1.12.0-windows-amd64.tar)= 4a10df2dd80242ef3a609b54231c36f9

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. 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.12.0 located here.

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