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

Kelp CLI v1.9.0 and Kelp GUI v1.0.0-rc1

Compare
Choose a tag to compare
@nikhilsaraf nikhilsaraf released this 07 May 15:07
· 190 commits to master since this release

This release contains v1.9.0 of the Kelp CLI and also includes v1.0.0-rc1 of the Kelp GUI.
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.8.1:

  • Upgrade stellar SDK dependency to 'horizonclient-v3.0.0' tag from stellar/go to make it compatible with protocol 13
  • Kelp GUI: allows revealing the log file on startup
  • Kelp GUI: explicit quit button inside the Kelp GUI window
  • Kelp GUI: allow bots to be deleted when in Initializing state
  • Kelp GUI: automatically pay test accounts with 1000 units of any asset issued by GBMMZ... public issuer
  • Kelp GUI: fix too many open files error
  • Kelp GUI: fix windows bash execution
  • Kelp GUI: run ccxt on windows
  • Kelp GUI: refactor os paths used to accommodate for 260 character file path limit in windows

See the CHANGELOG for more details on this release.

New Kelp GUI v1.0.0-rc1

This is a release-candidate because it is experimental, unpolished, and still has several known bugs. Do not run this on the production Stellar 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 special installation instructions.

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 if you run into any issues.

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 (linked above) for an example of this.

Limitations

  1. This will only run on the test network for now
  2. Some known issues that need to be ironed out, you can follow all open issues here

How can I get more tokens?

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

CLI

Note that Kelp 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.9.0 located here.

Upgrade Instructions

Download the package for your platform and begin making the market! After you untar the downloaded file, change to the generated directory (kelp-v1.9.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.9.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 that this version is fully compatible with existing config files.

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.

Hope you enjoy this release.