cryptum 0.0.376 → 0.0.378
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +24 -25
- data/lib/cryptum/option.rb +1 -1
- data/lib/cryptum/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 63398ee6c04a22f7ba9b7f7bfb682da2c5aa954035f8c46f18f7fc41b5e983aa
|
4
|
+
data.tar.gz: '0984c4623db08e72810136ea536550da0778bd844ef3c25a0b8e44eb0600efa2'
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: beefa5e2b48d8004433a400587fd6cc884d54c6b129327cd0373d59d7f5e983c36a3af0a18cf67ee0d0fd7d52c68cfb41286cfeefe366dd1b5be37638e867084
|
7
|
+
data.tar.gz: 21438d8e3fe7c7208e1487e218232503aed71dfec7fa7e1f0b3f3acbb5c7a357aad7090a2e1d39820435ab603726dee6198ce0dd919ad2259b0c445a945f989c
|
data/README.md
CHANGED
@@ -9,7 +9,7 @@ The goal of cryptum is three-fold:
|
|
9
9
|
- Grow asset portfolios.
|
10
10
|
|
11
11
|
#### How ####
|
12
|
-
Leveraging multiple algorithms based upon portfolio balances, market trends / % margins of change, 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.
|
12
|
+
Leveraging multiple algorithms based upon portfolio balances, market trends / % margins of change, 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 _immediately_ at a specific, fixed profit margin which can be defined by the user. By default, profit margins are determined by built-in algorithms which auto-calculate realistic values based upon conditions observed in the market.
|
13
13
|
|
14
14
|
### **Installation** ###
|
15
15
|
Tested on Linux, & OSX leveraging Ruby via RVM.
|
@@ -60,17 +60,16 @@ $ vi ~/cryptum/etc/open_ai.yaml
|
|
60
60
|
```
|
61
61
|
$ rvm use ruby-<VERSION>@cryptum
|
62
62
|
$ cryptum --help
|
63
|
+
|
63
64
|
USAGE: cryptum [opts]
|
64
65
|
-s, --symbol=SYMBOL <Required - Crypto Symbol.(e.g. btc-usd, eth-usd, etc.)
|
65
66
|
-A, --[no-]autotrade <Optional - Automatically Buy and Sell Crypto>
|
66
67
|
-l, --[no-]list-products <Optional - List Supported Crypto Currency Products and Exit>
|
67
68
|
-p, --proxy=PROXY <Optional - HTTP Proxy e.g. "http://127.0.0.1:8080">
|
68
|
-
-R
|
69
|
-
--[no-]reset-session-countdown
|
69
|
+
-R, --[no-]reset-trend-countdown <Optional - Reset Market Trend Countdown at Session Init (Defaults to false)>
|
70
70
|
-r, --session-root=PATH <Optional - Directory with etc && order_books (Defaults to ~/cryptum)>
|
71
71
|
-S, --[no-]sandbox <Optional - Use Coinbase Sandbox Environment for Testing Ideas>
|
72
|
-
-
|
73
|
-
--time-between-market-trend-reset
|
72
|
+
-t, --trend-reset-time=SECONDS <Optional - Seconds Between Market Trend Reset (Default 86_400 i.e. 1 day)>
|
74
73
|
```
|
75
74
|
|
76
75
|
Example usage to trade on weekly instead of default daily:
|
@@ -78,32 +77,32 @@ Example usage to trade on weekly instead of default daily:
|
|
78
77
|
$ cryptum --symbol btc-usd \
|
79
78
|
--autotrade \
|
80
79
|
--session-root ~/cryptum \
|
81
|
-
--
|
80
|
+
--trend-reset-time 604_800
|
82
81
|
```
|
83
82
|
|
84
|
-
By default, cryptum resets the market trend (i.e. number of buys vs number of sells) every day (i.e. 86400 seconds). As Maker & Taker fees drop in value, it may be useful to change the market trend reset value to something lower:
|
83
|
+
By default, cryptum resets the market trend (i.e. number of buys vs number of sells) every day (i.e. 86400 seconds). As Maker & Taker fees drop in value, it may be useful to change the market trend reset value to something lower (e.g. 4 hours):
|
85
84
|
```
|
86
85
|
$ cryptum --symbol btc-usd \
|
87
86
|
--autotrade \
|
88
87
|
--session-root ~/cryptum \
|
89
|
-
--
|
90
|
-
```
|
91
|
-
|
92
|
-
Possible values for
|
93
|
-
|
94
|
-
|
95
|
-
|
96
|
-
|
97
|
-
|
98
|
-
|
99
|
-
|
100
|
-
|
101
|
-
|
102
|
-
|
103
|
-
|
104
|
-
|
105
|
-
|
106
|
-
|
88
|
+
--trend-reset-time 14_400
|
89
|
+
```
|
90
|
+
|
91
|
+
Possible values for --trend-reset-time reside in the seconds column:
|
92
|
+
|Seconds |Description|UI Label|
|
93
|
+
|----------|-----------|--------|
|
94
|
+
|`604_800` |1 week |1W |
|
95
|
+
|`86_400` |1 day |1D |
|
96
|
+
|`14_400` |4 hours |4h |
|
97
|
+
|`10_800` |3 hours |3h |
|
98
|
+
|`7_200` |2 hours |2h |
|
99
|
+
|`3_600` |1 hour |1h |
|
100
|
+
|`2_700` |5 minutes |45m |
|
101
|
+
|`1_800` |30 minutes |30m |
|
102
|
+
|`900` |15 minutes |15m |
|
103
|
+
|`300` |5 minutes |5m |
|
104
|
+
|`180` |3 minutes |3m |
|
105
|
+
|`60` |1 minute |1m |
|
107
106
|
|
108
107
|
If you choose a lower value than the default, the target profit margin's (i.e. TPM) will also be reduced (assuming the TPM is still higher than Maker + Taker fees). This may be desireable - although TPM is reduced, trading volume should increase resulting in better Maker & Taker fee tiers (i.e. lower cost / trade).
|
109
108
|
|
data/lib/cryptum/option.rb
CHANGED
@@ -61,7 +61,7 @@ module Cryptum
|
|
61
61
|
|
62
62
|
options.on(
|
63
63
|
'-tSECONDS',
|
64
|
-
'--
|
64
|
+
'--trend-reset-time=SECONDS',
|
65
65
|
'<Optional - Seconds Between Market Trend Reset (Default 86_400 i.e. 1 day)>'
|
66
66
|
) { |t| option_choice.market_trend_reset = t.to_i }
|
67
67
|
end.parse!
|
data/lib/cryptum/version.rb
CHANGED