Welcome to Cryptum!

What

Cryptum is an automated, momentum-trading crypto robot written in Ruby.

Why

The goal of cryptum is three-fold:

  • Identify bugs that qualify for bounty on H1
  • Take the emotion out of trading crypto currency.
  • Grow asset portfolios.

How

Leveraging a timing algorithm based upon portfolio balances, market trends, and a duration of time, cryptum determines order size amounts to trickle-buy crytpo. Once a given buy order is filled, a limit sell order is submitted at a specific, fixed profit margin which can be defined by the user.

Installation

Tested on Linux, & OSX leveraging Ruby via RVM.

$ rvm gemset create cryptum
$ rvm list gemsets
$ rvm use ruby-<VERSION>@cryptum
$ gem install --verbose cryptum
$ cryptum --help
  • Create a Local Cryptum Config Folder

    $ mkdir -p ~/cryptum/order_books
    
  • Copy the Gem etc to the Local Config Folder

    $ cp -a $(ruby -r cryptum -e 'puts "#{Gem.path.first}/gems/cryptum-#{Cryptum::VERSION}/etc"') ~/cryptum
    
  • Copy coinbase_pro.yaml.EXAMPLE to the Local Config Folder

    $ cp ~/cryptum/etc/coinbase_pro.yaml.EXAMPLE \
     ~/cryptum/etc/coinbase_pro.yaml
    
  • Add Your API Details to ~/cryptum/etc/coinbase_pro.yaml:

    $ vi ~/cryptum/etc/coinbase_pro.yaml
    

Usage

$ rvm use ruby-<VERSION>@cryptum
$ cryptum --help
$ cryptum --symbol btc-usd \
          --autotrade \
          --repo-root ~/cryptum

From an error monitoring perspective, they can be monitored via:

tail -f /tmp/cryptum-errors.txt

Contributing

For details around contributing to this project, please refer to the Cryptum Development Guide.

Bug reports and pull requests are welcome on GitHub at https://github.com/0dayinc/cryptum. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

Code of Conduct

Everyone interacting in the Cryptum project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

DISCLAIMER

Cryptum is for educational purposes only. No information, forward looking statements, or estimations presented herein represent any final determination on investment performance. While the capabilities implemented in this project have been researched and thought to be reasonably accurate, any investment is speculative in nature.

0day Inc. and/or its agents cannot and do not guarantee any rate of return or investment timeline based on the capabilities provided herein. Feel free to use cryptum at your own risk.