Kelp v1.10.0 Release Notes

Release Date: 2020-10-22 // 5 months ago
  • โž• Added

    ๐Ÿ”„ Changed

    ๐Ÿ—„ Deprecated

    • mirror strategy should allow different divide by values for bid and ask sides, deprecate VOLUME_DIVIDE_BY config field (#545)

    ๐Ÿ›  Fixed

    • โšก๏ธ Kelp GUI: fix issue of fiat currency dropdown not updating correctly (fe19dcbaac0845e5bec7415528ffe02db93245af)
    • ๐Ÿ›  fix index out of range when getting prices from sdex (#416)
    • ๐Ÿ›  Fix baseAmount used when placing orders (#435)
    • ๐Ÿ›  Fix FetchTrades for Kraken (#450)
    • โšก๏ธ sellSideStrategy.go#PreUpdate does not call GetLevels when base asset is 0.0 (#457)
    • โœ… KrakenExchange should get latest cursor in seconds instead of millis (#465)
    • bot should crash if delete cycles threshold is exceeded (#471)
    • โœ‚ remove minOrderSizeBase from UUID in sellTwapLevelProvider.go (#482)
    • Kelp GUI: fix another instance of OSPath.String() being called (#430)
    • ๐Ÿ”€ failure to submit ops (async or sync) should count towards the delete cycles threshold (#498)
    • mirror strategy should prepend deleteOps before both bid and ask ops (#501)
    • ๐ŸŒฒ mirror strategy: log num trades received from backing exchange on triggered fill (#505)
    • Kelp GUI: Propagate bot initialization & startup errors back to GUI (#506)
    • More granular Kelp AppNames (#488)
    • Kelp GUI: disallow invalid characters in bot name (#429)
    • mirror strategy fails to start up without db enabled, nil pointer dereference (#525)
    • modify offers in mirror strategy is not correctly adjusting price and amount (#526)
    • Rounding issues in mirror strategy causing offers to not be placed (#541)

Previous changes from v1.9.0

  • * * * * * * * * * * * * * * ** * * * * * * * * * * * * * ** * * * * * * * * * * * * * ** * * * * * * * * * * * * * ** *
    โฌ†๏ธ Upgrade to this version of Kelp by May 7th for uninterrupted use of Kelp on the Stellar Network.
    ๐Ÿ—„ All prior versions of Kelp are deprecated immediately because they will not work with protocol 13.
    This version of Kelp is fully compatible with existing config files.
    * * * * * * * * * * * * * * ** * * * * * * * * * * * * * ** * * * * * * * * * * * * * ** * * * * * * * * * * * * * ** *

    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โ€.

    ๐Ÿ”„ 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

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