## **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](https://hackerone.com/coinbase)
- Take the emotion out of trading crypto currency.
- Grow asset portfolios.

#### How ####
By combining real-time market data in conjunction with personalized portfolio and order history, cryptum leverages a collection of status indicators to derive probabilities to buy, sell, hold, cancel orders, or skip a respective crytpo.

Once these probabilities are derived (which occurs at a high cadence), the respective transaction will be submitted for fulfillment.

### **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 '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
```

### **Contributing** ###

For details around contributing to this project, please refer to the [Cryptum Development Guide](https://github.com/0dayinc/cryptum/blob/master/web/app/public/wiki/dev_getting_started.md).

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](https://github.com/0dayinc/cryptum/blob/master/CODE_OF_CONDUCT.md).

### **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](https://github.com/0dayinc/cryptum/blob/master/CODE_OF_CONDUCT.md).

### **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.